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