source: trunk/src/gcc/libstdc++-v3/docs/doxygen/mainpage.html@ 1392

Last change on this file since 1392 was 1392, checked in by bird, 22 years ago

This commit was generated by cvs2svn to compensate for changes in r1391,
which included commits to RCS files with non-trunk default branches.
  • Property cvs2svn:cvs-rev set to 1.1.1.2
  • Property svn:eol-style set to native
  • Property svn:executable set to *
File size: 5.1 KB
Line 
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++-v3 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++-v3 Source Documentation</h1>
25
26<h2>Documentation Overview</h2>
27
28<p class="smallertext">@LEVEL@-level docs, generated @DATE@.</p>
29
30<p>There are two types of documentation for libstdc++-v3. One is the
31 distribution documentation, which can be read online at
32 <a href="http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html">http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html</a>
33 or offline from docs/html/documentation.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 Both &quot;user-level&quot; and &quot;maintainer-level&quot; source
39 documentation is produced: user-level docs are for the users of this
40 library. The maint-level docs are for those interested in the underlying
41 workings of the library; they include all the user-level docs plus
42 additional notes and additional classes/functions/etc.
43</p>
44
45<p>Here are quick links to the pages which we seem to use the most; a full
46 index is at the bottom:
47 <!-- Keep this in sync with below. -->
48 <ul>
49 <li><a href="annotated.html">Compound List</a>
50 <li><a href="classes.html">Alphabetical List</a>
51 <li><a href="namespaces.html">Namespace List</a>
52 <li><a href="files.html">File List</a>
53 <li><a href="modules.html">Modules</a>
54 </ul>
55</p>
56
57<h2> Generating this file </h2>
58<p>These HTML pages are automatically generated, along with the man pages.
59 The Makefile rules <code> 'make doxygen' </code> and
60 <code> 'make doxygen-maint' </code> in the libstdc++-v3 build directory
61 generates these pages using a tool called, appropriately enough, Doxygen.
62 To learn more about Doxygen, take a look at
63 <a href="http://www.doxygen.org/">
64 <!-- snagged from the generated page -->
65 <img src="doxygen.png" alt="the Doxygen homepage"
66 align=center border=0 width=110 height=53>
67 </a>
68</p>
69
70<p>The libstdc++-v3 configuration files needed to generate doxygen output
71 are located:
72 <ul><li><code>docs/doxygen/user.cfg.in</code>
73 <li><code>docs/doxygen/run_doxygen</code>
74 </ul>
75</p>
76
77<h2> libstdc++-v3 doxygen style guide </h2>
78<p>In general, libstdc++-v3 files should be formatted according to the
79 GNU C++ Coding Standard rules found in the file <a
80href="http://gcc.gnu.org/onlinedocs/libstdc++/17_intro/C++STYLE">C++STYLE</a>.
81 Before any doxygen-specific formatting tweaks are made, please try to
82 make sure that the initial formatting is sound.
83</p>
84
85<h2> Full page index </h2>
86<p>Here are entry points to all the pages generated by Doxygen:
87 <ul>
88 <li><a href="index.html">Main Page</a>
89 <li><a href="modules.html">Modules</a>
90 <li><a href="namespaces.html">Namespace List</a>
91 <li><a href="hierarchy.html">Class Hierarchy</a>
92 <li><a href="classes.html">Alphabetical List</a>
93 <li><a href="annotated.html">Compound List</a>
94 <li><a href="files.html">File List</a>
95 <li><a href="namespacemembers.html">Namespace Members</a>
96 <li><a href="functions.html">Compound Members</a>
97 <li><a href="globals.html">File Members</a>
98 <li><a href="todo.html">TODO List</a> (This is incomplete... how ironic.)
99 </ul>
100</p>
101
102
103<h2> License, Copyright, and Other Lawyerly Verbosity </h2>
104<p>The libstdc++-v3 documentation is released under
105 <a href="http://gcc.gnu.org/onlinedocs/libstdc++/17_intro/license.html">
106 these terms</a>.
107</p>
108<p>Part of the generated documentation involved comments
109 and notes from SGI, who says we gotta say this:
110 <blockquote>
111 Permission to use, copy, modify, distribute and sell this software and its
112 documentation for any purpose is hereby granted without fee, provided
113 that the below copyright notice appears in all copies and that both
114 the copyright notice and this permission notice appear in supporting
115 documentation. Silicon Graphics makes no representations about the
116 suitability of this software for any purpose. It is provided "as is"
117 without express or implied warranty.
118 <br><br>
119 Copyright &copy; 1994
120 Hewlett-Packard Company
121 </blockquote>
122</p>
123<p>Part of the generated documentation is quoted from the ISO C++ Standard,
124 which is Copyright &copy; 1998 by Information Technology Industry Council.
125</p>
126
127</body>
128</html>
129
Note: See TracBrowser for help on using the repository browser.