feedc0de/boost_assert
1
0
Fork 0
forked from boostorg/assert
Code Pull Requests Activity

Update documentation

Browse Source
This commit is contained in:
Peter Dimov
2021-09-19 03:37:51 +03:00
parent 1f98fab0bf
commit a0d8040e93
4 changed files with 31 additions and 15 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
doc/changes.adoc
View File

@ -1,5 +1,5 @@
////
Copyright 2019 Peter Dimov
Copyright 2019, 2021 Peter Dimov
Distributed under the Boost Software License, Version 1.0.
http://www.boost.org/LICENSE_1_0.txt
////
@ -10,6 +10,10 @@ http://www.boost.org/LICENSE_1_0.txt
:toc-title:
:idprefix:
## Changes in 1.78.0
* Added `source_location::to_string`.
## Changes in 1.73.0
* Added `source_location`.

2
doc/index.adoc
View File

@ -30,7 +30,7 @@ include::changes.adoc[]
This documentation is
* Copyright 2002, 2007, 2014, 2017, 2019, 2020 Peter Dimov
* Copyright 2002, 2007, 2014, 2017, 2019-2021 Peter Dimov
* Copyright 2011 Beman Dawes
* Copyright 2015 Ion Gaztañaga
* Distributed under the http://www.boost.org/LICENSE_1_0.txt[Boost Software License, Version 1.0].

36
doc/source_location.adoc
View File

@ -1,5 +1,5 @@
////
Copyright 2019 Peter Dimov
Copyright 2019, 2021 Peter Dimov
Distributed under the Boost Software License, Version 1.0.
http://www.boost.org/LICENSE_1_0.txt
////
@ -28,19 +28,21 @@ namespace boost
struct source_location
{
constexpr source_location() noexcept;
constexpr source_location(char const* file, uint_least32_t line,
char const* function, uint_least32_t column = 0) noexcept;
constexpr source_location() noexcept;
constexpr source_location(char const* file, uint_least32_t line,
char const* function, uint_least32_t column = 0) noexcept;
constexpr char const* file_name() const noexcept;
constexpr char const* function_name() const noexcept;
constexpr uint_least32_t line() const noexcept;
constexpr uint_least32_t column() const noexcept;
constexpr char const* file_name() const noexcept;
constexpr char const* function_name() const noexcept;
constexpr uint_least32_t line() const noexcept;
constexpr uint_least32_t column() const noexcept;
std::string to_string() const;
};
template<class E, class T>
std::basic_ostream<E, T> &
operator<<( std::basic_ostream<E, T> & os, source_location const & loc );
operator<<( std::basic_ostream<E, T> & os, source_location const & loc );
} // namespace boost
@ -67,16 +69,26 @@ 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.
## to_string
```
std::string to_string() const;
```
Returns: ::
a string representation of `*this`.
## operator<<
```
template<class E, class T>
std::basic_ostream<E, T> &
operator<<( std::basic_ostream<E, T> & os, source_location const & loc );
operator<<( std::basic_ostream<E, T> & os, source_location const & loc );
```
Effects: :: Outputs a string representation of `loc` to `os`.
Returns: :: `os`.
Effects: :: `os << loc.to_string()`.
Returns: ::
`os`.
## BOOST_CURRENT_LOCATION

2
test/source_location_test3.cpp
View File

@ -1,4 +1,4 @@
// Copyright 2020 Peter Dimov
// Copyright 2020, 2021 Peter Dimov
// Distributed under the Boost Software License, Version 1.0.
// http://www.boost.org/LICENSE_1_0.txt