Skip to content

Commit d24a219

Browse files
igaztanagaigaztanaga
committed
Fix some documentation bugs generated by doxygen leaking macros
1 parent a1a5058 commit d24a219

File tree

7 files changed

+24
-28
lines changed

7 files changed

+24
-28
lines changed

‎doc/Jamfile.v2‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ 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...\"\\

‎doc/container.qbk‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -490,7 +490,7 @@ To avoid unbounded memory waste, Boost.Container's `devector` uses a different s
490490
* Potentially, the maximum number of possible relocations (movements) reusing the memory buffer are Olog(N),
491491
but that would lead non-amortized constant-time insertion at the extremes. In consequence, the number of
492492
relocations must be limited ('relocation limit') and a reallocation (allocation of a new memory buffer) will be
493-
performed if the load-factor of the container defined as (size()/length_of_buffer) surpasses the relocation limit (see
493+
performed if the load-factor of the container defined as (`size()/length_of_internal_buffer`) surpasses the relocation limit (see
494494
Lars Greger Nordland Hagen's [@http://larshagencpp.github.io/blog/2016/05/22/devector "Double-ended vector - is it useful?"]
495495
article for more details).
496496

‎include/boost/container/deque.hpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2061,7 +2061,7 @@ class deque : protected deque_base<typename real_allocator<T, Allocator>::type,
20612061
}
20622062
}
20632063

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

20662066
#define BOOST_CONTAINER_DEQUE_EMPLACE_CODE(N) \
20672067
BOOST_MOVE_TMPL_LT##N BOOST_MOVE_CLASS##N BOOST_MOVE_GT##N\

‎include/boost/container/detail/container_rebind.hpp‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -150,7 +150,7 @@ namespace dtl {
150150
typedef Cont<U, typename void_or_portable_rebind_alloc<V, A, U>::type, P0, P1, P2, P3, P4, P5, P6, P7, P8> type;
151151
};
152152

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

155155
//for small_vector,static_vector
156156

‎include/boost/container/detail/dispatch_uses_allocator.hpp‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -459,7 +459,7 @@ BOOST_MOVE_ITER2D_0TOMAX(9, BOOST_DISPATCH_USES_ALLOCATOR_PIECEWISE_CONSTRUCT_BO
459459
#undef BOOST_DISPATCH_USES_ALLOCATOR_PIECEWISE_CONSTRUCT_MSVC2010_TUPLE_CODE
460460
#undef BOOST_DISPATCH_USES_ALLOCATOR_PIECEWISE_CONSTRUCT_MSVC2012_TUPLE_MAX_IT
461461

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

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

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

553553
} //namespace dtl
554554

‎include/boost/container/devector.hpp‎

Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1501,7 +1501,7 @@ class devector
15011501
* [EmplaceConstructible]: http://en.cppreference.com/w/cpp/concept/EmplaceConstructible
15021502
* [MoveInsertable]: http://en.cppreference.com/w/cpp/concept/MoveInsertable
15031503
*/
1504-
#if !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES) || defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
1504+
#if defined(BOOST_CONTAINER_DOXYGEN_INVOKED) || !defined(BOOST_NO_CXX11_VARIADIC_TEMPLATES)
15051505
template <class... Args>
15061506
reference emplace_front(Args&&... args)
15071507
{
@@ -1520,7 +1520,7 @@ class devector
15201520
}
15211521
}
15221522

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

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

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

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

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

16601660

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

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

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

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

18571857

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

2215-
#endif
2216-
22172215
private:
22182216

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

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

@@ -2372,7 +2368,7 @@ class devector
23722368
}
23732369
}
23742370

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

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

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

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

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

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

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

26802676
void reallocate_at(size_type new_capacity, size_type buffer_offset)
26812677
{

‎include/boost/container/options.hpp‎

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -58,7 +58,7 @@ struct tree_opt
5858

5959
typedef tree_opt<red_black_tree, true> tree_assoc_defaults;
6060

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

6363
//!This option setter specifies the underlying tree type
6464
//!(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
176176

177177
#endif
178178

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

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

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

217217
#if !defined(BOOST_CONTAINER_DOXYGEN_INVOKED)
218218

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

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

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

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

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

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

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

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

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

0 commit comments

Comments
 (0)