doc groups + wip: public only

Author: SpectraL519

.gitmodules

@@ -588,7 +588,7 @@ RESOLVE_UNNAMED_PARAMS = YES
 # section is generated. This option has no effect if EXTRACT_ALL is enabled.
 # The default value is: NO.
 
-HIDE_UNDOC_MEMBERS     = NO
+HIDE_UNDOC_MEMBERS     = YES
 
 # If the HIDE_UNDOC_CLASSES tag is set to YES, doxygen will hide all
 # undocumented classes that are normally visible in the class hierarchy. If set
@@ -597,7 +597,7 @@ HIDE_UNDOC_MEMBERS     = NO
 # if EXTRACT_ALL is enabled.
 # The default value is: NO.
 
-HIDE_UNDOC_CLASSES     = NO
+HIDE_UNDOC_CLASSES     = YES
 
 # If the HIDE_FRIEND_COMPOUNDS tag is set to YES, doxygen will hide all friend
 # declarations. If set to NO, these declarations will be included in the

Doxyfile

@@ -0,0 +1,13 @@
+/// @defgroup gl Graph Library (GL)
+/// @brief Core graph models, structures, and utilities.
+///
+/// @defgroup hgl Hypergraph Library (HGL)
+/// @brief Core hypergraph models, structures, and utilities.
+///
+/// @defgroup gl_alg GL Algorithms
+/// @ingroup gl
+/// @brief Algorithms for standard graphs.
+///
+/// @defgroup hgl_alg HGL Algorithms
+/// @ingroup hgl
+/// @brief Algorithms for hypergraphs.

docs/groups.dox

@@ -12,6 +12,7 @@
 
 namespace gl::algorithm {
 
+/// @ingroup gl_alg
 template <
     traits::c_graph G,
     traits::c_forward_range_of<search_node<G>> InitQueueRangeType = std::vector<search_node<G>>,

include/gl/algorithm/templates/bfs.hpp

@@ -48,8 +48,10 @@ using swap_impl_tag_t = typename swap_impl_tag<GT, NewImplTag>::type;
 
 } // namespace traits
 
+/// @internal
 namespace detail {
 
+/// @internal
 template <traits::c_graph_impl_tag TargetImplTag, traits::c_graph_impl_tag SourceImplTag>
 struct to_impl {
     template <typename TargetGraph, typename SourceGraph>

include/gl/conversion.hpp

@@ -62,12 +62,14 @@ template <traits::c_graph_impl_tag TargetImplTag, traits::c_graph Graph>
 
 namespace detail {
 
+/// @internal
 template <traits::c_graph_impl_tag TargetImplTag, traits::c_graph_impl_tag SourceImplTag>
 struct to_impl;
 
 } // namespace detail
 
 /// @brief A general-purpose graph container.
+/// @ingroup gl
 ///
 /// This class represents a highly customizable graph data structure configured by the provided
 /// `GraphTraits`. It serves as the primary interface for managing vertices, edges, and their properties.

include/gl/graph.hpp

@@ -10,6 +10,7 @@
 
 namespace hgl::algorithm {
 
+/// @ingroup hgl_alg
 template <
     traversal_direction Dir = traversal_direction::forward,
     traits::c_hypergraph H,

include/hgl/algorithm/templates/bfs.hpp

@@ -75,6 +75,7 @@ struct to_impl;
 
 } // namespace detail
 
+/// @ingroup hgl
 template <traits::c_instantiation_of<hypergraph_traits> HypergraphTraits>
 class hypergraph final {
 public:

include/hgl/hypergraph.hpp

@@ -4,10 +4,16 @@ repo_url: "https://github.com/SpectraL519/cpp-gl"
 
 nav:
   - Home: index.md
-  - CPP-GL API:
-    - Namespaces: cpp-gl/namespaces.md
-    - Classes & Structs: cpp-gl/annotated.md
-    - Files: cpp-gl/files.md
+  - GL:
+      - Overview: cpp-gl/group__gl.md
+      - Algorithms: cpp-gl/group__gl__alg.md
+  - HGL:
+      - Overview: cpp-gl/group__hgl.md
+      - Algorithms: cpp-gl/group__hgl__alg.md
+  - Full API Index:
+      - Namespaces: cpp-gl/namespaces.md
+      - Classes & Structs: cpp-gl/annotated.md
+      - Files: cpp-gl/files.md
 
 theme:
   name: material
@@ -63,10 +69,14 @@ plugins:
   - mkdoxy:
       projects:
         cpp-gl:
-          src-dirs: include
+          src-dirs: "include docs/groups.dox"
           full-doc: True
           doxy-cfg:
             PROJECT_NAME: "CPP-GL"
+            EXTRACT_ALL: False
+            HIDE_UNDOC_MEMBERS: True
+            HIDE_UNDOC_CLASSES: True
+            EXTRACT_STATIC: False
 
 extra_javascript:
   - scripts/mathjax.js