This is an archive of the discontinued LLVM Phabricator instance.

Modernize doxygen comments in Support/Dwarf.h
ClosedPublic

Authored by friss on Oct 22 2014, 12:00 PM.

Details

Summary

In post-review of r219442, Rafael pointed out that the comment style of the
newly introduced helper didn't follow LLVM's coding standard. I wanted to
mordernize the whole file, but it seemed too silly to document each of these
simple self-describing functions with the same sentence except for 1 word.
I'm wondering if it's OK to use doxygen's group feature like in the attached
patch, or if repeating "\brief Returns the string for the xxxx parameter of
nullptr if not found." is prefered.

Diff Detail

Repository
rL LLVM

Event Timeline

friss updated this revision to Diff 15268.Oct 22 2014, 12:00 PM
friss retitled this revision from to Modernize doxygen comments in Support/Dwarf.h.
friss added reviewers: rafael, dblaikie, echristo.
friss updated this object.
friss added a subscriber: Unknown Object (MLST).
echristo accepted this revision.Oct 22 2014, 12:06 PM
echristo edited edge metadata.

LGTM. If someone desperately cares what part of doxygen we use or don't use they'll pipe up :)

-eric

This revision is now accepted and ready to land.Oct 22 2014, 12:06 PM
rafael accepted this revision.Oct 22 2014, 12:08 PM
rafael edited edge metadata.

Much better, thanks.

friss closed this revision.Oct 22 2014, 9:19 PM
friss updated this revision to Diff 15297.

Closed by commit rL220467 (authored by @friss).