From f76116405de93e521a27e48e3f362a9ede91171a Mon Sep 17 00:00:00 2001 From: Glen Fernandes Date: Sun, 28 May 2017 21:36:52 -0400 Subject: [PATCH] Minor formatting changes in pointer_traits documentation --- doc/pointer_traits.qbk | 52 +++++++++++++++++++----------------------- 1 file changed, 23 insertions(+), 29 deletions(-) diff --git a/doc/pointer_traits.qbk b/doc/pointer_traits.qbk index bddea9b..fe43e46 100644 --- a/doc/pointer_traits.qbk +++ b/doc/pointer_traits.qbk @@ -74,64 +74,58 @@ namespace boost { [section Member types] -[heading `pointer_traits`] - -[ordered_list - [`typedef` ['see below] `element_type;` - [variablelist +[variablelist + [[`typedef` ['see below] `element_type;`] + [[variablelist [[Type] [`T::element_type` if such a type exists; otherwise `U` if `T` is a class template instantiation of the form `Pointer`, where `Args` is zero or more type arguments; otherwise the specialization - is ill-formed.]]]] - [`typedef` ['see below] `difference_type;` - [variablelist + is ill-formed.]]]]] + [[`typedef` ['see below] `difference_type;`] + [[variablelist [[Type] [`T::difference_type` if such a type exists; otherwise - `std::ptrdiff_t`.]]]] - [`template struct rebind_to { typedef` ['see below] `type; };` - [variablelist + `std::ptrdiff_t`.]]]]] + [[`template struct rebind_to { typedef` ['see below] `type; };`] + [[variablelist [[Type] [`type` is `T::rebind` if such a type exists; otherwise, `Pointer` if `T` is a class template instantiation of the form `Pointer`, where `Args` is zero or more type arguments; otherwise, the instantiation of `rebind_to` is - ill-formed.]]]]] + ill-formed.]]]]]] [endsect] [section Member functions] -[heading `pointer_traits`] - -[ordered_list - [`static pointer pointer_to(`['see below] `v);` - [variablelist +[variablelist pointer_traits + [[`static pointer pointer_to(`['see below] `v);`] + [[variablelist [[Remark] [If `element_type` is a void type, the type of `v` is unspecified; otherwise, it is `element_type&`.]] [[Returns] - [A pointer to `v` obtained by calling `T::pointer_to(v)`.]]]] - [`static element_type* to_address(pointer v) noexcept;` - [variablelist + [A pointer to `v` obtained by calling `T::pointer_to(v)`.]]]]] + [[`static element_type* to_address(pointer v) noexcept;`] + [[variablelist [[Requires] [`v` is not a null pointer.]] [[Returns] [A pointer of type `element_type*` that references the same location - as the argument.]]]]] + as the argument.]]]]]] -[heading `pointer_traits`] - -[ordered_list - [`static pointer pointer_to(`['see below] `v) noexcept;` - [variablelist +[variablelist pointer_traits + [[`static pointer pointer_to(`['see below] `v) noexcept;`] + [[variablelist [[Remark] [If `element_type` is a void type, the type of `v` is unspecified; otherwise, it is `element_type&`.]] [[Returns] - [The result of `std::addressof(v)`.]]]] - [`static element_type* to_address(pointer v) noexcept;` - [variablelist [[Returns] [The value of `v`.]]]]] + [The result of `std::addressof(v)`.]]]]] + [[`static element_type* to_address(pointer v) noexcept;`] + [[variablelist [[Returns] [The value of `v`.]]]]]] [endsect]