OSDN Git Service

2008-02-11 Benjamin Kosnik <bkoz@redhat.com>
[pf3gnuchains/gcc-fork.git] / libstdc++-v3 / doc / doxygen / mainpage.html
1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2 <html>
3 <head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1">
4 <title>libstdc++ Source: Main Index</title>
5 <link href="style.css" rel="stylesheet" type="text/css">
6 </head>
7
8 <body bgcolor="#ffffff">
9 <!--
10      Originally generated by Doxygen 1.2.12.
11
12      This used to be surrounded by /* */ marks and tagged with @mainpage, so
13      that Doxygen would create the index page from it.  HOWEVER, Doxygen
14      ignores all but the most basic HTML tags, and even with those it strips
15      all the attributes.  (See, the HTML you write for @mainpage isn't used
16      directly; it all gets run through Doxygen and re-output.)  So lots of
17      tags were all being mangled.
18
19      Funk 'dat.  Now we let Doxygen do whatever it feels like doing for the
20      index page, and then we just flat copy this over top of it.  Voila!
21      Tags actually work like they're supposed to in HTML.
22 -->
23
24 <h1>libstdc++ Source Documentation</h1>
25
26 <h2>Documentation Overview</h2>
27
28 <p class="smallertext">Generated on @DATE@.</p>
29
30 <p>There are two types of documentation for libstdc++.  One is the
31    distribution documentation, which can be read online
32    <a href="http://gcc.gnu.org/onlinedocs/libstdc++/index.html">here</a>
33    or offline from the file doc/html/index.html in the library source
34    directory.
35 </p>
36
37 <p>The other type is the source documentation, of which this is the first page.
38 </p>
39
40 <p>Here are entry points to all the pages generated by Doxygen:
41    <ul>
42     <li><a href="modules.html">Modules</a>
43     <li><a href="namespaces.html">Namespace List</a>
44     <li><a href="hierarchy.html">Class List</a>
45     <li><a href="annotated.html">Class Annotated List</a>
46     <li><a href="classes.html">Class Alphabetical Index</a>
47     <li><a href="globals_func.html">Function Alphabetical List</a>
48     <li><a href="files.html">Source File List</a>
49     <li><a href="todo.html">TODO List</a> (This is incomplete... how ironic.)
50    </ul>
51 </p>
52
53 <p>If you are using Doxygen for your own projects, you can use
54    <a href="libstdc++.tag">a tag file for the appropriate version</a> and
55    an entry such as
56    <blockquote>
57    TAGFILES = "libstdc++.tag = 
58    http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen"
59    </blockquote>
60    Be sure to adjust the URL for the right version.  If you download a
61    local copy of the source documentation for faster viewing, you can use
62    the doxytag/installdox programs (part of Doxygen) to adjust the links
63    for you.
64 </p>
65
66 <h2>Generating the documentation</h2>
67 <p>These HTML pages are automatically generated, along with the man
68    pages.  See the section "Documentation Style"
69    in <code>doc/xml/manual/appendix_contributing.xml</code> in the
70    source tree for how to create (and write) the doxygen markup.
71   This style guide can also be viewed on the <a href="manual/bk01apas03.html">web</a>.
72
73 <h2>License, Copyright, and Other Lawyerly Verbosity</h2>
74 <p>The libstdc++ documentation is released under
75    <a href="manual/bk01pt01ch01s02.html">
76    these terms</a>.
77 </p>
78 <p>Part of the generated documentation involved comments and notes from
79    SGI, who says we gotta say this:
80    <blockquote>
81    Permission to use, copy, modify, distribute and sell this software and its
82    documentation for any purpose is hereby granted without fee, provided
83    that the below copyright notice appears in all copies and that both
84    the copyright notice and this permission notice appear in supporting
85    documentation. Silicon Graphics makes no representations about the
86    suitability of this software for any purpose. It is provided "as is"
87    without express or implied warranty.
88    <br><br>
89    Copyright &copy; 1994
90    Hewlett-Packard Company
91    </blockquote>
92 </p>
93 <p>Part of the generated documentation is quoted from the ISO C++ Standard,
94    which is Copyright &copy; 1998 by Information Technology Industry Council.
95 </p>
96
97 </body>
98 </html>