[cfe-commits] r158636 - /cfe/trunk/include/clang/Lex/HeaderSearch.h

[James Dennett]

On Sun, Jun 17, 2012 at 11:57 AM, Matt Beaumont-Gay
<matthewbg at google.com> wrote:
> On Sun, Jun 17, 2012 at 12:39 AM, James Dennett <jdennett at google.com> wrote:
>>   /// DirInfo - Keep track of whether this is a system header, and if so,
>
> This could be \brief too, yes? (Or at least take out the redundant
> variable name.)

Yes.  I'll come back to this one (and others) on a subsequent pass, if
nobody gets to it before me.

There are many (thousands?) of these, and my first pass through the
code is to eliminate the Doxygen warnings so that subsequent edits can
keep things clean. There may well be a temporary increase in local
inconsistency, though there's already a fair mixture of \brief and
other styles so overall this will tend to increase uniformity.
(Actually I might not eliminate all warnings on this first pass;
warnings about missing \param documentation are not so mechanical,
though the cases where it's harder to document functions are
correlated with the places where clearer interfaces are most needed.)

-- James