Makefile.am (doxygen-maint): The script isn't executable in CVS.

2001-11-23  Phil Edwards  <pme@gcc.gnu.org>

	* Makefile.am (doxygen-maint):  The script isn't executable in CVS.
	* Makefile.in:  Regenerated.
	* docs/doxygen/TODO:  New file listing doxygen work to be done.
	* docs/doxygen/run_doxygen:  Fix up man pages.
	* docs/doxygen/user.cfg.in:  Insert maint-only toggles.
	* docs/doxygen/maint.cfg.in:  Copy from user.cfg and turn toggles on.
	* include/bits/stl_construct.h:  Use new hooks for internal functions.

	* docs/html/17_intro/TODO:  Small updates.
	* docs/html/faq/index.html:  Likewise.
	* docs/html/faq/index.txt:  Regenerated.

	* include/bits/stl_alloc.h:  Doxygenate, reindent comments, remove
	SGI-isms and wrappers.
	(simple_alloc, debug_alloc):  Uglify class names.
	(__default_alloc_template):  Uglify "threads" template parameter and
	update corresponding macros.
	* include/backward/alloc.h:  Bring up to date.

From-SVN: r47296

1 files changed, 52 insertions, 0 deletions

diff --git a/libstdc++-v3/docs/doxygen/TODO b/libstdc++-v3/docs/doxygen/TODO
new file mode 100644
index 0000000..20f7959
--- /dev/null
+++ b/libstdc++-v3/docs/doxygen/TODO
@@ -0,0 +1,52 @@
+
+The approach I've been using for a given header is to recursively do each
+of the "bits" headers which make up the standard header.  So, e.g., while
+there are five headers making up <algorithm>, three of them were already
+documented in the course of doing other headers.
+
+"Untouched" means I've deliberately skipped it for various reasons, or
+haven't gotten to it yet.  It /will/ be done (by somebody, eventually.)
+
+
+ Area           Still needs to be doxygen-documented
+-----------------------------------------------------------
+
+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
+c21             Untouched, Note B
+c22             Untouched
+c23             See doxygroups.cc and Note B.
+                stl_alloc.h, stl_uninitialized.h remain from the common files.
+c24             Untouched
+c25             stl_tempbuf.h (small), stl_algo.h (big)
+c26             <complex>, <valarray>, stl_numeric.h[26.4], Note A
+c27             Untouched
+
+backward/       Not scanned by doxygen.  Should it be?
+
+ext/            Untouched
+
+__gnu_cxx       Extensions such as verbose_terminate_handler are documented
+                but do not appear in output, since the __gnu_cxx namespace is
+                itself undocumented.  Should it be?  Eeeeeeehhh...
+
+[1.3.5]         "implementation-defined behavior:  behavior ... that depends
+                on the implementation *and that each implementation shall
+                document*."  [my emphasis]  Not all implementation choices
+                have been thus described; doxygen is not necessarily the
+                appropriate place for such descriptions, either.
+
+-----------------------------------------------------------
+
+NOTES:
+
+A)  So far I have not tried to document any of the <c*> headers.  So entities
+such as atexit() are undocumented throughout the library.
+
+B)  Huge chunks of containers and strings are described in common "Tables"
+in the standard.  How to reproduce this information?
+
+
+vim:ts=4:et: