<div dir="ltr">If they handle our existing explicit-`\brief` comments correctly I don't see why not. You might want to add a blurb to <a href="http://llvm.org/docs/CodingStandards.html#doxygen-use-in-documentation-comments">http://llvm.org/docs/CodingStandards.html#doxygen-use-in-documentation-comments</a> which currently suggests the explicit-`\brief`; you probably want to gather a bit more community consensus for updating the coding standard though.<div><br></div><div>-- Sean Silva<br><div><br></div></div></div><div class="gmail_extra"><br><div class="gmail_quote">On Fri, May 1, 2015 at 4:28 PM, Matthias Braun <span dir="ltr"><<a href="mailto:matze@braunis.de" target="_blank">matze@braunis.de</a>></span> wrote:<br><blockquote class="gmail_quote" style="margin:0 0 0 .8ex;border-left:1px #ccc solid;padding-left:1ex">We just had some discussion in the IRC channel and wondered whether it would be a good idea to enable one of the doxygen autobrief options for llvm:<br>
<br>
JAVADOC_AUTOBRIEF<br>
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.)<br>
<br>
The default value is: NO.<br>
<br>
QT_AUTOBRIEF<br>
If the QT_AUTOBRIEF tag is set to YES then doxygen will interpret the first line (until the first dot) of a Qt-style comment as the brief description. If set to NO, the Qt-style will behave just like regular Qt-style comments (thus requiring an explicit \brief command for a brief description.)<br>
<br>
The default value is: NO.<br>
<br>
<br>
Seeing that the \brief commands are often missing and visually noisy (IMO) this may improve our documentation and save us some typing in the future.<br>
<br>
- Matthias<br>
_______________________________________________<br>
LLVM Developers mailing list<br>
<a href="mailto:LLVMdev@cs.uiuc.edu">LLVMdev@cs.uiuc.edu</a>         <a href="http://llvm.cs.uiuc.edu" target="_blank">http://llvm.cs.uiuc.edu</a><br>
<a href="http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev" target="_blank">http://lists.cs.uiuc.edu/mailman/listinfo/llvmdev</a><br>
</blockquote></div><br></div>