[patch] Doxygen tweaks

[Jonathan Wakely <cow at compsoc dot man dot ac dot uk>]

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.

Attachment: libstdcxx-doxygen_fixes.patch
Description: Text document