[patch] Doxygen tweaks
Jonathan Wakely
cow@compsoc.man.ac.uk
Thu Nov 18 10:49:00 GMT 2004
Hello y'all,
I noticed the following while running Doxygen last night:
Building file list...
/mnt/sata1/1/redi/gcc/build/x86_64-unknown-linux-gnu/libstdc++-v3/include/algorithm:56: Warning: the name `algorithm' supplied as the second argument in the \file statement matches the following input files:
/mnt/sata1/1/redi/gcc/build/x86_64-unknown-linux-gnu/libstdc++-v3/include/algorithm
/mnt/sata1/1/redi/gcc/build/x86_64-unknown-linux-gnu/libstdc++-v3/include/ext/algorithm
Please use a more specific name by including a (larger) part of the path!
This confuses Doxygen (1.3.9.1) and although <algorithm> is mentioned
in the file list it is not a hyperlink and does not have its own page,
as shown here:
http://www.compsoc.man.ac.uk/~cow/tmp/libstdcxx_files.html
This doesn't happen on the "latest collection" docs on the GCC website,
I assume because the "ext" sub-directory is not included in those docs.
If you leave the argument to @file blank then Doxygen applies the
documentation to the current file, which is unambiguous and <algorithm>
gets its own page.
Patch fixes algorithm and a few other files with shadows in ext dir, and
some other doxygen bugs that caused warnings and/or errors.
OK to commit?
2004-11-18 Jonathan Wakely <redi@gcc.gnu.org>
* include/bits/basic_string.h, include/bits/locale_classes.h,
include/bits/valarray_after.h, include/bits/valarray_before.h,
include/ext/stdio_sync_filebuf.h, include/std/std_algorithm.h,
include/std/std_functional.h, include/std/std_memory.h,
include/std/std_numeric.h: Doxygen fixes.
jon
--
Progress is not made by early risers.
Progress is made by lazy men looking for easier ways to do things.
-------------- next part --------------
Index: include/bits/basic_string.h
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/include/bits/basic_string.h,v
retrieving revision 1.71
diff -u -p -r1.71 basic_string.h
--- include/bits/basic_string.h 28 Oct 2004 01:04:34 -0000 1.71
+++ include/bits/basic_string.h 17 Nov 2004 22:27:42 -0000
@@ -257,8 +257,7 @@ namespace std
// Data Members (public):
// NB: This is an unsigned type, and thus represents the maximum
// size that the allocator can hold.
- /// @var
- /// Value returned by various member functions when they fail.
+ /// Value returned by various member functions when they fail.
static const size_type npos = static_cast<size_type>(-1);
private:
Index: include/bits/locale_classes.h
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/include/bits/locale_classes.h,v
retrieving revision 1.23
diff -u -p -r1.23 locale_classes.h
--- include/bits/locale_classes.h 22 May 2004 23:46:32 -0000 1.23
+++ include/bits/locale_classes.h 17 Nov 2004 22:27:54 -0000
@@ -32,7 +32,7 @@
// ISO C++ 14882: 22.1 Locales
//
-/** @file localefwd.h
+/** @file locale_classes.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
*/
Index: include/bits/valarray_after.h
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/include/bits/valarray_after.h,v
retrieving revision 1.5
diff -u -p -r1.5 valarray_after.h
--- include/bits/valarray_after.h 16 Aug 2004 14:50:31 -0000 1.5
+++ include/bits/valarray_after.h 17 Nov 2004 22:27:58 -0000
@@ -30,7 +30,7 @@
// Written by Gabriel Dos Reis <Gabriel.Dos-Reis@cmla.ens-cachan.fr>
-/** @file valarray_meta.h
+/** @file valarray_after.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
*/
Index: include/bits/valarray_before.h
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/include/bits/valarray_before.h,v
retrieving revision 1.5
diff -u -p -r1.5 valarray_before.h
--- include/bits/valarray_before.h 8 Jul 2004 20:48:04 -0000 1.5
+++ include/bits/valarray_before.h 17 Nov 2004 22:27:58 -0000
@@ -30,7 +30,7 @@
// Written by Gabriel Dos Reis <Gabriel.Dos-Reis@cmla.ens-cachan.fr>
-/** @file valarray_meta.h
+/** @file valarray_before.h
* This is an internal header file, included by other library headers.
* You should not attempt to use it directly.
*/
Index: include/ext/stdio_sync_filebuf.h
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/include/ext/stdio_sync_filebuf.h,v
retrieving revision 1.10
diff -u -p -r1.10 stdio_sync_filebuf.h
--- include/ext/stdio_sync_filebuf.h 5 Nov 2004 19:58:02 -0000 1.10
+++ include/ext/stdio_sync_filebuf.h 17 Nov 2004 22:28:06 -0000
@@ -27,7 +27,7 @@
// invalidate any other reasons why the executable file might be covered by
// the GNU General Public License.
-/** @file ext/stdiostream.h
+/** @file ext/stdio_sync_filebuf.h
* This file is a GNU extension to the Standard C++ Library.
*/
Index: include/std/std_algorithm.h
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/include/std/std_algorithm.h,v
retrieving revision 1.6
diff -u -p -r1.6 std_algorithm.h
--- include/std/std_algorithm.h 11 Nov 2003 20:09:09 -0000 1.6
+++ include/std/std_algorithm.h 17 Nov 2004 22:28:10 -0000
@@ -53,7 +53,7 @@
* purpose. It is provided "as is" without express or implied warranty.
*/
-/** @file algorithm
+/** @file
* This is a Standard C++ Library header. You should @c #include this header
* in your programs, rather than any of the "st[dl]_*.h" implementation files.
*/
Index: include/std/std_functional.h
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/include/std/std_functional.h,v
retrieving revision 1.5
diff -u -p -r1.5 std_functional.h
--- include/std/std_functional.h 11 Nov 2003 20:09:09 -0000 1.5
+++ include/std/std_functional.h 17 Nov 2004 22:28:10 -0000
@@ -41,7 +41,7 @@
*
*/
-/** @file functional
+/** @file
* This is a Standard C++ Library header. You should @c #include this header
* in your programs, rather than any of the "st[dl]_*.h" implementation files.
*/
Index: include/std/std_memory.h
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/include/std/std_memory.h,v
retrieving revision 1.14
diff -u -p -r1.14 std_memory.h
--- include/std/std_memory.h 5 Nov 2004 19:58:03 -0000 1.14
+++ include/std/std_memory.h 17 Nov 2004 22:28:10 -0000
@@ -41,7 +41,7 @@
*
*/
-/** @file memory
+/** @file
* This is a Standard C++ Library header. You should @c #include this header
* in your programs, rather than any of the "st[dl]_*.h" implementation files.
*/
@@ -255,7 +255,7 @@ namespace std
* specification here, but omitting it is standard conforming. Its
* presence can be detected only if _Tp::~_Tp() throws, but this is
* prohibited. [17.4.3.6]/2
- * @end maint
+ * @endif
*/
~auto_ptr() { delete _M_ptr; }
Index: include/std/std_numeric.h
===================================================================
RCS file: /cvs/gcc/gcc/libstdc++-v3/include/std/std_numeric.h,v
retrieving revision 1.5
diff -u -p -r1.5 std_numeric.h
--- include/std/std_numeric.h 11 Nov 2003 20:09:10 -0000 1.5
+++ include/std/std_numeric.h 17 Nov 2004 22:28:10 -0000
@@ -53,7 +53,7 @@
* purpose. It is provided "as is" without express or implied warranty.
*/
-/** @file numeric
+/** @file
* This is a Standard C++ Library header. You should @c #include this header
* in your programs, rather than any of the "st[dl]_*.h" implementation files.
*/
More information about the Libstdc++
mailing list