Fix some documentation bugs generated by doxygen leaking macros

2026-01-19 04:02:17 +00:00 · 2025-12-28 01:55:20 +01:00
parent a1a50581dd
commit d24a219afe
7 changed files with 24 additions and 28 deletions
--- a/doc/Jamfile.v2
+++ b/doc/Jamfile.v2
@@ -49,7 +49,7 @@ doxygen autodoc
                                   \"BOOST_INTRUSIVE_OPTION_CONSTANT(OPTION_NAME, TYPE, VALUE, CONSTANT_NAME)   = template<TYPE VALUE> struct OPTION_NAME{};\" \\
                                   \"BOOST_INTRUSIVE_OPTION_TYPE(OPTION_NAME, TYPE, TYPEDEF_EXPR, TYPEDEF_NAME) = template<class TYPE> struct OPTION_NAME{};\" \\
                                   \"BOOST_CONTAINER_DOC1ST(T1, T2)=T1\" \\
-                                   \"BOOST_CONTAINER_DOCIGN(T)= \"\\
+                                   \"BOOST_CONTAINER_DOCIGN(T)=\"\\
                                   \"BOOST_CONTAINER_DOCONLY(T)=T\"\\
                                   \"BOOST_CONTAINER_SCOPEDALLOC_DUMMYTRUE=\"\\
                                   \"BOOST_CONTAINER_SCOPEDALLOC_ALLINNER=InnerAllocs...\"\\
--- a/doc/container.qbk
+++ b/doc/container.qbk
@@ -490,7 +490,7 @@ To avoid unbounded memory waste, Boost.Container's `devector` uses a different s
 * Potentially, the maximum number of possible relocations (movements) reusing the memory buffer are Olog(N),
  but that would lead non-amortized constant-time insertion at the extremes. In consequence, the number of
  relocations must be limited ('relocation limit') and a reallocation (allocation of a new memory buffer) will be
-  performed if the load-factor of the container defined as (size()/length_of_buffer) surpasses the relocation limit (see
+  performed if the load-factor of the container defined as (`size()/length_of_internal_buffer`) surpasses the relocation limit (see
  Lars Greger Nordland Hagen's [@http://larshagencpp.github.io/blog/2016/05/22/devector "Double-ended vector - is it useful?"]
  article for more details).

--- a/include/boost/container/deque.hpp
+++ b/include/boost/container/deque.hpp
@@ -2061,7 +2061,7 @@ class deque : protected deque_base<typename real_allocator<T, Allocator>::type,
      }
   }

-   #else //!defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES)
+   #else //   !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES)

   #define BOOST_CONTAINER_DEQUE_EMPLACE_CODE(N) \
   BOOST_MOVE_TMPL_LT##N BOOST_MOVE_CLASS##N BOOST_MOVE_GT##N\
--- a/include/boost/container/detail/container_rebind.hpp
+++ b/include/boost/container/detail/container_rebind.hpp
@@ -150,7 +150,7 @@ namespace dtl {
      typedef Cont<U, typename void_or_portable_rebind_alloc<V, A, U>::type, P0, P1, P2, P3, P4, P5, P6, P7, P8> type;
   };

-#endif   //!defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES)
+#endif   //   !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES)

   //for small_vector,static_vector

--- a/include/boost/container/detail/dispatch_uses_allocator.hpp
+++ b/include/boost/container/detail/dispatch_uses_allocator.hpp
@@ -459,7 +459,7 @@ BOOST_MOVE_ITER2D_0TOMAX(9, BOOST_DISPATCH_USES_ALLOCATOR_PIECEWISE_CONSTRUCT_BO
   #undef BOOST_DISPATCH_USES_ALLOCATOR_PIECEWISE_CONSTRUCT_MSVC2010_TUPLE_CODE
   #undef BOOST_DISPATCH_USES_ALLOCATOR_PIECEWISE_CONSTRUCT_MSVC2012_TUPLE_MAX_IT

-#endif   //!defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES)
+#endif   //   !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES)

 template<class T>
 struct uses_allocator_destroy
@@ -548,7 +548,7 @@ BOOST_MOVE_ITERATE_0TO9(BOOST_CONTAINER_DISPATCH_USES_ALLOCATOR_PAIR_TRY_EMPLACE
 BOOST_MOVE_ITERATE_0TO9(BOOST_CONTAINER_CONSTRUCT_DISPATCH_USES_ALLOCATOR_CODE)
 #undef BOOST_CONTAINER_CONSTRUCT_DISPATCH_USES_ALLOCATOR_CODE

-#endif   //!defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES)
+#endif   //   !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES)

 }  //namespace dtl

--- a/include/boost/container/devector.hpp
+++ b/include/boost/container/devector.hpp
@@ -1501,7 +1501,7 @@ class devector
   * [EmplaceConstructible]: http://en.cppreference.com/w/cpp/concept/EmplaceConstructible
   * [MoveInsertable]: http://en.cppreference.com/w/cpp/concept/MoveInsertable
   */
-   #if !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES) || defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
+   #if defined(BOOST_CONTAINER_DOXYGEN_INVOKED) || !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES)
   template <class... Args>
   reference emplace_front(Args&&... args)
   {
@@ -1520,7 +1520,7 @@ class devector
      }
   }

