[prev in list] [next in list] [prev in thread] [next in thread] 

List:       kde-commits
Subject:    [kio] src/core: Fix apidoc format.
From:       Frederik Schwarzer <schwarzer () kde ! org>
Date:       2016-01-23 11:20:06
Message-ID: E1aMwEg-0001OV-Nw () scm ! kde ! org
[Download RAW message or body]

Git commit 277701fbe09ea2fb83a0efadca61abd69d02a49f by Frederik Schwarzer.
Committed on 23/01/2016 at 11:19.
Pushed by schwarzer into branch 'master'.

Fix apidoc format.

No full-stop (.) allowed in short description.

M  +5    -5    src/core/storedtransferjob.h
M  +2    -2    src/core/transferjob.h

http://commits.kde.org/kio/277701fbe09ea2fb83a0efadca61abd69d02a49f

diff --git a/src/core/storedtransferjob.h b/src/core/storedtransferjob.h
index 3f267c9..82ffe77 100644
--- a/src/core/storedtransferjob.h
+++ b/src/core/storedtransferjob.h
@@ -75,7 +75,7 @@ private:
 };
 
 /**
- * Get (a.k.a. read), into a single QByteArray.
+ * Get (means: read), into a single QByteArray.
  * @see StoredTransferJob
  *
  * @param url the URL of the file
@@ -86,7 +86,7 @@ private:
 KIOCORE_EXPORT StoredTransferJob *storedGet(const QUrl &url, LoadType reload = \
NoReload, JobFlags flags = DefaultFlags);  
 /**
- * Put (a.k.a. write) data from a QIODevice.
+ * Put (means: write) data from a QIODevice.
  * @see StoredTransferJob
  *
  * @param input The data to write, a device to read from. Must be open for reading.
@@ -102,7 +102,7 @@ KIOCORE_EXPORT StoredTransferJob *storedPut(QIODevice* input, \
const QUrl &url, i  JobFlags flags = DefaultFlags);
 
 /**
- * Put (a.k.a. write) data from a single QByteArray.
+ * Put (means: write) data from a single QByteArray.
  * @see StoredTransferJob
  *
  * @param arr The data to write
@@ -116,7 +116,7 @@ KIOCORE_EXPORT StoredTransferJob *storedPut(const QByteArray \
&arr, const QUrl &u  JobFlags flags = DefaultFlags);
 
 /**
- * HTTP POST (a.k.a. write) data from a single QByteArray.
+ * HTTP POST (means: write) data from a single QByteArray.
  * @see StoredTransferJob
  *
  * @param arr The data to write
@@ -128,7 +128,7 @@ KIOCORE_EXPORT StoredTransferJob *storedPut(const QByteArray \
&arr, const QUrl &u  KIOCORE_EXPORT StoredTransferJob *storedHttpPost(const \
QByteArray &arr, const QUrl &url,  JobFlags flags = DefaultFlags);
 /**
- * HTTP POST (a.k.a. write) data from the given IO device.
+ * HTTP POST (means: write) data from the given IO device.
  * @see StoredTransferJob
  *
  * @param device Device from which the encoded data to be posted is read. Must be \
                open for reading.
diff --git a/src/core/transferjob.h b/src/core/transferjob.h
index 6d78793..428638b 100644
--- a/src/core/transferjob.h
+++ b/src/core/transferjob.h
@@ -212,7 +212,7 @@ private:
 };
 
 /**
- * Get (a.k.a. read).
+ * Get (means: read).
  * This is the job to use in order to "download" a file into memory.
  * The slave emits the data through the data() signal.
  *
@@ -236,7 +236,7 @@ private:
 KIOCORE_EXPORT TransferJob *get(const QUrl &url, LoadType reload = NoReload, \
JobFlags flags = DefaultFlags);  
 /**
- * Put (a.k.a. write)
+ * Put (means: write)
  *
  * @param url Where to write data.
  * @param permissions May be -1. In this case no special permission mode is set.


[prev in list] [next in list] [prev in thread] [next in thread]