xref: /netbsd-src/external/gpl3/gcc/dist/libstdc++-v3/doc/html/api.html (revision fb8a8121f28072308659629b86cfb7c449bd93e1)
14fee23f9Smrg<?xml version="1.0" encoding="UTF-8" standalone="no"?>
2d79abf08Smrg<!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 ©
34fee23f9Smrg      2008
448fb7bfaSmrg    ,
548fb7bfaSmrg      2010
64d5abbe8Smrg    ,
74d5abbe8Smrg      2014
84fee23f9Smrg
9a3e9eb18Smrg      <a class="link" href="https://www.fsf.org" target="_top">FSF
104fee23f9Smrg      </a>
114d5abbe8Smrg    </p></div><div><div class="legalnotice"><a id="id-1.4.1.2.2"></a><p>
124fee23f9Smrg      <a class="link" href="manual/license.html" title="License">License
134fee23f9Smrg      </a>
144fee23f9Smrg    </p></div></div></div><hr /></div><p>
1548fb7bfaSmrg  The GNU C++ library sources have been specially formatted so that
1648fb7bfaSmrg  with the proper invocation of another tool (Doxygen), a set of
1748fb7bfaSmrg  indexed reference material can generated from the sources files
1848fb7bfaSmrg  themselves. The resultant documentation is referred to as the API
1948fb7bfaSmrg  documentation, and is useful for examining the signatures of public
2048fb7bfaSmrg  member functions for the library classes, finding out what is in a
2148fb7bfaSmrg  particular include file, looking at inheritance diagrams, etc.
224fee23f9Smrg</p><p>
233f4ceed9Smrg  The API documentation, rendered into HTML, can be viewed online
243f4ceed9Smrg  <a class="link" href="http://gcc.gnu.org/onlinedocs/" target="_top">for each GCC release</a>
253f4ceed9Smrg  and
263f4ceed9Smrg  <a class="link" href="http://gcc.gnu.org/onlinedocs/libstdc++/latest-doxygen/index.html" target="_top">
273f4ceed9Smrg  for the main development tree
284fee23f9Smrg  </a>
293f4ceed9Smrg  (see the date on the first page).
303f4ceed9Smrg</p><p>
3148fb7bfaSmrg  The rendered HTML, as above, is also available for download on the
324d5abbe8Smrg  gcc.gnu.org site in a directory located at
33*fb8a8121Smrg   <code class="literal">&lt;URL:https://gcc.gnu.org/pub/gcc/libstdc++/doxygen/&gt;</code>.
344fee23f9Smrg   You will almost certainly need to use one of the
3548fb7bfaSmrg   <a class="link" href="http://gcc.gnu.org/mirrors.html" target="_top">mirror sites</a> to download
364fee23f9Smrg   the tarball. After unpacking, simply load libstdc++-html-*/index.html
374fee23f9Smrg   into a browser.
384fee23f9Smrg</p><p>
3948fb7bfaSmrg  In addition, a rendered set of man pages are available in the same
4048fb7bfaSmrg  location specified above. Start with C++Intro(3).
4148fb7bfaSmrg</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>