Patchwork [v3] forward_list doxyen tweaks

login
register
mail settings
Submitter Benjamin Kosnik
Date Nov. 8, 2010, 11:14 p.m.
Message ID <20101108171430.352e5fb3@shotwell>
Download mbox | patch
Permalink /patch/70474/
State New
Headers show

Comments

Benjamin Kosnik - Nov. 8, 2010, 11:14 p.m.
Addition of debug/forward_list confused doxygen. This markup fixes the
generated warning in the same way that other files (vector, etc) have
also been fixed.

tested x86_64/linux

-benjamin

Patch

2010-11-08  Benjamin Kosnik  <bkoz@redhat.com>

	    * doc/doxygen/user.cfg.in: Adjust scanned includes.
	    * include/std/forward_list: Make doxygen file markup unambiguous.

Index: doc/doxygen/user.cfg.in
===================================================================
--- doc/doxygen/user.cfg.in	(revision 166458)
+++ doc/doxygen/user.cfg.in	(working copy)
@@ -180,7 +180,7 @@ 
 # You can put \n's in the value part of an alias to insert newlines.
 
 ALIASES                = "doctodo=@todo\nDoc me!  See doc/doxygen/TODO and http://gcc.gnu.org/ml/libstdc++/2002-02/msg00003.html for more.  " \
-                         "isiosfwd=One of the @link io I/O @endlink typedefs"
+			 "isiosfwd=One of the @link io I/O @endlink typedefs"
 
 # Set the OPTIMIZE_OUTPUT_FOR_C tag to YES if your project consists of C
 # sources only. Doxygen will then generate output that is more tailored for C.
@@ -583,147 +583,146 @@ 
 # with spaces.
 
 INPUT                  = @srcdir@/doc/doxygen/doxygroups.cc \
