From e92a4045ac5a8bc726448c432c63c245a6aab601 Mon Sep 17 00:00:00 2001
From: Phil Edwards
Date: Wed, 1 May 2002 22:57:59 +0000
Subject: [PATCH] std_bitset.h: Fix doxygen comments.
2002-05-01 Phil Edwards
* include/std/std_bitset.h: Fix doxygen comments.
* docs/html/documentation.html: Minor tweaks for 3.1.
* docs/html/27_io/howto.html: Likewise.
* docs/html/ext/howto.html: Likewise, mention stdio_filebuf.
* docs/html/faq/index.html: Likewise.
* docs/html/faq/index.txt: Regenerated.
From-SVN: r53025
---
libstdc++-v3/ChangeLog | 9 +++++++++
libstdc++-v3/docs/html/27_io/howto.html | 9 +++++----
libstdc++-v3/docs/html/documentation.html | 9 ++++-----
libstdc++-v3/docs/html/ext/howto.html | 8 ++++++--
libstdc++-v3/docs/html/faq/index.html | 7 ++++---
libstdc++-v3/docs/html/faq/index.txt | 11 ++++++-----
libstdc++-v3/include/std/std_bitset.h | 5 ++++-
7 files changed, 38 insertions(+), 20 deletions(-)
diff --git a/libstdc++-v3/ChangeLog b/libstdc++-v3/ChangeLog
index 7eba269f7cf..045cb8353f3 100644
--- a/libstdc++-v3/ChangeLog
+++ b/libstdc++-v3/ChangeLog
@@ -1,3 +1,12 @@
+2002-05-01 Phil Edwards
+
+ * include/std/std_bitset.h: Fix doxygen comments.
+ * docs/html/documentation.html: Minor tweaks for 3.1.
+ * docs/html/27_io/howto.html: Likewise.
+ * docs/html/ext/howto.html: Likewise, mention stdio_filebuf.
+ * docs/html/faq/index.html: Likewise.
+ * docs/html/faq/index.txt: Regenerated.
+
2002-05-01 Benjamin Kosnik
PR libstdc++/6533
diff --git a/libstdc++-v3/docs/html/27_io/howto.html b/libstdc++-v3/docs/html/27_io/howto.html
index 6e07310dff1..bf235560dfa 100644
--- a/libstdc++-v3/docs/html/27_io/howto.html
+++ b/libstdc++-v3/docs/html/27_io/howto.html
@@ -377,7 +377,8 @@
return 0;
}
- Try it yourself!
+ Try it yourself! More examples can be found in 3.1.x code, in
+ include/ext/*_filebuf.h
.
@@ -432,8 +433,8 @@
The upside is that correctness is ensured. The downside is that
writing through cout
can quite easily lead to awful
performance when the C++ I/O library is layered on top of the C I/O
- library (as it is for 3.0 by default). Some patches are in the
- works which should improve the situation for 3.1.
+ library (as it is for 3.0 by default). Some patches have been applied
+ which improve the situation for 3.1.
However, the C and C++ standard streams only need to be kept in sync
when both libraries' facilities are in use. If your program only uses
@@ -447,7 +448,7 @@
You must do this before performing any I/O via the C++ stream objects.
Once you call this, the C++ streams will operate independently of the
- (unused) C streams. For GCC 3.0, this means that cout
and
+ (unused) C streams. For GCC 3.x, this means that cout
and
company will become fully buffered on their own.
Note, by the way, that the synchronization requirement only applies to
diff --git a/libstdc++-v3/docs/html/documentation.html b/libstdc++-v3/docs/html/documentation.html
index 321878bed1b..d5fc8ac6f82 100644
--- a/libstdc++-v3/docs/html/documentation.html
+++ b/libstdc++-v3/docs/html/documentation.html
@@ -29,11 +29,11 @@
The available user-level collections are also viewable online:
Other collections (man pages, maintainer docs) are only available on the
FTP sites.
@@ -52,9 +52,8 @@
- This is a short list of text files pertaining to this
- implementation of ISO 14882. A brief description follows the name
- of the file.
+
This is a short list of text files pertaining to this implementation of
+ ISO 14882. A brief description follows the name of the file.
diff --git a/libstdc++-v3/docs/html/ext/howto.html b/libstdc++-v3/docs/html/ext/howto.html
index b883445de0b..cbea1f58395 100644
--- a/libstdc++-v3/docs/html/ext/howto.html
+++ b/libstdc++-v3/docs/html/ext/howto.html
@@ -119,7 +119,7 @@
their own page. Since the SGI STL is no
longer actively maintained, we will try and keep this code working
ourselves.
- filebuf
s have another ctor with this signature:
+ - 3.0.x
filebuf
s have another ctor with this signature:
basic_filebuf(__c_file_type*, ios_base::openmode, int_type);
This comes in very handy in a number of places, such as
attaching Unix sockets, pipes, and anything else which uses file
@@ -143,6 +143,10 @@
library cannot track what you do on your own with a file descriptor,
so if you perform any I/O directly, don't expect the library to be
aware of it.
+ - Beginning with 3.1, the extra
filebuf
constructor and
+ the fd()
function were removed from the standard
+ filebuf. Instead, <ext/stdio_filebuf.h>
contains
+ a derived class called __gnu_cxx::stdio_filebuf
.
Return to top of page or
@@ -226,7 +230,7 @@
(If you decide to be unportable, then you're free do do what you want,
but it's not our fault if stuff breaks.) They are presented here for
information for maintainers and contributors in addition to users, but
- we will probably make them available for users in 3.1 somehow.
+ we will probably make them available for users in 3.2 somehow.
These classes are always available:
diff --git a/libstdc++-v3/docs/html/faq/index.html b/libstdc++-v3/docs/html/faq/index.html
index e38f212030d..149d3712e83 100644
--- a/libstdc++-v3/docs/html/faq/index.html
+++ b/libstdc++-v3/docs/html/faq/index.html
@@ -142,7 +142,7 @@
has recently been taken over by the
GCC team. All of
the rapid development and near-legendary
- portability
+ portability
that are the hallmarks of an open-source project are being
applied to libstdc++.
@@ -617,7 +617,8 @@ New in 3.0.97:
then you will suddenly be faced with huge numbers of ambiguity
errors. This was discussed on the -v3 list; Nathan Myers
sums
- things up here.
+ things up here. The collisions with vector/string iterator
+ types have been fixed for 3.1.
The g++-3 headers are
@@ -758,7 +759,7 @@ http://clisp.cons.org/~haible/gccinclude-glibc-2.2-compat.diff
expansion in container classes and buffer usage in synchronized
stream objects.
-
An ABI for libstdc++ will eventually be developed, so that
+
An ABI for libstdc++ is being developed, so that
multiple binary-incompatible copies of the library can be replaced
with a single backwards-compatible library, like libgcc_s.so is.
diff --git a/libstdc++-v3/docs/html/faq/index.txt b/libstdc++-v3/docs/html/faq/index.txt
index 73c48dfc186..91a510fed70 100644
--- a/libstdc++-v3/docs/html/faq/index.txt
+++ b/libstdc++-v3/docs/html/faq/index.txt
@@ -501,7 +501,8 @@ New in 3.0.97:
same namespace as other comparison functions (e.g., 'using' them and
the header), then you will suddenly be faced with huge
numbers of ambiguity errors. This was discussed on the -v3 list;
- Nathan Myers [79]sums things up here.
+ Nathan Myers [79]sums things up here. The collisions with
+ vector/string iterator types have been fixed for 3.1.
The g++-3 headers are not ours
@@ -615,9 +616,9 @@ http://clisp.cons.org/~haible/gccinclude-glibc-2.2-compat.diff
already underway for post-3.0 releases, starting with memory
expansion in container classes and buffer usage in synchronized
stream objects.
- 3. An ABI for libstdc++ will eventually be developed, so that
- multiple binary-incompatible copies of the library can be replaced
- with a single backwards-compatible library, like libgcc_s.so is.
+ 3. An ABI for libstdc++ is being developed, so that multiple
+ binary-incompatible copies of the library can be replaced with a
+ single backwards-compatible library, like libgcc_s.so is.
4. The current libstdc++ contains extensions to the Library which
must be explicitly requested by client code (for example, the hash
tables from SGI). Other extensions may be added to libstdc++-v3 if
@@ -825,7 +826,7 @@ References
50. ../faq/index.html#4_4_interface
51. ../17_intro/DESIGN
52. http://gcc.gnu.org/
- 53. http://gcc.gnu.org/gcc-2.95/buildstat.html
+ 53. http://gcc.gnu.org/gcc-3.0/buildstat.html
54. http://gcc.gnu.org/libstdc++/
55. http://gcc.gnu.org/libstdc++/download.html
56. http://gcc.gnu.org/libstdc++/
diff --git a/libstdc++-v3/include/std/std_bitset.h b/libstdc++-v3/include/std/std_bitset.h
index bda3899f481..0945c90f5fc 100644
--- a/libstdc++-v3/include/std/std_bitset.h
+++ b/libstdc++-v3/include/std/std_bitset.h
@@ -480,7 +480,8 @@ namespace std
*
* @ingroup Containers
*
- * Meets the requirements of a container.
+ * (Note that %bitset does @e not meet the formal requirements of a
+ * container. Mainly, it lacks iterators.)
*
* The template argument, @a _Nb, may be any nonzero number of type
* size_t.
@@ -973,6 +974,7 @@ namespace std
/**
* @brief Finds the index of the first "on" bit.
+ * @return The index of the first bit set, or size() if not found.
* @ingroup SGIextensions
* @sa _Find_next
*/
@@ -982,6 +984,7 @@ namespace std
/**
* @brief Finds the index of the next "on" bit after prev.
+ * @return The index of the next bit set, or size() if not found.
* @param prev Where to start searching.
* @ingroup SGIextensions
* @sa _Find_first
--
2.30.2