# libstdc++ Source Documentation

## Documentation Overview

User-level docs, generated 2007-11-01.

There are two types of documentation for libstdc++. 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. Both "user-level" and "maintainer-level" source documentation is produced: user-level docs are for the users of this library. The maint-level docs are for those interested in the underlying workings of the library; they include all the user-level docs plus additional notes and additional classes/functions/etc.

Here are entry points to all the pages generated by Doxygen:

- Modules
- Namespace List
- Class List
- Class Annotated List
- Class Alphabetical Index
- Function Alphabetical List
- Source File List
- TODO List (This is incomplete... how ironic.)

If you are using Doxygen for your own projects, you can use a tag file for the appropriate version and an entry such as

> TAGFILES = "libstdc++.tag = http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen"

Be sure to adjust the URL for the right version. If you download a local copy of the source documentation for faster viewing, you can use the doxytag/installdox programs (part of Doxygen) to adjust the links for you.

## Generating the documentation

These HTML pages are automatically generated, along with the man pages. See `docs/doxygen/guide.html` in the source tree for how to create (and write) the pages.

## License, Copyright, and Other Lawyerly Verbosity

The libstdc++ documentation is released under these terms.

Part of the generated documentation involved comments and notes from SGI, who says we gotta say this:

> Permission to use, copy, modify, distribute and sell this software and its documentation for any purpose is hereby granted without fee, provided that the below copyright notice appears in all copies and that both the copyright notice and this permission notice appear in supporting documentation. Silicon Graphics makes no representations about the suitability of this software for any purpose. It is provided "as is" without express or implied warranty.
> Copyright © 1994 Hewlett-Packard Company

Part of the generated documentation is quoted from the ISO C++ Standard, which is Copyright © 1998 by Information Technology Industry Council.