mirror of
https://github.com/boostorg/website.git
synced 2026-01-27 07:22:15 +00:00
367 lines
23 KiB
HTML
367 lines
23 KiB
HTML
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
|
<!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>Reference</title><link rel="stylesheet" href="../../../../doc/style/html/main.css" type="text/css" /><meta name="generator" content="DocBook XSL Stylesheets V1.72.0" /><link rel="start" href="index.html" title="Boostbook" /><link rel="up" href="index.html" title="Boostbook" /><link rel="prev" href="boostbook/boostbook_html_params.html" title="Boostbook HTML params" /><link rel="next" href="boostbook/dtd/class-specialization.html" title="BoostBook element class-specialization" /><script type="text/javascript" src="../../../../doc/javascript/main.js"></script>
|
|
<script type="text/javascript" > <!--
|
|
boostscript.init( new Array(
|
|
boostscript.nested_links,
|
|
boostscript.style_switcher,
|
|
boostscript.common
|
|
),
|
|
'../../../../doc/javascript'
|
|
);
|
|
//--></script>
|
|
|
|
<script type="text/javascript" > <!--
|
|
boostscript.call( boostscript.style_switcher, 'include_alternate_stylesheets',
|
|
'../../../../doc/style/html/syntax.xml',
|
|
'../../../../doc/style/html'
|
|
);
|
|
//--></script>
|
|
<link rel="alternate stylesheet" type="text/css" title="Quickbook source" href="../../../../doc/style/html/conversion/boostbook_to_quickbook.css" />
|
|
<script type="text/javascript" > <!--
|
|
boostscript.call( boostscript.style_switcher, 'load_user_stylesheet' );
|
|
//--></script>
|
|
</head>
|
|
<body>
|
|
<div id="heading">
|
|
<div id="heading-placard"></div>
|
|
<div class="heading-navigation-box">
|
|
<div class="nested-links-select-box" id="chapters_select_box">
|
|
<script type="text/javascript" > <!--
|
|
boostscript.call( boostscript.nested_links, 'select_box',
|
|
'chapters_select_box',
|
|
'../../../../doc/chapters.xml',
|
|
'../../../../libs');
|
|
//--></script>
|
|
</div>
|
|
<div class="nested-links-select-box" id="sections_select_box">
|
|
<script type="text/javascript" > <!--
|
|
boostscript.call( boostscript.nested_links, 'select_box',
|
|
'sections_select_box',
|
|
'sections.xml',
|
|
'./');
|
|
//--></script>
|
|
</div>
|
|
</div>
|
|
<div class="search-box">
|
|
<form id="cref" action="http://google.com/cse">
|
|
<div class="search-box-label"></div>
|
|
<div>
|
|
<input type="hidden" name="cref" value="http://tinyurl.com/33np8c" />
|
|
<input class="search-box" type="text" name="q" id="q" size="40" maxlength="255" alt="Search Text" />
|
|
</div>
|
|
</form>
|
|
</div>
|
|
</div>
|
|
<div class="spirit-nav">
|
|
<div class="spirit-nav-icon">
|
|
<a accesskey="p" href="boostbook/boostbook_html_params.html">
|
|
<div class="prev-icon"></div>
|
|
</a>
|
|
</div>
|
|
<div class="spirit-nav-icon">
|
|
<a accesskey="u" href="index.html">
|
|
<div class="up-icon"></div>
|
|
</a>
|
|
</div>
|
|
<div class="spirit-nav-icon">
|
|
<a accesskey="h" href="index.html">
|
|
<div class="home-icon"></div>
|
|
</a>
|
|
</div>
|
|
<div class="spirit-nav-icon">
|
|
<a accesskey="n" href="boostbook/dtd/class-specialization.html">
|
|
<div class="next-icon"></div>
|
|
</a>
|
|
</div>
|
|
</div>
|
|
<div id="body">
|
|
<div id="body-inner">
|
|
<div id="content">
|
|
<div class="section">
|
|
<div class="titlepage">
|
|
<div>
|
|
<div>
|
|
<h2 class="title"><a id="reference"></a>Reference</h2>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<p>Elements:</p>
|
|
<div class="itemizedlist">
|
|
<ul compact="compact">
|
|
<li>
|
|
<a href="boostbook/dtd/boostbook.html" title="BoostBook element boostbook">Element <code class="sgmltag-element">boostbook</code> - Defines a BoostBook book</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/class.html" title="BoostBook element class">Element <code class="sgmltag-element">class</code> - Declares a class or class template</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/class-specialization.html" title="BoostBook element class-specialization">Element <code class="sgmltag-element">class-specialization</code> - A specialization (partial or full) of a class template</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/code.html" title="BoostBook element code">Element <code class="sgmltag-element">code</code> - Mimics the <code class="sgmltag-element">code</code> tag in HTML</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/compile-fail-test.html" title="BoostBook element compile-fail-test">Element <code class="sgmltag-element">compile-fail-test</code> - A testcase that should fail to compile</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/compile-test.html" title="BoostBook element compile-test">Element <code class="sgmltag-element">compile-test</code> - A testcase that should compile correctly</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/complexity.html" title="BoostBook element complexity">Element <code class="sgmltag-element">complexity</code> - The time/space/etc. complexity of a function</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/constructor.html" title="BoostBook element constructor">Element <code class="sgmltag-element">constructor</code> - Declares a constructor of the enclosing class</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/copy-assignment.html" title="BoostBook element copy-assignment">Element <code class="sgmltag-element">copy-assignment</code> - Declares a copy-assignment operator</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/data-member.html" title="BoostBook element data-member">Element <code class="sgmltag-element">data-member</code> - Declares a data member of a class</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/default.html" title="BoostBook element default">Element <code class="sgmltag-element">default</code> - The default value of a function or template parameter</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/description.html" title="BoostBook element description">Element <code class="sgmltag-element">description</code> - Detailed description of a construct</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/destructor.html" title="BoostBook element destructor">Element <code class="sgmltag-element">destructor</code> - Declares a destructor for the enclosing class</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/effects.html" title="BoostBook element effects">Element <code class="sgmltag-element">effects</code> - Declares the side effects of a function</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/enum.html" title="BoostBook element enum">Element <code class="sgmltag-element">enum</code> - Declares an enumeration type</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/enumvalue.html" title="BoostBook element enumvalue">Element <code class="sgmltag-element">enumvalue</code> - A single value of an enumeration</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/free-function-group.html" title="BoostBook element free-function-group">Element <code class="sgmltag-element">free-function-group</code> - A set of functions that are grouped together under one name</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/function.html" title="BoostBook element function">Element <code class="sgmltag-element">function</code> - Declares a function</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/functionname.html" title="BoostBook element functionname">Element <code class="sgmltag-element">functionname</code> - References a function with the given name</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/header.html" title="BoostBook element header">Element <code class="sgmltag-element">header</code> - Declares a C++ header with the given name</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/if-fails.html" title="BoostBook element if-fails">Element <code class="sgmltag-element">if-fails</code> - What it means when a testcase fails</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/inherit.html" title="BoostBook element inherit">Element <code class="sgmltag-element">inherit</code> - Declares a base class of the enclosing class or struct</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/lib.html" title="BoostBook element lib">Element <code class="sgmltag-element">lib</code> - A library dependency</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/library.html" title="BoostBook element library">Element <code class="sgmltag-element">library</code> - Top-level element for a library</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/library-reference.html" title="BoostBook element library-reference">Element <code class="sgmltag-element">library-reference</code> - Declares the reference material for a library</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/librarycategory.html" title="BoostBook element librarycategory">Element <code class="sgmltag-element">librarycategory</code> - Declares that the enclosing library is in this category</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/librarycategorydef.html" title="BoostBook element librarycategorydef">Element <code class="sgmltag-element">librarycategorydef</code> - Defines a new library category</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/librarycategorylist.html" title="BoostBook element librarycategorylist">Element <code class="sgmltag-element">librarycategorylist</code> - Categorized listing of libraries</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/libraryinfo.html" title="BoostBook element libraryinfo">Element <code class="sgmltag-element">libraryinfo</code> - Provides information about a library</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/librarylist.html" title="BoostBook element librarylist">Element <code class="sgmltag-element">librarylist</code> - Placeholder for an alphabetical list of libraries</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/libraryname.html" title="BoostBook element libraryname">Element <code class="sgmltag-element">libraryname</code> - References a library of the given name</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/librarypurpose.html" title="BoostBook element librarypurpose">Element <code class="sgmltag-element">librarypurpose</code> - Describes in one short sentence or phrase the purpose of a library</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/link-fail-test.html" title="BoostBook element link-fail-test">Element <code class="sgmltag-element">link-fail-test</code> - Declares a test that should compile but fail to link</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/link-test.html" title="BoostBook element link-test">Element <code class="sgmltag-element">link-test</code> - Declares a test that should compile and link</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/method.html" title="BoostBook element method">Element <code class="sgmltag-element">method</code> - Declares a method, i.e., a member function</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/method-group.html" title="BoostBook element method-group">Element <code class="sgmltag-element">method-group</code> - A set of methods that are grouped together under one name</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/namespace.html" title="BoostBook element namespace">Element <code class="sgmltag-element">namespace</code> - Declares a namespace</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/notes.html" title="BoostBook element notes">Element <code class="sgmltag-element">notes</code> - Non-normative notes about a function's semantics</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/overloaded-function.html" title="BoostBook element overloaded-function">Element <code class="sgmltag-element">overloaded-function</code> - An overloaded function</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/overloaded-method.html" title="BoostBook element overloaded-method">Element <code class="sgmltag-element">overloaded-method</code> - An overloaded method</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/parameter.html" title="BoostBook element parameter">Element <code class="sgmltag-element">parameter</code> - A function parameter</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/paramtype.html" title="BoostBook element paramtype">Element <code class="sgmltag-element">paramtype</code> - The type of a function parameter</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/postconditions.html" title="BoostBook element postconditions">Element <code class="sgmltag-element">postconditions</code> - Conditions that must hold after the function returns</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/precondition.html" title="BoostBook element precondition">Element <code class="sgmltag-element">precondition</code> - Conditions that must be met prior to executing a function</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/programlisting.html" title="BoostBook element programlisting">Element <code class="sgmltag-element">programlisting</code> - A sample of program code</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/purpose.html" title="BoostBook element purpose">Element <code class="sgmltag-element">purpose</code> - A short description of an entity's use</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/rationale.html" title="BoostBook element rationale">Element <code class="sgmltag-element">rationale</code> - Describes the rationale for a particular function's design</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/requirement.html" title="BoostBook element requirement">Element <code class="sgmltag-element">requirement</code> - A requirement/property in the Jamfile for a testcase</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/requires.html" title="BoostBook element requires">Element <code class="sgmltag-element">requires</code> - Declares the requirements of a function</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/returns.html" title="BoostBook element returns">Element <code class="sgmltag-element">returns</code> - Description of the return value of a function</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/run-fail-test.html" title="BoostBook element run-fail-test">Element <code class="sgmltag-element">run-fail-test</code> - A testcase that should compile and link, but fail on execution</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/run-test.html" title="BoostBook element run-test">Element <code class="sgmltag-element">run-test</code> - A testcase that should compile, link, and execute</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/signature.html" title="BoostBook element signature">Element <code class="sgmltag-element">signature</code> - One signature of an overloaded function or method</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/snippet.html" title="BoostBook element snippet">Element <code class="sgmltag-element">snippet</code> - Pulls in a code snippet from a <code class="sgmltag-element">programlisting</code> element</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/source.html" title="BoostBook element source">Element <code class="sgmltag-element">source</code> - Defines source code for a test</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/specialization.html" title="BoostBook element specialization">Element <code class="sgmltag-element">specialization</code> - Defines the specialization arguments for a class specialization</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/static-constant.html" title="BoostBook element static-constant">Element <code class="sgmltag-element">static-constant</code> - Declares a static constant, e.g., <code class="computeroutput">const int foo = 5;</code>.</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/struct.html" title="BoostBook element struct">Element <code class="sgmltag-element">struct</code> - Declares a C++ struct</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/struct-specialization.html" title="BoostBook element struct-specialization">Element <code class="sgmltag-element">struct-specialization</code> - A specialization (full or partial) of a struct template</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/template.html" title="BoostBook element template">Element <code class="sgmltag-element">template</code> - Declares the template parameters of a class or function</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/template-arg.html" title="BoostBook element template-arg">Element <code class="sgmltag-element">template-arg</code> - A template argument in a specialization</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/template-nontype-parameter.html" title="BoostBook element template-nontype-parameter">Element <code class="sgmltag-element">template-nontype-parameter</code> - A nontype template parameter</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/template-type-parameter.html" title="BoostBook element template-type-parameter">Element <code class="sgmltag-element">template-type-parameter</code> - Declares a template type parameter</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/template-varargs.html" title="BoostBook element template-varargs">Element <code class="sgmltag-element">template-varargs</code> - Declares a variable-length list of template parameters</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/testsuite.html" title="BoostBook element testsuite">Element <code class="sgmltag-element">testsuite</code> - Describes a library testsuite</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/throws.html" title="BoostBook element throws">Element <code class="sgmltag-element">throws</code> - Description of the exceptions thrown by a function</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/type.html" title="BoostBook element type">Element <code class="sgmltag-element">type</code> - The type of an element or return type of a function</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/typedef.html" title="BoostBook element typedef">Element <code class="sgmltag-element">typedef</code> - Declares a typedef</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/union.html" title="BoostBook element union">Element <code class="sgmltag-element">union</code> - Declares a C++ union or union template</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/union-specialization.html" title="BoostBook element union-specialization">Element <code class="sgmltag-element">union-specialization</code> - A specialization (full or partial) of a union template</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/using-class.html" title="BoostBook element using-class">Element <code class="sgmltag-element">using-class</code> - Injects the method and function names of a class into the local scope</a>
|
|
</li>
|
|
<li>
|
|
<a href="boostbook/dtd/using-namespace.html" title="BoostBook element using-namespace">Element <code class="sgmltag-element">using-namespace</code> - Injects the declared names from a namespace into the local scope</a>
|
|
</li>
|
|
</ul>
|
|
</div>
|
|
</div>
|
|
</div>
|
|
<div class="clear"></div>
|
|
</div>
|
|
</div>
|
|
<div class="spirit-nav">
|
|
<div class="spirit-nav-icon">
|
|
<a accesskey="p" href="boostbook/boostbook_html_params.html">
|
|
<div class="prev-icon"></div>
|
|
</a>
|
|
</div>
|
|
<div class="spirit-nav-icon">
|
|
<a accesskey="u" href="index.html">
|
|
<div class="up-icon"></div>
|
|
</a>
|
|
</div>
|
|
<div class="spirit-nav-icon">
|
|
<a accesskey="h" href="index.html">
|
|
<div class="home-icon"></div>
|
|
</a>
|
|
</div>
|
|
<div class="spirit-nav-icon">
|
|
<a accesskey="n" href="boostbook/dtd/class-specialization.html">
|
|
<div class="next-icon"></div>
|
|
</a>
|
|
</div>
|
|
</div>
|
|
<div id="footer">
|
|
<div id="footer-left">
|
|
<div id="copyright">
|
|
<p>Copyright © 2003 -2005 Douglas Gregor</p>
|
|
</div>
|
|
<div id="license">
|
|
<p>Distributed under the
|
|
<a href="/LICENSE_1_0.txt" class="internal">Boost Software License, Version 1.0</a>.
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div id="footer-right">
|
|
<div id="banners">
|
|
<p id="banner-xhtml">
|
|
<a href="http://validator.w3.org/check?uri=referer" class="external">XHTML 1.0</a>
|
|
</p>
|
|
<p id="banner-css">
|
|
<a href="http://jigsaw.w3.org/css-validator/check/referer" class="external">CSS</a>
|
|
</p>
|
|
<p id="banner-sourceforge">
|
|
<a href="http://sourceforge.net" class="external">SourceForge</a>
|
|
</p>
|
|
</div>
|
|
</div>
|
|
<div class="clear"></div>
|
|
</div>
|
|
</body>
|
|
</html>
|