gcc/libstdc++-v3/docs/html/documentation.html

97 lines
4.2 KiB
HTML
Raw Normal View History

<HTML>
<HEAD>
<META NAME="KEYWORDS" CONTENT="libstdc++, homepage, home, g++, libg++, STL">
<TITLE>Standard C++ Library v3</TITLE>
<LINK REL=StyleSheet HREF="lib3styles.css">
<!-- $Id: documentation.html,v 1.3 2001/05/23 02:00:05 pme Exp $ -->
</HEAD>
<BODY>
<P><B>All of these documents</B> (in fact, this entire homepage set) are
bundled with the library source, under the <TT>docs</TT> subdirectory,
for releases and snapshots. The sole exception is the
automatically-generated source documentation, available separately.
</P>
<HR>
<H2><A NAME="4">Source Documentation</A></H2>
<P>In addition to the distribution documentation (these pages), we also
have a set of HTML documents generated from the sources themselves,
using the Doxygen tool. These are useful for examining the signatures
of public member functions for the library classes, etc.
</P>
<P>
The latest collection is <TT>libstdc++-doxygen-20010501.tar.gz</TT> (3.7MB),
<A HREF="libstdc++-doxygen-20010501/index.html">viewable online</A>.
The collection is also available in the libstdc++ snapshots directory at
<TT>&lt;URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/&gt;</TT>. You will
almost certainly need to use one of the
<A HREF="http://gcc.gnu.org/mirrors.html">mirror sites</A> to download
the tarball. After unpacking, simply load
libstdc++-doxygen-20010501/index.html <!-- also update this date -->
in a browser. Feedback (and additional documentation!) is welcome.
</P>
<HR>
<H2><A NAME="2">Configuring, Building, Installing</A></H2>
<UL>
<LI><A HREF="configopts.html">Configure options</A>
<LI><A HREF="install.html">Getting started: configure, build, install</A><BR>
</UL>
<HR>
<H2><A NAME="1">Introductory notes for libstdc++</A></H2>
<P>This is a short list of text files pertaining to this
implementation of ISO 14882. A brief description follows the name
of the file.
</P>
<P>
<UL>
<LI><A HREF="17_intro/BADNAMES">BADNAMES</A>
- names to avoid because of potential collisions
<LI><A HREF="17_intro/BUGS">BUGS</A>
<LI><A HREF="17_intro/C++STYLE">C++STYLE</A>
- coding style by example
<LI><A HREF="17_intro/CHECKLIST">CHECKLIST</A>
- a list of required features and their status.
<LI><A HREF="17_intro/COPYING">COPYING</A>
- GPL v2 license terms
<LI><A HREF="17_intro/DESIGN">DESIGN</A>
- overview of the implementation plan
<LI><A HREF="17_intro/HEADER_POLICY">HEADER_POLICY</A>
- header naming and sub-include structure
<LI><A HREF="17_intro/PROBLEMS">PROBLEMS</A>
<!-- Linking to "../README" doesn't work; we are at the top level
of the web pages. Punt. -->
<LI>README - directory structure
<LI><A HREF="17_intro/RELEASE-NOTES">RELEASE-NOTES</A>
- instructions for building, using
<LI><A HREF="17_intro/TODO">TODO</A>
- tasks and known bugs
<LI><A HREF="17_intro/organization">organization</A>
<LI><A HREF="17_intro/contribute.html">Contributor checklist</A>
<LI><A HREF="17_intro/libstdc++-assign.txt">Copyright assignment form for libstdc++-v3</A>
</UL>
</P>
<HR>
<H2><A NAME="3">Chapter-Specific Information, Extensions, Notes and Advice</A></H2>
<OL>
<LI><A HREF="17_intro/howto.html">Chapter 17 (Intro)</A>
<LI><A HREF="18_support/howto.html">Chapter 18 (Library Support)</A>
<LI><A HREF="19_diagnostics/howto.html">Chapter 19 (Diagnostics)</A>
<LI><A HREF="20_util/howto.html">Chapter 20 (Utilities)</A>
<LI><A HREF="21_strings/howto.html">Chapter 21 (Strings)</A>
<LI><A HREF="22_locale/howto.html">Chapter 22 (Localization)</A>
<LI><A HREF="23_containers/howto.html">Chapter 23 (Containers)</A>
<LI><A HREF="24_iterators/howto.html">Chapter 24 (Iterators)</A>
<LI><A HREF="25_algorithms/howto.html">Chapter 25 (Algorithms)</A>
<LI><A HREF="26_numerics/howto.html">Chapter 26 (Numerics)</A>
<LI><A HREF="27_io/howto.html">Chapter 27 (I/O)</A>
<LI><A HREF="ext/howto.html">Extensions to the Standard Library</A>
</OL>
</BODY>
</HTML>