diff mbox

[v3] doxygen markup fixes

Message ID CAH6eHdQPpYCY=mXbPqwKTLbjCgbvWw6=b5r0r7YMN8wR6yJ8hw@mail.gmail.com
State New
Headers show

Commit Message

Jonathan Wakely Aug. 7, 2011, 12:25 p.m. UTC 
On 7 August 2011 12:53, Jonathan Wakely <jwakely.gcc@gmail.com> wrote:
> On 7 August 2011 08:30, Benjamin Kosnik <bkoz@redhat.com> wrote:
>>
>> This fixes markup that gives warnings or errors as part of html/pdf
>> documentation generation. Most of this stuff is pretty simple, and is
>> just making sure that the documented parameter names exactly match the
>> signatures.
>>
>> tested x86/linux
>>
>> -benjamin
>
> +/** @file bits/alloc_traits.h
> + *  This is an internal header file, included by other library headers.
> + *  Do not attempt to use it directly. @headername{scoped_allocator}
> + */
> +
>
> The correct header for allocator_traits is <memory>
>

Fixed like so.

2011-08-07  Jonathan Wakely  <jwakely.gcc@gmail.com>

        * include/bits/alloc_traits.h: Fix doxygen @headername.

Comments

Benjamin Kosnik Aug. 8, 2011, 6:09 p.m. UTC | #1 
> > +/** @file bits/alloc_traits.h
> > + *  This is an internal header file, included by other library
> > headers.
> > + *  Do not attempt to use it directly.
> > @headername{scoped_allocator}
> > + */
> > +
> >
> > The correct header for allocator_traits is <memory>

Ack. Thanks for the review. Kind of mind-numbing, these changes. 

-benjamin
Jonathan Wakely Aug. 8, 2011, 6:13 p.m. UTC | #2 
On 8 August 2011 19:09, Benjamin Kosnik wrote:
>
>> > +/** @file bits/alloc_traits.h
>> > + *  This is an internal header file, included by other library
>> > headers.
>> > + *  Do not attempt to use it directly.
>> > @headername{scoped_allocator}
>> > + */
>> > +
>> >
>> > The correct header for allocator_traits is <memory>
>
> Ack. Thanks for the review. Kind of mind-numbing, these changes.

Yeah, I can imagine, well done for slogging through them all!
diff mbox

Patch

Index: include/bits/alloc_traits.h
===================================================================
--- include/bits/alloc_traits.h (revision 177545)
+++ include/bits/alloc_traits.h (working copy)
@@ -24,7 +24,7 @@ 

 /** @file bits/alloc_traits.h
  *  This is an internal header file, included by other library headers.
- *  Do not attempt to use it directly. @headername{scoped_allocator}
+ *  Do not attempt to use it directly. @headername{memory}
  */

 #ifndef _ALLOC_TRAITS_H