Doxygen document generation

.github/workflows/doxy.yml

@@ -0,0 +1,26 @@
+name: Doxygen Action
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+
+    - name: Doxygen Action
+      uses: mattnotmitt/[email protected]
+      with:
+        doxyfile-path: "./Doxyfile" 
+        working-directory: "." 
+
+    - name: Deploy
+      uses: peaceiris/actions-gh-pages@v3
+      with:
+        github_token: ${{ secrets.GITHUB_TOKEN }}
+        publish_dir: ./documentation/html

Doxyfile

@@ -0,0 +1,57 @@
+# Doxyfile configuration file
+
+# Project name and version
+PROJECT_NAME           = "ApraPipes"
+PROJECT_NUMBER         = 1.0
+
+# The directory where the documentation will be created
+OUTPUT_DIRECTORY       = ./documentation
+
+# The root directory of the source code
+INPUT                  = ./base
+
+# File patterns to include in the documentation
+FILE_PATTERNS          = *.h *.hpp *.c *.cpp
+
+# Exclude directories and files
+EXCLUDE                = *
+
+# Recurse through subdirectories
+RECURSIVE              = YES
+
+# Generate documentation for all entities
+EXTRACT_ALL            = YES
+
+# Strip implementation details from documentation
+EXTRACT_PRIVATE        = YES
+EXTRACT_STATIC         = YES
+HIDE_UNDOC_MEMBERS     = YES
+HIDE_UNDOC_CLASSES     = YES
+
+# Configuration options for HTML output
+GENERATE_HTML          = YES
+HTML_OUTPUT            = html
+HTML_FILE_EXTENSION    = .html
+HTML_COLORSTYLE_HUE    = 220
+HTML_TIMESTAMP         = YES
+
+# Configuration options for LaTeX output
+GENERATE_LATEX         = YES
+
+# Configuration options for Man pages (UNIX specific)
+GENERATE_MAN           = NO
+
+LATEX_OUTPUT           = latex
+
+
+# Additional include paths
+INCLUDE_PATH           = 
+
+# Predefined macros
+PREDEFINED             = 
+
+# Enable collaboration diagram
+HAVE_DOT               = YES
+UML_LOOK               = YES
+CALL_GRAPH             = YES
+CALLER_GRAPH           = YES

build_documentation.sh

@@ -0,0 +1 @@
+doxygen Doxyfile

build_scripts/build_dependencies_jetson_cuda.sh

@@ -1,7 +1,7 @@
 #!/bin/bash
 
 # List of required dependencies
-dependencies=("git-lfs" "libncurses5-dev" "ninja-build" "nasm" "curl" "libudev-dev" "libssl-dev")
+dependencies=("git-lfs" "libncurses5-dev" "ninja-build" "nasm" "curl" "libudev-dev" "libssl-dev" "doxygen" "graphviz")
 
 missing_dependencies=()
 

build_scripts/build_dependencies_linux_cuda.sh

@@ -5,7 +5,7 @@ dependencies=( "curl" "zip" "unzip" "tar" "autoconf" "automake" "autopoint" "bui
               "flex" "git-core" "git-lfs" "libass-dev" "libfreetype6-dev" "libgnutls28-dev" "libmp3lame-dev" 
               "libsdl2-dev" "libssl-dev" "libtool" "libsoup-gnome2.4-dev" "libncurses5-dev" "libva-dev" "libvdpau-dev" 
               "libvorbis-dev" "libxcb1-dev" "libxdamage-dev" "libxcursor-dev" "libxinerama-dev" "libx11-dev" "libgles2-mesa-dev" "libxcb-shm0-dev" "libxcb-xfixes0-dev" 
-               "ninja-build" "pkg-config" "texinfo" "wget" "yasm" "zlib1g-dev" "nasm" "gperf" "bison" "python3" "python3-pip")
+               "ninja-build" "pkg-config" "texinfo" "wget" "yasm" "zlib1g-dev" "nasm" "gperf" "bison" "python3" "python3-pip" "doxygen" "graphviz")
 
 missing_dependencies=()
 

build_scripts/build_dependencies_linux_no_cuda.sh

@@ -5,7 +5,7 @@ dependencies=( "curl" "zip" "unzip" "tar" "autoconf" "automake" "autopoint" "bui
               "flex" "git-core" "git-lfs" "libass-dev" "libfreetype6-dev" "libgnutls28-dev" "libmp3lame-dev" 
               "libsdl2-dev" "libssl-dev" "libtool" "libsoup-gnome2.4-dev" "libncurses5-dev" "libva-dev" "libvdpau-dev" 
               "libvorbis-dev" "libxcb1-dev" "libxdamage-dev" "libxcursor-dev" "libxinerama-dev" "libx11-dev" "libgles2-mesa-dev" "libxcb-shm0-dev" "libxcb-xfixes0-dev" 
-               "ninja-build" "pkg-config" "texinfo" "wget" "yasm" "zlib1g-dev" "nasm" "gperf" "bison" "python3" "python3-pip")
+               "ninja-build" "pkg-config" "texinfo" "wget" "yasm" "zlib1g-dev" "nasm" "gperf" "bison" "python3" "python3-pip" "doxygen" "graphviz")
 
 missing_dependencies=()
 

build_scripts/build_dependencies_windows_cuda.ps1

@@ -5,7 +5,7 @@ iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/in
 
 # Enable feature and install dependencies
 choco feature enable -n allowEmptyChecksums
-choco install 7zip git python3 cmake pkgconfiglite -y
+choco install 7zip git python3 cmake pkgconfiglite doxygen.portable graphviz -y
 
 # Install required Python packages
 pip3 install ninja

build_scripts/build_dependencies_windows_no_cuda.ps1

@@ -5,7 +5,7 @@ iex ((New-Object System.Net.WebClient).DownloadString('https://chocolatey.org/in
 
 # Enable feature and install dependencies
 choco feature enable -n allowEmptyChecksums
-choco install 7zip git python3 cmake pkgconfiglite -y
+choco install 7zip git python3 cmake pkgconfiglite doxygen.portable graphviz -y
 
 # Install required Python packages
 pip3 install ninja