Merge pull request #3 from stlab/sean-parent/fixes

Doc preset target fixed to workaround vscode bug.
Doxygen warnings are now be reported to the CMake/build output
Patched a doxygen-awesome-css issue for template formatting.
Enabled the DISTRIBUTE_GROUP_DOC feature of Doxygen to simplify documenting related functions.

Author: sean-parent

cmake/cpp-library-docs.cmake

@@ -57,13 +57,24 @@ function(_cpp_library_setup_docs)
         configure_file(${DOXYFILE_IN} ${DOXYFILE_OUT} @ONLY)
     endif()
 
-    # Add custom target for documentation
-    add_custom_target(docs
-        COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT}
-        WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
-        COMMENT "Generating API documentation with Doxygen"
-        VERBATIM
-    )
+    # Add custom target for documentation with proper stderr capture
+    if(WIN32)
+        # On Windows, use PowerShell to redirect stderr to stdout
+        add_custom_target(docs
+            COMMAND PowerShell -Command "& { ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT} 2>&1 }"
+            WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+            COMMENT "Generating API documentation with Doxygen"
+            VERBATIM
+        )
+    else()
+        # On Unix-like systems, use shell redirection
+        add_custom_target(docs
+            COMMAND ${DOXYGEN_EXECUTABLE} ${DOXYFILE_OUT} 2>&1
+            WORKING_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}
+            COMMENT "Generating API documentation with Doxygen"
+            VERBATIM
+        )
+    endif()
 
     # Ensure the output directory exists
     file(MAKE_DIRECTORY ${OUTPUT_DIR})

templates/CMakePresets.json

@@ -73,7 +73,7 @@
   "buildPresets": [
     { "name": "default", "displayName": "Default Build", "configurePreset": "default" },
     { "name": "test", "displayName": "Build Tests", "configurePreset": "test" },
-    { "name": "docs", "displayName": "Build Docs", "configurePreset": "docs", "targets": ["docs"] },
+    { "name": "docs", "displayName": "Build Docs", "configurePreset": "docs", "targets": "docs" },
     { "name": "clang-tidy", "displayName": "Build with Clang-Tidy", "configurePreset": "clang-tidy" },
     { "name": "init", "displayName": "Initialize Templates", "configurePreset": "init" }
   ],

templates/Doxyfile.in

@@ -1,22 +1,24 @@
 # Auto-generated from cpp-library (https://github.com/stlab/cpp-library)
 # Do not edit this file directly - it will be overwritten when templates are regenerated
 
-PROJECT_NAME           = "@PROJECT_NAME@"
-PROJECT_BRIEF          = "@PROJECT_BRIEF@"
-PROJECT_NUMBER         = @PROJECT_VERSION@
-OUTPUT_DIRECTORY       = @OUTPUT_DIR@
-GENERATE_LATEX         = NO
-QUIET                  = YES
-WARN_IF_UNDOCUMENTED   = YES
-INPUT                  = @INPUT_DIR@
-RECURSIVE              = YES
-EXCLUDE_SYMBOLS        = @EXCLUDE_SYMBOLS@
-EXAMPLE_PATH           = @EXAMPLES_PATH@
-HIDE_UNDOC_NAMESPACES  = NO
-HTML_EXTRA_STYLESHEET  = @AWESOME_CSS_PATH@/doxygen-awesome.css \
-                         @AWESOME_CSS_PATH@/doxygen-awesome-sidebar-only.css
-HTML_COLORSTYLE        = LIGHT
-GENERATE_TREEVIEW      = YES
-DISABLE_INDEX          = NO
-FULL_SIDEBAR           = NO
+PROJECT_NAME            = "@PROJECT_NAME@"
+PROJECT_BRIEF           = "@PROJECT_BRIEF@"
+PROJECT_NUMBER          = @PROJECT_VERSION@
+OUTPUT_DIRECTORY        = @OUTPUT_DIR@
+GENERATE_LATEX          = NO
+QUIET                   = YES
+WARN_IF_UNDOCUMENTED    = YES
+INPUT                   = @INPUT_DIR@
+RECURSIVE               = YES
+EXCLUDE_SYMBOLS         = @EXCLUDE_SYMBOLS@
+EXAMPLE_PATH            = @EXAMPLES_PATH@
+HIDE_UNDOC_NAMESPACES   = NO
+HTML_EXTRA_STYLESHEET   = @AWESOME_CSS_PATH@/doxygen-awesome.css \
+                          @AWESOME_CSS_PATH@/doxygen-awesome-sidebar-only.css \
+                          @CPP_LIBRARY_ROOT@/templates/custom.css
+HTML_COLORSTYLE         = LIGHT
+GENERATE_TREEVIEW       = YES
+DISABLE_INDEX           = NO
+FULL_SIDEBAR            = NO
 # USE_MDFILE_AS_MAINPAGE = README.md
+DISTRIBUTE_GROUP_DOC    = YES

templates/custom.css

@@ -0,0 +1,20 @@
+/*
+    Fix for [email protected]
+
+    https://github.com/jothepro/doxygen-awesome-css/issues/186
+
+*/
+
+table.memberdecls .memItemLeft,
+table.memberdecls .memItemRight,
+table.memberdecls .memTemplItemLeft,
+table.memberdecls .memTemplItemRight,
+table.memberdecls .memTemplParams {
+    padding-top: unset;
+    border-top: unset;
+}
+
+table.memberdecls .memTemplParams {
+    border-bottom: 0;
+    padding-bottom: 0;
+}