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.

0 files changed, 0 insertions, 0 deletions