From: Vladimír Vondruš <mosra@centrum.cz>
Date: Mon, 10 Jan 2022 12:04:07 +0000 (+0100)
Subject: documentation/doxygen: add a clarifying note to the test Doxyfile.
X-Git-Url: https://www.chiark.greenend.org.uk/ucgi/~cjwatson/git?a=commitdiff_plain;h=d970994e87b08c7981baef80198eef3833f957f7;p=blog.git

documentation/doxygen: add a clarifying note to the test Doxyfile.
---

diff --git a/documentation/test_doxygen/contents_autobrief_cpp_comments/Doxyfile b/documentation/test_doxygen/contents_autobrief_cpp_comments/Doxyfile
index 7e9ad922..bf3f5a30 100644
--- a/documentation/test_doxygen/contents_autobrief_cpp_comments/Doxyfile
+++ b/documentation/test_doxygen/contents_autobrief_cpp_comments/Doxyfile
@@ -12,3 +12,6 @@ CASE_SENSE_NAMES        = YES
 ##! M_LINKS_NAVBAR1     =
 ##! M_LINKS_NAVBAR2     =
 ##! M_SEARCH_DISABLED   = YES
+
+# In this case neither JAVADOC_AUTOBRIEF nor QT_AUTOBRIEF needs to be set to
+# recognize the first line of /// comments as brief