aboutsummaryrefslogtreecommitdiff
path: root/libstdc++-v3/include/std/streambuf
diff options
context:
space:
mode:
authorBenjamin Kosnik <bkoz@redhat.com>2010-02-04 18:20:34 +0000
committerBenjamin Kosnik <bkoz@gcc.gnu.org>2010-02-04 18:20:34 +0000
commit2a60a9f6523b9942c2a2d9f565ecc70eead5eb1d (patch)
tree6e1ccffdd20429524a30357350839bd5d4964941 /libstdc++-v3/include/std/streambuf
parent2480e18fe054c7b3a343d7b7bccbc0deb03d4a4a (diff)
downloadgcc-2a60a9f6523b9942c2a2d9f565ecc70eead5eb1d.zip
gcc-2a60a9f6523b9942c2a2d9f565ecc70eead5eb1d.tar.gz
gcc-2a60a9f6523b9942c2a2d9f565ecc70eead5eb1d.tar.bz2
re PR libstdc++/42460 (man page errors for generated libstdc++ man pages)
2010-02-04 Benjamin Kosnik <bkoz@redhat.com> PR libstdc++/42460 * doc/doxygen/user.cfg.in: Update file list. * include/debug/safe_sequence.h: Doxygen markup fixes for '' and "". * include/debug/safe_base.h: Same. * include/debug/macros.h: Same. * include/tr1_impl/regex: Same. * include/std/iostream: Same. * include/std/streambuf: Same. * include/std/bitset: Same. * include/std/iosfwd: Same. * include/std/limits: Same. * include/std/fstream: Same. * include/std/istream: Same. * include/std/ostream: Same. * include/std/sstream: Same. * include/parallel/multiway_merge.h: Same. * include/parallel/for_each.h: Same. * include/parallel/workstealing.h: Same. * include/parallel/omp_loop_static.h: Same. * include/parallel/omp_loop.h: Same. * include/c_std/csignal: Same. * include/c_std/cstdlib: Same. * include/c_std/cstdio: Same. * include/c_std/cstdarg: Same. * include/c_std/cctype: Same. * include/c_std/cerrno: Same. * include/c_std/cmath: Same. * include/c_std/ciso646: Same. * include/c_std/ctime: Same. * include/c_std/clocale: Same. * include/c_std/climits: Same. * include/c_std/cassert: Same. * include/c_std/csetjmp: Same. * include/c_std/cwchar: Same. * include/c_std/cfloat: Same. * include/c_std/cstring: Same. * include/c_std/cstddef: Same. * include/c_std/cwctype: Same. * include/profile/iterator_tracker.h: Same. * include/profile/impl/profiler_trace.h: Same. * include/ext/vstring.h: Same. * include/ext/algorithm: Same. * include/ext/pb_ds/detail/pat_trie_/pat_trie_.h.pp: Same. * include/ext/pb_ds/detail/bin_search_tree_/bin_search_tree_.h.pp: Same. * include/ext/pb_ds/detail/type_utils.hpp: Same. * include/ext/pb_ds/detail/splay_tree_/splay_tree_.hpp: Same * include/ext/pb_ds/detail/rb_tree_map_/rb_tree_.hpp: Same. * include/ext/rc_string_base.h: Same. * include/ext/stdio_sync_filebuf.h: Same. * include/ext/functional: Same. * include/ext/mt_allocator.h: Same. * include/bits/basic_ios.h: Same. * include/bits/stl_map.h: Same. * include/bits/stl_algobase.h: Same. * include/bits/stl_queue.h: Same. * include/bits/locale_classes.h: Same. * include/bits/stl_set.h: Same. * include/bits/locale_facets.h: Same. * include/bits/stl_stack.h: Same. * include/bits/stl_iterator_base_types.h: Same. * include/bits/basic_string.h: Same. * include/bits/stl_multimap.h: Same. * include/bits/ios_base.h: Same. * include/bits/stl_deque.h: Same. * include/bits/stl_multiset.h: Same. * include/bits/stl_iterator_base_funcs.h: Same. * include/bits/char_traits.h: Same. * include/bits/stl_algo.h: Same. * include/bits/stl_iterator.h: Same. * include/bits/stl_tempbuf.h: Same. * include/bits/random.tcc: Same. * include/bits/stl_function.h: Same. * include/bits/cpp_type_traits.h: Same. * include/bits/random.h: Same. * include/bits/allocator.h: Same. * include/bits/locale_facets_nonio.h: Same. * include/c_global/csignal: Same. * include/c_global/cstdlib: Same. * include/c_global/cstdio: Same. * include/c_global/cstdarg: Same. * include/c_global/cctype: Same. * include/c_global/cerrno: Same. * include/c_global/cmath: Same. * include/c_global/ciso646: Same. * include/c_global/ctime: Same. * include/c_global/clocale: Same. * include/c_global/climits: Same. * include/c_global/cassert: Same. * include/c_global/csetjmp: Same. * include/c_global/cwchar: Same. * include/c_global/cfloat: Same. * include/c_global/cstring: Same. * include/c_global/cstddef: Same. * include/c_global/cwctype: Same. * include/tr1/hypergeometric.tcc: Same. * include/tr1/random.tcc: Same. * include/tr1/functional: Same. * include/tr1/random.h: Same. * include/backward/auto_ptr.h: Same. * include/backward/binders.h: Same. * testsuite/23_containers/deque/requirements/dr438/assign_neg.cc: Adjust line numbers. * testsuite/23_containers/deque/requirements/dr438/insert_neg.cc: Same. * testsuite/23_containers/deque/requirements/dr438/constructor_1_neg.cc: Same. * testsuite/23_containers/deque/requirements/dr438/constructor_2_neg.cc: Same. From-SVN: r156502
Diffstat (limited to 'libstdc++-v3/include/std/streambuf')
-rw-r--r--libstdc++-v3/include/std/streambuf64
1 files changed, 33 insertions, 31 deletions
diff --git a/libstdc++-v3/include/std/streambuf b/libstdc++-v3/include/std/streambuf
index 7d6b8c7..ac8767e 100644
--- a/libstdc++-v3/include/std/streambuf
+++ b/libstdc++-v3/include/std/streambuf
@@ -1,7 +1,7 @@
// Stream buffer classes -*- C++ -*-
// Copyright (C) 1997, 1998, 1999, 2000, 2001, 2002, 2003, 2004, 2005,
-// 2006, 2007, 2008, 2009 Free Software Foundation, Inc.
+// 2006, 2007, 2008, 2009, 2010 Free Software Foundation, Inc.
//
// This file is part of the GNU ISO C++ Library. This library is free
// software; you can redistribute it and/or modify it under the
@@ -79,7 +79,7 @@ _GLIBCXX_BEGIN_NAMESPACE(std)
* represents, at any moment, a (sub)sequence of characters from the
* sequence. Operations performed on a sequence alter the values
* stored in these pointers, perform reads and writes directly to or
- * from associated sequences, and alter "the stream position" and
+ * from associated sequences, and alter <em>the stream position</em> and
* conversion state as needed to maintain this subsequence relationship.
* The three pointers are:
* - the <em>beginning pointer</em>, or lowest element address in the
@@ -340,9 +340,10 @@ _GLIBCXX_BEGIN_NAMESPACE(std)
* @param c The character to push back.
* @return The previous character, if possible.
*
- * Similar to sungetc(), but @a c is pushed onto the stream instead
- * of 'the previous character.' If successful, the next character
- * fetched from the input stream will be @a c.
+ * Similar to sungetc(), but @a c is pushed onto the stream
+ * instead of <em>the previous character.</em> If successful,
+ * the next character fetched from the input stream will be @a
+ * c.
*/
int_type
sputbackc(char_type __c)
@@ -364,10 +365,10 @@ _GLIBCXX_BEGIN_NAMESPACE(std)
* @brief Moving backwards in the input stream.
* @return The previous character, if possible.
*
- * If a putback position is available, this function decrements the
- * input pointer and returns that character. Otherwise, calls and
- * returns pbackfail(). The effect is to 'unget' the last character
- * 'gotten.'
+ * If a putback position is available, this function decrements
+ * the input pointer and returns that character. Otherwise,
+ * calls and returns pbackfail(). The effect is to @a unget
+ * the last character @a gotten.
*/
int_type
sungetc()
@@ -540,11 +541,11 @@ _GLIBCXX_BEGIN_NAMESPACE(std)
* @brief Changes translations.
* @param loc A new locale.
*
- * Translations done during I/O which depend on the current locale
- * are changed by this call. The standard adds, 'Between invocations
- * of this function a class derived from streambuf can safely cache
- * results of calls to locale functions and to members of facets
- * so obtained.'
+ * Translations done during I/O which depend on the current
+ * locale are changed by this call. The standard adds,
+ * <em>Between invocations of this function a class derived
+ * from streambuf can safely cache results of calls to locale
+ * functions and to members of facets so obtained.</em>
*
* @note Base class version does nothing.
*/
@@ -596,7 +597,7 @@ _GLIBCXX_BEGIN_NAMESPACE(std)
* @return -1 on failure.
*
* Each derived class provides its own appropriate behavior,
- * including the definition of "failure".
+ * including the definition of @a failure.
* @note Base class version does nothing, returns zero.
*/
virtual int
@@ -608,18 +609,18 @@ _GLIBCXX_BEGIN_NAMESPACE(std)
* @return An estimate of the number of characters available in the
* input sequence, or -1.
*
- * 'If it returns a positive value, then successive calls to
- * @c underflow() will not return @c traits::eof() until at least that
- * number of characters have been supplied. If @c showmanyc()
- * returns -1, then calls to @c underflow() or @c uflow() will fail.'
- * [27.5.2.4.3]/1
+ * <em>If it returns a positive value, then successive calls to
+ * @c underflow() will not return @c traits::eof() until at
+ * least that number of characters have been supplied. If @c
+ * showmanyc() returns -1, then calls to @c underflow() or @c
+ * uflow() will fail.</em> [27.5.2.4.3]/1
*
* @note Base class version does nothing, returns zero.
- * @note The standard adds that 'the intention is not only that the
+ * @note The standard adds that <em>the intention is not only that the
* calls [to underflow or uflow] will not return @c eof() but
- * that they will return immediately.'
- * @note The standard adds that 'the morphemes of @c showmanyc are
- * 'es-how-many-see', not 'show-manic'.'
+ * that they will return immediately.</em>
+ * @note The standard adds that <em>the morphemes of @c showmanyc are
+ * @b es-how-many-see, not @b show-manic.</em>
*/
virtual streamsize
showmanyc() { return 0; }
@@ -646,7 +647,7 @@ _GLIBCXX_BEGIN_NAMESPACE(std)
*
* Informally, this function is called when the input buffer is
* exhausted (or does not exist, as buffering need not actually be
- * done). If a buffer exists, it is 'refilled'. In either case, the
+ * done). If a buffer exists, it is @a refilled. In either case, the
* next available character is returned, or @c traits::eof() to
* indicate a null pending sequence.
*
@@ -690,7 +691,7 @@ _GLIBCXX_BEGIN_NAMESPACE(std)
/**
* @brief Tries to back up the input sequence.
* @param c The character to be inserted back into the sequence.
- * @return eof() on failure, 'some other value' on success
+ * @return eof() on failure, <em>some other value</em> on success
* @post The constraints of @c gptr(), @c eback(), and @c pptr()
* are the same as for @c underflow().
*
@@ -724,11 +725,12 @@ _GLIBCXX_BEGIN_NAMESPACE(std)
* @return eof() to indicate failure, something else (usually
* @a c, or not_eof())
*
- * Informally, this function is called when the output buffer is full
- * (or does not exist, as buffering need not actually be done). If a
- * buffer exists, it is 'consumed', with 'some effect' on the
- * controlled sequence. (Typically, the buffer is written out to the
- * sequence verbatim.) In either case, the character @a c is also
+ * Informally, this function is called when the output buffer
+ * is full (or does not exist, as buffering need not actually
+ * be done). If a buffer exists, it is @a consumed, with
+ * <em>some effect</em> on the controlled sequence.
+ * (Typically, the buffer is written out to the sequence
+ * verbatim.) In either case, the character @a c is also
* written out, if @a c is not @c eof().
*
* For a formal definition of this function, see a good text