Skip to content

Commit

Permalink
doxygen cleanups
Browse files Browse the repository at this point in the history
  • Loading branch information
timblechmann committed Nov 4, 2023
1 parent 498bd23 commit e145cd1
Show file tree
Hide file tree
Showing 3 changed files with 38 additions and 7 deletions.
10 changes: 9 additions & 1 deletion doc/Jamfile.v2
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,16 @@
# Distributed under the Boost Software License, Version 1.0. (See accompanying
# file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt)

using quickbook ;
using boostbook ;
using doxygen ;
using xsltproc ;

import set ;
import doxygen ;
import quickbook ;
import xsltproc ;
import notfile ;
import path ;

doxygen autodoc
:
Expand Down
32 changes: 26 additions & 6 deletions include/boost/lockfree/policies.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -18,16 +18,10 @@ namespace boost { namespace lockfree {
#ifndef BOOST_DOXYGEN_INVOKED
namespace tag {
struct allocator;
} // namespace tag
namespace tag {
struct fixed_sized;
} // namespace tag
namespace tag {
struct capacity;
} // namespace tag

#endif

/** Configures a data structure as \b fixed-sized.
*
* The internal nodes are stored inside an array and they are addressed by array indexing. This limits the possible
Expand All @@ -53,6 +47,32 @@ template < class Alloc >
struct allocator : boost::parameter::template_keyword< tag::allocator, Alloc >
{};

#else

/** Configures a data structure as \b fixed-sized.
*
* The internal nodes are stored inside an array and they are addressed by array indexing. This limits the possible
* size of the queue to the number of elements that can be addressed by the index type (usually 2**16-2), but on
* platforms that lack double-width compare-and-exchange instructions, this is the best way to achieve lock-freedom.
* This implies that a data structure is bounded.
* */
template < bool IsFixedSized >
struct fixed_sized;

/** Sets the \b capacity of a data structure at compile-time.
*
* This implies that a data structure is bounded and fixed-sized.
* */
template < size_t Size >
struct capacity;

/** Defines the \b allocator type of a data structure.
* */
template < class Alloc >
struct allocator;

#endif

}} // namespace boost::lockfree

#endif /* BOOST_LOCKFREE_POLICIES_HPP_INCLUDED */
3 changes: 3 additions & 0 deletions include/boost/lockfree/queue.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -44,12 +44,15 @@


namespace boost { namespace lockfree {

#ifndef BOOST_DOXYGEN_INVOKED
namespace detail {

typedef parameter::parameters< boost::parameter::optional< tag::allocator >, boost::parameter::optional< tag::capacity > >
queue_signature;

} /* namespace detail */
#endif


/** The queue class provides a multi-writer/multi-reader queue, pushing and popping is lock-free,
Expand Down

0 comments on commit e145cd1

Please sign in to comment.