Adapted documentation of the callstack wrapper class, made two parameters constant

Author: mhahnFr

include/callstack.hpp

@@ -1,7 +1,7 @@
 /*
  * CallstackLibrary - Library creating human-readable call stacks.
  *
- * Copyright (C) 2022 - 2024  mhahnFr
+ * Copyright (C) 2022 - 2025  mhahnFr
  *
  * This file is part of the CallstackLibrary.
  *
@@ -38,26 +38,26 @@
  #include "callstack_cxx_compat.hpp"
 
 /**
- * This namespace contains a wrapper class for the `struct callstack`.
+ * This namespace contains a wrapper class for the @code struct callstack@endcode.
  * It is needed to avoid name conflicts between the structure and the wrapper class.
  */
 namespace lcs {
 /**
- * @brief A wrapper class around the `struct callstack`.
+ * @brief A wrapper class around the @code struct callstack@endcode.
  *
  * It provides the usual constructors and operator overloads. Additionally, it contains the
  * possibility to implicitly cast an object of this class to a pointer to the C structure.
  */
 class callstack {
-    /** A `typedef` for convenience. */
+    /** A @c typedef for convenience. */
     typedef ::callstack struct_callstack;
-    /** The original C structure.    */
+    /** The original C structure.     */
     struct_callstack self;
 
     /**
-     * @brief Helper function to throw the appropriate exception.
+     * Helper function to throw the appropriate exception.
      *
-     * @throws A `system_error` if compiled using C++11 or newer, a runtime error otherwise.
+     * @throws std::system_error if compiled using C++11 or newer, a @c std::runtime_error otherwise
      */
     inline static void error() {
 #if __cplusplus >= 201103
@@ -71,14 +71,15 @@ class callstack {
     /**
      * @brief A trivial default constructor.
      *
-     * Zero-initializes the underlying C structure. If the given boolean value is `true`,
-     * it is initialized using the function `callstack_emplace()`.
-     * Throws a `runtime_error` or a `system_error` if compiled using C++11 or newer if
-     * `emplace` is set to `true` and the backtrace could not be created.
+     * Zero-initializes the underlying C structure. If the given boolean value is @c true,
+     * it is initialized using the function @c callstack_emplace().
+     * Throws a @c std::runtime_error (or a @c std::system_error if compiled using C++11 or newer) if
+     * @c emplace is set to @c true and the backtrace could not be created.
      *
-     * @param emplace Whether to call `callstack_emplace()`.
+     * @param emplace Whether to call @c callstack_emplace().
+     * @throws std::system_error if the backtrace could not be created
      */
-    inline explicit callstack(bool emplace = true) {
+    inline explicit callstack(const bool emplace = true) {
         if (emplace) {
             if (!callstack_emplace(*this)) {
                 error();
@@ -91,11 +92,12 @@ class callstack {
     /**
      * @brief Constructs this object using the given stack address.
      *
-     * Initializes the underlying C structure using the function `callstack_emplaceWithAddress()`.
-     * Throws a `runtime_error` or a `system_error` if compiled using C++11 or newer if
+     * Initializes the underlying C structure using the function @c callstack_emplaceWithAddress().
+     * Throws a @c std::runtime_error (or a @c std::system_error if compiled using C++11 or newer) if
      * the backtrace could not be created.
      *
      * @param address The stack address after which frames are ignored.
+     * @throws std::system_error if the backtrace could not be created
      */
     inline explicit callstack(void* address) {
         if (!callstack_emplaceWithAddress(*this, address)) {
@@ -106,13 +108,14 @@ class callstack {
     /**
      * @brief Constructs the underlying C structure with the given backtrace.
      *
-     * if the given trace length is smaller than zero, a `runtime_error` or a `system_error`
-     * if compiled using C++11 or newer is thrown.
+     * if the given trace length is smaller than zero, a @c std::runtime_error
+     * (or a @c std::system_error if compiled using C++11 or newer) is thrown.
      *
      * @param trace The backtrace.
      * @param length The length of the given backtrace.
+     * @throws std::system_error if the trace length is smaller than @c 0
      */
-    inline callstack(void** trace, int length) {
+    inline callstack(void** trace, const int length) {
         if (!callstack_emplaceWithBacktrace(*this, trace, length)) {
             error();
         }
@@ -163,9 +166,9 @@ class callstack {
      *
      * @param onlyBinaries whether to only deduct the names of the runtime images
      * @return @c this
-     * @throws an exception when the translation failed
+     * @throws std::runtime_error if the translation failed
      */
-    inline callstack& translate(bool onlyBinaries = false) {
+    inline callstack& translate(const bool onlyBinaries = false) {
         if (onlyBinaries) {
             if (callstack_getBinaries(*this) == LCS_NULL) {
                 throw std::runtime_error("LCS: Failed to translate the callstack (binaries only)");
@@ -186,7 +189,7 @@ class callstack {
      * the cache of the library and only valid as long as the cache is.
      *
      * @return @c this
-     * @throws an exception if the translation failed
+     * @throws std::runtime_error if the translation failed
      */
     inline callstack& translateBinariesCached() {
         if (callstack_getBinariesCached(*this) == LCS_NULL) {