Patchwork Fix incorrect libstdc++ @headername macro invocation.

login
register
mail settings
Submitter Ollie Wild
Date Nov. 27, 2012, 8:51 p.m.
Message ID <CAFOgFcRO23bL=jAT=2vsVurbHtpmYraUvCS1hG_oKtyNKGcWNg@mail.gmail.com>
Download mbox | patch
Permalink /patch/202301/
State New
Headers show

Comments

Ollie Wild - Nov. 27, 2012, 8:51 p.m.
This patch fixes an incorrect invocation of the @headername Doxygen
macro.  Namely, multiple values must be separated by commas, not "or".
 The effect can be observed at
http://gcc.gnu.org/onlinedocs/gcc-4.7.2/libstdc++/api/a01484.html:

"This is an internal header file, included by other library headers.
Do not attempt to use it directly. Instead, include <map or=""
set>="">."

Submitting as trivial, and will backport to google/gcc-4_7.

Google ref b/7621728.

Ollie


2012-11-27  Ollie Wild  <aaw@google.com>

        * include/bits/stl_tree.h (@headername): Fix incorrect Doxygen macro
        invocation.
commit 952030841d65ce1d6153f5b682944b2215edc306
Author: Ollie Wild <aaw@google.com>
Date:   Tue Nov 27 14:37:05 2012 -0600

    Fix incorrect @headername Doxygen macro invocation.
    
    Format is @headername{hdr1,hdr2} not @headername{hdr1 or hdr2}.
    
    2012-11-27  Ollie Wild  <aaw@google.com>
    
    	* include/bits/stl_tree.h (@headername): Fix incorrect Doxygen macro
    	invocation.

Patch

diff --git a/libstdc++-v3/ChangeLog b/libstdc++-v3/ChangeLog
index c6d0687..9d22b9d 100644
--- a/libstdc++-v3/ChangeLog
+++ b/libstdc++-v3/ChangeLog
@@ -1,3 +1,8 @@ 
+2012-11-27  Ollie Wild  <aaw@google.com>
+
+	* include/bits/stl_tree.h (@headername): Fix incorrect Doxygen macro
+	invocation.
+
 2012-11-26  Jonathan Wakely  <jwakely.gcc@gmail.com>
 
 	* include/std/functional (__is_socketlike): Change from class
diff --git a/libstdc++-v3/include/bits/stl_tree.h b/libstdc++-v3/include/bits/stl_tree.h
index 03a5e30..037aad3 100644
--- a/libstdc++-v3/include/bits/stl_tree.h
+++ b/libstdc++-v3/include/bits/stl_tree.h
@@ -54,7 +54,7 @@ 
 
 /** @file bits/stl_tree.h
  *  This is an internal header file, included by other library headers.
- *  Do not attempt to use it directly. @headername{map or set}
+ *  Do not attempt to use it directly. @headername{map,set}
  */
 
 #ifndef _STL_TREE_H