From 79250ec7d57115dce8f0c156bac1901460b1fb64 Mon Sep 17 00:00:00 2001 From: Paul Mucur Date: Tue, 28 Nov 2023 11:32:29 +0000 Subject: [PATCH 1/2] Restore extraction of brief descriptions As of Doxygen 1.8.19 (specifically, https://github.com/doxygen/doxygen/commit/327423e217337bf4e64515aba6cf78b9877bc165), the first line of a comment is no longer automatically extracted as a brief description unless we enable the JAVADOC_AUTOBRIEF setting. See https://www.doxygen.nl/manual/config.html#cfg_javadoc_autobrief: > If the `JAVADOC_AUTOBRIEF` tag is set to `YES` then doxygen will > interpret the first line (until the first dot) of a Javadoc-style > comment as the brief description. If set to `NO`, the Javadoc-style > will behave just like regular Qt-style comments (thus requiring an > explicit @brief command for a brief description.) Fixes #1563. --- docs/Doxyfile.in | 3 +++ 1 file changed, 3 insertions(+) diff --git a/docs/Doxyfile.in b/docs/Doxyfile.in index 5dc4be72f..d4606adc7 100644 --- a/docs/Doxyfile.in +++ b/docs/Doxyfile.in @@ -52,6 +52,9 @@ EXTRACT_ALL = NO ALWAYS_DETAILED_SEC = NO #REPEAT_BRIEF = NO +# Needed to automatically extract implicit brief descriptions in recent versions of Doxygen +JAVADOC_AUTOBRIEF = YES + # Need these next options to ensure that functions with modifiers do not confuse the Doxygen parser. # And any further function modifiers here. MACRO_EXPANSION = YES From f0978db449f903ebe86d077685a2fa7467a1aa54 Mon Sep 17 00:00:00 2001 From: Paul Mucur Date: Tue, 28 Nov 2023 11:35:58 +0000 Subject: [PATCH 2/2] Restore "API Documentation" in the main menu Between Doxygen 1.8.17 and Doxygen 1.9.8, the top-level "modules" tab type in the Doxygen layout has changed such that our "API Documentation" section is no longer generated and is instead considered of the type "topics". Update our layout XML to reflect this change and restore this critical section of the documentation. Fixes #1563. --- docs/DoxygenLayout.xml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/DoxygenLayout.xml b/docs/DoxygenLayout.xml index 07c1c980c..ce397c909 100644 --- a/docs/DoxygenLayout.xml +++ b/docs/DoxygenLayout.xml @@ -3,7 +3,8 @@ - + +