Update documentation

This commit is contained in:
Peter Dimov
2020-01-21 03:03:16 +02:00
parent e52b379928
commit 312b047876

View File

@@ -38,6 +38,10 @@ struct source_location
constexpr uint_least32_t column() const noexcept;
};
template<class E, class T>
std::basic_ostream<E, T> &
operator<<( std::basic_ostream<E, T> & os, source_location const & loc );
} // namespace boost
#define BOOST_CURRENT_LOCATION \
@@ -63,6 +67,17 @@ Effects: :: Constructs a `source_location` object for which `file_name()`
returns `file`, `function_name()` returns `function`, `line()` returns the
`line` argument and `column()` returns the `column` argument.
## operator<<
```
template<class E, class T>
std::basic_ostream<E, T> &
operator<<( std::basic_ostream<E, T> & os, source_location const & loc );
```
Effects: :: Outputs a string representation of `loc` to `os`.
Returns: :: `os`.
## BOOST_CURRENT_LOCATION
When `BOOST_DISABLE_CURRENT_LOCATION` is not defined, the definition of