Skip to content

Commit

Permalink
Restore extraction of brief descriptions
Browse files Browse the repository at this point in the history
As of Doxygen 1.8.19 (specifically,
doxygen/doxygen@327423e),
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.
  • Loading branch information
mudge committed Nov 28, 2023
1 parent 263a668 commit 79250ec
Showing 1 changed file with 3 additions and 0 deletions.
3 changes: 3 additions & 0 deletions docs/Doxyfile.in
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 79250ec

Please sign in to comment.