summaryrefslogtreecommitdiffstats
path: root/examples/group.cpp
diff options
context:
space:
mode:
authorChristopher Friedt <chrisfriedt@gmail.com>2019-05-03 01:16:17 (GMT)
committerChristopher Friedt <chrisfriedt@gmail.com>2019-05-03 01:16:17 (GMT)
commit5d7fa9a584c72363195a08033585f7aa2f63cde8 (patch)
treea09ac4faae01e3d81862598b0012fe52bb0fbb81 /examples/group.cpp
parentac76b9a7a70b3c828c76442f5977937fcb87811a (diff)
downloadDoxygen-5d7fa9a584c72363195a08033585f7aa2f63cde8.zip
Doxygen-5d7fa9a584c72363195a08033585f7aa2f63cde8.tar.gz
Doxygen-5d7fa9a584c72363195a08033585f7aa2f63cde8.tar.bz2
Allow Javadoc-style comment blocks with a Doxyfile variable
Javadoc allows comments like this (which I refer to as "banner" comments) /***************** * *****************/ but doxygen does not recognize them. Instead, the doxygen manual says to do this /*************//** * ****************/ which some users aren't even aware is required. It also behaves poorly with clang-format. I'm proposing to add a Doxyfile boolean option JAVADOC_BANNER which will default to NO. When set to YES, it will consider the first and second comments above to be equivalent. However, I don't believe that the JAVADOC_BANNER option should default to YES, as there are likely a number of projects who have used the former syntax with full expectation that it would *not* appear in their documentation. At least having the JAVADOC_BANNER default to NO allows users to opt-in voluntarily by adding JAVADOC_BANNER = YES to their Doxyfile. If the consensus is to make it a default at a later time, first a warning can be added during build that should trigger users to modify their comment style, and then eventually the default could be set to JAVADOC_BANNER = YES, or the config option could be removed entirely and it would just always be enabled.
Diffstat (limited to 'examples/group.cpp')
0 files changed, 0 insertions, 0 deletions