options doc refinement

Author: SpectraL519

include/gl/io/options.hpp

@@ -29,12 +29,16 @@ inline constexpr iword_type layout_options_mask =
 /// @brief @ref gl::io::options_manip "Stream manipulator" to enable concise graph formatting.
 ///
 /// Clears all layout-specific flags to default back to a compact representation.
+///
+/// @hideinitializer
 inline constexpr options_manip concise{0ul, detail::layout_options_mask};
 
 /// @ingroup GL GL-IO
 /// @brief @ref gl::io::options_manip "Stream manipulator" to enable verbose graph formatting.
 ///
 /// Modifies the stream state to output detailed structural information.
+///
+/// @hideinitializer
 inline constexpr options_manip verbose{
     detail::build_mask(detail::option_bit::verbose), detail::layout_options_mask
 };
@@ -43,44 +47,53 @@ inline constexpr options_manip verbose{
 /// @brief @ref gl::io::options_manip "Stream manipulator" to enable the Graph Specification Format (GSF).
 ///
 /// Modifies the stream to output or expect data matching the precise internal parsing format used for serialization and deserialization.
+///
+/// @hideinitializer
 inline constexpr options_manip spec_fmt{
     detail::build_mask(detail::option_bit::spec_fmt), detail::layout_options_mask
 };
 
 /// @ingroup GL GL-IO
 /// @brief @ref gl::io::options_manip "Stream manipulator" to enable the processing of vertex properties.
+/// @hideinitializer
 inline constexpr options_manip with_vertex_properties =
     set_options(detail::option_bit::with_vertex_properties);
 
 /// @ingroup GL GL-IO
 /// @brief @ref gl::io::options_manip "Stream manipulator" to disable the processing of vertex properties.
+/// @hideinitializer
 inline constexpr options_manip without_vertex_properties =
     clear_options(detail::option_bit::with_vertex_properties);
 
 /// @ingroup GL GL-IO
 /// @brief @ref gl::io::options_manip "Stream manipulator" to enable the processing of edge properties.
+/// @hideinitializer
 inline constexpr options_manip with_edge_properties =
     set_options(detail::option_bit::with_connection_properties);
 
 /// @ingroup GL GL-IO
 /// @brief @ref gl::io::options_manip "Stream manipulator" to disable the processing of edge properties.
+/// @hideinitializer
 inline constexpr options_manip without_edge_properties =
     clear_options(detail::option_bit::with_connection_properties);
 
 /// @ingroup GL GL-IO
 /// @brief @ref gl::io::options_manip "Stream manipulator" to enable the processing of both vertex and edge properties simultaneously.
+/// @hideinitializer
 inline constexpr options_manip with_properties = set_options(
     detail::option_bit::with_vertex_properties, detail::option_bit::with_connection_properties
 );
 
 /// @ingroup GL GL-IO
 /// @brief @ref gl::io::options_manip "Stream manipulator" to disable the processing of both vertex and edge properties simultaneously.
+/// @hideinitializer
 inline constexpr options_manip without_properties = clear_options(
     detail::option_bit::with_vertex_properties, detail::option_bit::with_connection_properties
 );
 
 /// @ingroup GL GL-IO
 /// @brief @ref gl::io::options_manip "Stream manipulator" to reset all custom graph formatting flags back to their default states.
+/// @hideinitializer
 inline constexpr options_manip default_options{0ul, ~static_cast<iword_type>(0)};
 
 } // namespace gl::io

include/gl/io/options_manip.hpp

@@ -28,7 +28,7 @@ using iword_type = long;
 using bit_position_type = unsigned;
 
 /// @ingroup GL GL-IO
-/// @brief Base bit representing the first position in an `iword` flag map.
+/// @brief Base bit representing the a single position in an `iword` flag map.
 inline constexpr iword_type iword_bit = 1ul;
 
 /// @ingroup GL GL-IO

include/gl/traits.hpp

@@ -14,8 +14,6 @@
 #include <ranges>
 #include <type_traits>
 
-/// @namespace gl::traits
-/// @brief Contains C++20 concepts and type traits used to constrain library templates.
 namespace gl::traits {
 
 /// @ingroup GL GL-Traits

mkdocs.yml

@@ -17,6 +17,7 @@ nav:
   # - HGL:
   - API Index:
       - Modules: cpp-gl/modules.md
+      - Namespaces: cpp-gl/namespaces.md
       - Classes & Structs: cpp-gl/annotated.md
       - Class Hierarchy: cpp-gl/hierarchy.md
       - Concepts: cpp-gl/concepts.md