Add index page for dev docs

mschoema · Feb 1, 2024 · 728adeb · 728adeb
1 parent bde4356
commit 728adeb
Show file tree

Hide file tree

Showing 4 changed files with 38 additions and 7 deletions.
diff --git a/.github/workflows/generate_dev_docs.yml b/.github/workflows/generate_dev_docs.yml
@@ -29,7 +29,7 @@ jobs:
       - name: Generate documentation
         uses: mattnotmitt/doxygen-action@v1.9.5
         with:
-          doxyfile-path: "doxygen/Doxyfile_test"
+          doxyfile-path: "doxygen/Doxyfile_gha"
 
       # store the documentation files
       - name: Upload output directory
@@ -82,5 +82,5 @@ jobs:
       - name: Commit changes
         uses: EndBug/add-and-commit@v9
         with:
-          message: 'Update docs'
+          message: 'Update dev docs'
           default_author: github_actions
diff --git a/doc/images/mobilitydb-logo-icon.png b/doc/images/mobilitydb-logo-icon.png
diff --git a/doxygen/Doxyfile_test → doxygen/Doxyfile_gha b/doxygen/Doxyfile_test → doxygen/Doxyfile_gha
@@ -1,5 +1,8 @@
 # Doxyfile 1.9.8
 
+# This Doxygen file is used by a GitHub Action
+# to generate the dev docs automatic
+
 # This file describes the settings to be used by the documentation system
 # doxygen (www.doxygen.org) for a project.
 #
@@ -85,7 +88,7 @@ CREATE_SUBDIRS         = NO
 # level increment doubles the number of directories, resulting in 4096
 # directories at level 8 which is the default and also the maximum value. The
 # sub-directories are organized in 2 levels, the first level always has a fixed
-# numer of 16 directories.
+# number of 16 directories.
 # Minimum value: 0, maximum value: 8, default value: 8.
 # This tag requires that the tag CREATE_SUBDIRS is set to YES.
 
@@ -272,7 +275,8 @@ TAB_SIZE               = 4
 # with the commands \{ and \} for these it is advised to use the version @{ and
 # @} or use a double escape (\\{ and \\})
 
-ALIASES                = "sqlfunc=@par SQL Function:^^" \
+ALIASES                = "csqlfunc=@par C-SQL Function:^^" \
+                         "sqlfunc=@par SQL Function:^^" \
                          "sqlop=@par SQL Operator:^^" \
                          "pymeosfunc=@par PyMEOS Function:^^"
 

diff --git a/meos/include/general/doxygen_meos.h b/meos/include/general/doxygen_meos.h
@@ -29,7 +29,34 @@
 
 /**
  * @file
- * @brief Sections for the documentation of the MEOS library
+ * @mainpage MEOS and MobilityDB Developer's Documentation
+ *
+ * \htmlonly
+ * <div class="row">
+ *   <div class="column">
+ *     <img src="meos-logo.png" alt="MEOS logo" width="10%"/>
+ *   </div>
+ *   <div class="column">
+ *     <img src="mobilitydb-logo.png" alt="MobilityDB logo" width="10%"/>
+ *   </div>
+ * </div>
+ * \endhtmlonly
+ *
+ * @image latex meos-logo.png width=10%
+ * @image latex mobilitydb-logo.png width=10%
+ *
+ * This document defines the developer's documentation of both the MEOS library
+ * and MobilityDB. The documentation is divided into modules, where the
+ * top-level modules are as follows:
+ *
+ * - MEOS library
+ *   - MEOS API
+ *   - Internal functions
+ * - MobilityDB API
+ *
+ * \tableofcontents
+ *
+ * Please refer to the Modules tab for a detailed account of these modules.
  */
 
 /*****************************************************************************
@@ -42,11 +69,11 @@
  * @defgroup meos MEOS library
  * @brief Mobility Engine Open Source (MEOS) library
  *
- * @defgroup meos_api API of the MEOS library
+ * @defgroup meos_api API
  * @ingroup meos
  * @brief API of the Mobility Engine Open Source (MEOS) library
  *
- * @defgroup meos_internal Internal API of the MEOS library
+ * @defgroup meos_internal Internal API
  * @ingroup meos
  * @brief Internal API of Mobility Engine Open Source (MEOS) library
  */