Page MenuHomePhabricator

Remove \brief commands from doxygen comments.
ClosedPublic

Authored by aprantl on May 1 2018, 9:21 AM.

Details

Summary

Note that I did the same thing for LLVM this morning (https://reviews.llvm.org/D46290).

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

for i in $(git grep -l '\@brief'); do perl -pi -e 's/\@brief //g' $i & done
for i in $(git grep -l '\\brief'); do perl -pi -e 's/\\brief //g' $i & done

Diff Detail

Repository
rL LLVM

Event Timeline

aprantl created this revision.May 1 2018, 9:21 AM
aprantl added a reviewer: rnk.May 1 2018, 9:22 AM
rnk accepted this revision.May 8 2018, 11:00 AM

lgtm! (Back from a week long vacation)

This revision is now accepted and ready to land.May 8 2018, 11:00 AM
Closed by commit rC331834: Remove \brief commands from doxygen comments. (authored by adrian, committed by ). · Explain WhyMay 8 2018, 6:06 PM
Closed by commit rL331834: Remove \brief commands from doxygen comments. (authored by adrian, committed by ). · Explain Why
This revision was automatically updated to reflect the committed changes.
This revision was automatically updated to reflect the committed changes.