-   #else //!defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES) || defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
+   #else //defined(BOOST_CONTAINER_DOXYGEN_INVOKED) || !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES)

   #define BOOST_CONTAINER_DEVECTOR_EMPLACE_FRONT(N) \
   BOOST_MOVE_TMPL_LT##N BOOST_MOVE_CLASS##N BOOST_MOVE_GT##N \
@@ -1617,7 +1617,7 @@ class devector
   * [MoveInsertable]: http://en.cppreference.com/w/cpp/concept/MoveInsertable
   * [MoveAssignable]: http://en.cppreference.com/w/cpp/concept/MoveAssignable
   */
-   #if !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES) || defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
+   #if defined(BOOST_CONTAINER_DOXYGEN_INVOKED) || !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES)
   template <class... Args>
   inline reference emplace_back(Args&&... args)
   {
@@ -1634,7 +1634,7 @@ class devector
      }
   }

-   #else //!defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES) || defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
+   #else //defined(BOOST_CONTAINER_DOXYGEN_INVOKED) || !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES)

   #define BOOST_CONTAINER_DEVECTOR_EMPLACE_BACK(N) \
   BOOST_MOVE_TMPL_LT##N BOOST_MOVE_CLASS##N BOOST_MOVE_GT##N \
@@ -1655,7 +1655,7 @@ class devector
   BOOST_MOVE_ITERATE_0TO9(BOOST_CONTAINER_DEVECTOR_EMPLACE_BACK)
   #undef BOOST_CONTAINER_DEVECTOR_EMPLACE_BACK

-   #endif    //!defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES) || defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
+   #endif    //defined(BOOST_CONTAINER_DOXYGEN_INVOKED) || !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES)


   #if defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
@@ -1731,7 +1731,7 @@ class devector
   * [MoveInsertable]: http://en.cppreference.com/w/cpp/concept/MoveInsertable
   * [MoveAssignable]: http://en.cppreference.com/w/cpp/concept/MoveAssignable
   */
-   #if !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES) || defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
+   #if defined(BOOST_CONTAINER_DOXYGEN_INVOKED) || !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES)
   template <class... Args>
   iterator emplace(const_iterator position, Args&&... args)
   {
@@ -1789,7 +1789,7 @@ class devector
      return this->insert_range_slow_path(position, 1, proxy_t(::boost::forward<Args>(args)...));
   }

-   #else //!defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES) || defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
+   #else //defined(BOOST_CONTAINER_DOXYGEN_INVOKED) || !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES)

   #define BOOST_CONTAINER_DEVECTOR_EMPLACE(N) \
   BOOST_MOVE_TMPL_LT##N BOOST_MOVE_CLASS##N BOOST_MOVE_GT##N \
@@ -1852,7 +1852,7 @@ class devector
   BOOST_MOVE_ITERATE_0TO9(BOOST_CONTAINER_DEVECTOR_EMPLACE)
   #undef BOOST_CONTAINER_DEVECTOR_EMPLACE

-   #endif    //!defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES) || defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
+   #endif    //defined(BOOST_CONTAINER_DOXYGEN_INVOKED) || !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES)


   #if defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
@@ -2212,8 +2212,6 @@ class devector
      }
   }

-   #endif
-
   private:

   void priv_move_assign(BOOST_RV_REF(devector) x, dtl::bool_<true> /*steal_resources*/)
@@ -2280,8 +2278,6 @@ class devector
      return boost::intrusive::pointer_traits<pointer>::const_cast_from(i);
   }

