diff options
| author | pme <pme@138bc75d-0d04-0410-961f-82ee72b054a4> | 2002-02-05 00:14:37 +0000 |
|---|---|---|
| committer | pme <pme@138bc75d-0d04-0410-961f-82ee72b054a4> | 2002-02-05 00:14:37 +0000 |
| commit | ca33b868ea1fe9b7202647264b15a35afd1b32eb (patch) | |
| tree | 59af872e275659095bb92bbd4026564bbcfaa4b1 /libstdc++-v3/docs/doxygen/mainpage.html | |
| parent | 842e01df84797a64c6d35648978dba611fa304c0 (diff) | |
| download | gcc-ca33b868ea1fe9b7202647264b15a35afd1b32eb.tar.gz | |
2002-02-04 Phil Edwards <pme@gcc.gnu.org>
* docs/doxygen/TODO: Impl-defined behavior now documented...
* docs/html/17_intro/howto.html: ...here.
* docs/doxygen/mainpage.doxy: Remove, rename...
* docs/doxygen/mainpage.html: ...to this. Tweak HTML, add license.
* docs/doxygen/style.css: Add small text.
* docs/doxygen/run_doxygen: Adjust for new mainpage.
* docs/doxygen/user.cfg.in: Likewise.
2002-02-04 Stephan Buys <s.buys@icon.co.za>
* include/bits/stl_map.h: Initial doxygen markup.
* include/std/std_fstream.h: Initial doxygen markup.
git-svn-id: svn+ssh://gcc.gnu.org/svn/gcc/trunk@49502 138bc75d-0d04-0410-961f-82ee72b054a4
Diffstat (limited to 'libstdc++-v3/docs/doxygen/mainpage.html')
| -rw-r--r-- | libstdc++-v3/docs/doxygen/mainpage.html | 130 |
1 files changed, 130 insertions, 0 deletions
diff --git a/libstdc++-v3/docs/doxygen/mainpage.html b/libstdc++-v3/docs/doxygen/mainpage.html new file mode 100644 index 00000000000..d7b1c436d29 --- /dev/null +++ b/libstdc++-v3/docs/doxygen/mainpage.html @@ -0,0 +1,130 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> +<html> +<head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> +<title>Main Page</title> +<link href="style.css" rel="stylesheet" type="text/css"> +</head> + +<body bgcolor="#ffffff"> +<!-- + Originally generated by Doxygen 1.2.12. + + This used to be surrounded by /* */ marks and tagged with @mainpage, so + that Doxygen would create the index page from it. HOWEVER, Doxygen + ignores all but the most basic HTML tags, and even with those it strips + all the attributes. (See, the HTML you write for @mainpage isn't used + directly; it all gets run through Doxygen and re-output.) So lots of + tags were all being mangled. + + Funk 'dat. Now we let Doxygen do whateer it feels like doing for the + index page, and then we just flat copy this over top of it. Voila! + Tags actually work like they're supposed to. +--> + +<h1>libstdc++-v3 Source Documentation</h1> + +<h2> Documentation Overview </h2> + +<p class="smallertext">Generated 2002-02-04.</p> + +<p>There are two types of documentation for libstdc++-v3. One is the + distribution documentation, which can be read online at + <a href="http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html">http://gcc.gnu.org/onlinedocs/libstdc++/documentation.html</a> + or offline from docs/html/documentation.html in the library source + directory. +</p> + +<p>The other type is the source documentation, of which this is the first page. + Here are quick links to the pages which we seem to use the most; a full + index is at the bottom: + <!-- Keep this in sync with below. --> + <ul> + <li><a href="annotated.html">Compound List</a> + <li><a href="classes.html">Alphabetical List</a> + <li><a href="files.html">File List</a> + <li><a href="modules.html">Modules</a> + </ul> +</p> + +<h2> Generating this file </h2> +<p>These HTML pages are automatically generated, along with the man pages. + The Makefile rule <code> 'make + doxygen' </code> in the libstdc++-v3 build directory generates these pages + using a tool called, appropriately enough, Doxygen. To learn more about + Doxygen, take a look at + <a href="http://www.doxygen.org/"> + <!-- snagged from the generated page --> + <img src="doxygen.gif" alt="the Doxygen homepage" + align=center border=0 width=110 height=53> + </a> +</p> + +<p>The libstdc++-v3 configuration files needed to generate doxygen output + are located: + <ul><li><code>docs/doxygen/user.cfg.in</code> + <li><code>docs/doxygen/run_doxygen</code> + </ul> +</p> + +<h2> libstdc++-v3 doxygen style guide </h2> +<p>In general, libstdc++-v3 files should be formatted according to the + GNU C++ Coding Standard rules found in the file <a +href="http://gcc.gnu.org/onlinedocs/libstdc++/17_intro/C++STYLE">C++STYLE</a>. + Before any doxygen-specific formatting tweaks are made, please try to + make sure that the initial formatting is sound. +</p> + +<p>The formatting guidelines for using libstdc++-v3 with doxygen are still + incomplete. There seems to be a marginal preference for the use of + Java-Doc style formatting, with the idea that the single-line style + (triple-slash) is the least intrusive mechanism for getting libstdc++-v3 + documented and cross-referenced while at the same time minimizing + disruption to the current formatting. Full documentation of functions + (parameter types, return values, etc) will require the slash-splat-splat + "extended C" commenting style. +</p> + +<h2> Full page index </h2> +<p>Here are entry points to all the pages generated by Doxygen: + <ul> + <li><a href="index.html">Main Page</a> + <li><a href="modules.html">Modules</a> + <li><a href="namespaces.html">Namespace List</a> + <li><a href="hierarchy.html">Class Hierarchy</a> + <li><a href="classes.html">Alphabetical List</a> + <li><a href="annotated.html">Compound List</a> + <li><a href="files.html">File List</a> + <li><a href="namespacemembers.html">Namespace Members</a> + <li><a href="functions.html">Compound Members</a> + <li><a href="globals.html">File Members</a> + </ul> +</p> + + +<h2> License, Copyright, and Other Lawyerly Verbosity </h2> +<p>The libstdc++-v3 documentation is released under + <a href="http://gcc.gnu.org/onlinedocs/libstdc++/17_intro/license.html"> + these terms</a>. +</p> +<p>Part of the generated documentation involved comments + and notes from SGI, who says we gotta say this: + <blockquote> + 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. + <br><br> + Copyright © 1994 + Hewlett-Packard Company + </blockquote> +</p> +<p>Part of the generated documentation is quoted from the C++ standard, which + is copyright 1998 by Information Technology Industry Council. +</p> + +</body> +</html> + |