Generate MEOS documentation with doxygen

.github/workflows/meos_generate_dev_docs.yml

@@ -42,4 +42,6 @@ jobs:
         github_token: ${{ secrets.GITHUB_TOKEN }}
         # Default Doxyfile build documentation to html directory.
         # Change the directory if changes in Doxyfile
-        publish_dir: ./html
+        publish_dir: ./docs/html
+        # destination_dir: meos
+        publish_branch: gh-pages

doxygen/Doxyfile

@@ -1042,7 +1042,7 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH             =
+IMAGE_PATH             = @CMAKE_CURRENT_SOURCE_DIR@/../doc/images
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program

doxygen/Doxyfile_gha

@@ -1042,7 +1042,7 @@ EXAMPLE_RECURSIVE      = NO
 # that contain images that are to be included in the documentation (see the
 # \image command).
 
-IMAGE_PATH             =
+IMAGE_PATH             = ./doc/images/
 
 # The INPUT_FILTER tag can be used to specify a program that doxygen should
 # invoke to filter for each input file. Doxygen will invoke the filter program
@@ -1292,7 +1292,8 @@ HTML_EXTRA_STYLESHEET  =
 # files will be copied as-is; there are no commands or markers available.
 # This tag requires that the tag GENERATE_HTML is set to YES.
 
-HTML_EXTRA_FILES       =
+HTML_EXTRA_FILES       = ./doc/images/meos-logo.png \
+                         ./doc/images/mobilitydb-logo.png
 
 # The HTML_COLORSTYLE_HUE tag controls the color of the HTML output. Doxygen
 # will adjust the colors in the style sheet and background images according to

meos/include/general/doxygen_libmeos.h

@@ -28,7 +28,26 @@
  *****************************************************************************/
 
 /**
- * @brief Sections for the documentation of the MEOS library
+ * @mainpage MEOS and MobilityDB Developer's Documentation
+ *
+ * @image html meos-logo.png width=10%
+ * @image html mobilitydb-logo.png width=10%
+ *
+ * @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.
  */
 
 /*****************************************************************************
@@ -41,11 +60,11 @@
  * @defgroup libmeos MEOS library
  * @brief Mobility Engine Open Source (MEOS) library.
  *
- * @defgroup libmeos_api API of the MEOS library
+ * @defgroup libmeos_api MEOS API
  * @ingroup libmeos
  * @brief API of the Mobility Engine Open Source (MEOS) library.
  *
- * @defgroup libmeos_internal Internal functions of the MEOS library
+ * @defgroup libmeos_internal Internal functions
  * @ingroup libmeos
  * @brief Internal functions of Mobility Engine Open Source (MEOS) library.
  */