This is the mail archive of the
libstdc++@gcc.gnu.org
mailing list for the libstdc++ project.
Re: doxygen fixes
> ? ? ? ?* include/std/iostream: Fix doxygen link.
> ? ? ? ?* include/bits/forward_list.h: Fix doxygen markup.
> ? ? ? ?* include/ext/vstring.h: Escape backslash in doxygen comment.
> ? ? ? ?* include/bits/basic_string.h: Likewise.
>
> tested with make doc-html-doxygen on GNU/Linux x86_64
>
> Doc fixes only, so OK for trunk?
oops, patch attached this time!
Index: include/std/iostream
===================================================================
--- include/std/iostream (revision 144705)
+++ include/std/iostream (working copy)
@@ -53,7 +53,7 @@ _GLIBCXX_BEGIN_NAMESPACE(std)
* The <iostream> header declares the eight <em>standard stream
* objects</em>. For other declarations, see
* http://gcc.gnu.org/onlinedocs/libstdc++/manual/bk01pt11ch24.html
- * and the @link s27_2_iosfwd I/O forward declarations @endlink
+ * and the @link iosfwd I/O forward declarations @endlink
*
* They are required by default to cooperate with the global C library's
* @c FILE streams, and to be available during program startup and
Index: include/bits/forward_list.h
===================================================================
--- include/bits/forward_list.h (revision 144705)
+++ include/bits/forward_list.h (working copy)
@@ -50,7 +50,7 @@ _GLIBCXX_BEGIN_NAMESPACE(std)
using __gnu_cxx::__const_pointer_cast;
/**
- * @brief A helper basic node class for @forward_list.
+ * @brief A helper basic node class for %forward_list.
* This is just a linked list with nothing inside it.
* There are purely list shuffling utility methods here.
*/
@@ -111,7 +111,7 @@ _GLIBCXX_BEGIN_NAMESPACE(std)
};
/**
- * @brief A helper node class for @forward_list.
+ * @brief A helper node class for %forward_list.
* This is just a linked list with a data value in each node.
* There is a sorting utility method.
*/
@@ -290,7 +290,7 @@ _GLIBCXX_BEGIN_NAMESPACE(std)
{ return __x._M_node != __y._M_node; }
/**
- * @brief Base class for @forward_list.
+ * @brief Base class for %forward_list.
*/
template<typename _Tp, typename _Alloc = allocator<_Tp> >
struct _Fwd_list_base
Index: include/ext/vstring.h
===================================================================
--- include/ext/vstring.h (revision 144705)
+++ include/ext/vstring.h (working copy)
@@ -204,7 +204,7 @@ _GLIBCXX_BEGIN_NAMESPACE(__gnu_cxx)
* @param __n Number of characters to copy.
* @param __a Allocator to use (default is default allocator).
*
- * NB: @a __s must have at least @a __n characters, '\0' has no special
+ * NB: @a __s must have at least @a __n characters, '\\0' has no special
* meaning.
*/
__versa_string(const _CharT* __s, size_type __n,
@@ -2006,7 +2006,7 @@ _GLIBCXX_BEGIN_NAMESPACE(__gnu_cxx)
* the comparison is nonzero returns it, otherwise the shorter
* one is ordered first.
*
- * NB: s must have at least n2 characters, '\0' has no special
+ * NB: s must have at least n2 characters, '\\0' has no special
* meaning.
*/
int
Index: include/bits/basic_string.h
===================================================================
--- include/bits/basic_string.h (revision 144705)
+++ include/bits/basic_string.h (working copy)
@@ -458,7 +458,7 @@ _GLIBCXX_BEGIN_NAMESPACE(std)
* @param n Number of characters to copy.
* @param a Allocator to use (default is default allocator).
*
- * NB: @a s must have at least @a n characters, '\0' has no special
+ * NB: @a s must have at least @a n characters, '\\0' has no special
* meaning.
*/
basic_string(const _CharT* __s, size_type __n,
@@ -2140,7 +2140,7 @@ _GLIBCXX_BEGIN_NAMESPACE(std)
* result of the comparison is nonzero returns it, otherwise the shorter
* one is ordered first.
*
- * NB: s must have at least n2 characters, '\0' has no special
+ * NB: s must have at least n2 characters, '\\0' has no special
* meaning.
*/
int