boostorg/core
1
0
Fork 1
mirror of https://github.com/boostorg/core.git synced 2025-07-30 04:47:24 +02:00
Code Issues Packages Projects Releases Wiki Activity

Minor formatting changes in pointer_traits documentation

Browse Source
This commit is contained in:
Glen Fernandes
2017-05-28 21:36:52 -04:00
parent 89b1792724
commit f76116405d
1 changed files with 23 additions and 29 deletions
Download Patch File Download Diff File Expand all files Collapse all files

52
doc/pointer_traits.qbk
View File

@ -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<U, Args>`, 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<class U> struct rebind_to { typedef` ['see below] `type; };`
[variablelist
`std::ptrdiff_t`.]]]]]
[[`template<class U> struct rebind_to { typedef` ['see below] `type; };`]
[[variablelist
[[Type]
[`type` is `T::rebind<U>` if such a type exists; otherwise,
`Pointer<V, Args>` if `T` is a class template instantiation of the
form `Pointer<T, Args>`, 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<T*>`]
[ordered_list
[`static pointer pointer_to(`['see below] `v) noexcept;`
[variablelist
[variablelist pointer_traits<T*>
[[`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]