From c4e6c13d7ca779deb20f26e65f34e67f2785ef75 Mon Sep 17 00:00:00 2001 From: Antony Polukhin Date: Thu, 1 Dec 2016 09:55:55 +0300 Subject: [PATCH] Docs regenerated --- boost/stacktrace/frame.html | 79 +++++++++++---- boost/stacktrace/stacktrace.html | 95 +++++++++++-------- .../build_macros_and_backends.html | 4 +- boost_stacktrace_header_reference.html | 26 ++--- index.html | 2 +- 5 files changed, 128 insertions(+), 78 deletions(-) diff --git a/boost/stacktrace/frame.html b/boost/stacktrace/frame.html index 10097d2..48d0cba 100644 --- a/boost/stacktrace/frame.html +++ b/boost/stacktrace/frame.html @@ -34,28 +34,29 @@ class frame { public: // construct/copy/destruct - frame() = delete; - frame(const frame &) = default; - explicit frame(const void *) noexcept; - frame & operator=(const frame &) = default; + frame() noexcept; + frame(const frame &) = default; + explicit frame(const void *) noexcept; + frame & operator=(const frame &) = default; - // public member functions - std::string name() const; - const void * address() const noexcept; - std::string source_file() const; - std::size_t source_line() const; + // public member functions + std::string name() const; + const void * address() const noexcept; + std::string source_file() const; + std::size_t source_line() const; + explicit operator bool() const noexcept; + bool empty() const noexcept; };
-

Description

+

Description

-

+

frame public construct/copy/destruct

    -
  1. frame() = delete;
  2. -
    frame(const frame &) = default;
    Copy constructs frame.

    Complexity: O(1).

    +
    frame() noexcept;
    Constructs frame that references NULL address. Calls to source_file() and source_line() wil lreturn empty string. Calls to source_line() will return 0.

    Complexity: O(1).

    Async-Handler-Safety: Safe.

    @@ -67,7 +68,7 @@
  3. -
    explicit frame(const void * addr) noexcept;
    Constructs frame that can extract information from addr at runtime.

    Complexity: O(1).

    +
    frame(const frame &) = default;
    Copy constructs frame.

    Complexity: O(1).

    Async-Handler-Safety: Safe.

    @@ -79,7 +80,19 @@
  4. -
    frame & operator=(const frame &) = default;
    Copy assigns frame.

    Complexity: O(1).

    +
    explicit frame(const void * addr) noexcept;
    Constructs frame that can extract information from addr at runtime.

    Complexity: O(1).

    +

    Async-Handler-Safety: Safe. +

    +
    ++ + + + +

    Throws:

    		Nothing.
    +
    5. +
  5. +
    frame & operator=(const frame &) = default;
    Copy assigns frame.

    Complexity: O(1).

    Async-Handler-Safety: Safe.

    @@ -93,11 +106,11 @@
    -

    -frame public member functions

    +

    +frame public member functions

    1. -
      std::string name() const;
      +
      std::string name() const;

      Async-Handler-Safety: Unsafe.

      @@ -116,7 +129,7 @@
  6. -
    const void * address() const noexcept;
    +
    const void * address() const noexcept;

    Async-Handler-Safety: Safe.

    @@ -135,7 +148,7 @@
  • -
    std::string source_file() const;
    +
    std::string source_file() const;

    Async-Handler-Safety: Unsafe.

    @@ -154,7 +167,7 @@
  • -
    std::size_t source_line() const;
    +
    std::size_t source_line() const;

    Async-Handler-Safety: Unsafe.

    @@ -172,6 +185,30 @@
    • +
  • +
    explicit operator bool() const noexcept;
    Checks that frame is not references NULL address.

    +Complexity: O(1)

    +

    Async-Handler-Safety: Safe.

    +
    ++ + + + +

    Returns:

    true if this->address() != 0

    +
    • +
  • +
    bool empty() const noexcept;
    Checks that frame references NULL address.

    +Complexity: O(1)

    +

    Async-Handler-Safety: Safe.

    +
    ++ + + + +

    Returns:

    true if this->address() == 0

    +
    • diff --git a/boost/stacktrace/stacktrace.html b/boost/stacktrace/stacktrace.html index 67c91a0..7370f6b 100644 --- a/boost/stacktrace/stacktrace.html +++ b/boost/stacktrace/stacktrace.html @@ -42,62 +42,63 @@ typedef std::reverse_iterator< const_iterator > const_reverse_iterator; // construct/copy/destruct - stacktrace() noexcept; - stacktrace(const stacktrace &) noexcept; - stacktrace & operator=(const stacktrace &) noexcept; - ~stacktrace(); + stacktrace() noexcept; + stacktrace(const stacktrace &) noexcept; + stacktrace & operator=(const stacktrace &) noexcept; + ~stacktrace(); - // public member functions - std::size_t size() const noexcept; - frame operator[](std::size_t) const noexcept; - const_iterator begin() const noexcept; - const_iterator cbegin() const noexcept; - const_iterator end() const noexcept; - const_iterator cend() const noexcept; - const_reverse_iterator rbegin() const noexcept; - const_reverse_iterator crbegin() const noexcept; - const_reverse_iterator rend() const noexcept; - const_reverse_iterator crend() const noexcept; - explicit operator bool() const noexcept; - bool operator<(const stacktrace &) const noexcept; - bool operator==(const stacktrace &) const noexcept; - std::size_t hash_code() const noexcept; + // public member functions + std::size_t size() const noexcept; + frame operator[](std::size_t) const noexcept; + const_iterator begin() const noexcept; + const_iterator cbegin() const noexcept; + const_iterator end() const noexcept; + const_iterator cend() const noexcept; + const_reverse_iterator rbegin() const noexcept; + const_reverse_iterator crbegin() const noexcept; + const_reverse_iterator rend() const noexcept; + const_reverse_iterator crend() const noexcept; + explicit operator bool() const noexcept; + bool empty() const noexcept; + bool operator<(const stacktrace &) const noexcept; + bool operator==(const stacktrace &) const noexcept; + std::size_t hash_code() const noexcept; };
    -

    Description

    +

    Description

    -

    +

    stacktrace public construct/copy/destruct

    1. -
      stacktrace() noexcept;
      Stores the current function call sequence inside the class.

      Complexity: O(N) where N is call sequence length, O(1) for noop backend.

      +
      stacktrace() noexcept;
      Stores the current function call sequence inside the class.

      Complexity: O(N) where N is call sequence length, O(1) for noop backend.

      Async-Handler-Safety: Depends on backend, see "Build, Macros and Backends" section.

    2. -
      stacktrace(const stacktrace & st) noexcept;
      +
      stacktrace(const stacktrace & st) noexcept;

      Complexity: O(st.size())

      Async-Handler-Safety: Safe.

    3. -
      stacktrace & operator=(const stacktrace & st) noexcept;
      +
      stacktrace & operator=(const stacktrace & st) noexcept;

      Complexity: O(st.size())

      Async-Handler-Safety: Safe.

    4. -
      ~stacktrace();
      +
      ~stacktrace();

      Complexity: O(1)

      Async-Handler-Safety: Safe.

    -

    -stacktrace public member functions

    +

    +stacktrace public member functions

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

      Complexity: O(1)

      Async-Handler-Safety: Safe.

      @@ -110,7 +111,7 @@
  • -
    frame operator[](std::size_t frame_no) const noexcept;
    +
    frame operator[](std::size_t frame_no) const noexcept;

    Complexity: Amortized O(1), O(1) for noop backend.

    @@ -136,47 +137,47 @@
  • -
    const_iterator begin() const noexcept;
    +
    const_iterator begin() const noexcept;

    Complexity: O(1)

    Async-Handler-Safety: Safe.

  • -
    const_iterator cbegin() const noexcept;
    +
    const_iterator cbegin() const noexcept;

    Complexity: O(1)

    Async-Handler-Safety: Safe.

  • -
    const_iterator end() const noexcept;
    +
    const_iterator end() const noexcept;

    Complexity: O(1)

    Async-Handler-Safety: Safe.

  • -
    const_iterator cend() const noexcept;
    +
    const_iterator cend() const noexcept;

    Complexity: O(1)

    Async-Handler-Safety: Safe.

  • -
    const_reverse_iterator rbegin() const noexcept;
    +
    const_reverse_iterator rbegin() const noexcept;

    Complexity: O(1)

    Async-Handler-Safety: Safe.

  • -
    const_reverse_iterator crbegin() const noexcept;
    +
    const_reverse_iterator crbegin() const noexcept;

    Complexity: O(1)

    Async-Handler-Safety: Safe.

  • -
    const_reverse_iterator rend() const noexcept;
    +
    const_reverse_iterator rend() const noexcept;

    Complexity: O(1)

    Async-Handler-Safety: Safe.

  • -
    const_reverse_iterator crend() const noexcept;
    +
    const_reverse_iterator crend() const noexcept;

    Complexity: O(1)

    Async-Handler-Safety: Safe.

  • -
    explicit operator bool() const noexcept;
    Allows to check that stack trace capturing was successful.

    +

    explicit operator bool() const noexcept;
    Allows to check that stack trace capturing was successful.

    Complexity: O(1)

    Async-Handler-Safety: Safe.

    @@ -188,15 +189,27 @@
  • -
    bool operator<(const stacktrace & rhs) const noexcept;
    Compares stacktraces for less, order is platform dependant.

    Complexity: Amortized O(1); worst case O(size())

    +
    bool empty() const noexcept;
    Allows to check that stack trace failed.

    +Complexity: O(1)

    +

    Async-Handler-Safety: Safe.

    +
    ++ + + + +

    Returns:

    true if this->size() == 0

    +
    • +
  • +
    bool operator<(const stacktrace & rhs) const noexcept;
    Compares stacktraces for less, order is platform dependant.

    Complexity: Amortized O(1); worst case O(size())

    Async-Handler-Safety: Safe.

  • -
    bool operator==(const stacktrace & rhs) const noexcept;
    Compares stacktraces for equality.

    Complexity: Amortized O(1); worst case O(size())

    +
    bool operator==(const stacktrace & rhs) const noexcept;
    Compares stacktraces for equality.

    Complexity: Amortized O(1); worst case O(size())

    Async-Handler-Safety: Safe.

  • -
    std::size_t hash_code() const noexcept;
    Returns hashed code of the stacktrace.

    Complexity: O(1)

    +
    std::size_t hash_code() const noexcept;
    Returns hashed code of the stacktrace.

    Complexity: O(1)

    Async-Handler-Safety: Safe.

    • diff --git a/boost_stacktrace/build_macros_and_backends.html b/boost_stacktrace/build_macros_and_backends.html index 9d208bb..017f256 100644 --- a/boost_stacktrace/build_macros_and_backends.html +++ b/boost_stacktrace/build_macros_and_backends.html @@ -110,7 +110,7 @@

    - Constructors + yes

    @@ -211,7 +211,7 @@

    - all functions + yes

    diff --git a/boost_stacktrace_header_reference.html b/boost_stacktrace_header_reference.html index 1818530..31573b0 100644 --- a/boost_stacktrace_header_reference.html +++ b/boost_stacktrace_header_reference.html @@ -38,18 +38,18 @@ class stacktrace; // Comparison operators that provide platform dependant ordering and have amortized O(1) complexity; O(size()) worst case complexity; are Async-Handler-Safe. - bool operator>(const stacktrace & lhs, const stacktrace & rhs); - bool operator<=(const stacktrace & lhs, const stacktrace & rhs); - bool operator>=(const stacktrace & lhs, const stacktrace & rhs); - bool operator!=(const stacktrace & lhs, const stacktrace & rhs); + bool operator>(const stacktrace & lhs, const stacktrace & rhs); + bool operator<=(const stacktrace & lhs, const stacktrace & rhs); + bool operator>=(const stacktrace & lhs, const stacktrace & rhs); + bool operator!=(const stacktrace & lhs, const stacktrace & rhs); // Hashing support, O(1) complexity; Async-Handler-Safe. - std::size_t hash_value(const stacktrace & st); + std::size_t hash_value(const stacktrace & st); // Outputs stacktrace in a human readable format to output stream; unsafe to use in async handlers. template<typename CharT, typename TraitsT> std::basic_ostream< CharT, TraitsT > & - operator<<(std::basic_ostream< CharT, TraitsT > & os, + operator<<(std::basic_ostream< CharT, TraitsT > & os, const stacktrace & bt); } } @@ -71,20 +71,20 @@ class frame; // Comparison operators that provide platform dependant ordering and have O(1) complexity; are Async-Handler-Safe. - bool operator<(const frame & lhs, const frame & rhs); - bool operator>(const frame & lhs, const frame & rhs); - bool operator<=(const frame & lhs, const frame & rhs); - bool operator>=(const frame & lhs, const frame & rhs); + bool operator<(const frame & lhs, const frame & rhs); + bool operator>(const frame & lhs, const frame & rhs); + bool operator<=(const frame & lhs, const frame & rhs); + bool operator>=(const frame & lhs, const frame & rhs); bool operator==(const frame & lhs, const frame & rhs); - bool operator!=(const frame & lhs, const frame & rhs); + bool operator!=(const frame & lhs, const frame & rhs); // Hashing support, O(1) complexity; Async-Handler-Safe. - std::size_t hash_value(const frame & f); + std::size_t hash_value(const frame & f); // Outputs stacktrace::frame in a human readable format to output stream; unsafe to use in async handlers. template<typename CharT, typename TraitsT> std::basic_ostream< CharT, TraitsT > & - operator<<(std::basic_ostream< CharT, TraitsT > & os, const frame & f); + operator<<(std::basic_ostream< CharT, TraitsT > & os, const frame & f); } } diff --git a/index.html b/index.html index efeffd4..c631c9b 100644 --- a/index.html +++ b/index.html @@ -86,7 +86,7 @@ - +

    Last revised: November 30, 2016 at 07:48:20 GMT

    Last revised: December 01, 2016 at 06:55:37 GMT