added doxygen comments

fktn-k · Jan 6, 2025 · 84bdf33 · 84bdf33
1 parent 5c3d5c0
commit 84bdf33
Show file tree

Hide file tree

Showing 2 changed files with 20 additions and 0 deletions.
diff --git a/include/fkYAML/node.hpp b/include/fkYAML/node.hpp
@@ -136,9 +136,11 @@ class basic_node {
     using yaml_version_t = detail::yaml_version_t;
 
     /// @brief A type for mapping range objects for the map_items() function.
+    /// @sa https://fktn-k.github.io/fkYAML/api/basic_node/map_range/
     using map_range = fkyaml::detail::map_range_proxy<basic_node>;
 
     /// @brief A type for constant mapping range objects for the map_items() function.
+    /// @sa https://fktn-k.github.io/fkYAML/api/basic_node/map_range/
     using const_map_range = fkyaml::detail::map_range_proxy<const basic_node>;
 
 private:
@@ -1601,13 +1603,21 @@ class basic_node {
         return rend();
     }
 
+    /// @brief Returns a range of mapping entries.
+    /// @throw `type_error` if this basic_node is not a mapping.
+    /// @return A range of mapping entries.
+    /// @sa https://fktn-k.github.io/fkYAML/api/basic_node/map_items/
     map_range map_items() {
         if FK_YAML_UNLIKELY (!is_mapping()) {
             throw type_error("map_items() cannot be called on a non-mapping node.", get_type());
         }
         return {*this};
     }
 
+    /// @brief Returns a const range of mapping entries.
+    /// @throw `type_error` if this basic_node is not a mapping.
+    /// @return A const range of mapping entries.
+    /// @sa https://fktn-k.github.io/fkYAML/api/basic_node/map_items/
     const_map_range map_items() const {
         if FK_YAML_UNLIKELY (!is_mapping()) {
             throw type_error("map_items() cannot be called on a non-mapping node.", get_type());

diff --git a/single_include/fkYAML/node.hpp b/single_include/fkYAML/node.hpp
@@ -12559,9 +12559,11 @@ class basic_node {
     using yaml_version_t = detail::yaml_version_t;
 
     /// @brief A type for mapping range objects for the map_items() function.
+    /// @sa https://fktn-k.github.io/fkYAML/api/basic_node/map_range/
     using map_range = fkyaml::detail::map_range_proxy<basic_node>;
 
     /// @brief A type for constant mapping range objects for the map_items() function.
+    /// @sa https://fktn-k.github.io/fkYAML/api/basic_node/map_range/
     using const_map_range = fkyaml::detail::map_range_proxy<const basic_node>;
 
 private:
@@ -14024,13 +14026,21 @@ class basic_node {
         return rend();
     }
 
+    /// @brief Returns a range of mapping entries.
+    /// @throw `type_error` if this basic_node is not a mapping.
+    /// @return A range of mapping entries.
+    /// @sa https://fktn-k.github.io/fkYAML/api/basic_node/map_items/
     map_range map_items() {
         if FK_YAML_UNLIKELY (!is_mapping()) {
             throw type_error("map_items() cannot be called on a non-mapping node.", get_type());
         }
         return {*this};
     }
 
+    /// @brief Returns a const range of mapping entries.
+    /// @throw `type_error` if this basic_node is not a mapping.
+    /// @return A const range of mapping entries.
+    /// @sa https://fktn-k.github.io/fkYAML/api/basic_node/map_items/
     const_map_range map_items() const {
         if FK_YAML_UNLIKELY (!is_mapping()) {
             throw type_error("map_items() cannot be called on a non-mapping node.", get_type());