diff options
Diffstat (limited to 'libstdc++-v3/docs/doxygen')
| -rw-r--r-- | libstdc++-v3/docs/doxygen/TODO | 7 | ||||
| -rw-r--r-- | libstdc++-v3/docs/doxygen/mainpage.html (renamed from libstdc++-v3/docs/doxygen/mainpage.doxy) | 62 | ||||
| -rw-r--r-- | libstdc++-v3/docs/doxygen/run_doxygen | 1 | ||||
| -rw-r--r-- | libstdc++-v3/docs/doxygen/style.css | 1 | ||||
| -rw-r--r-- | libstdc++-v3/docs/doxygen/user.cfg.in | 3 |
5 files changed, 61 insertions, 13 deletions
diff --git a/libstdc++-v3/docs/doxygen/TODO b/libstdc++-v3/docs/doxygen/TODO index 0a8cfbb..da2f25a 100644 --- a/libstdc++-v3/docs/doxygen/TODO +++ b/libstdc++-v3/docs/doxygen/TODO @@ -30,13 +30,6 @@ ext/* Some of the SGI algorithm/functional extensions. __gnu_cxx Tricky. Right now ext/* are in this namespace. -[1.3.5] "implementation-defined behavior: behavior ... that depends - on the implementation *and that each implementation shall - document*." [my emphasis] Not all implementation choices - have been thus described; doxygen is not necessarily the - appropriate place for such descriptions, either. I suggest - adding this list to the Chapter 17 HOWTO. - ----------------------------------------------------------- NOTES: diff --git a/libstdc++-v3/docs/doxygen/mainpage.doxy b/libstdc++-v3/docs/doxygen/mainpage.html index b3a4d29..d7b1c43 100644 --- a/libstdc++-v3/docs/doxygen/mainpage.doxy +++ b/libstdc++-v3/docs/doxygen/mainpage.html @@ -1,7 +1,32 @@ -/*! \mainpage +<!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> @@ -26,8 +51,12 @@ 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">the Doxygen - webpage</a>. + 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 @@ -71,6 +100,31 @@ href="http://gcc.gnu.org/onlinedocs/libstdc++/17_intro/C++STYLE">C++STYLE</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> diff --git a/libstdc++-v3/docs/doxygen/run_doxygen b/libstdc++-v3/docs/doxygen/run_doxygen index 18866da..e93c947 100644 --- a/libstdc++-v3/docs/doxygen/run_doxygen +++ b/libstdc++-v3/docs/doxygen/run_doxygen @@ -146,6 +146,7 @@ set -e set +e test $do_html = yes && { + cp ${srcdir}/docs/doxygen/mainpage.html ${outdir}/html_${mode}/index.html echo :: echo :: HTML pages begin with echo :: ${outdir}/html_${mode}/index.html diff --git a/libstdc++-v3/docs/doxygen/style.css b/libstdc++-v3/docs/doxygen/style.css index 5b03b69..5e43005 100644 --- a/libstdc++-v3/docs/doxygen/style.css +++ b/libstdc++-v3/docs/doxygen/style.css @@ -21,3 +21,4 @@ FONT.comment { color: #800000 } FONT.preprocessor { color: #806020 } FONT.stringliteral { color: #002080 } FONT.charliteral { color: #008080 } +.smallertext { font-size: smaller } diff --git a/libstdc++-v3/docs/doxygen/user.cfg.in b/libstdc++-v3/docs/doxygen/user.cfg.in index b6baf6d..430194b 100644 --- a/libstdc++-v3/docs/doxygen/user.cfg.in +++ b/libstdc++-v3/docs/doxygen/user.cfg.in @@ -296,8 +296,7 @@ WARN_LOGFILE = # directories like "/usr/src/myproject". Separate the files or directories # with spaces. -INPUT = @srcdir@/docs/doxygen/mainpage.doxy \ - @srcdir@/docs/doxygen/doxygroups.cc \ +INPUT = @srcdir@/docs/doxygen/doxygroups.cc \ @srcdir@/src \ @srcdir@/libsupc++/exception \ @srcdir@/libsupc++/new \ |