diff options
author | Phil Edwards <pme@gcc.gnu.org> | 2003-07-16 23:59:54 +0000 |
---|---|---|
committer | Phil Edwards <pme@gcc.gnu.org> | 2003-07-16 23:59:54 +0000 |
commit | 1ef4a5d4c3f780623ed85b66fe7412c5afe85d81 (patch) | |
tree | 4092c31014cacaeeb2be24e0172f406eb56500fb /libstdc++-v3/docs/doxygen/mainpage.html | |
parent | fada196198e4c9350a78fe08c7a132bb4055ba05 (diff) | |
download | gcc-1ef4a5d4c3f780623ed85b66fe7412c5afe85d81.zip gcc-1ef4a5d4c3f780623ed85b66fe7412c5afe85d81.tar.gz gcc-1ef4a5d4c3f780623ed85b66fe7412c5afe85d81.tar.bz2 |
mainpage.html: Move building/writing instructions...
2003-07-16 Phil Edwards <pme@gcc.gnu.org>
* docs/doxygen/mainpage.html: Move building/writing instructions...
* docs/doxygen/guide.html: ...to here. New file.
From-SVN: r69485
Diffstat (limited to 'libstdc++-v3/docs/doxygen/mainpage.html')
-rw-r--r-- | libstdc++-v3/docs/doxygen/mainpage.html | 52 |
1 files changed, 7 insertions, 45 deletions
diff --git a/libstdc++-v3/docs/doxygen/mainpage.html b/libstdc++-v3/docs/doxygen/mainpage.html index e0998fc..fdd40ed 100644 --- a/libstdc++-v3/docs/doxygen/mainpage.html +++ b/libstdc++-v3/docs/doxygen/mainpage.html @@ -42,47 +42,6 @@ additional notes and additional classes/functions/etc. </p> -<p>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="namespaces.html">Namespace 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 rules <code> 'make doxygen' </code> and - <code> 'make doxygen-maint' </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.png" 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> - -<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> @@ -99,14 +58,18 @@ href="http://gcc.gnu.org/onlinedocs/libstdc++/17_intro/C++STYLE">C++STYLE</a>. </ul> </p> +<h2>Generating the documentation</h2> +<p>These HTML pages are automatically generated, along with the man pages. + See <code>docs/doxygen/guide.html</code> in the source tree for how to + create (and write) the pages. -<h2> License, Copyright, and Other Lawyerly Verbosity </h2> +<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: +<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 @@ -126,4 +89,3 @@ href="http://gcc.gnu.org/onlinedocs/libstdc++/17_intro/C++STYLE">C++STYLE</a>. </body> </html> - |