Page MenuHomePhabricator

Remove \brief commands from doxygen comments.
ClosedPublic

Authored by aprantl on Apr 30 2018, 2:27 PM.

Details

Summary

We've been running doxygen with the autobrief option for a couple of years now. This makes the \brief markers into our comments redundant. Since they are a visual distraction and we don't want to encourage more \brief markers in new code either, this patch removes them all.

Patch produced by

find . -name '*.cpp' -exec perl -pi -e 's/\\brief //g' \{} \;
find . -name '*.h' -exec perl -pi -e 's/\\brief //g' \{} \;

Diff Detail

Repository
rL LLVM

Event Timeline

aprantl created this revision.Apr 30 2018, 2:27 PM

Let's hope nobody asks for a full context diff :-)

sanjoy accepted this revision.Apr 30 2018, 2:34 PM

lgtm

This revision is now accepted and ready to land.Apr 30 2018, 2:34 PM

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.

Closed by commit rL331272: Remove \brief commands from doxygen comments. (authored by adrian, committed by ). · Explain WhyMay 1 2018, 9:02 AM
This revision was automatically updated to reflect the committed changes.