From 312b04787661304b6e7176ec517d329a87f311da Mon Sep 17 00:00:00 2001 From: Peter Dimov Date: Tue, 21 Jan 2020 03:03:16 +0200 Subject: [PATCH] Update documentation --- doc/source_location.adoc | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/doc/source_location.adoc b/doc/source_location.adoc index 070afb0..d3436e8 100644 --- a/doc/source_location.adoc +++ b/doc/source_location.adoc @@ -38,6 +38,10 @@ struct source_location constexpr uint_least32_t column() const noexcept; }; +template + std::basic_ostream & + operator<<( std::basic_ostream & 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 + std::basic_ostream & + operator<<( std::basic_ostream & 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