On Tue, Aug 25, 2015 at 7:14 PM, Christoph Lipka <christ...@lipka-koeln.de> wrote: > Am 25.08.2015 um 18:36 schrieb Bostjan Mihoric: > [...] > > /// @file > > /// My typedef. > typedef void VOID; > > /// My simple function. Details. > extern VOID Function(VOID); > > Note that I have enabled OPTIMIZE_OUTPUT_FOR_C, JAVADOC_AUTOBRIEF and > enabled all warnings. > > The first thing is that Doxygen will generate doc for this function, > but emit no warnings and also not create a link with details (whole > line is read as brief). The problem goes away when there are at least > two lines beginning with ///. I noticed documentation states that I > need to make at least two lines in case of single-line comments. My > question is: why? Is there a special reason for it? > > > Yes, there is. From the docs (emphasis mine): > > "For the BRIEF description there are also several possibilities: > [...] > 3. A third option is to use a special C++ style comment which DOES NOT span > more than one line. [...]" > > In other words, single-line C++ style comments are reserved for autobrief > comments that do _not_ stop at the first dot-whitespace sequence as > Javadoc-autobrief comments do. > > (My personal preference would be for the entire first _paragraph_ to always > be considered a brief description, but alas, that's not supported.) >
Agreed, at least when JAVADOC_AUTOBRIEF is specifically enabled it should work like that. But what I still don't understand, why does Doxygen then not emit warnings? Surely, having just a brief description does not also mean "and ignore parameters and return type"? And why does the VOID redefine not work? Thanks! ------------------------------------------------------------------------------ _______________________________________________ Doxygen-users mailing list Doxygen-users@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/doxygen-users
