[PATCH] D46290: Remove \brief commands from doxygen comments.

Matthias Braun via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Mon Apr 30 15:47:03 PDT 2018


MatzeB added a comment.

BTW: I did not do this years ago, because the doxygen documentation claims that the brief comment stops at the first linebreak or the first dot. Hence I was preaching the rule that you still need `\brief` when the comment is more than 1 line. I now heard that apparently this is not how doxygen behaves (so documentation bug I guess).

I guess there may be some cases hiding here where you now shorten the brief comment because it stops after the first dot (or is that not true either) instead of the whole paragraph. Even if that is the case I prefer that over all the `\\brief` noise in the sourcecode.


https://reviews.llvm.org/D46290





More information about the llvm-commits mailing list