Skip to content

C
core
Kaydet (Commit) 0e8d0c72 authored tarafından Korrawit Pruegsanusak's avatar Korrawit Pruegsanusak Kaydeden (comit) Michael Stahl
Dosyalara gözat
Seçenekler

correct doxygen syntax 

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

Change-Id: I4bd3699640b03a062868b1f92fd6d78d75f5b3d4
Reviewed-on: https://gerrit.libreoffice.org/59910
Tested-by: Jenkins
Reviewed-by: 's avatarMichael Stahl <Michael.Stahl@cib.de>
üst 653218c7
Hide whitespace changes
Inline Side-by-side
Showing with 76 additions and 76 deletions
include/rtl/digest.h
Dosyayı görüntüle @ 0e8d0c72
...@@ -77,7 +77,7 @@ typedef enum __rtl_DigestError rtlDigestError; ...@@ -77,7 +77,7 @@ typedef enum __rtl_DigestError rtlDigestError;
/** Create a digest handle for the given algorithm. /** Create a digest handle for the given algorithm.
@see rtlDigestAlgorithm @see rtlDigestAlgorithm
@param Algorithm [in] digest algorithm. @param[in] Algorithm digest algorithm.
@return Digest handle, or 0 upon failure. @return Digest handle, or 0 upon failure.
*/ */
SAL_DLLPUBLIC rtlDigest SAL_CALL rtl_digest_create ( SAL_DLLPUBLIC rtlDigest SAL_CALL rtl_digest_create (
...@@ -87,7 +87,7 @@ SAL_DLLPUBLIC rtlDigest SAL_CALL rtl_digest_create ( ...@@ -87,7 +87,7 @@ SAL_DLLPUBLIC rtlDigest SAL_CALL rtl_digest_create (
/** Destroy a digest handle. /** Destroy a digest handle.
@post Digest handle destroyed and invalid. @post Digest handle destroyed and invalid.
@param Digest [in] digest handle to be destroyed. @param[in] Digest digest handle to be destroyed.
@return None. @return None.
*/ */
SAL_DLLPUBLIC void SAL_CALL rtl_digest_destroy ( SAL_DLLPUBLIC void SAL_CALL rtl_digest_destroy (
...@@ -96,8 +96,8 @@ 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. /** Query the algorithm of a given digest.
@param Digest [in] digest handle. @param[in] Digest digest handle.
@return digest algorithm, or rtl_Digest_AlgorithmInvalid upon failure. @return digest algorithm, or <code>rtl_Digest_AlgorithmInvalid</code> upon failure.
*/ */
SAL_DLLPUBLIC rtlDigestAlgorithm SAL_CALL rtl_digest_queryAlgorithm ( SAL_DLLPUBLIC rtlDigestAlgorithm SAL_CALL rtl_digest_queryAlgorithm (
rtlDigest Digest rtlDigest Digest
...@@ -105,7 +105,7 @@ SAL_DLLPUBLIC rtlDigestAlgorithm SAL_CALL rtl_digest_queryAlgorithm ( ...@@ -105,7 +105,7 @@ SAL_DLLPUBLIC rtlDigestAlgorithm SAL_CALL rtl_digest_queryAlgorithm (
/** Query the length of a given digest. /** Query the length of a given digest.
@param Digest [in] digest handle. @param[in] Digest digest handle.
@return digest length, or 0 upon failure. @return digest length, or 0 upon failure.
*/ */
SAL_DLLPUBLIC sal_uInt32 SAL_CALL rtl_digest_queryLength ( SAL_DLLPUBLIC sal_uInt32 SAL_CALL rtl_digest_queryLength (
...@@ -114,11 +114,11 @@ 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. /** Initialize a digest with given data.
@param Digest [in] digest handle. @param[in] Digest digest handle.
@param pData [in] data buffer. @param[in] pData data buffer.
@param nDatLen [in] data length. @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 ( SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_init (
rtlDigest Digest, rtlDigest Digest,
...@@ -127,11 +127,11 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_init ( ...@@ -127,11 +127,11 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_init (
/** Update a digest with given data. /** Update a digest with given data.
@param Digest [in] digest handle. @param[in] Digest digest handle.
@param pData [in] data buffer. @param[in] pData data buffer.
@param nDatLen [in] data length. @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 ( SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_update (
rtlDigest Digest, rtlDigest Digest,
...@@ -145,11 +145,11 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_update ( ...@@ -145,11 +145,11 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_update (
@see rtl_digest_queryLength() @see rtl_digest_queryLength()
@see rtl_digest_update() @see rtl_digest_update()
@param Digest [in] digest handle. @param[in] Digest digest handle.
@param pBuffer [in] digest value buffer. @param[in] pBuffer digest value buffer.
@param nBufLen [in] digest value length. @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 ( SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_get (
rtlDigest Digest, rtlDigest Digest,
...@@ -200,12 +200,12 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getMD2 ( ...@@ -200,12 +200,12 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getMD2 (
@see rtl_digest_updateMD2() @see rtl_digest_updateMD2()
@see rtl_digest_getMD2() @see rtl_digest_getMD2()
@param pData [in] data buffer. @param[in] pData data buffer.
@param nDatLen [in] data length. @param[in] nDatLen data length.
@param pBuffer [in] digest value buffer. @param[in] pBuffer digest value buffer.
@param nBufLen [in] digest value length. @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 ( SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_MD2 (
const void *pData, sal_uInt32 nDatLen, const void *pData, sal_uInt32 nDatLen,
...@@ -268,12 +268,12 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_rawMD5 ( ...@@ -268,12 +268,12 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_rawMD5 (
@see rtl_digest_updateMD5() @see rtl_digest_updateMD5()
@see rtl_digest_getMD5() @see rtl_digest_getMD5()
@param pData [in] data buffer. @param[in] pData data buffer.
@param nDatLen [in] data length. @param[in] nDatLen data length.
@param pBuffer [in] digest value buffer. @param[in] pBuffer digest value buffer.
@param nBufLen [in] digest value length. @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 ( SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_MD5 (
const void *pData, sal_uInt32 nDatLen, const void *pData, sal_uInt32 nDatLen,
...@@ -342,12 +342,12 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getSHA ( ...@@ -342,12 +342,12 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getSHA (
@see rtl_digest_updateSHA() @see rtl_digest_updateSHA()
@see rtl_digest_getSHA() @see rtl_digest_getSHA()
@param pData [in] data buffer. @param[in] pData data buffer.
@param nDatLen [in] data length. @param[in] nDatLen data length.
@param pBuffer [in] digest value buffer. @param[in] pBuffer digest value buffer.
@param nBufLen [in] digest value length. @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 ( SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_SHA (
const void *pData, sal_uInt32 nDatLen, const void *pData, sal_uInt32 nDatLen,
...@@ -420,12 +420,12 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getSHA1 ( ...@@ -420,12 +420,12 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getSHA1 (
@see rtl_digest_updateSHA1() @see rtl_digest_updateSHA1()
@see rtl_digest_getSHA1() @see rtl_digest_getSHA1()
@param pData [in] data buffer. @param[in] pData data buffer.
@param nDatLen [in] data length. @param[in] nDatLen data length.
@param pBuffer [in] digest value buffer. @param[in] pBuffer digest value buffer.
@param nBufLen [in] digest value length. @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 ( SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_SHA1 (
const void *pData, sal_uInt32 nDatLen, const void *pData, sal_uInt32 nDatLen,
...@@ -455,11 +455,11 @@ SAL_DLLPUBLIC void SAL_CALL rtl_digest_destroyHMAC_MD5 ( ...@@ -455,11 +455,11 @@ SAL_DLLPUBLIC void SAL_CALL rtl_digest_destroyHMAC_MD5 (
/** Initialize a HMAC_MD5 digest. /** Initialize a HMAC_MD5 digest.
@see rtl_digest_init() @see rtl_digest_init()
@param Digest [in] digest handle. @param[in] Digest digest handle.
@param pKeyData [in] key material buffer. @param[in] pKeyData key material buffer.
@param nKeyLen [in] key material length. @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 ( SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_initHMAC_MD5 (
rtlDigest Digest, rtlDigest Digest,
...@@ -491,14 +491,14 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getHMAC_MD5 ( ...@@ -491,14 +491,14 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getHMAC_MD5 (
@see rtl_digest_updateHMAC_MD5() @see rtl_digest_updateHMAC_MD5()
@see rtl_digest_getHMAC_MD5() @see rtl_digest_getHMAC_MD5()
@param pKeyData [in] key material buffer. @param[in] pKeyData key material buffer.
@param nKeyLen [in] key material length. @param[in] nKeyLen key material length.
@param pData [in] data buffer. @param[in] pData data buffer.
@param nDatLen [in] data length. @param[in] nDatLen data length.
@param pBuffer [in] digest value buffer. @param[in] pBuffer digest value buffer.
@param nBufLen [in] digest value length. @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 ( SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_HMAC_MD5 (
const sal_uInt8 *pKeyData, sal_uInt32 nKeyLen, const sal_uInt8 *pKeyData, sal_uInt32 nKeyLen,
...@@ -541,11 +541,11 @@ SAL_DLLPUBLIC void SAL_CALL rtl_digest_destroyHMAC_SHA1 ( ...@@ -541,11 +541,11 @@ SAL_DLLPUBLIC void SAL_CALL rtl_digest_destroyHMAC_SHA1 (
@see rtl_digest_init() @see rtl_digest_init()
@param Digest [in] digest handle. @param[in] Digest digest handle.
@param pKeyData [in] key material buffer. @param[in] pKeyData key material buffer.
@param nKeyLen [in] key material length. @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 ( SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_initHMAC_SHA1 (
rtlDigest Digest, rtlDigest Digest,
...@@ -588,14 +588,14 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getHMAC_SHA1 ( ...@@ -588,14 +588,14 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getHMAC_SHA1 (
@see rtl_digest_updateHMAC_SHA1() @see rtl_digest_updateHMAC_SHA1()
@see rtl_digest_getHMAC_SHA1() @see rtl_digest_getHMAC_SHA1()
@param pKeyData [in] key material buffer. @param[in] pKeyData key material buffer.
@param nKeyLen [in] key material length. @param[in] nKeyLen key material length.
@param pData [in] data buffer. @param[in] pData data buffer.
@param nDatLen [in] data length. @param[in] nDatLen data length.
@param pBuffer [in] digest value buffer. @param[in] pBuffer digest value buffer.
@param nBufLen [in] digest value length. @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 ( SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_HMAC_SHA1 (
const sal_uInt8 *pKeyData, sal_uInt32 nKeyLen, const sal_uInt8 *pKeyData, sal_uInt32 nKeyLen,
...@@ -614,15 +614,15 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_HMAC_SHA1 ( ...@@ -614,15 +614,15 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_HMAC_SHA1 (
or if the input is guaranteed to have a good length or if the input is guaranteed to have a good length
by a start-key derivation round. by a start-key derivation round.
@param pKeyData [out] derived key @param[out] pKeyData derived key
@param nKeyLen [in] derived key length @param[in] nKeyLen derived key length
@param pPassData [in] password @param[in] pPassData password
@param nPassLen [in] password length @param[in] nPassLen password length
@param pSaltData [in] salt @param[in] pSaltData salt
@param nSaltLen [in] salt length @param[in] nSaltLen salt length
@param nCount [in] iteration count @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_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_PBKDF2 (
sal_uInt8 *pKeyData , sal_uInt32 nKeyLen, sal_uInt8 *pKeyData , sal_uInt32 nKeyLen,
......
include/rtl/process.h
Dosyayı görüntüle @ 0e8d0c72
...@@ -40,7 +40,7 @@ extern "C" { ...@@ -40,7 +40,7 @@ extern "C" {
in other processes with a very probability. in other processes with a very probability.
@param pTargetUUID 16 byte of memory @param pTargetUUID 16 byte of memory
@see rtl_createUiid() @see rtl_createUuid()
*/ */
SAL_DLLPUBLIC void SAL_CALL rtl_getGlobalProcessId( sal_uInt8 *pTargetUUID ); SAL_DLLPUBLIC void SAL_CALL rtl_getGlobalProcessId( sal_uInt8 *pTargetUUID );
...@@ -50,11 +50,11 @@ 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 given by command args, that means that all arguments starting with "-env:" will be
ignored by this function. ignored by this function.
@param nArg [in] The number of the argument to return. @param[in] nArg The number of the argument to return.
@param strCommandArg [out] The string receives the nArg-th command-line argument. @param[out] strCommandArg The string receives the nArg-th command-line argument.
@return osl_Process_E_None or does not return. @retval osl_Process_E_None or does not return.
@see osl_getCommandArg() @see osl_getCommandArg()
@see rtl_getCommandArgCount() @see rtl_getAppCommandArgCount()
*/ */
SAL_DLLPUBLIC oslProcessError SAL_CALL rtl_getAppCommandArg(sal_uInt32 nArg, rtl_uString **strCommandArg); 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 ...@@ -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. @return the number of commandline arguments passed to the main-function of this process.
@see osl_getCommandArgCount() @see osl_getCommandArgCount()
@see rtl_getCommandArg() @see rtl_getAppCommandArg()
*/ */
SAL_DLLPUBLIC sal_uInt32 SAL_CALL rtl_getAppCommandArgCount(void); SAL_DLLPUBLIC sal_uInt32 SAL_CALL rtl_getAppCommandArgCount(void);
......
include/rtl/random.h
Dosyayı görüntüle @ 0e8d0c72
...@@ -57,7 +57,7 @@ SAL_DLLPUBLIC rtlRandomPool SAL_CALL rtl_random_createPool (void) SAL_THROW_EXTE ...@@ -57,7 +57,7 @@ SAL_DLLPUBLIC rtlRandomPool SAL_CALL rtl_random_createPool (void) SAL_THROW_EXTE
/** Destroy a Random Pool. /** Destroy a Random Pool.
@param Pool [in] a Random Pool. @param[in] Pool a Random Pool.
@return none. Pool is invalid. @return none. Pool is invalid.
*/ */
SAL_DLLPUBLIC void SAL_CALL rtl_random_destroyPool ( SAL_DLLPUBLIC void SAL_CALL rtl_random_destroyPool (
...@@ -69,7 +69,7 @@ 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] Pool a Random Pool.
@param[in] Buffer a buffer containing the bytes to add. @param[in] Buffer a buffer containing the bytes to add.
@param[in] Bytes the number of bytes to read from the buffer. @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 ( SAL_DLLPUBLIC rtlRandomError SAL_CALL rtl_random_addBytes (
rtlRandomPool Pool, rtlRandomPool Pool,
...@@ -82,7 +82,7 @@ SAL_DLLPUBLIC rtlRandomError SAL_CALL rtl_random_addBytes ( ...@@ -82,7 +82,7 @@ SAL_DLLPUBLIC rtlRandomError SAL_CALL rtl_random_addBytes (
@param[in] Pool a Random Pool. @param[in] Pool a Random Pool.
@param[in,out] Buffer a buffer to receive the random bytes. @param[in,out] Buffer a buffer to receive the random bytes.
@param[in] Bytes the number of bytes to write to the buffer. @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 ( SAL_DLLPUBLIC rtlRandomError SAL_CALL rtl_random_getBytes (
rtlRandomPool Pool, rtlRandomPool Pool,
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment