From f5e22fc55809739767f9453cd9a843ee8df044ae Mon Sep 17 00:00:00 2001 From: Antony Polukhin Date: Thu, 8 Sep 2016 08:31:35 +0300 Subject: [PATCH] Docs generated --- boost/stacktrace/stacktrace.html | 124 +++++++++++++++++++++++++ boost_stacktrace/getting_started.html | 41 ++++++++ boost_stacktrace_header_reference.html | 58 ++++++++++++ index.html | 84 +++++++++++++++++ standalone_HTML.manifest | 4 + 5 files changed, 311 insertions(+) create mode 100644 boost/stacktrace/stacktrace.html create mode 100644 boost_stacktrace/getting_started.html create mode 100644 boost_stacktrace_header_reference.html create mode 100644 index.html create mode 100644 standalone_HTML.manifest diff --git a/boost/stacktrace/stacktrace.html b/boost/stacktrace/stacktrace.html new file mode 100644 index 0000000..735658a --- /dev/null +++ b/boost/stacktrace/stacktrace.html @@ -0,0 +1,124 @@ + + + +Class stacktrace + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHome +
+
+
+
+

Class stacktrace

+

boost::stacktrace::stacktrace

+
+

Synopsis

+
// In header: <boost/stacktrace.hpp>
+
+
+class stacktrace {
+public:
+  // construct/copy/destruct
+  stacktrace() noexcept;
+  stacktrace(const stacktrace &) noexcept;
+  stacktrace & operator=(const stacktrace &) noexcept;
+  ~stacktrace();
+
+  // public member functions
+  std::size_t size() const noexcept;
+  std::string operator[](std::size_t) const;
+};
+
+

Description

+
+

+stacktrace + public + construct/copy/destruct

+
    +
  1. +
    stacktrace() noexcept;
    Stores the current function call sequence inside the class.
    2. +
  2. stacktrace(const stacktrace & bt) noexcept;
    3. +
  3. stacktrace & operator=(const stacktrace & bt) noexcept;
    4. +
  4. ~stacktrace();
    5. +
+
+
+

+stacktrace public member functions

+
    +
  1. +
    std::size_t size() const noexcept;
    +

    +

    +
    ++ + + + +

    Returns:

    Number of function names stored inside the class.

    +
    2. +
  2. +
    std::string operator[](std::size_t frame) const;
    +

    + + +

    +
    ++ + + + + + + + + + + + + + +

    Parameters:

    ++ + + + +

    frame

    Zero based index of function to return. 0 is the function index where stacktrace was constructed and index close to this->size() contains function main().

    Returns:

    Function name in a human readable form.

    Throws:

    		std::bad_alloc if not enough memory.
    +
    3. +
+
+
+
+ + + +
Copyright © 2016 Antony Polukhin

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHome +
+ + diff --git a/boost_stacktrace/getting_started.html b/boost_stacktrace/getting_started.html new file mode 100644 index 0000000..905d268 --- /dev/null +++ b/boost_stacktrace/getting_started.html @@ -0,0 +1,41 @@ + + + +Getting Started + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+

+Getting Started +

+ + + +
Copyright © 2016 Antony Polukhin

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/boost_stacktrace_header_reference.html b/boost_stacktrace_header_reference.html new file mode 100644 index 0000000..9cac644 --- /dev/null +++ b/boost_stacktrace_header_reference.html @@ -0,0 +1,58 @@ + + + +Boost.Stacktrace Header Reference + + + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
+PrevUpHomeNext +
+
+

+Boost.Stacktrace Header Reference

+
Header <boost/stacktrace.hpp>
+
+
+
namespace boost {
+  namespace stacktrace {
+    class stacktrace;
+
+    // Outputs stacktrace in a human readable format to output stream. 
+    template<typename CharT, typename TraitsT> 
+      std::basic_ostream< CharT, TraitsT > & 
+      operator<<(std::basic_ostream< CharT, TraitsT > & os, 
+                 const stacktrace & bt);
+  }
+}
+
+
+ + + +
Copyright © 2016 Antony Polukhin

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+PrevUpHomeNext +
+ + diff --git a/index.html b/index.html new file mode 100644 index 0000000..975fdd2 --- /dev/null +++ b/index.html @@ -0,0 +1,84 @@ + + + +Chapter 1. Boost.Stacktrace 1.0 + + + + + + + + + + + + + +
Boost C++ LibrariesHomeLibrariesPeopleFAQMore
+
+
Next
+
+
+

+Chapter 1. Boost.Stacktrace 1.0

+

Copyright © 2016 Antony Polukhin

+
+

+ Distributed under the Boost Software License, Version 1.0. (See accompanying + file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +

+
+
+
+

Table of Contents

+
+
Motivation
+
Getting Started
+
Boost.Stacktrace Header Reference
+
Header <boost/stacktrace.hpp>
+
+
+
+
+

+ How to display the call sequence in C++? From what function was called the + current function? What call sequence lead to an exception? +

+

+ Boost.Stacktrace library is a simple library that provides information about + call sequence in human readable form. +

+
+ + + + + +
[Warning]Warning

+ Library is in early development stage! A lot of thing will change soon! +

+
+ + + + + +
[Warning]Warning

+ This is not an official Boost library! It wasn't reviewed and can't be downloaded + from www.boost.org. This library is available to the community to know real + interest and get comments for refinement. The intention is to submit library + to formal review, if community think that it is interesting! +

+
+
+ + + +

Last revised: September 08, 2016 at 05:28:10 GMT

+
+
Next
+ + diff --git a/standalone_HTML.manifest b/standalone_HTML.manifest new file mode 100644 index 0000000..24ee2f7 --- /dev/null +++ b/standalone_HTML.manifest @@ -0,0 +1,4 @@ +index.html +boost_stacktrace/getting_started.html +boost_stacktrace_header_reference.html +boost/stacktrace/stacktrace.html