-                         @srcdir@/libsupc++/cxxabi.h \
-                         @srcdir@/libsupc++/cxxabi-forced.h \
-                         @srcdir@/libsupc++/exception \
-                         @srcdir@/libsupc++/exception_defines.h \
-                         @srcdir@/libsupc++/exception_ptr.h \
-                         @srcdir@/libsupc++/initializer_list \
-                         @srcdir@/libsupc++/nested_exception.h \
-                         @srcdir@/libsupc++/new \
-                         @srcdir@/libsupc++/typeinfo \
-                         include/algorithm \
-                         include/array \
-                         include/atomic \
-                         include/bitset \
-                         include/chrono \
-                         include/complex \
-                         include/condition_variable \
-                         include/deque \
-                         include/forward_list \
-                         include/fstream \
-                         include/functional \
-                         include/future \
-                         include/iomanip \
-                         include/ios \
-                         include/iosfwd \
-                         include/iostream \
-                         include/istream \
-                         include/iterator \
-                         include/limits \
-                         include/list \
-                         include/locale \
-                         include/map \
-                         include/memory \
-                         include/mutex \
-                         include/numeric \
-                         include/ostream \
-                         include/queue \
-                         include/random \
-                         include/ratio \
-                         include/regex \
-                         include/set \
-                         include/sstream \
-                         include/stack \
-                         include/stdexcept \
-                         include/streambuf \
-                         include/string \
-                         include/system_error \
-                         include/thread \
-                         include/tuple \
-                         include/typeindex \
-                         include/type_traits \
-                         include/unordered_map \
-                         include/unordered_set \
-                         include/utility \
-                         include/valarray \
-                         include/vector \
-                         include/cassert \
-                         include/ccomplex \
-                         include/cctype \
-                         include/cerrno \
-                         include/cfenv \
-                         include/cfloat \
-                         include/cinttypes \
-                         include/ciso646 \
-                         include/climits \
-                         include/clocale \
-                         include/cmath \
-                         include/csetjmp \
-                         include/csignal \
-                         include/cstdarg \
-                         include/cstdbool \
-                         include/cstddef \
-                         include/cstdint \
-                         include/cstdio \
-                         include/cstdlib \
-                         include/cstring \
-                         include/ctgmath \
-                         include/ctime \
-                         include/cwchar \
-                         include/cwctype \
-                         include/backward/hash_map \
-                         include/backward/hash_set \
-                         include/backward/strstream \
-                         include/debug/bitset \
-                         include/debug/deque \
-                         include/debug/forward_list \
-                         include/debug/list \
-                         include/debug/map \
-                         include/debug/set \
-                         include/debug/string \
-                         include/debug/unordered_map \
-                         include/debug/unordered_set \
-                         include/debug/vector \
-                         include/profile/bitset \
-                         include/profile/deque \
-                         include/profile/forward_list \
-                         include/profile/list \
-                         include/profile/map \
-                         include/profile/set \
-                         include/profile/unordered_map \
-                         include/profile/unordered_set \
-                         include/profile/vector \
-                         include/ext/algorithm \
-                         include/ext/functional \
-                         include/ext/iterator \
-                         include/ext/memory \
-                         include/ext/numeric \
-                         include/ext/rb_tree \
-                         include/ext/rope \
-                         include/ext/slist \
-                         include/parallel/algorithm \
-                         include/parallel/numeric \
-                         include/tr1/ccomplex \
-                         include/tr1/cctype \
-                         include/tr1/cfenv \
-                         include/tr1/cfloat \
-                         include/tr1/cinttypes \
-                         include/tr1/climits \
-                         include/tr1/cmath \
-                         include/tr1/complex \
-                         include/tr1/cstdarg \
-                         include/tr1/cstdbool \
-                         include/tr1/cstdint \
-                         include/tr1/cstdio \
-                         include/tr1/cstdlib \
-                         include/tr1/ctgmath \
-                         include/tr1/ctime \
-                         include/tr1/cwchar \
-                         include/tr1/cwctype \
-                         include/decimal/decimal \
-                         include/ \
-                         include/@host_alias@/bits \
-                         include/backward \
-                         include/bits \
-                         include/debug \
-                         include/parallel \
-			 include/precompiled \
-                         include/profile \
-                         include/profile/impl \
-                         include/ext \
-                         include/ext/pb_ds \
-                         include/ext/pb_ds/detail
+			 @srcdir@/libsupc++/cxxabi.h \
+			 @srcdir@/libsupc++/cxxabi-forced.h \
+			 @srcdir@/libsupc++/exception \
+			 @srcdir@/libsupc++/exception_defines.h \
+			 @srcdir@/libsupc++/exception_ptr.h \
+			 @srcdir@/libsupc++/initializer_list \
+			 @srcdir@/libsupc++/nested_exception.h \
+			 @srcdir@/libsupc++/new \
+			 @srcdir@/libsupc++/typeinfo \
+			 include/algorithm \
+			 include/array \
+			 include/atomic \
+			 include/bitset \
+			 include/chrono \
+			 include/complex \
+			 include/condition_variable \
+			 include/deque \
+			 include/forward_list \
+			 include/fstream \
+			 include/functional \
+			 include/future \
+			 include/iomanip \
+			 include/ios \
+			 include/iosfwd \
+			 include/iostream \
+			 include/istream \
+			 include/iterator \
+			 include/limits \
+			 include/list \
+			 include/locale \
+			 include/map \
+			 include/memory \
+			 include/mutex \
+			 include/numeric \
+			 include/ostream \
+			 include/queue \
+			 include/random \
+			 include/ratio \
+			 include/regex \
+			 include/set \
+			 include/sstream \
+			 include/stack \
+			 include/stdexcept \
+			 include/streambuf \
+			 include/string \
+			 include/system_error \
+			 include/thread \
+			 include/tuple \
+			 include/typeindex \
+			 include/type_traits \
+			 include/unordered_map \
+			 include/unordered_set \
+			 include/utility \
+			 include/valarray \
+			 include/vector \
+			 include/cassert \
+			 include/ccomplex \
+			 include/cctype \
+			 include/cerrno \
+			 include/cfenv \
+			 include/cfloat \
+			 include/cinttypes \
+			 include/ciso646 \
+			 include/climits \
+			 include/clocale \
+			 include/cmath \
+			 include/csetjmp \
+			 include/csignal \
+			 include/cstdarg \
+			 include/cstdbool \
+			 include/cstddef \
+			 include/cstdint \
+			 include/cstdio \
+			 include/cstdlib \
+			 include/cstring \
+			 include/ctgmath \
+			 include/ctime \
+			 include/cwchar \
+			 include/cwctype \
+			 include/backward/hash_map \
+			 include/backward/hash_set \
+			 include/backward/strstream \
+			 include/debug/bitset \
+			 include/debug/deque \
+			 include/debug/forward_list \
+			 include/debug/list \
+			 include/debug/map \
+			 include/debug/set \
+			 include/debug/string \
+			 include/debug/unordered_map \
+			 include/debug/unordered_set \
+			 include/debug/vector \
+			 include/profile/bitset \
+			 include/profile/deque \
+			 include/profile/forward_list \
+			 include/profile/list \
+			 include/profile/map \
+			 include/profile/set \
+			 include/profile/unordered_map \
+			 include/profile/unordered_set \
+			 include/profile/vector \
+			 include/ext/algorithm \
+			 include/ext/functional \
+			 include/ext/iterator \
+			 include/ext/memory \
+			 include/ext/numeric \
+			 include/ext/rb_tree \
+			 include/ext/rope \
+			 include/ext/slist \
+			 include/parallel/algorithm \
+			 include/parallel/numeric \
+			 include/tr1/ccomplex \
+			 include/tr1/cctype \
+			 include/tr1/cfenv \
+			 include/tr1/cfloat \
+			 include/tr1/cinttypes \
+			 include/tr1/climits \
+			 include/tr1/cmath \
+			 include/tr1/complex \
+			 include/tr1/cstdarg \
+			 include/tr1/cstdbool \
+			 include/tr1/cstdint \
+			 include/tr1/cstdio \
+			 include/tr1/cstdlib \
+			 include/tr1/ctgmath \
+			 include/tr1/ctime \
+			 include/tr1/cwchar \
+			 include/tr1/cwctype \
+			 include/decimal/decimal \
+			 include/ \
+			 include/@host_alias@/bits \
+			 include/backward \
+			 include/bits \
+			 include/debug \
+			 include/parallel \
+			 include/profile \
+			 include/profile/impl \
+			 include/ext \
+			 include/ext/pb_ds \
+			 include/ext/pb_ds/detail
 
 # This tag can be used to specify the character encoding of the source files
 # that doxygen parses. Internally doxygen uses the UTF-8 encoding, which is