-   #ifndef BOOST_CONTAINER_DOXYGEN_INVOKED
-
   inline T* priv_raw_begin() BOOST_NOEXCEPT
   {   return boost::movelib::to_raw_pointer(m_.buffer) + m_.front_idx;   }

@@ -2372,7 +2368,7 @@ class devector
      }
   }

-   #else //!defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES) || defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
+   #else //   !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES) || defined(BOOST_CONTAINER_DOXYGEN_INVOKED)

   #define BOOST_CONTAINER_DEVECTOR_ALLOC_CONSTRUCT(N) \
   BOOST_MOVE_TMPL_LT##N BOOST_MOVE_CLASS##N BOOST_MOVE_GT##N \
@@ -2402,7 +2398,7 @@ class devector
   BOOST_MOVE_ITERATE_0TO9(BOOST_CONTAINER_DEVECTOR_ALLOC_CONSTRUCT)
   #undef BOOST_CONTAINER_DEVECTOR_ALLOC_CONSTRUCT

-   #endif    //!defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES) || defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
+   #endif    //   !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES) || defined(BOOST_CONTAINER_DOXYGEN_INVOKED)

   size_type calculate_new_capacity(size_type requested_capacity)
   {
@@ -2576,7 +2572,7 @@ class devector
      m_.set_back_idx(m_.back_idx + n);
   }

-   #else //!defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES) || defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
+   #else //   !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES) || defined(BOOST_CONTAINER_DOXYGEN_INVOKED)

   #define BOOST_CONTAINER_DEVECTOR_SLOW_PATH(N) \
   BOOST_MOVE_TMPL_LT##N BOOST_MOVE_CLASS##N BOOST_MOVE_GT##N \
@@ -2675,7 +2671,7 @@ class devector
   BOOST_MOVE_ITERATE_0TO9(BOOST_CONTAINER_DEVECTOR_SLOW_PATH)
   #undef BOOST_CONTAINER_DEVECTOR_SLOW_PATH

-   #endif    //!defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES) || defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
+   #endif    //   !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES) || defined(BOOST_CONTAINER_DOXYGEN_INVOKED)

   void reallocate_at(size_type new_capacity, size_type buffer_offset)
   {
--- a/include/boost/container/options.hpp
+++ b/include/boost/container/options.hpp
@@ -58,7 +58,7 @@ struct tree_opt

 typedef tree_opt<red_black_tree, true> tree_assoc_defaults;

-#endif   //!defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
+#endif   // !defined(BOOST_CONTAINER_DOXYGEN_INVOKED)

 //!This option setter specifies the underlying tree type
 //!(red-black, AVL, Scapegoat or Splay) for ordered associative containers
@@ -176,7 +176,7 @@ using hash_assoc_options_t = typename boost::container::hash_assoc_options<Optio

 #endif

-#endif   //!defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
+#endif   // !defined(BOOST_CONTAINER_DOXYGEN_INVOKED)

 ////////////////////////////////////////////////////////////////
 //
@@ -212,7 +212,7 @@ struct default_if_zero<0u, DefaultN>
   BOOST_STATIC_CONSTEXPR std::size_t value = DefaultN;
 };

-#endif   //!defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
+#endif   // !defined(BOOST_CONTAINER_DOXYGEN_INVOKED)

 #if !defined(BOOST_CONTAINER_DOXYGEN_INVOKED)

@@ -258,7 +258,7 @@ struct growth_factor_60{};
 //!capacity a 100% (doubling its capacity) when existing capacity is exhausted.
 struct growth_factor_100{};

-#endif   //!defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
+#endif   // !defined(BOOST_CONTAINER_DOXYGEN_INVOKED)

 //!This option setter specifies the growth factor strategy of the
 //!underlying vector.
@@ -377,7 +377,7 @@ struct small_vector_opt

 typedef small_vector_opt<void, 0u, void> small_vector_null_opt;

-#endif    //!defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
+#endif    //   !defined(BOOST_CONTAINER_DOXYGEN_INVOKED)

 //! Helper metafunction to combine options into a single type to be used
 //! by \c boost::container::small_vector.
@@ -448,7 +448,7 @@ struct static_vector_opt

 typedef static_vector_opt<true, 0u, void> static_vector_null_opt;

-#endif    //!defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
+#endif    //   !defined(BOOST_CONTAINER_DOXYGEN_INVOKED)

 //! Helper metafunction to combine options into a single type to be used
 //! by \c boost::container::static_vector.