Update documentation

This commit is contained in:
Peter Dimov committed 2022-02-09 20:52:23 +02:00
1 parent 8d8e6a90de
commit abd62362ef
3 files changed
+39 -2

No files matched your search

+37 -1
View File
@@ -185,9 +185,13 @@ namespace errc {
template<> struct is_error_condition_enum<errc::errc_t>
{ static const bool value = true; };
constexpr error_code make_error_code( errc::errc_t e ) noexcept;
constexpr error_condition make_error_condition( errc::errc_t e ) noexcept;
constexpr error_code make_error_code( errc::errc_t e ) noexcept;
error_code make_error_code( errc::errc_t e,
boost::source_location const * loc ) noexcept;
} // namespace system
} // namespace boost
```
@@ -256,6 +260,38 @@ void my_api_function( boost::system::error_code& ec )
}
```
```
constexpr error_code make_error_code( errc::errc_t e,
boost::source_location const * loc ) noexcept;
```
[none]
* {blank}
+
Returns: :: `error_code( e, generic_category(), loc )`.
Same as the above overload, but takes a source location.
* {blank}
+
```
void my_api_function( boost::system::error_code& ec )
{
void* p = std::malloc( 16 );
if( p == 0 )
{
// return ENOMEM
BOOST_STATIC_CONSTEXPR boost::source_location loc =
BOOST_CURRENT_LOCATION;
ec = make_error_code( boost::system::errc::out_of_memory, &loc );
return;
}
// use p
}
```
## <boost/system/{zwsp}error_category.hpp>
### error_category