[libstdc++] Documentation checkin and update

Phil Edwards pedwards@disaster.jaj.com
Tue Sep 25 17:01:00 GMT 2001


This patch seems to touch every line of the guts of <functional>, but it's
just comments.  Honest.

First, all the extensions that SGI made to their STL, which we then imported,
are listed with minimal documentation.  (Full docs are still on SGI's site.)
I wanted the extensions highlighted as such.

The extensions that we ourselves have made, in the form of "anticipating"
the proposed resolutions to certain Defect Reports of the C++ committee,
are also listed.  At first I was going to link to the DRs on anubis (the
committee web server), but it can be terribly nonresponsive sometimes.
So I've added 2 of the 9 files which make up the latest Issues List, and
added them to the repository for easier linking and browsing.  (They are
not included in the diff below.  They are exactly as they appear on anubis,
or as they exist in the downloadable zip file.)

Finally, the code which makes up clause 20 of the standard was commented
for Doxygen.  There will be some more doxygen changes later this week
(controlling the forest of generated index links).

Doing all this led to a couple other minor additions, mostly HTML markup
changes.  Two unneeded #ifdef/#endif inclusion guards were removed; the
guards aren't defined anywhere else, as a comment had already noted.

Checked in on the trunk.


2001-09-25  Phil Edwards  <pme@gcc.gnu.org>

	* docs/html/20_util/howto.html:  Add anchor name.
	* docs/html/23_containers/howto.html:  Line wrapping, another link.
	* docs/html/25_algorithms/howto.html:  Another note.

	* docs/html/ext/howto.html:  Link to SGI extensions.  List DRs and
	link to them...
	* docs/html/ext/lwg-active.html:  ...in this new file (from R19),
	* docs/html/ext/lwg-defects.html:  and this new file (from R19).
	* docs/html/ext/sgiexts.html:  New file.  Mention SGI extensions
	carried over to libstdc++-v3.
	* docs/html/faq/index.html:  Link to SGI extensions.  Mention the
	"missing .." pseudobug.
	* docs/html/faq/index.txt:  Regenerate.

	* include/bits/ios_base.h:  DR-related comment cleanup.
	* include/bits/istream.tcc:  Likewise.
	* include/bits/locale_facets.h:  Likewise.
	* include/bits/locale_facets.tcc:  Likewise.
	* include/bits/ostream.tcc:  Likewise.
	* include/bits/std_bitset.h:  Likewise.
	* include/bits/std_iosfwd.h:  Likewise.
	* include/bits/std_istream.h:  Likewise.
	* include/bits/std_ostream.h:  Likewise.
	* include/bits/std_streambuf.h:  Likewise.
	* include/bits/stl_pair.h:  Likewise.
	* include/bits/streambuf_iterator.h:  Likewise.

	* include/bits/std_map.h:  Remove unused header inclusion guard
	_CPP_BITS_STL_TREE_H from around bits/stl_tree.h.
	* include/bits/std_set.h:  Likewise.

	* include/bits/stl_function.h:  Doxygen markup.
	* docs/doxygen/doxygroups.cc:  New file, specifying module grouping.
	* libsupc++/typeinfo:  Doxygen markup tweak.

-------------- next part --------------
A non-text attachment was scrubbed...
Name: big_doc_patch.bz2
Type: application/x-bzip2
Size: 16779 bytes
Desc: not available
URL: <http://gcc.gnu.org/pipermail/libstdc++/attachments/20010925/4dfd3f47/attachment.bz2>


More information about the Libstdc++ mailing list