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