14fee23f9Smrg<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN"> 24fee23f9Smrg<html> 34fee23f9Smrg<head><meta http-equiv="Content-Type" content="text/html;charset=iso-8859-1"> 44fee23f9Smrg<title>libstdc++ Source: Main Index</title> 54fee23f9Smrg</head> 64fee23f9Smrg 74fee23f9Smrg<body bgcolor="#ffffff"> 84fee23f9Smrg<!-- 94fee23f9Smrg Originally generated by Doxygen 1.2.12. 104fee23f9Smrg 114fee23f9Smrg This used to be surrounded by /* */ marks and tagged with @mainpage, so 124fee23f9Smrg that Doxygen would create the index page from it. HOWEVER, Doxygen 134fee23f9Smrg ignores all but the most basic HTML tags, and even with those it strips 144fee23f9Smrg all the attributes. (See, the HTML you write for @mainpage isn't used 154fee23f9Smrg directly; it all gets run through Doxygen and re-output.) So lots of 164fee23f9Smrg tags were all being mangled. 174fee23f9Smrg 184fee23f9Smrg Funk 'dat. Now we let Doxygen do whatever it feels like doing for the 194fee23f9Smrg index page, and then we just flat copy this over top of it. Voila! 204fee23f9Smrg Tags actually work like they're supposed to in HTML. 214fee23f9Smrg--> 224fee23f9Smrg 234fee23f9Smrg<h1>libstdc++ Source Documentation</h1> 244fee23f9Smrg 254fee23f9Smrg<h2>Documentation Overview</h2> 264fee23f9Smrg 274fee23f9Smrg<p class="smallertext">Generated on @DATE@.</p> 284fee23f9Smrg 294fee23f9Smrg<p>There are two types of documentation for libstdc++. One is the 304fee23f9Smrg distribution documentation, which can be read online 31*d79abf08Smrg <a href="https://gcc.gnu.org/onlinedocs/libstdc++/index.html">here</a> 324fee23f9Smrg or offline from the file doc/html/index.html in the library source 334fee23f9Smrg directory. 344fee23f9Smrg</p> 354fee23f9Smrg 364fee23f9Smrg<p>The other type is the source documentation, of which this is the first page. 374fee23f9Smrg</p> 384fee23f9Smrg 394fee23f9Smrg<p>Here are entry points to all the pages generated by Doxygen: 404fee23f9Smrg <ul> 414fee23f9Smrg <li><a href="modules.html">Modules</a></li> 424fee23f9Smrg 434fee23f9Smrg <li>Namespaces 444fee23f9Smrg <ul> 454fee23f9Smrg <li><a href="namespaces.html">List</a></li> 464fee23f9Smrg <li><a href="namespacemembers.html">Members</a></li> 474fee23f9Smrg </ul> 484fee23f9Smrg </li> 494fee23f9Smrg 504fee23f9Smrg <li>Classes 514fee23f9Smrg <ul> 524fee23f9Smrg <li><a href="classes.html">List</a></li> 534fee23f9Smrg <li><a href="hierarchy.html">Hierarchy</a></li> 544fee23f9Smrg <li><a href="functions.html">Members</a></li> 554fee23f9Smrg </ul> 564fee23f9Smrg </li> 574fee23f9Smrg 584fee23f9Smrg <li><a href="files.html">Source Files</a></li> 594fee23f9Smrg <li><a href="todo.html">TODO List</a></li> 604fee23f9Smrg </ul> 614fee23f9Smrg</p> 624fee23f9Smrg 634fee23f9Smrg<p>If you are using Doxygen for your own projects, you can use 644fee23f9Smrg <a href="libstdc++.tag">a tag file for the appropriate version</a> and 654fee23f9Smrg an entry such as 664fee23f9Smrg <blockquote> 674fee23f9Smrg TAGFILES = "libstdc++.tag = 684fee23f9Smrg http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen" 694fee23f9Smrg </blockquote> 704fee23f9Smrg Be sure to adjust the URL for the right version. If you download a 714fee23f9Smrg local copy of the source documentation for faster viewing, you can use 724fee23f9Smrg the doxytag/installdox programs (part of Doxygen) to adjust the links 734fee23f9Smrg for you. 744fee23f9Smrg</p> 754fee23f9Smrg 764fee23f9Smrg<h2>Generating the documentation</h2> 774fee23f9Smrg<p>These HTML pages are automatically generated, along with the man 784fee23f9Smrg pages. See the section "Documentation Style" 794fee23f9Smrg in <code>doc/xml/manual/appendix_contributing.xml</code> in the 804fee23f9Smrg source tree for how to create (and write) the doxygen markup. 81*d79abf08Smrg This style guide can also be viewed on the <a href="https://gcc.gnu.org/onlinedocs/libstdc++/manual/documentation_hacking.html">web</a>. 824fee23f9Smrg 834fee23f9Smrg<h2>License, Copyright, and Other Lawyerly Verbosity</h2> 844fee23f9Smrg<p>The libstdc++ documentation is released under 85*d79abf08Smrg <a href="https://gcc.gnu.org/onlinedocs/libstdc++/manual/appendix_gpl.html"> 864fee23f9Smrg these terms</a>. 874fee23f9Smrg</p> 884fee23f9Smrg<p>Part of the generated documentation involved comments and notes from 894fee23f9Smrg SGI, who says we gotta say this: 904fee23f9Smrg <blockquote> 914fee23f9Smrg Permission to use, copy, modify, distribute and sell this software and its 924fee23f9Smrg documentation for any purpose is hereby granted without fee, provided 934fee23f9Smrg that the below copyright notice appears in all copies and that both 944fee23f9Smrg the copyright notice and this permission notice appear in supporting 954fee23f9Smrg documentation. Silicon Graphics makes no representations about the 964fee23f9Smrg suitability of this software for any purpose. It is provided "as is" 974fee23f9Smrg without express or implied warranty. 984fee23f9Smrg <br><br> 994fee23f9Smrg Copyright © 1994 1004fee23f9Smrg Hewlett-Packard Company 1014fee23f9Smrg </blockquote> 1024fee23f9Smrg</p> 1034fee23f9Smrg<p>Part of the generated documentation is quoted from the ISO C++ Standard, 1044fee23f9Smrg which is Copyright © 1998 by Information Technology Industry Council. 1054fee23f9Smrg</p> 1064fee23f9Smrg 1074fee23f9Smrg</body> 1084fee23f9Smrg</html> 109