xref: /netbsd-src/external/gpl3/gcc.old/dist/libstdc++-v3/doc/html/api.html (revision 8feb0f0b7eaff0608f8350bbfa3098827b4bb91b)
136ac495dSmrg<?xml version="1.0" encoding="UTF-8" standalone="no"?>
236ac495dSmrg<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>The GNU C++ Library API Reference</title><meta name="generator" content="DocBook XSL Stylesheets Vsnapshot" /><meta name="keywords" content="ISO C++, runtime, library" /><link rel="home" href="index.html" title="The GNU C++ Library" /><link rel="up" href="bk02.html" title="" /><link rel="prev" href="bk02.html" title="" /><link rel="next" href="bk03.html" title="" /></head><body><div class="navheader"><table width="100%" summary="Navigation header"><tr><th colspan="3" align="center">The GNU C++ Library API Reference</th></tr><tr><td width="20%" align="left"><a accesskey="p" href="bk02.html">Prev</a> </td><th width="60%" align="center"></th><td width="20%" align="right"> <a accesskey="n" href="bk03.html">Next</a></td></tr></table><hr /></div><div class="article"><div class="titlepage"><div><div><h1 class="title"><a id="api"></a>The GNU C++ Library API Reference</h1></div><div><p class="copyright">Copyright ©
336ac495dSmrg      2008
436ac495dSmrg    ,
536ac495dSmrg      2010
636ac495dSmrg    ,
736ac495dSmrg      2014
836ac495dSmrg
9a2dc1f3fSmrg      <a class="link" href="https://www.fsf.org" target="_top">FSF
1036ac495dSmrg      </a>
1136ac495dSmrg    </p></div><div><div class="legalnotice"><a id="id-1.4.1.2.2"></a><p>
1236ac495dSmrg      <a class="link" href="manual/license.html" title="License">License
1336ac495dSmrg      </a>
1436ac495dSmrg    </p></div></div></div><hr /></div><p>
1536ac495dSmrg  The GNU C++ library sources have been specially formatted so that
1636ac495dSmrg  with the proper invocation of another tool (Doxygen), a set of
1736ac495dSmrg  indexed reference material can generated from the sources files
1836ac495dSmrg  themselves. The resultant documentation is referred to as the API
1936ac495dSmrg  documentation, and is useful for examining the signatures of public
2036ac495dSmrg  member functions for the library classes, finding out what is in a
2136ac495dSmrg  particular include file, looking at inheritance diagrams, etc.
2236ac495dSmrg</p><p>
2336ac495dSmrg  The API documentation, rendered into HTML, can be viewed online
2436ac495dSmrg  <a class="link" href="http://gcc.gnu.org/onlinedocs/" target="_top">for each GCC release</a>
2536ac495dSmrg  and
2636ac495dSmrg  <a class="link" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/index.html" target="_top">
2736ac495dSmrg  for the main development tree
2836ac495dSmrg  </a>
2936ac495dSmrg  (see the date on the first page).
3036ac495dSmrg</p><p>
3136ac495dSmrg  The rendered HTML, as above, is also available for download on the
3236ac495dSmrg  gcc.gnu.org site in a directory located at
33*8feb0f0bSmrg   <code class="literal">&lt;URL:https://gcc.gnu.org/pub/gcc/libstdc++/doxygen/&gt;</code>.
3436ac495dSmrg   You will almost certainly need to use one of the
3536ac495dSmrg   <a class="link" href="http://gcc.gnu.org/mirrors.html" target="_top">mirror sites</a> to download
3636ac495dSmrg   the tarball. After unpacking, simply load libstdc++-html-*/index.html
3736ac495dSmrg   into a browser.
3836ac495dSmrg</p><p>
3936ac495dSmrg  In addition, a rendered set of man pages are available in the same
4036ac495dSmrg  location specified above. Start with C++Intro(3).
4136ac495dSmrg</p></div><div class="navfooter"><hr /><table width="100%" summary="Navigation footer"><tr><td width="40%" align="left"><a accesskey="p" href="bk02.html">Prev</a> </td><td width="20%" align="center"><a accesskey="u" href="bk02.html">Up</a></td><td width="40%" align="right"> <a accesskey="n" href="bk03.html">Next</a></td></tr><tr><td width="40%" align="left" valign="top"> </td><td width="20%" align="center"><a accesskey="h" href="index.html">Home</a></td><td width="40%" align="right" valign="top"> </td></tr></table></div></body></html>