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

   1 <HTML>
   2 <HEAD>
   3  <META NAME="KEYWORDS" CONTENT="libstdc++, homepage, home, g++, libg++, STL">
   4  <TITLE>Standard C++ Library v3</TITLE>
   5 <LINK REL=StyleSheet HREF="lib3styles.css">
   6 <!-- $Id: documentation.html,v 1.2 2001/05/19 20:27:36 pme Exp $ -->
   7 </HEAD>
   8 <BODY>
   9
  10
  11 <P><B>All of these documents</B> (in fact, this entire homepage set) are
  12    bundled with the library source, under the <TT>docs</TT> subdirectory,
  13    for releases and snapshots.  The sole exception is the
  14    <A HREF="#4">automatically-generated source documentation</A>,
  15    available separately.
  16 </P>
  17
  18 <H2><A NAME="1">Introductory notes for libstdc++</A></H2>
  19    <P>This is a short list of text files pertaining to this
  20    implementation of ISO 14882. A brief description follows the name
  21    of the file.
  22    </P>
  23       <UL>
  24          <LI><A HREF="17_intro/BADNAMES">BADNAMES</A>
  25          - names to avoid because of potential collisions
  26          <LI><A HREF="17_intro/BUGS">BUGS</A>
  27          <LI><A HREF="17_intro/C++STYLE">C++STYLE</A>
  28          - coding style by example
  29          <LI><A HREF="17_intro/CHECKLIST">CHECKLIST</A>
  30          - a list of required features and their status.
  31          <LI><A HREF="17_intro/COPYING">COPYING</A>
  32          - GPL v2 license terms
  33          <LI><A HREF="17_intro/DESIGN">DESIGN</A>
  34          - overview of the implementation plan
  35          <LI><A HREF="17_intro/HEADER_POLICY">HEADER_POLICY</A>
  36          - header naming and sub-include structure
  37          <LI><A HREF="17_intro/PROBLEMS">PROBLEMS</A>
  38          <!-- Linking to "../README" doesn't work; we are at the top level
  39               of the web pages.  Punt.  -->
  40          <LI>README - directory structure
  41          <LI><A HREF="17_intro/RELEASE-NOTES">RELEASE-NOTES</A>
  42          - instructions for building, using
  43          <LI><A HREF="17_intro/TODO">TODO</A>
  44          - tasks and known bugs
  45          <LI><A HREF="17_intro/organization">organization</A>
  46          <LI><A HREF="17_intro/contribute.html">Contributor checklist</A>
  47          <LI><A HREF="17_intro/libstdc++-assign.txt">Copyright assignment form for libstdc++-v3</A>
  48       </UL>
  49
  50 <HR>
  51 <H2><A NAME="2">Configuring, Building, Installing</A></H2>
  52       <UL>
  53         <LI><A HREF="configopts.html">Configure options</A>
  54         <LI><A HREF="install.html">Getting started: configure, build, install</A><BR>
  55       </UL>
  56
  57 <HR>
  58 <H2><A NAME="3">Chapter-Specific Information, Extensions, Notes and Advice</A></H2>
  59       <OL>
  60          <LI><A HREF="17_intro/howto.html">Chapter 17 (Intro)</A>
  61          <LI><A HREF="18_support/howto.html">Chapter 18 (Library Support)</A>
  62          <LI><A HREF="19_diagnostics/howto.html">Chapter 19 (Diagnostics)</A>
  63          <LI><A HREF="20_util/howto.html">Chapter 20 (Utilities)</A>
  64          <LI><A HREF="21_strings/howto.html">Chapter 21 (Strings)</A>
  65          <LI><A HREF="22_locale/howto.html">Chapter 22 (Localization)</A>
  66          <LI><A HREF="23_containers/howto.html">Chapter 23 (Containers)</A>
  67          <LI><A HREF="24_iterators/howto.html">Chapter 24 (Iterators)</A>
  68          <LI><A HREF="25_algorithms/howto.html">Chapter 25 (Algorithms)</A>
  69          <LI><A HREF="26_numerics/howto.html">Chapter 26 (Numerics)</A>
  70          <LI><A HREF="27_io/howto.html">Chapter 27 (I/O)</A>
  71          <LI><A HREF="ext/howto.html">Extensions to the Standard Library</A>
  72       </OL>
  73
  74 <HR>
  75 <H2><A NAME="4">Source Documentation</A></H2>
  76 <P>In addition to the distribution documentation (these pages), we also
  77    have a set of HTML documents generated from the sources themselves,
  78    using the Doxygen tool.  These are useful for examining the signatures
  79    of public member functions for the library classes, etc.
  80 </P>
  81 <P>
  82    The latest
  83    collection is libstdc++-doxygen-20010501.tar.gz (3.7MB), available in
  84    the libstdc++ snapshots directory at
  85    <TT>&lt;URL:ftp://gcc.gnu.org/pub/gcc/libstdc++/&gt;</TT>.  You will
  86    almost certainly need to use one of the
  87    <A HREF="http://gcc.gnu.org/mirrors.html">mirror sites</A> to download
  88    the tarball.  After unpacking, simply load
  89    libstdc++-doxygen-20010501/index.html in a browser.  You can also
  90    browse the same collection
  91    <A HREF="libstdc++-doxygen-20010501/index.html">online</A>.
  92    Feedback (and additional documentation!) is welcome.
  93 </P>
  94
  95
  96 </BODY>
  97 </HTML>