There are two types of documentation for libstdc++-v3. One is the distribution documentation, which can be read online at http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html or offline from docs/html/documentation.html in the library source directory.
The other type is the source documentation, of which this is the first page. Here are quick links to the pages which we seem to use the most; a full index is at the bottom:
These HTML pages are automatically generated, along with the man pages.
The Makefile rule 'make
doxygen' in the libstdc++-v3 build directory generates these pages
using a tool called, appropriately enough, Doxygen. To learn more about
Doxygen, take a look at the Doxygen
webpage.
The libstdc++-v3 configuration files needed to generate doxygen output are located:
docs/doxygen/user.cfg.in
docs/doxygen/maint.cfg.in
In general, libstdc++-v3 files should be formatted according to the GNU C++ Coding Standard rules found in the file C++STYLE. Before any doxygen-specific formatting tweaks are made, please try to make sure that the initial formatting is sound.
The formatting guidelines for using libstdc++-v3 with doxygen are still incomplete. There seems to be a marginal preference for the use of Java-Doc style formatting, with the idea that the single-line style (triple-slash) is the least intrusive mechanism for getting libstdc++-v3 documented and cross-referenced while at the same time minimizing disruption to the current formatting. Full documentation of functions (parameter types, return values, etc) will require the slash-splat-splat "extended C" commenting style.
Here are entry points to all the pages generated by Doxygen:
*/