[skip ci] Updates to Doxygen related comments.

Stiffstream · Mar 19, 2024 · 4856bd3 · 4856bd3
1 parent 3d47a8b
commit 4856bd3
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 2 deletions.
diff --git a/dev/so_5/agent_identity.hpp b/dev/so_5/agent_identity.hpp
@@ -33,7 +33,7 @@ namespace so_5
  * This type is intended to be used as a thin wrapper that covers cases described
  * above. It holds a reference to agent's name if the name is specified or
  * just pointer to an agent if there is no name. This type can be seen as
- * a more as more convenient version of:
+ * a more convenient version of:
  * \code
  * std::variant<std::string_view, const agent_t*>;
  * \endcode

diff --git a/dev/so_5/agent_tuning_options.hpp b/dev/so_5/agent_tuning_options.hpp
@@ -154,7 +154,7 @@ class SO_5_TYPE name_for_agent_t
 struct name_for_agent_methods_mixin_t
 {
 	/*!
-	 * \brief A helper factory for making #name_for_agent_t instance.
+	 * \brief A helper factory for making %name_for_agent_t instance.
 	 *
 	 * Usage example:
 	 * \code

diff --git a/dev/so_5/version.dox b/dev/so_5/version.dox
@@ -17,6 +17,9 @@ New methods so_5::stats::prefix_t::as_string_view() and
 so_5::stats::suffix_t::as_string_view(). Several methods of
 so_5::stats::prefix_t and so_5::stats::suffix_t are now constexpr.
 
+A possibility to set an optional name for agent. New types so_5::name_for_agent_t,
+so_5::agent_identity_t. New methods so_5::agent_t::name_for_agent(), so_5::agent_t::so_agent_name().
+
 \section so_5__5_8_1 5.8.1 "Alpamayo"
 
 New functions so_5::msinks::transform_then_redirect() and new