Update Doxygen

PhotonVision · Nov 21, 2024 · 41cab67 · 41cab67
1 parent c9bb4fd
commit 41cab67
Show file tree

Hide file tree

Showing 3 changed files with 1,507 additions and 494 deletions.
diff --git a/gradle.properties b/gradle.properties
@@ -6,3 +6,4 @@ org.gradle.jvmargs= \
   --add-exports jdk.compiler/com.sun.tools.javac.parser=ALL-UNNAMED \
   --add-exports jdk.compiler/com.sun.tools.javac.tree=ALL-UNNAMED \
   --add-exports jdk.compiler/com.sun.tools.javac.util=ALL-UNNAMED
+org.ysb33r.gradle.doxygen.download.url=https://frcmaven.wpi.edu/artifactory/generic-release-mirror/doxygen
diff --git a/photon-docs/build.gradle b/photon-docs/build.gradle
@@ -2,7 +2,7 @@
 
 plugins {
     id 'java'
-    id "org.ysb33r.doxygen" version "0.7.0"
+    id "org.ysb33r.doxygen" version "1.0.4"
 }
 
 
@@ -36,15 +36,16 @@ doxygen {
     String arch = System.getProperty("os.arch");
     if (arch.equals("x86_64") || arch.equals("amd64")) {
         executables {
-            doxygen version : '1.9.4',
-            baseURI : 'https://frcmaven.wpi.edu/artifactory/generic-release-mirror/doxygen'
+            doxygen {
+                executableByVersion('1.12.0')
+            }
         }
     }
 }
 
 doxygen {
-    generate_html true
-    html_extra_stylesheet 'theme.css'
+    option 'generate_html', true
+    option 'html_extra_stylesheet', 'theme.css'
 
     cppProjectZips.each {
         dependsOn it
@@ -53,126 +54,37 @@ doxygen {
             cppIncludeRoots.add(it.absolutePath)
         }
     }
-    cppIncludeRoots << '../ntcore/build/generated/main/native/include/'
-
-    if (project.hasProperty('docWarningsAsErrors')) {
-        // Eigen
-        exclude 'Eigen/**'
-        exclude 'unsupported/**'
-
-        // LLVM
-        exclude 'wpi/AlignOf.h'
-        exclude 'wpi/Casting.h'
-        exclude 'wpi/Chrono.h'
-        exclude 'wpi/Compiler.h'
-        exclude 'wpi/ConvertUTF.h'
-        exclude 'wpi/DenseMap.h'
-        exclude 'wpi/DenseMapInfo.h'
-        exclude 'wpi/Endian.h'
-        exclude 'wpi/EpochTracker.h'
-        exclude 'wpi/Errc.h'
-        exclude 'wpi/Errno.h'
-        exclude 'wpi/ErrorHandling.h'
-        exclude 'wpi/bit.h'
-        exclude 'wpi/fs.h'
-        exclude 'wpi/FunctionExtras.h'
-        exclude 'wpi/function_ref.h'
-        exclude 'wpi/Hashing.h'
-        exclude 'wpi/iterator.h'
-        exclude 'wpi/iterator_range.h'
-        exclude 'wpi/ManagedStatic.h'
-        exclude 'wpi/MapVector.h'
-        exclude 'wpi/MathExtras.h'
-        exclude 'wpi/MemAlloc.h'
-        exclude 'wpi/PointerIntPair.h'
-        exclude 'wpi/PointerLikeTypeTraits.h'
-        exclude 'wpi/PointerUnion.h'
-        exclude 'wpi/raw_os_ostream.h'
-        exclude 'wpi/raw_ostream.h'
-        exclude 'wpi/SmallPtrSet.h'
-        exclude 'wpi/SmallSet.h'
-        exclude 'wpi/SmallString.h'
-        exclude 'wpi/SmallVector.h'
-        exclude 'wpi/StringExtras.h'
-        exclude 'wpi/StringMap.h'
-        exclude 'wpi/SwapByteOrder.h'
-        exclude 'wpi/type_traits.h'
-        exclude 'wpi/VersionTuple.h'
-        exclude 'wpi/WindowsError.h'
-
-        // fmtlib
-        exclude 'fmt/**'
-
-        // libuv
-        exclude 'uv.h'
-        exclude 'uv/**'
-        exclude 'wpinet/uv/**'
-
-        // json
-        exclude 'wpi/adl_serializer.h'
-        exclude 'wpi/byte_container_with_subtype.h'
-        exclude 'wpi/detail/**'
-        exclude 'wpi/json.h'
-        exclude 'wpi/json_fwd.h'
-        exclude 'wpi/ordered_map.h'
-        exclude 'wpi/thirdparty/**'
-
-        // memory
-        exclude 'wpi/memory/**'
-
-        // mpack
-        exclude 'wpi/mpack.h'
-
-        // units
-        exclude 'units/**'
-    }
-
-    //TODO: building memory docs causes search to break
-    exclude 'wpi/memory/**'
-
-    exclude '*.pb.h'
-
-    // Save space by excluding protobuf and eigen
-    exclude 'Eigen/**'
-    exclude 'google/protobuf/**'
-
-    aliases 'effects=\\par <i>Effects:</i>^^',
-            'notes=\\par <i>Notes:</i>^^',
-            'requires=\\par <i>Requires:</i>^^',
-            'requiredbe=\\par <i>Required Behavior:</i>^^',
-            'concept{2}=<a href=\"md_doc_concepts.html#\1\">\2</a>',
-            'defaultbe=\\par <i>Default Behavior:</i>^^'
-    case_sense_names false
-    extension_mapping 'inc=C++', 'no_extension=C++'
-    extract_all true
-    extract_static true
-    file_patterns '*'
-    full_path_names true
-    generate_html true
-    generate_latex false
-    generate_treeview true
-    html_extra_stylesheet 'theme.css'
-    html_timestamp true
-    javadoc_autobrief true
-    project_name 'PhotonVision C++'
-    project_logo '../photon-client/src/assets/images/logoSmall.svg'
-    project_number pubVersion
-    quiet true
-    recursive true
-    strip_code_comments false
-    strip_from_inc_path cppIncludeRoots as String[]
-    strip_from_path cppIncludeRoots as String[]
-    use_mathjax true
-    warnings false
-    warn_if_incomplete_doc true
-    warn_if_undocumented false
-    warn_no_paramdoc true
+    option 'case_sense_names', false
+    option 'extension_mapping', 'inc=C++ no_extension=C++'
+    option 'extract_all', true
+    option 'extract_static', true
+    option 'file_patterns', '*'
+    option 'full_path_names', true
+    option 'generate_html', true
+    option 'generate_latex', false
+    option 'generate_treeview', true
+    option 'html_extra_stylesheet', 'theme.css'
+    option 'html_timestamp', true
+    option 'javadoc_autobrief', true
+    option 'project_name', 'PhotonVision C++'
+    option 'project_logo', '../docs/source/assets/RoundLogo.png'
+    option 'project_number', pubVersion
+    option 'quiet', true
+    option 'recursive', true
+    option 'strip_code_comments', false
+    option 'strip_from_inc_path', cppIncludeRoots
+    option 'strip_from_path', cppIncludeRoots
+    option 'use_mathjax', true
+    option 'warnings', false
+    option 'warn_if_incomplete_doc', true
+    option 'warn_if_undocumented', false
+    option 'warn_no_paramdoc', true
 
     //enable doxygen preprocessor expansion of WPI_DEPRECATED to fix MotorController docs
-    enable_preprocessing true
-    macro_expansion true
-    expand_only_predef true
-    predefined "WPI_DEPRECATED(x)=[[deprecated(x)]]\"\\\n" +
+    option 'enable_preprocessing', true
+    option 'macro_expansion', true
+    option 'expand_only_predef', true
+    option 'predefined', "WPI_DEPRECATED(x)=[[deprecated(x)]]\"\\\n" +
             "\"__cplusplus\"\\\n" +
             "\"HAL_ENUM(name)=enum name : int32_t"