correct doxygen syntax

rename two functions according to 2a3678c713a88f43867aead48f320d1d301bcab1:
* rtl_getCommandArg -> rtl_getAppCommandArg
* rtl_getCommandArgCount -> rtl_getAppCommandArgCount

Change-Id: I4bd3699640b03a062868b1f92fd6d78d75f5b3d4
Reviewed-on: https://gerrit.libreoffice.org/59910
Tested-by: Jenkins
Reviewed-by: Michael Stahl <Michael.Stahl@cib.de>

3 files changed, 76 insertions, 76 deletions

diff --git a/include/rtl/digest.h b/include/rtl/digest.h
index 6652038874fe..4f6dd13ca6fa 100644
--- a/include/rtl/digest.h
+++ b/include/rtl/digest.h
@@ -77,7 +77,7 @@ typedef enum __rtl_DigestError rtlDigestError;
 /** Create a digest handle for the given algorithm.
     @see rtlDigestAlgorithm
 
-    @param  Algorithm [in] digest algorithm.
+    @param[in] Algorithm digest algorithm.
     @return Digest handle, or 0 upon failure.
  */
 SAL_DLLPUBLIC rtlDigest SAL_CALL rtl_digest_create  (
@@ -87,7 +87,7 @@ SAL_DLLPUBLIC rtlDigest SAL_CALL rtl_digest_create  (
 
 /** Destroy a digest handle.
     @post Digest handle destroyed and invalid.
-    @param    Digest [in] digest handle to be destroyed.
+    @param[in] Digest digest handle to be destroyed.
     @return   None.
  */
 SAL_DLLPUBLIC void SAL_CALL rtl_digest_destroy (
@@ -96,8 +96,8 @@ SAL_DLLPUBLIC void SAL_CALL rtl_digest_destroy (
 
 
 /** Query the algorithm of a given digest.
-    @param  Digest [in] digest handle.
-    @return digest algorithm, or rtl_Digest_AlgorithmInvalid upon failure.
+    @param[in] Digest digest handle.
+    @return digest algorithm, or <code>rtl_Digest_AlgorithmInvalid</code> upon failure.
  */
 SAL_DLLPUBLIC rtlDigestAlgorithm SAL_CALL rtl_digest_queryAlgorithm (
     rtlDigest Digest
@@ -105,7 +105,7 @@ SAL_DLLPUBLIC rtlDigestAlgorithm SAL_CALL rtl_digest_queryAlgorithm (
 
 
 /** Query the length of a given digest.
-    @param  Digest [in] digest handle.
+    @param[in] Digest digest handle.
     @return digest length, or 0 upon failure.
  */
 SAL_DLLPUBLIC sal_uInt32 SAL_CALL rtl_digest_queryLength (
@@ -114,11 +114,11 @@ SAL_DLLPUBLIC sal_uInt32 SAL_CALL rtl_digest_queryLength (
 
 
 /** Initialize a digest with given data.
-    @param  Digest  [in] digest handle.
-    @param  pData   [in] data buffer.
-    @param  nDatLen [in] data length.
+    @param[in] Digest  digest handle.
+    @param[in] pData   data buffer.
+    @param[in] nDatLen data length.
 
-    @return rtl_Digest_E_None upon success.
+    @retval rtl_Digest_E_None upon success.
  */
 SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_init (
     rtlDigest Digest,
@@ -127,11 +127,11 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_init (
 
 
 /** Update a digest with given data.
-    @param  Digest  [in] digest handle.
-    @param  pData   [in] data buffer.
-    @param  nDatLen [in] data length.
+    @param[in] Digest  digest handle.
+    @param[in] pData   data buffer.
+    @param[in] nDatLen data length.
 
-    @return rtl_Digest_E_None upon success.
+    @retval rtl_Digest_E_None upon success.
  */
 SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_update (
     rtlDigest Digest,
@@ -145,11 +145,11 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_update (
     @see      rtl_digest_queryLength()
     @see      rtl_digest_update()
 
-    @param  Digest  [in] digest handle.
-    @param  pBuffer [in] digest value buffer.
-    @param  nBufLen [in] digest value length.
+    @param[in] Digest  digest handle.
+    @param[in] pBuffer digest value buffer.
+    @param[in] nBufLen digest value length.
 
-    @return rtl_Digest_E_None upon success.
+    @retval rtl_Digest_E_None upon success.
  */
 SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_get (
     rtlDigest Digest,
@@ -200,12 +200,12 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getMD2 (
     @see rtl_digest_updateMD2()
     @see rtl_digest_getMD2()
 
-    @param  pData   [in] data buffer.
-    @param  nDatLen [in] data length.
-    @param  pBuffer [in] digest value buffer.
-    @param  nBufLen [in] digest value length.
+    @param[in] pData   data buffer.
+    @param[in] nDatLen data length.
+    @param[in] pBuffer digest value buffer.
+    @param[in] nBufLen digest value length.
 
-    @return rtl_Digest_E_None upon success.
+    @retval rtl_Digest_E_None upon success.
  */
 SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_MD2 (
     const void *pData,   sal_uInt32 nDatLen,
@@ -268,12 +268,12 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_rawMD5 (
     @see rtl_digest_updateMD5()
     @see rtl_digest_getMD5()
 
-    @param  pData   [in] data buffer.
-    @param  nDatLen [in] data length.
-    @param  pBuffer [in] digest value buffer.
-    @param  nBufLen [in] digest value length.
+    @param[in] pData   data buffer.
+    @param[in] nDatLen data length.
+    @param[in] pBuffer digest value buffer.
+    @param[in] nBufLen digest value length.
 
-    @return rtl_Digest_E_None upon success.
+    @retval rtl_Digest_E_None upon success.
  */
 SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_MD5 (
     const void *pData,   sal_uInt32 nDatLen,
@@ -342,12 +342,12 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getSHA (
     @see rtl_digest_updateSHA()
     @see rtl_digest_getSHA()
 
-    @param  pData   [in] data buffer.
-    @param  nDatLen [in] data length.
-    @param  pBuffer [in] digest value buffer.
-    @param  nBufLen [in] digest value length.
+    @param[in] pData   data buffer.
+    @param[in] nDatLen data length.
+    @param[in] pBuffer digest value buffer.
+    @param[in] nBufLen digest value length.
 
-    @return rtl_Digest_E_None upon success.
+    @retval rtl_Digest_E_None upon success.
  */
 SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_SHA (
     const void *pData,   sal_uInt32 nDatLen,
@@ -420,12 +420,12 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getSHA1 (
     @see rtl_digest_updateSHA1()
     @see rtl_digest_getSHA1()
 
-    @param  pData   [in] data buffer.
-    @param  nDatLen [in] data length.
-    @param  pBuffer [in] digest value buffer.
-    @param  nBufLen [in] digest value length.
+    @param[in] pData   data buffer.
+    @param[in] nDatLen data length.
+    @param[in] pBuffer digest value buffer.
+    @param[in] nBufLen digest value length.
 
-    @return rtl_Digest_E_None upon success.
+    @retval rtl_Digest_E_None upon success.
  */
 SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_SHA1 (
     const void *pData,   sal_uInt32 nDatLen,
@@ -455,11 +455,11 @@ SAL_DLLPUBLIC void SAL_CALL rtl_digest_destroyHMAC_MD5 (
 /** Initialize a HMAC_MD5 digest.
     @see rtl_digest_init()
 
-    @param  Digest   [in] digest handle.
-    @param  pKeyData [in] key material buffer.
-    @param  nKeyLen  [in] key material length.
+    @param[in] Digest   digest handle.
+    @param[in] pKeyData key material buffer.
+    @param[in] nKeyLen  key material length.
 
-    @return rtl_Digest_E_None upon success.
+    @retval rtl_Digest_E_None upon success.
  */
 SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_initHMAC_MD5 (
     rtlDigest Digest,
@@ -491,14 +491,14 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getHMAC_MD5 (
     @see rtl_digest_updateHMAC_MD5()
     @see rtl_digest_getHMAC_MD5()
 
-    @param  pKeyData [in] key material buffer.
-    @param  nKeyLen  [in] key material length.
-    @param  pData    [in] data buffer.
-    @param  nDatLen  [in] data length.
-    @param  pBuffer  [in] digest value buffer.
-    @param  nBufLen  [in] digest value length.
+    @param[in] pKeyData key material buffer.
+    @param[in] nKeyLen  key material length.
+    @param[in] pData    data buffer.
+    @param[in] nDatLen  data length.
+    @param[in] pBuffer  digest value buffer.
+    @param[in] nBufLen  digest value length.
 
-    @return rtl_Digest_E_None upon success.
+    @retval rtl_Digest_E_None upon success.
  */
 SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_HMAC_MD5 (
     const sal_uInt8 *pKeyData, sal_uInt32 nKeyLen,
@@ -541,11 +541,11 @@ SAL_DLLPUBLIC void SAL_CALL rtl_digest_destroyHMAC_SHA1 (
 
     @see rtl_digest_init()
 
-    @param  Digest   [in] digest handle.
-    @param  pKeyData [in] key material buffer.
-    @param  nKeyLen  [in] key material length.
+    @param[in] Digest   digest handle.
+    @param[in] pKeyData key material buffer.
+    @param[in] nKeyLen  key material length.
 
-    @return rtl_Digest_E_None upon success.
+    @retval rtl_Digest_E_None upon success.
  */
 SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_initHMAC_SHA1 (
     rtlDigest Digest,
@@ -588,14 +588,14 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getHMAC_SHA1 (
     @see rtl_digest_updateHMAC_SHA1()
     @see rtl_digest_getHMAC_SHA1()
 
-    @param  pKeyData [in] key material buffer.
-    @param  nKeyLen  [in] key material length.
-    @param  pData    [in] data buffer.
-    @param  nDatLen  [in] data length.
-    @param  pBuffer  [in] digest value buffer.
-    @param  nBufLen  [in] digest value length.
+    @param[in] pKeyData key material buffer.
+    @param[in] nKeyLen  key material length.
+    @param[in] pData    data buffer.
+    @param[in] nDatLen  data length.
+    @param[in] pBuffer  digest value buffer.
+    @param[in] nBufLen  digest value length.
 
-    @return rtl_Digest_E_None upon success.
+    @retval rtl_Digest_E_None upon success.
  */
 SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_HMAC_SHA1 (
     const sal_uInt8 *pKeyData, sal_uInt32 nKeyLen,
@@ -614,15 +614,15 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_HMAC_SHA1 (
                 or if the input is guaranteed to have a good length
                 by a start-key derivation round.
 
-    @param  pKeyData  [out] derived key
-    @param  nKeyLen   [in]  derived key length
-    @param  pPassData [in]  password
-    @param  nPassLen  [in]  password length
-    @param  pSaltData [in]  salt
-    @param  nSaltLen  [in]  salt length
-    @param  nCount    [in]  iteration count
+    @param[out] pKeyData  derived key
+    @param[in]  nKeyLen   derived key length
+    @param[in]  pPassData password
+    @param[in]  nPassLen  password length
+    @param[in]  pSaltData salt
+    @param[in]  nSaltLen  salt length
+    @param[in]  nCount    iteration count
 
-    @return rtl_Digest_E_None upon success.
+    @retval rtl_Digest_E_None upon success.
 */
 SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_PBKDF2 (
     sal_uInt8       *pKeyData , sal_uInt32 nKeyLen,
diff --git a/include/rtl/process.h b/include/rtl/process.h
index 388bd91e36aa..dc2b5b7113d0 100644
--- a/include/rtl/process.h
+++ b/include/rtl/process.h
@@ -40,7 +40,7 @@ extern "C" {
     in other processes with a very probability.
 
     @param pTargetUUID 16 byte of memory
-    @see rtl_createUiid()
+    @see rtl_createUuid()
  */
 SAL_DLLPUBLIC void SAL_CALL rtl_getGlobalProcessId( sal_uInt8 *pTargetUUID );
 
@@ -50,11 +50,11 @@ SAL_DLLPUBLIC void SAL_CALL rtl_getGlobalProcessId( sal_uInt8 *pTargetUUID );
     given by command args, that means that all arguments starting with "-env:" will be
     ignored by this function.
 
-    @param nArg [in] The number of the argument to return.
-    @param strCommandArg [out] The string receives the nArg-th command-line argument.
-    @return osl_Process_E_None or does not return.
+    @param[in]  nArg          The number of the argument to return.
+    @param[out] strCommandArg The string receives the nArg-th command-line argument.
+    @retval osl_Process_E_None or does not return.
     @see osl_getCommandArg()
-    @see rtl_getCommandArgCount()
+    @see rtl_getAppCommandArgCount()
 */
 SAL_DLLPUBLIC oslProcessError SAL_CALL rtl_getAppCommandArg(sal_uInt32 nArg, rtl_uString **strCommandArg);
 
@@ -66,7 +66,7 @@ SAL_DLLPUBLIC oslProcessError SAL_CALL rtl_getAppCommandArg(sal_uInt32 nArg, rtl
 
     @return the number of commandline arguments passed to the main-function of this process.
     @see osl_getCommandArgCount()
-    @see rtl_getCommandArg()
+    @see rtl_getAppCommandArg()
 */
 SAL_DLLPUBLIC sal_uInt32 SAL_CALL rtl_getAppCommandArgCount(void);
 
diff --git a/include/rtl/random.h b/include/rtl/random.h
index a8dea31f52b1..8bdb03a8674e 100644
--- a/include/rtl/random.h
+++ b/include/rtl/random.h
@@ -57,7 +57,7 @@ SAL_DLLPUBLIC rtlRandomPool SAL_CALL rtl_random_createPool (void) SAL_THROW_EXTE
 
 
 /** Destroy a Random Pool.
-    @param  Pool [in] a Random Pool.
+    @param[in] Pool a Random Pool.
     @return none. Pool is invalid.
  */
 SAL_DLLPUBLIC void SAL_CALL rtl_random_destroyPool (
@@ -69,7 +69,7 @@ SAL_DLLPUBLIC void SAL_CALL rtl_random_destroyPool (
     @param[in] Pool   a Random Pool.
     @param[in] Buffer a buffer containing the bytes to add.
     @param[in] Bytes  the number of bytes to read from the buffer.
-    @return rtl_Random_E_None upon success.
+    @retval rtl_Random_E_None upon success.
  */
 SAL_DLLPUBLIC rtlRandomError SAL_CALL rtl_random_addBytes (
     rtlRandomPool  Pool,
@@ -82,7 +82,7 @@ SAL_DLLPUBLIC rtlRandomError SAL_CALL rtl_random_addBytes (
     @param[in] Pool    a Random Pool.
     @param[in,out] Buffer a buffer to receive the random bytes.
     @param[in] Bytes the number of bytes to write to the buffer.
-    @return rtl_Random_E_None upon success.
+    @retval rtl_Random_E_None upon success.
  */
 SAL_DLLPUBLIC rtlRandomError SAL_CALL rtl_random_getBytes (
     rtlRandomPool  Pool,