[PATCH] D45708: [NFC] Remove doxygen brief tag from BasicBlock.h

Matthias Braun via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Wed Apr 18 01:40:00 PDT 2018


MatzeB added a comment.

In https://reviews.llvm.org/D45708#1070667, @mattd wrote:

> I diffed the two outputs and also pulled up the text in a browser.  I do not see any significant changes in browser, and there wasn't.  However, I am happy to revert if any noticeable changes are witnessed.  I see multiline/paragraph text in the output.


Does that mean the doxygen documentation is just wrong?

https://www.stack.nl/~dimitri/doxygen/manual/config.html#cfg_javadoc_autobrief claims:

> 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.)

or does doxygen have a different notion of a what “first line” means?


Repository:
  rL LLVM

https://reviews.llvm.org/D45708





More information about the llvm-commits mailing list