@@ -741,8 +740,8 @@ 
 # *.hpp *.h++ *.idl *.odl *.cs *.php *.php3 *.inc *.m *.mm *.py *.f90
 
 FILE_PATTERNS          = *.h \
-                         *.hpp \
-                         *.tcc
+			 *.hpp \
+			 *.tcc
 
 # The RECURSIVE tag can be used to turn specify whether or not subdirectories
 # should be searched for input files as well. Possible values are YES and NO.
@@ -769,10 +768,8 @@ 
 # for example use the pattern */test/*
 
 EXCLUDE_PATTERNS       = stamp-* \
-                         *stdc++.h* \
-                         *stdtr1c++.h* \
-                         *extc++.h* \
-                         */.svn/*
+			 *.gch \
+			 */.svn/*
 
 # The EXCLUDE_SYMBOLS tag can be used to specify one or more symbol names
 # (namespaces, classes, functions, etc.) that should be excluded from the
@@ -1515,39 +1512,44 @@ 
 # instead of the = operator.
 
 PREDEFINED             = __cplusplus \
-                         __GTHREADS \
-                         _GLIBCXX_HAS_GTHREADS \
-                         __GXX_EXPERIMENTAL_CXX0X__ \
-                         _GLIBCXX_INCLUDE_AS_CXX0X \
-                         "_GLIBCXX_STD_P= " \
-                         "_GLIBCXX_STD_D= " \
-                         _GLIBCXX_STD=std \
-                         "_GLIBCXX_TR1= " \
-                         "_GLIBCXX_BEGIN_NAMESPACE_TR1= " \
-                         "_GLIBCXX_END_NAMESPACE_TR1= " \
-                         "_GLIBCXX_BEGIN_NAMESPACE(name)=namespace name {  " \
-                         "_GLIBCXX_BEGIN_NESTED_NAMESPACE(name, unused)=namespace name {  " \
-                         _GLIBCXX_END_NAMESPACE=} \
-                         _GLIBCXX_END_NESTED_NAMESPACE=} \
-                         "_GLIBCXX_TEMPLATE_ARGS=...  " \
-                         _GLIBCXX_DEPRECATED \
-                         _GLIBCXX_CONSTEXPR=constexpr \
-                         _GLIBCXX_USE_CONSTEXPR=constexpr \
-                         _GLIBCXX_USE_WCHAR_T \
-                         _GLIBCXX_USE_LONG_LONG \
-                         _GLIBCXX_USE_C99_STDINT_TR1 \
-                         _GLIBCXX_ATOMIC_BUILTINS_1 \
-                         _GLIBCXX_ATOMIC_BUILTINS_2 \
-                         _GLIBCXX_ATOMIC_BUILTINS_4 \
-                         _GLIBCXX_ATOMIC_BUILTINS_8 \
-                         _GLIBCXX_USE_SCHED_YIELD \
-                         _GLIBCXX_USE_NANOSLEEP \
-                         __GXX_RTTI \
-                         __glibcxx_function_requires=// \
-                         __glibcxx_class_requires=// \
-                         __glibcxx_class_requires2=// \
-                         __glibcxx_class_requires3=// \
-                         __glibcxx_class_requires4=//
+			 __GTHREADS \
+			 _GLIBCXX_HAS_GTHREADS \
+			 __GXX_EXPERIMENTAL_CXX0X__ \
+			 _GLIBCXX_INCLUDE_AS_CXX0X \
+			 "_GLIBCXX_PURE= " \
+			 "_GLIBCXX_CONST= " \
+			 "_GLIBCXX_NORETURN= " \
+			 "_GLIBCXX_NOTHROW= " \
+			 "_GLIBCXX_STD_D= " \
+			 "_GLIBCXX_STD_P= " \
+			 "_GLIBCXX_STD_PR= " \
+			 _GLIBCXX_STD=std \
+			 "_GLIBCXX_TR1= " \
+			 "_GLIBCXX_BEGIN_NAMESPACE_TR1= " \
+			 "_GLIBCXX_END_NAMESPACE_TR1= " \
+			 "_GLIBCXX_BEGIN_NAMESPACE(name)=namespace name {  " \
+			 "_GLIBCXX_BEGIN_NESTED_NAMESPACE(name, unused)=namespace name {  " \
+			 _GLIBCXX_END_NAMESPACE=} \
+			 _GLIBCXX_END_NESTED_NAMESPACE=} \
+			 "_GLIBCXX_TEMPLATE_ARGS=...  " \
+			 _GLIBCXX_DEPRECATED \
+			 _GLIBCXX_CONSTEXPR=constexpr \
+			 _GLIBCXX_USE_CONSTEXPR=constexpr \
+			 _GLIBCXX_USE_WCHAR_T \
+			 _GLIBCXX_USE_LONG_LONG \
+			 _GLIBCXX_USE_C99_STDINT_TR1 \
+			 _GLIBCXX_ATOMIC_BUILTINS_1 \
+			 _GLIBCXX_ATOMIC_BUILTINS_2 \
+			 _GLIBCXX_ATOMIC_BUILTINS_4 \
+			 _GLIBCXX_ATOMIC_BUILTINS_8 \
+			 _GLIBCXX_USE_SCHED_YIELD \
+			 _GLIBCXX_USE_NANOSLEEP \
+			 __GXX_RTTI \
+			 __glibcxx_function_requires=// \
+			 __glibcxx_class_requires=// \
+			 __glibcxx_class_requires2=// \
+			 __glibcxx_class_requires3=// \
+			 __glibcxx_class_requires4=//
 
 # If the MACRO_EXPANSION and EXPAND_ONLY_PREDEF tags are set to YES then
 # this tag can be used to specify a list of macro names that should be expanded.
Index: include/std/forward_list
===================================================================
--- include/std/forward_list	(revision 166458)
+++ include/std/forward_list	(working copy)
@@ -22,7 +22,7 @@ 
 // see the files COPYING3 and COPYING.RUNTIME respectively.  If not, see
 // <http://www.gnu.org/licenses/>.
 
-/** @file forward_list
+/** @file include/forward_list
  *  This is a Standard C++ Library header.
  */