Comment files to pass doxygen completeness check.

bigladder · Oct 27, 2023 · fcce572 · fcce572
1 parent 91d6c12
commit fcce572
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 4 deletions.
diff --git a/.github/workflows/doxygen-completeness-check.yml b/.github/workflows/doxygen-completeness-check.yml
@@ -9,5 +9,5 @@ jobs:
     - name: Run doxygen for C++ programs.
       uses: mattnotmitt/doxygen-action@v1.9.5
       with:
-          working-directory: 'src'
+          working-directory: '.'
           doxyfile-path: 'doxygen.cfg'
diff --git a/src/doxygen.cfg → doxygen.cfg b/src/doxygen.cfg → doxygen.cfg
@@ -68,7 +68,7 @@ PROJECT_LOGO           =
 # entered, it will be relative to the location where doxygen was started. If
 # left blank the current directory will be used.
 
-OUTPUT_DIRECTORY       =
+OUTPUT_DIRECTORY       = build
 
 # If the CREATE_SUBDIRS tag is set to YES then doxygen will create up to 4096
 # sub-directories (in 2 levels) under the output directory of each output format
@@ -943,7 +943,7 @@ WARN_LOGFILE           =
 # spaces. See also FILE_PATTERNS and EXTENSION_MAPPING
 # Note: If this tag is empty the current directory is searched.
 
-INPUT                  =
+INPUT                  = include/atheneum
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding. Doxygen uses
@@ -1917,7 +1917,7 @@ EXTRA_SEARCH_MAPPINGS  =
 # If the GENERATE_LATEX tag is set to YES, doxygen will generate LaTeX output.
 # The default value is: YES.
 
-GENERATE_LATEX         = YES
+GENERATE_LATEX         = NO
 
 # The LATEX_OUTPUT tag is used to specify where the LaTeX docs will be put. If a
 # relative path is entered the value of OUTPUT_DIRECTORY will be put in front of

diff --git a/include/atheneum/atheneum.h b/include/atheneum/atheneum.h
@@ -12,11 +12,20 @@ namespace Atheneum
 
 class AtheneumPrivate;
 
+/// @class Atheneum::Atheneum atheneum.h
+/// @brief Public interface file for for the Atheneum Pimpl idiom
+
 class Atheneum
 {
   public:
     Atheneum();
+
     ~Atheneum();
+
+    // --------------------------------------------------------------------------------------------
+    /// @brief	Call this function for the answer
+    /// @return	The answer to life, the universe, and everything
+    // --------------------------------------------------------------------------------------------
     int answer();
 
   private: