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

Revert "Update documentation"

Browse Source 
This reverts commit 8962c9101a.
This commit is contained in:
Peter Dimov
2021-06-13 04:47:19 +03:00
parent 723daf5d57
commit 88f7c2bf53
1 changed files with 18 additions and 33 deletions
Download Patch File Download Diff File Expand all files Collapse all files

51
doc/system/reference.adoc
View File

@ -670,16 +670,13 @@ namespace boost {
constexpr const error_category & category() const noexcept;
std::string message() const;
char const * message( char * buffer, std::size_t len ) const noexcept;
constexpr bool failed() const noexcept;
constexpr explicit operator bool() const noexcept;
operator std::error_condition() const;
// deprecated members; do not use
char const * message( char * buffer, std::size_t len ) const noexcept;
constexpr bool failed() const noexcept;
private: // exposition only
int val_;
@ -774,25 +771,6 @@ std::string message() const;
+
Returns: :: `cat_\->message( val_ )`.
```
constexpr explicit operator bool() const noexcept;
```
[none]
* {blank}
+
Returns: :: `value() != 0`.
```
operator std::error_condition() const;
```
[none]
* {blank}
+
Returns: ::
`std::error_condition( val_, *cat_ )`.
#### Deprecated members
```
char const * message( char * buffer, std::size_t len ) const noexcept;
```
@ -801,11 +779,6 @@ char const * message( char * buffer, std::size_t len ) const noexcept;
+
Returns: :: `cat_\->message( val_, buffer, len )`.
WARNING: This member function is deprecated and will be removed. This is done
for compatibility with `std::error_condition` as the next release is
expected to improve interoperability with `<system_error>` even further.
_Note that this does not affect_ `error_code::message`.
```
constexpr bool failed() const noexcept;
```
@ -814,10 +787,22 @@ constexpr bool failed() const noexcept;
+
Returns: :: `cat_\->failed( val_ )`.
WARNING: This member function is deprecated and will be removed. This is done
for compatibility with `std::error_condition` as the next release is
expected to improve interoperability with `<system_error>` even further.
_Note that this does not affect_ `error_code::failed`.
```
constexpr explicit operator bool() const noexcept;
```
[none]
* {blank}
+
Returns: :: `failed()`.
```
operator std::error_condition() const;
```
[none]
* {blank}
+
Returns: ::
`std::error_condition( val_, *cat_ )`.
### Nonmember functions