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

[Matt Davis via Phabricator via llvm-commits]

mattd added a comment.

In https://reviews.llvm.org/D45708#1070682, @MatzeB wrote:

> 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?


What I am seeing, is what I was expecting, the first line is up until the first dot, or to the first blank comment line.  The definition you reference seems incomplete; Mainly, the end of brief appears to be either either the first . in the comment or the first blank comment line.


Repository:
  rL LLVM

https://reviews.llvm.org/D45708