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

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

10 files changed, 8 insertions, 214 deletions

diff --git a/store/source/lockbyte.hxx b/store/source/lockbyte.hxx
index b92e8b470d61..314a42d5411d 100644
--- a/store/source/lockbyte.hxx
+++ b/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
diff --git a/store/source/object.hxx b/store/source/object.hxx
index 6d8c1303dc01..93f4fa4b2506 100644
--- a/store/source/object.hxx
+++ b/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
diff --git a/store/source/storbase.hxx b/store/source/storbase.hxx
index f3224b2a9dc9..3b677b405f22 100644
--- a/store/source/storbase.hxx
+++ b/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
diff --git a/store/source/storbios.hxx b/store/source/storbios.hxx
index a563f5b55a12..997cfbc9471b 100644
--- a/store/source/storbios.hxx
+++ b/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
diff --git a/store/source/storcach.hxx b/store/source/storcach.hxx
index 6778fc31bb17..0a16fd813e31 100644
--- a/store/source/storcach.hxx
+++ b/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
diff --git a/store/source/stordata.hxx b/store/source/stordata.hxx
index 33bfe0ef32ee..c8f1597f551a 100644
--- a/store/source/stordata.hxx
+++ b/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
diff --git a/store/source/stordir.hxx b/store/source/stordir.hxx
index 09bdfe7f5ccd..2d9408a74649 100644
--- a/store/source/stordir.hxx
+++ b/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
diff --git a/store/source/storlckb.hxx b/store/source/storlckb.hxx
index 16a05cc1bb9e..1303c3574b87 100644
--- a/store/source/storlckb.hxx
+++ b/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
diff --git a/store/source/storpage.hxx b/store/source/storpage.hxx
index 136e527b3efa..3893af5e6c85 100644
--- a/store/source/storpage.hxx
+++ b/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
diff --git a/store/source/stortree.hxx b/store/source/stortree.hxx
index 69db0c3c8e9a..2f18b2e50ef7 100644
--- a/store/source/stortree.hxx
+++ b/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