Fixed doxygen markup

diff --git a/cds/gc/details/hp.h b/cds/gc/details/hp.h
index 121d4562a5138c17fd83e3dd66363fe2466b74b5..21e83f799bc1bcd1d914cf45ec8cd174f2a4d5bd 100644 (file)
--- a/cds/gc/details/hp.h
+++ b/cds/gc/details/hp.h
@@ -255,22 +255,18 @@ namespace cds {
             class not_initialized : public std::runtime_error
             {
             public:
             class not_initialized : public std::runtime_error
             {
             public:

-                //@cond

                 not_initialized()
                     : std::runtime_error( "Global Hazard Pointer GarbageCollector is not initialized" )
                 {}
                 not_initialized()
                     : std::runtime_error( "Global Hazard Pointer GarbageCollector is not initialized" )
                 {}

-                //@endcond

             };
 
             /// Not enough Hazard Pointer
             class too_many_hazard_ptr : public std::length_error
             {
             public:
             };
 
             /// Not enough Hazard Pointer
             class too_many_hazard_ptr : public std::length_error
             {
             public:

-                //@cond

                 too_many_hazard_ptr()
                     : std::length_error( "Not enough Hazard Pointer" )
                 {}
                 too_many_hazard_ptr()
                     : std::length_error( "Not enough Hazard Pointer" )
                 {}

-                //@endcond

             };
 
         private:
             };
 
         private:


@@ -296,7 +292,6 @@ namespace cds {
                 atomics::atomic<OS::ThreadId>    m_idOwner;   ///< Owner thread id; 0 - the record is free (not owned)
                 atomics::atomic<bool>            m_bFree;     ///< true if record is free (not owned)
 
                 atomics::atomic<OS::ThreadId>    m_idOwner;   ///< Owner thread id; 0 - the record is free (not owned)
                 atomics::atomic<bool>            m_bFree;     ///< true if record is free (not owned)
 

-                //@cond

                 explicit hplist_node( const GarbageCollector& HzpMgr )
                     : hp_record( HzpMgr ),
                     m_pNextNode( nullptr ),
                 explicit hplist_node( const GarbageCollector& HzpMgr )
                     : hp_record( HzpMgr ),
                     m_pNextNode( nullptr ),


@@ -316,7 +311,6 @@ namespace cds {
                     assert( m_idOwner.load( atomics::memory_order_relaxed ) == OS::c_NullThreadId );
                     assert( m_bFree.load(atomics::memory_order_relaxed));
                 }
                     assert( m_idOwner.load( atomics::memory_order_relaxed ) == OS::c_NullThreadId );
                     assert( m_bFree.load(atomics::memory_order_relaxed));
                 }

-                //@endcond

             };
 
             atomics::atomic<hplist_node *>   m_pListHead  ;  ///< Head of GC list
             };
 
             atomics::atomic<hplist_node *>   m_pListHead  ;  ///< Head of GC list

diff --git a/cds/urcu/details/base.h b/cds/urcu/details/base.h
index 69775788a1e4a93494ca8998997441c23aea1ff6..638eb876b27a1002c21081c6f8e711f78e50b0c2 100644 (file)
--- a/cds/urcu/details/base.h
+++ b/cds/urcu/details/base.h
@@ -112,10 +112,10 @@ namespace cds {
           The \p libcds contains several implementations if signal-handling %RCU: \ref signal_buffered,
           \ref signal_threaded.
 
           The \p libcds contains several implementations if signal-handling %RCU: \ref signal_buffered,
           \ref signal_threaded.
 

-    @note The signal-handled %RCU is defined only for UNIX-like systems, not for Windows.
+        @note The signal-handled %RCU is defined only for UNIX-like systems, not for Windows.

 
 

-    @anchor cds_urcu_type
-    <b>RCU implementation type</b>
+        @anchor cds_urcu_type
+        <b>RCU implementation type</b>

 
         There are several internal implementation of RCU (all declared in \p %cds::urcu namespace):
         - \ref general_instant - general purpose RCU with immediate reclamation
 
         There are several internal implementation of RCU (all declared in \p %cds::urcu namespace):
         - \ref general_instant - general purpose RCU with immediate reclamation


@@ -130,8 +130,8 @@ namespace cds {
         and has the reacher interface that combines interfaces of wrapped class i.e. RCU global part like
         \p synchronize, and corresponding RCU thread-specific interface like \p access_lock, \p access_unlock and \p retire_ptr.
 
         and has the reacher interface that combines interfaces of wrapped class i.e. RCU global part like
         \p synchronize, and corresponding RCU thread-specific interface like \p access_lock, \p access_unlock and \p retire_ptr.
 

-    @anchor cds_urcu_gc
-    There are several wrapper classes (all declared in \p %cds::urcu namespace)
+        @anchor cds_urcu_gc
+        There are several wrapper classes (all declared in \p %cds::urcu namespace)

         - \ref cds_urcu_general_instant_gc "gc<general_instant>" - general purpose RCU with immediate reclamation,
             include file <tt><cds/urcu/general_instant.h></tt>
         - \ref cds_urcu_general_buffered_gc "gc<general_buffered>" - general purpose RCU with deferred (buffered) reclamation,
         - \ref cds_urcu_general_instant_gc "gc<general_instant>" - general purpose RCU with immediate reclamation,
             include file <tt><cds/urcu/general_instant.h></tt>
         - \ref cds_urcu_general_buffered_gc "gc<general_buffered>" - general purpose RCU with deferred (buffered) reclamation,


@@ -145,7 +145,7 @@ namespace cds {
 
         Any RCU-related container in \p libcds expects that its \p RCU template parameter is one of those wrapper.
 
 
         Any RCU-related container in \p libcds expects that its \p RCU template parameter is one of those wrapper.
 

-    @anchor cds_urcu_tags
+        @anchor cds_urcu_tags

         For simplicity, in some algorithms instead of using RCU implementation type
         you should specify corresponding RCU tags (all declared in \p %cds::urcu namespace):
         - \ref general_instant_tag - for \ref general_instant
         For simplicity, in some algorithms instead of using RCU implementation type
         you should specify corresponding RCU tags (all declared in \p %cds::urcu namespace):
         - \ref general_instant_tag - for \ref general_instant


@@ -154,8 +154,8 @@ namespace cds {
         - \ref signal_buffered_tag - for \ref signal_buffered
         - \ref signal_threaded_tag - for \ref signal_threaded
 
         - \ref signal_buffered_tag - for \ref signal_buffered
         - \ref signal_threaded_tag - for \ref signal_threaded
 

-    @anchor cds_urcu_performance
-    <b>Performance</b>
+        @anchor cds_urcu_performance
+        <b>Performance</b>

 
         As a result of our experiments we can range above %RCU implementation in such order,
         from high to low performance:
 
         As a result of our experiments we can range above %RCU implementation in such order,
         from high to low performance:


@@ -169,8 +169,8 @@ namespace cds {
         type of payload - mostly read-only (seeking) or read-write (inserting and deleting), -
         a hardware, your application, and so on.
 
         type of payload - mostly read-only (seeking) or read-write (inserting and deleting), -
         a hardware, your application, and so on.
 

-    @anchor cds_urcu_howto
-    <b>How to use</b>
+        @anchor cds_urcu_howto
+        <b>How to use</b>

 
         Usually, in your application you use only one \ref cds_urcu_gc "type of RCU" that is the best for your needs.
         However, the library allows to apply several RCU singleton in one application.
 
         Usually, in your application you use only one \ref cds_urcu_gc "type of RCU" that is the best for your needs.
         However, the library allows to apply several RCU singleton in one application.