aboutsummaryrefslogtreecommitdiff
path: root/libstdc++-v3/docs
diff options
context:
space:
mode:
authorPhil Edwards <pme@gcc.gnu.org>2001-12-19 21:57:43 +0000
committerPhil Edwards <pme@gcc.gnu.org>2001-12-19 21:57:43 +0000
commit82b61df521d17a96f60e56ede06a55a8894b1c2e (patch)
tree20530f0219543c3a5e48fc1f7fe35dca73c78c9b /libstdc++-v3/docs
parent572cd73ac976578951d38adf15c43d4dc9abb299 (diff)
downloadgcc-82b61df521d17a96f60e56ede06a55a8894b1c2e.zip
gcc-82b61df521d17a96f60e56ede06a55a8894b1c2e.tar.gz
gcc-82b61df521d17a96f60e56ede06a55a8894b1c2e.tar.bz2
Intro.3: New 'Allocators' module.
2001-12-19 Phil Edwards <pme@gcc.gnu.org> * docs/doxygen/Intro.3: New 'Allocators' module. * docs/doxygen/TODO: Update. * docs/doxygen/doxygroups.cc: Update. * docs/doxygen/run_doxygen: Update. * include/bits/stl_alloc.h: Tweak doxygen hooks in comments. * include/bits/std_memory.h: Doxygenate. * include/bits/stl_iterator_base_types.h: Likewise. * include/bits/stl_raw_storage_iter.h: Likewise. * include/bits/stl_tempbuf.h: Likewise. (get_temporary_buffer): Remove unused nonstandard overload. * include/bits/stl_uninitialized.h: Likewise. * include/bits/stl_iterator_base_types.h (input_iterator, output_iterator, forward_iterator, bidirectional_iterator, random_access_iterator): Move old names... * include/backward/iterator.h: ...to here. * include/bits/stl_bvector.h: Update. * include/ext/stl_rope.h: Update. From-SVN: r48185
Diffstat (limited to 'libstdc++-v3/docs')
-rw-r--r--libstdc++-v3/docs/doxygen/Intro.31
-rw-r--r--libstdc++-v3/docs/doxygen/TODO2
-rw-r--r--libstdc++-v3/docs/doxygen/doxygroups.cc14
-rw-r--r--libstdc++-v3/docs/doxygen/run_doxygen3
4 files changed, 12 insertions, 8 deletions
diff --git a/libstdc++-v3/docs/doxygen/Intro.3 b/libstdc++-v3/docs/doxygen/Intro.3
index 52998c9..1d0820c 100644
--- a/libstdc++-v3/docs/doxygen/Intro.3
+++ b/libstdc++-v3/docs/doxygen/Intro.3
@@ -29,6 +29,7 @@ or Austern's.) These category pages are:
.\" These are separated by ONE TAB. Nothing else. I don't like it either.
.TS
lB l.
+Allocators Classes encapsulating memory allocation schemes.
Arithmetic_functors Functors for basic math.
Assoc_containers Key-based containers.
Binder_functors Functors which "remember" an argument.
diff --git a/libstdc++-v3/docs/doxygen/TODO b/libstdc++-v3/docs/doxygen/TODO
index 20f7959..672513e 100644
--- a/libstdc++-v3/docs/doxygen/TODO
+++ b/libstdc++-v3/docs/doxygen/TODO
@@ -14,7 +14,7 @@ haven't gotten to it yet. It /will/ be done (by somebody, eventually.)
c17 FINISHED (Nothing in Clause 17 "exists" in terms of code.)
c18 <limits>, Note A
c19 Note A
-c20 std_memory.h[20.4], rel_ops (should they be doc'd?), Note A
+c20 rel_ops (should they be doc'd?), Note A
c21 Untouched, Note B
c22 Untouched
c23 See doxygroups.cc and Note B.
diff --git a/libstdc++-v3/docs/doxygen/doxygroups.cc b/libstdc++-v3/docs/doxygen/doxygroups.cc
index de304f1..7d4e65d 100644
--- a/libstdc++-v3/docs/doxygen/doxygroups.cc
+++ b/libstdc++-v3/docs/doxygen/doxygroups.cc
@@ -1,10 +1,12 @@
-// This just provides documentation for stuff that doesn't need to be in the
-// source headers themselves. It is a ".cc" file for the sole cheesy reason
-// that it triggers many different text editors into doing Nice Things when
-// typing comments. However, it is mentioned nowhere except the *cfg.in files.
-// Pieces separated by '// //' lines will usually not be presented to the
-// user on the same page.
+/*
+ This just provides documentation for stuff that doesn't need to be in the
+ source headers themselves. It is a ".cc" file for the sole cheesy reason
+ that it triggers many different text editors into doing Nice Things when
+ typing comments. However, it is mentioned nowhere except the *cfg.in files.
+ Pieces separated by '// //' lines will usually not be presented to the
+ user on the same page.
+*/
// // // // // // // // // // // // // // // // // // // // // // // //
/** @addtogroup SGIextensions STL extensions from SGI
diff --git a/libstdc++-v3/docs/doxygen/run_doxygen b/libstdc++-v3/docs/doxygen/run_doxygen
index 78f2385..7ac2744 100644
--- a/libstdc++-v3/docs/doxygen/run_doxygen
+++ b/libstdc++-v3/docs/doxygen/run_doxygen
@@ -166,11 +166,12 @@ rm stdheader
# implementations of man(1), e.g., Linux's. We need to have another top-level
# *roff tag to /stop/ the .SH NAME entry.
#problematic=`egrep --files-without-match '^\.SH SYNOPSIS' [A-Z]*.3`
-problematic='Containers.3 Sequences.3 Assoc_containers.3'
+problematic='Containers.3 Sequences.3 Assoc_containers.3 Allocators.3'
for f in $problematic; do
sed '/^\.SH NAME/{
n
a\
+\
.SH SYNOPSIS
}' $f > TEMP
mv TEMP $f