Remove a bunch of comment cruft - esp. "the end." bits

Change-Id: I5a339a4211ec8eb547459996be69610b9f2b3766
Reviewed-on: https://gerrit.libreoffice.org/38147Tested-by: Jenkins <ci@libreoffice.org>
Reviewed-by: Samuel Mehrbrodt <Samuel.Mehrbrodt@cib.de>

include/rtl/cipher.h

@@ -29,16 +29,10 @@
 extern "C" {
 #endif
 
-/*========================================================================
- *
- * rtlCipher interface.
- *
- *======================================================================*/
 /** Cipher Handle opaque type.
  */
 typedef void* rtlCipher;
 
-
 /** Cipher Algorithm enumeration.
     @see rtl_cipher_create()
  */
@@ -54,7 +48,6 @@ enum __rtl_CipherAlgorithm
  */
 typedef enum __rtl_CipherAlgorithm rtlCipherAlgorithm;
 
-
 /** Cipher Mode enumeration.
     @see rtl_cipher_create()
  */
@@ -71,7 +64,6 @@ enum __rtl_CipherMode
  */
 typedef enum __rtl_CipherMode rtlCipherMode;
 
-
 /** Cipher Direction enumeration.
     @see rtl_cipher_init()
  */
@@ -122,7 +114,6 @@ SAL_DLLPUBLIC rtlCipher SAL_CALL rtl_cipher_create (
     rtlCipherMode      Mode
 ) SAL_THROW_EXTERN_C();
 
-
 /** Inititialize a cipher for the given direction.
     @see rtlCipherDirection
 
@@ -141,7 +132,6 @@ SAL_DLLPUBLIC rtlCipherError SAL_CALL rtl_cipher_init (
     const sal_uInt8    *pArgData, sal_Size nArgLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Encode a buffer under a given cipher algorithm.
     @pre Initialized for a compatible cipher direction.
     @see     rtl_cipher_init()
@@ -159,7 +149,6 @@ SAL_DLLPUBLIC rtlCipherError SAL_CALL rtl_cipher_encode (
     sal_uInt8  *pBuffer, sal_Size nBufLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Decode a buffer under a given cipher algorithm.
     @pre Initialized for a compatible cipher direction.
     @see     rtl_cipher_init()
@@ -177,7 +166,6 @@ SAL_DLLPUBLIC rtlCipherError SAL_CALL rtl_cipher_decode (
     sal_uInt8  *pBuffer, sal_Size nBufLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Destroy a cipher handle.
     @param  Cipher [in] cipher handle to be destroyed.
     @return None. Cipher handle destroyed and invalid.
@@ -186,12 +174,6 @@ SAL_DLLPUBLIC void SAL_CALL rtl_cipher_destroy (
     rtlCipher Cipher
 ) SAL_THROW_EXTERN_C();
 
-
-/*========================================================================
- *
- * rtl_cipherBF (Blowfish) interface.
- *
- *======================================================================*/
 /** Create a Blowfish cipher handle for the given mode.
 
     The Blowfish block cipher algorithm is specified in
@@ -203,7 +185,6 @@ SAL_DLLPUBLIC rtlCipher SAL_CALL rtl_cipher_createBF (
     rtlCipherMode Mode
 ) SAL_THROW_EXTERN_C();
 
-
 /** Inititialize a Blowfish cipher for the given direction.
     @see rtl_cipher_init()
  */
@@ -214,7 +195,6 @@ SAL_DLLPUBLIC rtlCipherError SAL_CALL rtl_cipher_initBF (
     const sal_uInt8 *pArgData, sal_Size nArgLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Encode a buffer under the Blowfish cipher algorithm.
     @see rtl_cipher_encode()
  */
@@ -224,7 +204,6 @@ SAL_DLLPUBLIC rtlCipherError SAL_CALL rtl_cipher_encodeBF (
     sal_uInt8  *pBuffer, sal_Size nBufLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Decode a buffer under the Blowfish cipher algorithm.
     @see rtl_cipher_decode()
  */
@@ -234,7 +213,6 @@ SAL_DLLPUBLIC rtlCipherError SAL_CALL rtl_cipher_decodeBF (
     sal_uInt8  *pBuffer, sal_Size nBufLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Destroy a Blowfish cipher handle.
     @see rtl_cipher_destroy()
  */
@@ -242,12 +220,6 @@ SAL_DLLPUBLIC void SAL_CALL rtl_cipher_destroyBF (
     rtlCipher Cipher
 ) SAL_THROW_EXTERN_C();
 
-
-/*========================================================================
- *
- * rtl_cipherARCFOUR (RC4) interface.
- *
- *======================================================================*/
 /** Create a RC4 cipher handle for the given mode.
 
     The RC4 symmetric stream cipher algorithm is specified in
@@ -262,7 +234,6 @@ SAL_DLLPUBLIC rtlCipher SAL_CALL rtl_cipher_createARCFOUR (
     rtlCipherMode Mode
 ) SAL_THROW_EXTERN_C();
 
-
 /** Inititialize a RC4 cipher for the given direction.
     @see rtl_cipher_init()
  */
@@ -273,7 +244,6 @@ SAL_DLLPUBLIC rtlCipherError SAL_CALL rtl_cipher_initARCFOUR (
     const sal_uInt8 *pArgData, sal_Size nArgLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Encode a buffer under the RC4 cipher algorithm.
     @see rtl_cipher_encode()
  */
@@ -283,7 +253,6 @@ SAL_DLLPUBLIC rtlCipherError SAL_CALL rtl_cipher_encodeARCFOUR (
     sal_uInt8  *pBuffer, sal_Size nBufLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Decode a buffer under the RC4 cipher algorithm.
     @see rtl_cipher_decode()
  */
@@ -293,7 +262,6 @@ SAL_DLLPUBLIC rtlCipherError SAL_CALL rtl_cipher_decodeARCFOUR (
     sal_uInt8  *pBuffer, sal_Size nBufLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Destroy a RC4 cipher handle.
     @see rtl_cipher_destroy()
  */
@@ -301,13 +269,6 @@ SAL_DLLPUBLIC void SAL_CALL rtl_cipher_destroyARCFOUR (
     rtlCipher Cipher
 ) SAL_THROW_EXTERN_C();
 
-
-/*========================================================================
- *
- * The End.
- *
- *======================================================================*/
-
 #ifdef __cplusplus
 }
 #endif

include/rtl/crc.h

@@ -29,11 +29,6 @@
 extern "C" {
 #endif
 
-/*========================================================================
- *
- * rtl_crc32 interface.
- *
- *======================================================================*/
 /** Evaluate CRC32 over given data.
 
     This function evaluates the CRC polynomial 0xEDB88320.
@@ -48,12 +43,6 @@ SAL_DLLPUBLIC sal_uInt32 SAL_CALL rtl_crc32 (
     const void *Data, sal_uInt32 DatLen
 ) SAL_THROW_EXTERN_C();
 
-/*========================================================================
- *
- * The End.
- *
- *======================================================================*/
-
 #ifdef __cplusplus
 }
 #endif

include/rtl/digest.h

@@ -29,11 +29,6 @@
 extern "C" {
 #endif
 
-/*========================================================================
- *
- * rtlDigest.
- *
- *======================================================================*/
 /** Digest Handle opaque type.
  */
 typedef void* rtlDigest;
@@ -161,11 +156,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_get (
     sal_uInt8 *pBuffer, sal_uInt32 nBufLen
 ) SAL_THROW_EXTERN_C();
 
-/*========================================================================
- *
- * rtl_digest_MD2 interface.
- *
- *======================================================================*/
 #define RTL_DIGEST_LENGTH_MD2 16
 
 /** Create a MD2 digest handle.
@@ -186,7 +176,6 @@ SAL_DLLPUBLIC void SAL_CALL rtl_digest_destroyMD2 (
     rtlDigest Digest
 ) SAL_THROW_EXTERN_C();
 
-
 /** Update a MD2 digest with given data.
     @see rtl_digest_update()
  */
@@ -195,7 +184,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_updateMD2 (
     const void *pData, sal_uInt32 nDatLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Finalize a MD2 digest and retrieve the digest value.
     @see rtl_digest_get()
  */
@@ -204,7 +192,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getMD2 (
     sal_uInt8 *pBuffer, sal_uInt32 nBufLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Evaluate a MD2 digest value from given data.
 
     This function performs an optimized call sequence on a
@@ -225,11 +212,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_MD2 (
     sal_uInt8  *pBuffer, sal_uInt32 nBufLen
 ) SAL_THROW_EXTERN_C();
 
-/*========================================================================
- *
- * rtl_digest_MD5 interface.
- *
- *======================================================================*/
 #define RTL_DIGEST_LENGTH_MD5 16
 
 /** Create a MD5 digest handle.
@@ -242,7 +224,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_MD2 (
  */
 SAL_DLLPUBLIC rtlDigest SAL_CALL rtl_digest_createMD5 (void) SAL_THROW_EXTERN_C();
 
-
 /** Destroy a MD5 digest handle.
     @see rtl_digest_destroy()
  */
@@ -250,7 +231,6 @@ SAL_DLLPUBLIC void SAL_CALL rtl_digest_destroyMD5 (
     rtlDigest Digest
 ) SAL_THROW_EXTERN_C();
 
-
 /** Update a MD5 digest with given data.
     @see rtl_digest_update()
  */
@@ -259,7 +239,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_updateMD5 (
     const void *pData, sal_uInt32 nDatLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Finalize a MD5 digest and retrieve the digest value.
     @see rtl_digest_get()
  */
@@ -268,21 +247,19 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getMD5 (
     sal_uInt8 *pBuffer, sal_uInt32 nBufLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Retrieve the raw (not finalized) MD5 digest value.
 
     This function is a non-standard replacement for
     rtl_digest_getMD5() and must be used with caution.
 
     @post Digest initialized to accept another update sequence.
-    @see      rtl_digest_get()
+    @see rtl_digest_get()
  */
 SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_rawMD5 (
     rtlDigest Digest,
     sal_uInt8 *pBuffer, sal_uInt32 nBufLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Evaluate a MD5 digest value from given data.
 
     This function performs an optimized call sequence on a
@@ -303,11 +280,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_MD5 (
     sal_uInt8  *pBuffer, sal_uInt32 nBufLen
 ) SAL_THROW_EXTERN_C();
 
-/*========================================================================
- *
- * rtl_digest_SHA interface.
- *
- *======================================================================*/
 #define RTL_DIGEST_LENGTH_SHA 20
 
 /** Create a SHA digest handle.
@@ -320,7 +292,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_MD5 (
  */
 SAL_DLLPUBLIC rtlDigest SAL_CALL rtl_digest_createSHA (void) SAL_THROW_EXTERN_C();
 
-
 /** Destroy a SHA digest handle.
     @see rtl_digest_destroy()
  */
@@ -337,7 +308,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_updateSHA (
     const void *pData, sal_uInt32 nDatLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Finalize a SHA digest and retrieve the digest value.
     @see rtl_digest_get()
  */
@@ -346,7 +316,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getSHA (
     sal_uInt8 *pBuffer, sal_uInt32 nBufLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Evaluate a SHA digest value from given data.
 
     This function performs an optimized call sequence on a
@@ -384,7 +353,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_SHA (
  */
 SAL_DLLPUBLIC rtlDigest SAL_CALL rtl_digest_createSHA1 (void) SAL_THROW_EXTERN_C();
 
-
 /** Destroy a SHA1 digest handle.
     @see rtl_digest_destroy()
  */
@@ -392,7 +360,6 @@ SAL_DLLPUBLIC void SAL_CALL rtl_digest_destroySHA1 (
     rtlDigest Digest
 ) SAL_THROW_EXTERN_C();
 
-
 /** Update a SHA1 digest with given data.
     @see rtl_digest_update()
  */
@@ -401,7 +368,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_updateSHA1 (
     const void *pData, sal_uInt32 nDatLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Finalize a SHA1 digest and retrieve the digest value.
     @see rtl_digest_get()
  */
@@ -410,7 +376,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getSHA1 (
     sal_uInt8 *pBuffer, sal_uInt32 nBufLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Evaluate a SHA1 digest value from given data.
 
     This function performs an optimized call sequence on a
@@ -431,11 +396,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_SHA1 (
     sal_uInt8  *pBuffer, sal_uInt32 nBufLen
 ) SAL_THROW_EXTERN_C();
 
-/*========================================================================
- *
- * rtl_digest_HMAC_MD5 interface.
- *
- *======================================================================*/
 #define RTL_DIGEST_LENGTH_HMAC_MD5 RTL_DIGEST_LENGTH_MD5
 
 /** Create a HMAC_MD5 digest handle.
@@ -449,7 +409,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_SHA1 (
  */
 SAL_DLLPUBLIC rtlDigest SAL_CALL rtl_digest_createHMAC_MD5 (void) SAL_THROW_EXTERN_C();
 
-
 /** Destroy a HMAC_MD5 digest handle.
     @see rtl_digest_destroy()
  */
@@ -457,7 +416,6 @@ SAL_DLLPUBLIC void SAL_CALL rtl_digest_destroyHMAC_MD5 (
     rtlDigest Digest
 ) SAL_THROW_EXTERN_C();
 
-
 /** Initialize a HMAC_MD5 digest.
     @see rtl_digest_init()
 
@@ -472,7 +430,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_initHMAC_MD5 (
     const sal_uInt8 *pKeyData, sal_uInt32 nKeyLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Update a HMAC_MD5 digest with given data.
     @see rtl_digest_update()
  */
@@ -481,7 +438,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_updateHMAC_MD5 (
     const void *pData, sal_uInt32 nDatLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Finalize a HMAC_MD5 digest and retrieve the digest value.
     @see rtl_digest_get()
  */
@@ -490,7 +446,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getHMAC_MD5 (
     sal_uInt8 *pBuffer, sal_uInt32 nBufLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Evaluate a HMAC_MD5 digest value from given data.
 
     This function performs an optimized call sequence on a
@@ -515,11 +470,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_HMAC_MD5 (
     sal_uInt8       *pBuffer,  sal_uInt32 nBufLen
 ) SAL_THROW_EXTERN_C();
 
-/*========================================================================
- *
- * rtl_digest_HMAC_SHA1 interface.
- *
- *======================================================================*/
 #define RTL_DIGEST_LENGTH_HMAC_SHA1 RTL_DIGEST_LENGTH_SHA1
 
 /** Create a HMAC_SHA1 digest handle.
@@ -534,7 +484,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_HMAC_MD5 (
  */
 SAL_DLLPUBLIC rtlDigest SAL_CALL rtl_digest_createHMAC_SHA1 (void) SAL_THROW_EXTERN_C();
 
-
 /** Destroy a HMAC_SHA1 digest handle.
     @see rtl_digest_destroy()
  */
@@ -542,7 +491,6 @@ SAL_DLLPUBLIC void SAL_CALL rtl_digest_destroyHMAC_SHA1 (
     rtlDigest Digest
 ) SAL_THROW_EXTERN_C();
 
-
 /** Initialize a HMAC_SHA1 digest.
     @see rtl_digest_init()
 
@@ -557,7 +505,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_initHMAC_SHA1 (
     const sal_uInt8 *pKeyData, sal_uInt32 nKeyLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Update a HMAC_SHA1 digest with given data.
     @see rtl_digest_update()
  */
@@ -566,7 +513,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_updateHMAC_SHA1 (
     const void *pData, sal_uInt32 nDatLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Finalize a HMAC_SHA1 digest and retrieve the digest value.
     @see rtl_digest_get()
  */
@@ -575,7 +521,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_getHMAC_SHA1 (
     sal_uInt8 *pBuffer, sal_uInt32 nBufLen
 ) SAL_THROW_EXTERN_C();
 
-
 /** Evaluate a HMAC_SHA1 digest value from given data.
 
     This function performs an optimized call sequence on a
@@ -600,11 +545,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_HMAC_SHA1 (
     sal_uInt8       *pBuffer,  sal_uInt32 nBufLen
 ) SAL_THROW_EXTERN_C();
 
-/*========================================================================
- *
- * rtl_digest_PBKDF2 interface.
- *
- *======================================================================*/
 /** Password-Based Key Derivation Function.
 
     The PBKDF2 key derivation function is specified in
@@ -628,12 +568,6 @@ SAL_DLLPUBLIC rtlDigestError SAL_CALL rtl_digest_PBKDF2 (
     sal_uInt32       nCount
 ) SAL_THROW_EXTERN_C();
 
-/*========================================================================
- *
- * The End.
- *
- *======================================================================*/
-
 #ifdef __cplusplus
 }
 #endif

include/rtl/random.h

@@ -29,11 +29,6 @@
 extern "C" {
 #endif
 
-/*========================================================================
- *
- * rtlRandom interface.
- *
- *======================================================================*/
 /** Random Pool opaque type.
  */
 typedef void* rtlRandomPool;
@@ -95,12 +90,6 @@ SAL_DLLPUBLIC rtlRandomError SAL_CALL rtl_random_getBytes (
     sal_Size       Bytes
 ) SAL_THROW_EXTERN_C();
 
-/*========================================================================
- *
- * The End.
- *
- *======================================================================*/
-
 #ifdef __cplusplus
 }
 #endif

include/store/store.h

@@ -33,7 +33,6 @@ extern "C" {
  */
 typedef void* storeHandle;
 
-
 /** Acquire a Handle.
     @param  Handle [in] the Handle.
     @return store_E_None upon success
@@ -42,7 +41,6 @@ STORE_DLLPUBLIC storeError SAL_CALL store_acquireHandle (
     storeHandle Handle
 ) SAL_THROW_EXTERN_C();
 
-
 /** Release a Handle.
     @param  Handle [in] the Handle.
     @return store_E_None          upon success,
@@ -52,13 +50,10 @@ STORE_DLLPUBLIC storeError SAL_CALL store_releaseHandle (
     storeHandle Handle
 ) SAL_THROW_EXTERN_C();
 
-
-
 /** File Handle opaque type.
  */
 typedef void* storeFileHandle;
 
-
 /** Open a temporary file in memory.
     @param  nPageSize [in] the creation page size,
             integer multiple of minimum page size.
@@ -70,7 +65,6 @@ STORE_DLLPUBLIC storeError SAL_CALL store_createMemoryFile (
     storeFileHandle *phFile
 ) SAL_THROW_EXTERN_C();
 
-
 /** Open a file.
     @param  pFilename [in] the filename as URL or system path.
     @param  eAccessMode [in] the access mode.
@@ -90,7 +84,6 @@ STORE_DLLPUBLIC storeError SAL_CALL store_openFile (
     storeFileHandle *phFile
 ) SAL_THROW_EXTERN_C();
 
-
 /** Close a file.
     @param  hFile [in] the File Handle.
     @return store_E_None upon     success,
@@ -100,7 +93,6 @@ STORE_DLLPUBLIC storeError SAL_CALL store_closeFile (
     storeFileHandle hFile
 ) SAL_THROW_EXTERN_C();
 
-
 /** Flush a file.
     @param  hFile [in] the File Handle.
     @return store_E_None upon success
@@ -109,12 +101,10 @@ STORE_DLLPUBLIC storeError SAL_CALL store_flushFile (
     storeFileHandle hFile
 ) SAL_THROW_EXTERN_C();
 
-
 /** Directory Handle opaque type.
  */
 typedef void* storeDirectoryHandle;
 
-
 /** Open a directory.
     @see store_openFile()
 
@@ -133,7 +123,6 @@ STORE_DLLPUBLIC storeError SAL_CALL store_openDirectory (
     storeDirectoryHandle *phDirectory
 ) SAL_THROW_EXTERN_C();
 
-
 /** Find first directory entry.
     @param  hDirectory [in] the Directory Handle.
     @param  pFindData [out] the Find Data structure.
@@ -145,7 +134,6 @@ STORE_DLLPUBLIC storeError SAL_CALL store_findFirst (
     storeFindData        *pFindData
 ) SAL_THROW_EXTERN_C();
 
-
 /** Find next directory entry.
     @param  hDirectory [in] the Directory Handle.
     @param  pFindData [out] the Find Data structure.
@@ -157,13 +145,10 @@ STORE_DLLPUBLIC storeError SAL_CALL store_findNext (
     storeFindData        *pFindData
 ) SAL_THROW_EXTERN_C();
 
-
-
 /** Stream Handle opaque type.
  */
 typedef void* storeStreamHandle;
 
-
 /** Open a stream.
     @see store_openFile()
 
@@ -182,7 +167,6 @@ STORE_DLLPUBLIC storeError SAL_CALL store_openStream (
     storeStreamHandle *phStrm
 ) SAL_THROW_EXTERN_C();
 
-
 /** Read from a stream.
     @param  hStrm [in] the Stream Handle.
     @param  nOffset [in] the offset of the first byte to read.
@@ -199,7 +183,6 @@ STORE_DLLPUBLIC storeError SAL_CALL store_readStream (
     sal_uInt32        *pnDone
 ) SAL_THROW_EXTERN_C();
 
-
 /** Write to a stream.
     @param  hStrm [in] the Stream Handle.
     @param  nOffset [in] the offset of the first byte to write.
@@ -216,8 +199,6 @@ STORE_DLLPUBLIC storeError SAL_CALL store_writeStream (
     sal_uInt32        *pnDone
 ) SAL_THROW_EXTERN_C();
 
-
-
 /** Remove a file entry.
     @param  hFile [in] the File Handle
     @param  pPath [in] the entry path
@@ -230,12 +211,6 @@ STORE_DLLPUBLIC storeError SAL_CALL store_remove (
     rtl_uString    *pName
 ) SAL_THROW_EXTERN_C();
 
-/*========================================================================
- *
- * The End.
- *
- *======================================================================*/
-
 #ifdef __cplusplus
 }
 #endif

include/store/store.hxx

@@ -29,11 +29,6 @@
 namespace store
 {
 
-/*========================================================================
- *
- * OStoreStream interface.
- *
- *======================================================================*/
 class OStoreStream
 {
 public:
@@ -125,11 +120,6 @@ private:
     storeStreamHandle m_hImpl;
 };
 
-/*========================================================================
- *
- * OStoreDirectory interface.
- *
- *======================================================================*/
 class OStoreDirectory
 {
 public:
@@ -238,11 +228,6 @@ private:
     storeDirectoryHandle m_hImpl;
 };
 
-/*========================================================================
- *
- * OStoreFile interface.
- *
- *======================================================================*/
 class OStoreFile
 {
 public:
@@ -365,15 +350,8 @@ private:
     storeFileHandle m_hImpl;
 };
 
-/*========================================================================
- *
- * The End.
- *
- *======================================================================*/
-
 } // namespace store
 
 #endif /* ! INCLUDED_STORE_STORE_HXX */
 
-
 /* vim:set shiftwidth=4 softtabstop=4 expandtab: */

include/store/types.h

@@ -131,13 +131,6 @@ typedef struct
     sal_uInt32 m_nReserved;
 } storeFindData;
 
-
-/*========================================================================
- *
- * The End.
- *
- *======================================================================*/
-
 #ifdef __cplusplus
 }
 #endif

store/source/lockbyte.hxx

@@ -36,11 +36,6 @@
 namespace store
 {
 
-/*========================================================================
- *
- * ILockBytes interface.
- *
- *======================================================================*/
 class ILockBytes : public virtual salhelper::SimpleReferenceObject
 {
 public:
@@ -144,30 +139,16 @@ private:
     virtual storeError flush_Impl() = 0;
 };
 
-/*========================================================================
- *
- * ILockBytes factories.
- *
- *======================================================================*/
-
-storeError
-FileLockBytes_createInstance (
+storeError FileLockBytes_createInstance (
   rtl::Reference< store::ILockBytes > & rxLockBytes,
   rtl_uString *   pFilename,
   storeAccessMode eAccessMode
 );
 
-storeError
-MemoryLockBytes_createInstance (
+storeError MemoryLockBytes_createInstance (
   rtl::Reference< store::ILockBytes > & rxLockBytes
 );
 
-/*========================================================================
- *
- * The End.
- *
- *======================================================================*/
-
 } // namespace store
 
 #endif // INCLUDED_STORE_SOURCE_LOCKBYTE_HXX

store/source/object.hxx

@@ -27,11 +27,6 @@
 namespace store
 {
 
-/*========================================================================
- *
- * OStoreObject interface.
- *
- *======================================================================*/
 class OStoreObject : public virtual salhelper::SimpleReferenceObject
 {
 public:
@@ -62,12 +57,6 @@ template<class store_handle_type>
 store_handle_type * SAL_CALL query (
     OStoreObject * pHandle, store_handle_type *);
 
-/*========================================================================
- *
- * The End.
- *
- *======================================================================*/
-
 } // namespace store
 
 #endif // INCLUDED_STORE_SOURCE_OBJECT_HXX

store/source/storbase.hxx

@@ -39,11 +39,8 @@
 #include <string.h>
 #include <utility>
 
-/*========================================================================
- *
- * store common internals.
- *
- *======================================================================*/
+/** @file store common internals.
+*/
 
 namespace store
 {
@@ -76,11 +73,6 @@ inline sal_uInt32 htonl (sal_uInt32 h) { return h; }
 inline sal_uInt32 ntohl (sal_uInt32 n) { return n; }
 #endif /* OSL_BIGENDIAN */
 
-/*========================================================================
- *
- * OStorePageGuard.
- *
- *======================================================================*/
 struct OStorePageGuard
 {
     /** Representation.
@@ -122,11 +114,6 @@ struct OStorePageGuard
     }
 };
 
-/*========================================================================
- *
- * OStorePageDescriptor.
- *
- *======================================================================*/
 #define STORE_PAGE_NULL ((sal_uInt32)(~0))
 
 struct OStorePageDescriptor
@@ -176,15 +163,8 @@ struct OStorePageDescriptor
         return ((m_nAddr == rhs.m_nAddr) &&
                 (m_nSize == rhs.m_nSize)    );
     }
-
-
 };
 
-/*========================================================================
- *
- * OStorePageKey.
- *
- *======================================================================*/
 struct OStorePageKey
 {
     /** Representation.
@@ -227,11 +207,6 @@ struct OStorePageKey
     }
 };
 
-/*========================================================================
- *
- * OStorePageLink.
- *
- *======================================================================*/
 struct OStorePageLink
 {
     /** Representation.
@@ -281,11 +256,6 @@ struct OStorePageLink
 
 };
 
-/*========================================================================
- *
- * PageData.
- *
- *======================================================================*/
 struct PageData
 {
     typedef OStorePageGuard      G;
@@ -443,11 +413,6 @@ struct PageData
 
 };
 
-/*========================================================================
- *
- * PageHolderObject.
- *
- *======================================================================*/
 template< class T >
 class PageHolderObject
 {
@@ -520,6 +485,7 @@ public:
         OSL_PRECOND(pImpl != nullptr, "store::PageHolder<T>::operator*(): Null pointer");
         return pImpl;
     }
+
     T const * operator->() const
     {
         T const * pImpl = dynamic_page_cast<T>(m_xPage.get());
@@ -533,6 +499,7 @@ public:
         OSL_PRECOND(pImpl != nullptr, "store::PageHolder<T>::operator*(): Null pointer");
         return (*pImpl);
     }
+
     T const & operator*() const
     {
         T const * pImpl = dynamic_page_cast<T>(m_xPage.get());
@@ -553,6 +520,7 @@ public:
 
         return store_E_None;
     }
+
     static storeError verify (std::shared_ptr<PageData> const & rxPage, sal_uInt32 nAddr)
     {
         PageData const * pHead = rxPage.get();
@@ -571,7 +539,6 @@ public:
     }
 };
 
-
 class OStorePageBIOS;
 
 class OStorePageObject
@@ -663,12 +630,6 @@ inline sal_uInt32 OStorePageObject::location() const
     return m_xPage->location();
 }
 
-/*========================================================================
- *
- * The End.
- *
- *======================================================================*/
-
 } // namespace store
 
 #endif // INCLUDED_STORE_SOURCE_STORBASE_HXX

store/source/storbios.hxx

@@ -30,11 +30,6 @@
 #include "storbase.hxx"
 #include "storcach.hxx"
 
-/*========================================================================
- *
- * OStorePageBIOS.
- *
- *======================================================================*/
 namespace store
 {
 
@@ -189,12 +184,6 @@ inline bool OStorePageBIOS::isValid() const
     return m_xLockBytes.is();
 }
 
-/*========================================================================
- *
- * The End.
- *
- *======================================================================*/
-
 } // namespace store
 
 #endif // INCLUDED_STORE_SOURCE_STORBIOS_HXX

store/source/storcach.hxx

@@ -36,12 +36,6 @@ namespace store
 
 struct Entry;
 
-/*========================================================================
- *
- * PageCache interface.
- *
- *======================================================================*/
-
 class PageCache :
     public store::OStoreObject
 {
@@ -72,7 +66,6 @@ class PageCache :
     void rescale_Impl (std::size_t new_size);
 
 public:
-    // Construction
     explicit PageCache (sal_uInt16 nPageSize);
 
     PageCache(const PageCache&) = delete;
@@ -102,28 +95,14 @@ public:
         sal_uInt32 nOffset);
 
 protected:
-    // Destruction
     virtual ~PageCache() override;
 };
 
-/*========================================================================
- *
- * PageCache factory.
- *
- *======================================================================*/
-
-storeError
-PageCache_createInstance (
+storeError PageCache_createInstance (
     rtl::Reference< store::PageCache > & rxCache,
     sal_uInt16                           nPageSize
 );
 
-/*========================================================================
- *
- * The End.
- *
- *======================================================================*/
-
 } // namespace store
 
 #endif // INCLUDED_STORE_SOURCE_STORCACH_HXX

store/source/stordata.hxx

@@ -34,11 +34,6 @@
 namespace store
 {
 
-/*========================================================================
- *
- * OStoreDataPageData.
- *
- *======================================================================*/
 constexpr sal_uInt32 STORE_MAGIC_DATAPAGE(0x94190310);
 
 struct OStoreDataPageData : public store::PageData
@@ -95,11 +90,6 @@ struct OStoreDataPageData : public store::PageData
     }
 };
 
-/*========================================================================
- *
- * OStoreDataPageObject.
- *
- *======================================================================*/
 class OStoreDataPageObject : public store::OStorePageObject
 {
     typedef OStorePageObject     base;
@@ -118,11 +108,6 @@ public:
     virtual storeError verify (sal_uInt32 nAddr) const override;
 };
 
-/*========================================================================
- *
- * OStoreIndirectionPageData.
- *
- *======================================================================*/
 constexpr sal_uInt32 STORE_MAGIC_INDIRECTPAGE(0x89191107);
 
 struct OStoreIndirectionPageData : public store::PageData
@@ -205,11 +190,6 @@ struct OStoreIndirectionPageData : public store::PageData
     }
 };
 
-/*========================================================================
- *
- * OStoreIndirectionPageObject.
- *
- *======================================================================*/
 class OStoreIndirectionPageObject : public store::OStorePageObject
 {
     typedef OStorePageObject          base;
@@ -289,11 +269,6 @@ public:
         OStorePageBIOS        &rBIOS);
 };
 
-/*========================================================================
- *
- * OStorePageNameBlock.
- *
- *======================================================================*/
 struct OStorePageNameBlock
 {
     typedef OStorePageGuard G;
@@ -342,11 +317,6 @@ struct OStorePageNameBlock
     }
 };
 
-/*========================================================================
- *
- * OStoreDirectoryDataBlock.
- *
- *======================================================================*/
 #define STORE_LIMIT_DATAPAGE_DIRECT 16
 #define STORE_LIMIT_DATAPAGE_SINGLE  8
 #define STORE_LIMIT_DATAPAGE_DOUBLE  1
@@ -514,11 +484,6 @@ struct OStoreDirectoryDataBlock
     }
 };
 
-/*========================================================================
- *
- * OStoreDirectoryPageData.
- *
- *======================================================================*/
 #define STORE_MAGIC_DIRECTORYPAGE sal_uInt32(0x62190120)
 
 struct OStoreDirectoryPageData : public store::PageData
@@ -627,11 +592,6 @@ struct OStoreDirectoryPageData : public store::PageData
     }
 };
 
-/*========================================================================
- *
- * OStoreDirectoryPageObject.
- *
- *======================================================================*/
 class OStoreDirectoryPageObject : public store::OStorePageObject
 {
     typedef OStorePageObject          base;
@@ -792,12 +752,6 @@ private:
         OStorePageBIOS        &rBIOS);
 };
 
-/*========================================================================
- *
- * The End.
- *
- *======================================================================*/
-
 } // namespace store
 
 #endif // INCLUDED_STORE_SOURCE_STORDATA_HXX

store/source/stordir.hxx

@@ -35,11 +35,6 @@ namespace store
 
 struct OStoreDirectoryPageData;
 
-/*========================================================================
- *
- * OStoreDirectory_Impl interface.
- *
- *======================================================================*/
 class OStoreDirectory_Impl : public store::OStoreObject
 {
 public:
@@ -113,12 +108,6 @@ SAL_CALL query (OStoreObject *pHandle, SAL_UNUSED_PARAMETER OStoreDirectory_Impl
     return nullptr;
 }
 
-/*========================================================================
- *
- * The End.
- *
- *======================================================================*/
-
 } // namespace store
 
 #endif // INCLUDED_STORE_SOURCE_STORDIR_HXX

store/source/storlckb.hxx

@@ -35,11 +35,6 @@ namespace store
 struct OStoreDataPageData;
 struct OStoreDirectoryPageData;
 
-/*========================================================================
- *
- * OStoreLockBytes interface.
- *
- *======================================================================*/
 class OStoreLockBytes : public store::OStoreObject
 {
 public:
@@ -138,12 +133,6 @@ SAL_CALL query (OStoreObject *pHandle, SAL_UNUSED_PARAMETER OStoreLockBytes*)
     return nullptr;
 }
 
-/*========================================================================
- *
- * The End.
- *
- *======================================================================*/
-
 } // namespace store
 
 #endif // INCLUDED_STORE_SOURCE_STORLCKB_HXX

store/source/storpage.hxx

@@ -35,11 +35,6 @@ namespace store
 struct OStoreDirectoryPageData;
 class  OStoreDirectoryPageObject;
 
-/*========================================================================
- *
- * OStorePageManager interface.
- *
- *======================================================================*/
 class OStorePageManager : public store::OStorePageBIOS
 {
 public:
@@ -161,12 +156,6 @@ SAL_CALL query (OStoreObject *pHandle, SAL_UNUSED_PARAMETER OStorePageManager*)
     return nullptr;
 }
 
-/*========================================================================
- *
- * The End.
- *
- *======================================================================*/
-
 } // namespace store
 
 #endif // INCLUDED_STORE_SOURCE_STORPAGE_HXX

store/source/stortree.hxx

@@ -35,11 +35,6 @@ namespace store
 
 class OStorePageBIOS;
 
-/*========================================================================
- *
- * OStoreBTreeEntry.
- *
- *======================================================================*/
 struct OStoreBTreeEntry
 {
     typedef OStorePageKey  K;
@@ -95,11 +90,6 @@ struct OStoreBTreeEntry
     }
 };
 
-/*========================================================================
- *
- * OStoreBTreeNodeData.
- *
- *======================================================================*/
 #define STORE_MAGIC_BTREENODE sal_uInt32(0x58190322)
 
 struct OStoreBTreeNodeData : public store::PageData
@@ -218,11 +208,6 @@ struct OStoreBTreeNodeData : public store::PageData
     void truncate (sal_uInt16 n);
 };
 
-/*========================================================================
- *
- * OStoreBTreeNodeObject.
- *
- *======================================================================*/
 class OStoreBTreeNodeObject : public store::OStorePageObject
 {
     typedef OStorePageObject      base;
@@ -260,11 +245,6 @@ public:
         OStorePageBIOS &   rBIOS);
 };
 
-/*========================================================================
- *
- * OStoreBTreeRootObject.
- *
- *======================================================================*/
 class OStoreBTreeRootObject : public store::OStoreBTreeNodeObject
 {
     typedef OStoreBTreeNodeObject base;
@@ -316,12 +296,6 @@ private:
         OStorePageBIOS &           rBIOS);
 };
 
-/*========================================================================
- *
- * The End.
- *
- *======================================================================*/
-
 } // namespace store
 
 #endif // INCLUDED_STORE_SOURCE_STORTREE_HXX