Skip to content

Commit 03d4f4f

Browse files
committed
Place better BOOST_CONTAINER_DOXYGEN_INVOKED checks so that doxygen does not generate unwanted types in the documentation
1 parent 68b80e6 commit 03d4f4f

File tree

5 files changed

+17
-7
lines changed

5 files changed

+17
-7
lines changed

doc/Jamfile.v2

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,11 +49,13 @@ doxygen autodoc
4949
\"BOOST_INTRUSIVE_OPTION_CONSTANT(OPTION_NAME, TYPE, VALUE, CONSTANT_NAME) = template<TYPE VALUE> struct OPTION_NAME{};\" \\
5050
\"BOOST_INTRUSIVE_OPTION_TYPE(OPTION_NAME, TYPE, TYPEDEF_EXPR, TYPEDEF_NAME) = template<class TYPE> struct OPTION_NAME{};\" \\
5151
\"BOOST_CONTAINER_DOC1ST(T1, T2)=T1\" \\
52-
\"BOOST_CONTAINER_DOCIGN(T) \"\\
52+
\"BOOST_CONTAINER_DOCIGN(T)= \"\\
5353
\"BOOST_CONTAINER_DOCONLY(T)=T\"\\
5454
\"BOOST_CONTAINER_SCOPEDALLOC_DUMMYTRUE=\"\\
5555
\"BOOST_CONTAINER_SCOPEDALLOC_ALLINNER=InnerAllocs...\"\\
56+
\"BOOST_CONTAINER_SCOPEDALLOC_ALLINNERCLASS=typename... InnerAllocs\"\\
5657
\"BOOST_CONTAINER_DECL=\"\\
58+
\"BOOST_CONTAINER_CONSTANT_VAR=static constexpr \"\\
5759
\"BOOST_CONTAINER_FORCEINLINE=inline\" \\
5860
"
5961
<xsl:param>"boost.doxygen.reftitle=Boost.Container Header Reference"

include/boost/container/allocator_traits.hpp

Lines changed: 0 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,8 +80,6 @@
8080
#pragma GCC diagnostic pop
8181
#endif
8282

83-
#endif //#ifndef BOOST_CONTAINER_DOXYGEN_INVOKED
84-
8583
namespace boost {
8684
namespace container {
8785
namespace dtl {
@@ -194,8 +192,6 @@ construct_type(T* p, BOOST_FWD_REF(U) x, BOOST_FWD_REF(V) y)
194192

195193
} //namespace dtl
196194

197-
#ifndef BOOST_CONTAINER_DOXYGEN_INVOKED
198-
199195
template<class T, class VoidAllocator, class Options>
200196
class small_vector_allocator;
201197

include/boost/container/flat_map.hpp

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,6 +49,8 @@
4949
#include <initializer_list>
5050
#endif
5151

52+
#ifndef BOOST_CONTAINER_DOXYGEN_INVOKED
53+
5254
#if !defined(BOOST_NO_CXX11_RVALUE_REFERENCES)
5355
#define BOOST_CONTAINER_STD_PAIR_IS_MOVABLE
5456
#endif
@@ -64,6 +66,8 @@
6466
#pragma GCC optimize("no-strict-aliasing")
6567
#endif
6668

69+
#endif //#ifndef BOOST_CONTAINER_DOXYGEN_INVOKED
70+
6771
namespace boost {
6872
namespace container {
6973

@@ -87,7 +91,7 @@ template<class D>
8791
BOOST_CONTAINER_FORCEINLINE static D force_copy(D s)
8892
{ return s; }
8993

90-
#else //!BOOST_CONTAINER_DOXYGEN_INVOKED
94+
#else //!BOOST_CONTAINER_STD_PAIR_IS_MOVABLE
9195

9296
template<class D, class S>
9397
BOOST_CONTAINER_FORCEINLINE static D &force(S &s)
@@ -104,7 +108,7 @@ BOOST_CONTAINER_FORCEINLINE static D force_copy(const S &s)
104108
D ret_val(*vp);
105109
return ret_val;
106110
}
107-
#endif //BOOST_CONTAINER_DOXYGEN_INVOKED
111+
#endif //BOOST_CONTAINER_STD_PAIR_IS_MOVABLE
108112

109113
} //namespace dtl{
110114

include/boost/container/pmr/resource_adaptor.hpp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -31,6 +31,8 @@
3131
namespace boost {
3232
namespace container {
3333

34+
#ifndef BOOST_CONTAINER_DOXYGEN_INVOKED
35+
3436
namespace pmr_dtl {
3537

3638
template<class T>
@@ -53,6 +55,8 @@ struct max_allocator_alignment< std::allocator<T> >
5355

5456
} //namespace pmr_dtl
5557

58+
#endif //BOOST_CONTAINER_DOXYGEN_INVOKED
59+
5660
namespace pmr {
5761

5862
//! An instance of resource_adaptor<Allocator> is an adaptor that wraps a memory_resource interface

include/boost/container/small_vector.hpp

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -47,6 +47,8 @@
4747

4848
#include <cstddef> //offsetof
4949

50+
#ifndef BOOST_CONTAINER_DOXYGEN_INVOKED
51+
5052
namespace boost {
5153
namespace container {
5254

@@ -316,6 +318,8 @@ struct small_vector_storage<T, 0u, Alignment>
316318
BOOST_STATIC_CONSTEXPR std::size_t sms_size = 0u;
317319
};
318320

321+
#endif //BOOST_CONTAINER_DOXYGEN_INVOKED
322+
319323
//! This class consists of common code from all small_vector<T, N> types that don't depend on the
320324
//! "N" template parameter. This class is non-copyable and non-destructible, so this class typically
321325
//! used as reference argument to functions that read or write small vectors. Since `small_vector<T, N>`

0 commit comments

Comments
 (0)