boostorg/optional
1
0
Fork 1
mirror of https://github.com/boostorg/optional.git synced 2025-07-29 20:17:21 +02:00
Code Issues Packages Projects Releases Wiki Activity

Merge pull request #120 from Lastique/feature/fix_doc_warnings

Browse Source 
Fix doc warnings
This commit is contained in:
Andrzej Krzemieński
2024-01-02 17:42:59 +01:00
committed by GitHub
parent e31cf6f2a8 ac4611c05b
commit 034dfe2ef5
3 changed files with 28 additions and 23 deletions
Download Patch File Download Diff File Expand all files Collapse all files

25
doc/23_ref_optional_io.qbk
View File

@ -41,10 +41,11 @@ template<class CharType, class CharTrait, class T>
[#reference_operator_ostream]
`template <class CharType, class CharTrait, class T>` [br]
std::basic_ostream<CharType, CharTrait>&` [br]
operator<<(std::basic_ostream<CharType, CharTrait>& out, optional<T> const& v);`
```
template <class CharType, class CharTrait, class T>
std::basic_ostream<CharType, CharTrait>&
operator<<(std::basic_ostream<CharType, CharTrait>& out, optional<T> const& v);
```
* [*Effect:] Outputs an implementation-defined string. The output contains the information about whether the optional object contains a value or not. If `v` contains a value, the output contains result of calling `out << *v`.
* [*Returns:] `out`.
@ -52,9 +53,11 @@ template<class CharType, class CharTrait, class T>
__SPACE__
[#reference_operator_ostream_none]
`template <class CharType, class CharTrait, class T>` [br]
std::basic_ostream<CharType, CharTrait>&` [br]
operator<<(std::basic_ostream<CharType, CharTrait>& out, none_t);`
```
template <class CharType, class CharTrait, class T>
std::basic_ostream<CharType, CharTrait>&
operator<<(std::basic_ostream<CharType, CharTrait>& out, none_t);
```
* [*Effect:] Outputs an implementation-defined string.
* [*Returns:] `out`.
@ -62,9 +65,11 @@ __SPACE__
__SPACE__
[#reference_operator_istream]
`template <class CharType, class CharTrait, class T>` [br]
std::basic_ostream<CharType, CharTrait>&` [br]
operator>>(std::basic_istream<CharType, CharTrait>& in, optional<T>& v);`
```
template <class CharType, class CharTrait, class T>
std::basic_ostream<CharType, CharTrait>&
operator>>(std::basic_istream<CharType, CharTrait>& in, optional<T>& v);
```
* [*Requires:] `T` is __STD_DEFAULT_CONSTRUCTIBLE__ and __MOVE_CONSTRUCTIBLE__.
* [*Effect:] Reads the value of optional object from `in`. If the string representation indicates that the optional object should contain a value, `v` contains a value and its contained value is obtained as if by default-constructing an object `o` of type `T` and then calling `in >> o`; otherwise `v` does not contain a value, and the previously contained value (if any) has been destroyed.

6
doc/28_ref_optional_semantics.qbk
View File

@ -1428,9 +1428,9 @@ struct hash<boost::optional<T&> > ;
``
The specialization `hash<optional<T>>` is enabled if and only if
`hash<remove_­const_­t<T>>` is enabled. When enabled, for an object `o`
of type `optional<T>`, if `o.has_­value() == true`, then `hash<optional<T>>()(o)`
evaluates to the same value as `hash<remove_­const_­t<T>>()(*o)`; otherwise it
`hash<remove_const_t<T>>` is enabled. When enabled, for an object `o`
of type `optional<T>`, if `o.has_value() == true`, then `hash<optional<T>>()(o)`
evaluates to the same value as `hash<remove_const_t<T>>()(*o)`; otherwise it
evaluates to an unspecified value.
The member functions are not guaranteed to be `noexcept`.

20
doc/Jamfile.v2
View File

@ -29,20 +29,20 @@ install images
:
<location>html/images
;
boostbook standalone
:
optional
:
<format>html:<xsl:param>boost.root=../../../..
<format>html:<xsl:param>boost.libraries=../../../../libs/libraries.htm
<xsl:param>chapter.autolabel=0
<xsl:param>chunk.section.depth=8
<xsl:param>toc.section.depth=2
<xsl:param>toc.max.depth=2
<xsl:param>generate.section.toc.level=1
<format>pdf:<xsl:param>img.src.path=$(images)/
<format>pdf:<xsl:param>boost.url.prefix=http://www.boost.org/doc/libs/release/libs/optional/doc/html
<format>html:<xsl:param>"boost.root=../../../.."
<format>html:<xsl:param>"boost.libraries=../../../../libs/libraries.htm"
<xsl:param>"chapter.autolabel=0"
<xsl:param>"chunk.section.depth=8"
<xsl:param>"toc.section.depth=2"
<xsl:param>"toc.max.depth=2"
<xsl:param>"generate.section.toc.level=1"
<format>pdf:<xsl:param>"img.src.path=$(images)/"
<format>pdf:<xsl:param>"boost.url.prefix=http://www.boost.org/doc/libs/release/libs/optional/doc/html"
<format>docbook:<auto-index-internal>on
;