luo980/cpptrace
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Add print_with_snippets to docs

Browse Source
This commit is contained in:
Jeremy 2024-03-16 17:52:38 -05:00
parent a528aa8e0b
commit 8407adf6d3
No known key found for this signature in database
GPG Key ID: BE03111EB7ED6E2E
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
README.md
View File

@ -161,6 +161,9 @@ The core resolved stack trace object. Generate a trace with `cpptrace::generate_
`cpptrace::stacktrace::current()`. On top of a set of helper functions `struct stacktrace` allows `cpptrace::stacktrace::current()`. On top of a set of helper functions `struct stacktrace` allows
direct access to frames as well as iterators. direct access to frames as well as iterators.
`cpptrace::stacktrace::print` can be used to print a stacktrace. `cpptrace::stacktrace::print_with_snippets` can be used
to print a stack trace with source code snippets.
```cpp ```cpp
namespace cpptrace { namespace cpptrace {
// Some type sufficient for an instruction pointer, currently always an alias to std::uintptr_t // Some type sufficient for an instruction pointer, currently always an alias to std::uintptr_t
@ -190,6 +193,9 @@ namespace cpptrace {
void print() const; void print() const;
void print(std::ostream& stream) const; void print(std::ostream& stream) const;
void print(std::ostream& stream, bool color) const; void print(std::ostream& stream, bool color) const;
void print_with_snippets() const;
void print_with_snippets(std::ostream& stream) const;
void print_with_snippets(std::ostream& stream, bool color) const;
std::string to_string(bool color = false) const; std::string to_string(bool color = false) const;
void clear(); void clear();
bool empty() const noexcept; bool empty() const noexcept;