From: rankoo Date: Sat, 14 Aug 2010 02:31:35 +0000 (+0000) Subject: DocBook API documentation X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=274afdb46eb9c75e26941f8a56c829156a5fe525;p=docbook-dsssl DocBook API documentation --- diff --git a/docbook/relaxng/api/doc/html/HTML.manifest b/docbook/relaxng/api/doc/html/HTML.manifest new file mode 100644 index 000000000..cde1dfc36 --- /dev/null +++ b/docbook/relaxng/api/doc/html/HTML.manifest @@ -0,0 +1,78 @@ +index.html +docbook/api/class-specialization.html +docbook/api/link-test.html +docbook/api/link-fail-test.html +docbook/api/typedef.html +docbook/api/static-constant.html +docbook/api/code.html +docbook/api/destructor.html +docbook/api/template-type-parameter.html +docbook/api/description.html +docbook/api/librarylist.html +docbook/api/library-reference.html +docbook/api/api.html +docbook/api/union.html +docbook/api/inherit.html +docbook/api/template-varargs.html +docbook/api/source.html +docbook/api/function.html +docbook/api/macroname.html +docbook/api/postconditions.html +docbook/api/compile-test.html +docbook/api/method.html +docbook/api/snippet.html +docbook/api/constructor.html +docbook/api/namespace.html +docbook/api/if-fails.html +docbook/api/headername.html +docbook/api/free-function-group.html +docbook/api/functionname.html +docbook/api/librarycategory.html +docbook/api/notes.html +docbook/api/data-member.html +docbook/api/specialization.html +docbook/api/union-specialization.html +docbook/api/throws.html +docbook/api/template-arg.html +docbook/api/globalname.html +docbook/api/method-group.html +docbook/api/requirement.html +docbook/api/precondition.html +docbook/api/paramtype.html +docbook/api/using-class.html +docbook/api/run-test.html +docbook/api/librarypurpose.html +docbook/api/copy-assignment.html +docbook/api/run-fail-test.html +docbook/api/template.html +docbook/api/compile-fail-test.html +docbook/api/returns.html +docbook/api/default.html +docbook/api/parameter.html +docbook/api/signature.html +docbook/api/overloaded-function.html +docbook/api/access.html +docbook/api/class.html +docbook/api/librarycategorydef.html +docbook/api/type.html +docbook/api/enumvalue.html +docbook/api/overloaded-method.html +docbook/api/programlisting.html +docbook/api/complexity.html +docbook/api/purpose.html +docbook/api/template-nontype-parameter.html +docbook/api/library.html +docbook/api/librarycategorylist.html +docbook/api/using-namespace.html +docbook/api/enumname.html +docbook/api/struct-specialization.html +docbook/api/struct.html +docbook/api/lib.html +docbook/api/enum.html +docbook/api/requires.html +docbook/api/effects.html +docbook/api/libraryname.html +docbook/api/libraryinfo.html +docbook/api/testsuite.html +docbook/api/header.html +docbook/api/rationale.html diff --git a/docbook/relaxng/api/doc/html/api.css b/docbook/relaxng/api/doc/html/api.css new file mode 100644 index 000000000..72b7efd2d --- /dev/null +++ b/docbook/relaxng/api/doc/html/api.css @@ -0,0 +1,600 @@ +/*============================================================================= + Copyright (c) 2004 Joel de Guzman + http://spirit.sourceforge.net/ + + Distributed under the Boost Software License, Version 1.0. (See accompany- + ing file LICENSE_1_0.txt or copy at http://www.boost.org/LICENSE_1_0.txt) +=============================================================================*/ + +/*============================================================================= + Body defaults +=============================================================================*/ + + body + { + margin: 1em; + font-family: sans-serif; + } + +/*============================================================================= + Paragraphs +=============================================================================*/ + + p + { + text-align: left; + font-size: 10pt; + line-height: 1.15; + } + +/*============================================================================= + Program listings +=============================================================================*/ + + /* Code on paragraphs */ + p tt.computeroutput + { + font-size: 9pt; + } + + pre.synopsis + { + font-size: 9pt; + margin: 1pc 4% 0pc 4%; + padding: 0.5pc 0.5pc 0.5pc 0.5pc; + } + + .programlisting, + .screen + { + font-size: 9pt; + display: block; + margin: 1pc 4% 0pc 4%; + padding: 0.5pc 0.5pc 0.5pc 0.5pc; + } + + /* Program listings in tables don't get borders */ + td .programlisting, + td .screen + { + margin: 0pc 0pc 0pc 0pc; + padding: 0pc 0pc 0pc 0pc; + } + +/*============================================================================= + Headings +=============================================================================*/ + + h1, h2, h3, h4, h5, h6 + { + text-align: left; + margin: 1em 0em 0.5em 0em; + font-weight: bold; + } + + h1 { font: 140% } + h2 { font: bold 140% } + h3 { font: bold 130% } + h4 { font: bold 120% } + h5 { font: italic 110% } + h6 { font: italic 100% } + + /* Top page titles */ + title, + h1.title, + h2.title + h3.title, + h4.title, + h5.title, + h6.title, + .refentrytitle + { + font-weight: bold; + margin-bottom: 1pc; + } + + h1.title { font-size: 140% } + h2.title { font-size: 140% } + h3.title { font-size: 130% } + h4.title { font-size: 120% } + h5.title { font-size: 110% } + h6.title { font-size: 100% } + + .section h1 + { + margin: 0em 0em 0.5em 0em; + font-size: 140%; + } + + .section h2 { font-size: 140% } + .section h3 { font-size: 130% } + .section h4 { font-size: 120% } + .section h5 { font-size: 110% } + .section h6 { font-size: 100% } + + /* Code on titles */ + h1 tt.computeroutput { font-size: 140% } + h2 tt.computeroutput { font-size: 140% } + h3 tt.computeroutput { font-size: 130% } + h4 tt.computeroutput { font-size: 130% } + h5 tt.computeroutput { font-size: 130% } + h6 tt.computeroutput { font-size: 130% } + + +/*============================================================================= + Author +=============================================================================*/ + + h3.author + { + font-size: 100% + } + +/*============================================================================= + Lists +=============================================================================*/ + + li + { + font-size: 10pt; + line-height: 1.3; + } + + /* Unordered lists */ + ul + { + text-align: left; + } + + /* Ordered lists */ + ol + { + text-align: left; + } + +/*============================================================================= + Links +=============================================================================*/ + + a + { + text-decoration: none; /* no underline */ + } + + a:hover + { + text-decoration: underline; + } + +/*============================================================================= + Spirit style navigation +=============================================================================*/ + + .spirit-nav + { + text-align: right; + } + + .spirit-nav a + { + color: white; + padding-left: 0.5em; + } + + .spirit-nav img + { + border-width: 0px; + } + +/*============================================================================= + Copyright footer +=============================================================================*/ + .copyright-footer + { + text-align: right; + font-size: 70%; + } + + .copyright-footer p + { + text-align: right; + font-size: 80%; + } + +/*============================================================================= + Table of contents +=============================================================================*/ + + .toc + { + margin: 1pc 4% 0pc 4%; + padding: 0.1pc 1pc 0.1pc 1pc; + font-size: 80%; + line-height: 1.15; + } + + .api-toc + { + float: right; + padding: 0.5pc; + } + + /* Code on toc */ + .toc .computeroutput { font-size: 120% } + +/*============================================================================= + Tables +=============================================================================*/ + + .table-title, + div.table p.title + { + margin-left: 4%; + padding-right: 0.5em; + padding-left: 0.5em; + } + + .informaltable table, + .table table + { + width: 92%; + margin-left: 4%; + margin-right: 4%; + } + + div.informaltable table, + div.table table + { + padding: 4px; + } + + /* Table Cells */ + div.informaltable table tr td, + div.table table tr td + { + padding: 0.5em; + text-align: left; + font-size: 9pt; + } + + div.informaltable table tr th, + div.table table tr th + { + padding: 0.5em 0.5em 0.5em 0.5em; + border: 1pt solid white; + font-size: 80%; + } + + table.simplelist + { + width: auto !important; + margin: 0em !important; + padding: 0em !important; + border: none !important; + } + table.simplelist td + { + margin: 0em !important; + padding: 0em !important; + text-align: left !important; + font-size: 9pt !important; + border: none !important; + } + +/*============================================================================= + Blurbs +=============================================================================*/ + + div.note, + div.tip, + div.important, + div.caution, + div.warning, + p.blurb + { + font-size: 9pt; /* A little bit smaller than the main text */ + line-height: 1.2; + display: block; + margin: 1pc 4% 0pc 4%; + padding: 0.5pc 0.5pc 0.5pc 0.5pc; + } + + p.blurb img + { + padding: 1pt; + } + +/*============================================================================= + Variable Lists +=============================================================================*/ + + div.variablelist + { + margin: 1em 0; + } + + /* Make the terms in definition lists bold */ + div.variablelist dl dt, + span.term + { + font-weight: bold; + font-size: 10pt; + } + + div.variablelist table tbody tr td + { + text-align: left; + vertical-align: top; + padding: 0em 2em 0em 0em; + font-size: 10pt; + margin: 0em 0em 0.5em 0em; + line-height: 1; + } + + div.variablelist dl dt + { + margin-bottom: 0.2em; + } + + div.variablelist dl dd + { + margin: 0em 0em 0.5em 2em; + font-size: 10pt; + } + + div.variablelist table tbody tr td p, + div.variablelist dl dd p + { + margin: 0em 0em 0.5em 0em; + line-height: 1; + } + +/*============================================================================= + Misc +=============================================================================*/ + + /* Title of books and articles in bibliographies */ + span.title + { + font-style: italic; + } + + span.underline + { + text-decoration: underline; + } + + span.strikethrough + { + text-decoration: line-through; + } + + /* Copyright, Legal Notice */ + div div.legalnotice p + { + text-align: left + } + +/*============================================================================= + Colors +=============================================================================*/ + + @media screen + { + body { + background-color: #FFFFFF; + color: #000000; + } + + /* Syntax Highlighting */ + .keyword { color: #0000AA; } + .identifier { color: #000000; } + .special { color: #707070; } + .preprocessor { color: #402080; } + .char { color: teal; } + .comment { color: #800000; } + .string { color: teal; } + .number { color: teal; } + .white_bkd { background-color: #FFFFFF; } + .dk_grey_bkd { background-color: #999999; } + + /* Links */ + a, a .keyword, a .identifier, a .special, a .preprocessor + a .char, a .comment, a .string, a .number + { + color: #005a9c; + } + + a:visited, a:visited .keyword, a:visited .identifier, + a:visited .special, a:visited .preprocessor a:visited .char, + a:visited .comment, a:visited .string, a:visited .number + { + color: #9c5a9c; + } + + h1 a, h2 a, h3 a, h4 a, h5 a, h6 a, + h1 a:hover, h2 a:hover, h3 a:hover, h4 a:hover, h5 a:hover, h6 a:hover, + h1 a:visited, h2 a:visited, h3 a:visited, h4 a:visited, h5 a:visited, h6 a:visited + { + text-decoration: none; /* no underline */ + color: #000000; + } + + /* Copyright, Legal Notice */ + .copyright + { + color: #666666; + font-size: small; + } + + div div.legalnotice p + { + color: #666666; + } + + /* Program listing */ + pre.synopsis + { + border: 1px solid #DCDCDC; + } + + .programlisting, + .screen + { + border: 1px solid #DCDCDC; + } + + td .programlisting, + td .screen + { + border: 0px solid #DCDCDC; + } + + /* Blurbs */ + div.note, + div.tip, + div.important, + div.caution, + div.warning, + p.blurb + { + border: 1px solid #DCDCDC; + } + + /* Table of contents */ + .toc + { + border: 1px solid #DCDCDC; + } + + /* Tables */ + div.informaltable table tr td, + div.table table tr td + { + border: 1px solid #DCDCDC; + } + + div.informaltable table tr th, + div.table table tr th + { + background-color: #F0F0F0; + border: 1px solid #DCDCDC; + } + + .copyright-footer + { + color: #8F8F8F; + } + + /* Misc */ + span.highlight + { + color: #00A000; + } + } + + @media print + { + /* Links */ + a + { + color: black; + } + + a:visited + { + color: black; + } + + .spirit-nav + { + display: none; + } + + /* Program listing */ + pre.synopsis + { + border: 1px solid gray; + } + + .programlisting, + .screen + { + border: 1px solid gray; + } + + td .programlisting, + td .screen + { + border: 0px solid #DCDCDC; + } + + /* Table of contents */ + .toc + { + border: 1px solid gray; + } + + .informaltable table, + .table table + { + border: 1px solid gray; + border-collapse: collapse; + } + + /* Tables */ + div.informaltable table tr td, + div.table table tr td + { + border: 1px solid gray; + } + + div.informaltable table tr th, + div.table table tr th + { + border: 1px solid gray; + } + + table.simplelist tr td + { + border: none !important; + } + + /* Misc */ + span.highlight + { + font-weight: bold; + } + } + +/*============================================================================= + Images +=============================================================================*/ + + span.inlinemediaobject img + { + vertical-align: middle; + } + +/*============================================================================== + Super and Subscript: style so that line spacing isn't effected, see + http://www.adobe.com/cfusion/communityengine/index.cfm?event=showdetails&productId=1&postId=5341 +==============================================================================*/ + +sup, +sub { + height: 0; + line-height: 1; + vertical-align: baseline; + _vertical-align: bottom; + position: relative; + +} + +sup { + bottom: 1ex; +} + +sub { + top: .5ex; +} diff --git a/docbook/relaxng/api/doc/html/docbook/api/access.html b/docbook/relaxng/api/doc/html/docbook/api/access.html new file mode 100644 index 000000000..a0daeaac9 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/access.html @@ -0,0 +1,89 @@ + + + +DocBook API Element access + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element access

+

+ access + — Declares an access specification for class members +

+
+
+

Synopsis

access ::= + (static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| method| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)+ +
+
+

Description

+

The access specifications of class members (public, private, or protected) may be determined by enclosing them in an <access> element.

+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the access specification, e.g. "public", "private", or "protected".
id#IMPLIEDCDATAA global identifier for this element
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/api.html b/docbook/relaxng/api/doc/html/docbook/api/api.html new file mode 100644 index 000000000..ea2eab9a0 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/api.html @@ -0,0 +1,90 @@ + + + +DocBook API Element api + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element api

+

+ api + — Defines an API +

+
+
+

Synopsis

api ::= + (title, (chapter| library)*) +
+
+

Description

+

This element is the topmost level defined by + main XML file for all API documentation

+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/class-specialization.html b/docbook/relaxng/api/doc/html/docbook/api/class-specialization.html new file mode 100644 index 000000000..ff151a2df --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/class-specialization.html @@ -0,0 +1,91 @@ + + + +DocBook API Element class-specialization + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element class-specialization

+

+ class-specialization + — A specialization (partial or full) of a class template +

+
+
+

Synopsis

class-specialization ::= + (template?, specialization?, inherit?, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/class.html b/docbook/relaxng/api/doc/html/docbook/api/class.html new file mode 100644 index 000000000..0800bc347 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/class.html @@ -0,0 +1,137 @@ + + + +DocBook API Element class + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element class

+

+ class + — Declares a class or class template +

+
+
+

Synopsis

class ::= + (template?, inherit*, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) +
+
+

Description

+

C++ classes and class templates are described via the + <class> element. Each class has a name (e.g., "any") given by + the name attribute, a purpose given by the + <purpose> element, documentation, and a set of types, + functions, base classes, and data members. Here is a minimal + definition of the boost::any class:

+ + 
<namespace name="boost">
+  <class name="any">
+    <purpose>
+      A class whose instances can hold instances of any type that satisfies
+      ValueType requirements.
+    </purpose>
+  </class>
+</namespace>
+ +

Additional class documentation can be contained in a + description element following the <purpose> + element. This documentation will be typeset prior to documentation + for specific elements in the class (e.g., constructors or + methods).

+ +

Class inheritance is described via the <inherit> + element. The <inherit> element requires an access + attribute which must be one of public, + protected, or private. The + content of the <inherited> element in C++ code that names the + class inherited, and may contain markup to link to the class. The + following description of the class + boost::bad_any_cast describes public + inheritance from the class std::bad_cast. It + also defines the <purpose> element, which contains a short + description of the use of the class.

+ + 
<class name="bad_any_cast">
+  <inherit access="public"><classname>std::bad_cast</classname></inherit>
+  <purpose><para>The exception thrown in the event of a failed
+  <functionname>any_cast</functionname> of an
+  <classname>any</classname> value.</para></purpose>
+</class>
+ +

Class templates are defined by <class> elements with a + <template> child element at the beginning.

+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/code.html b/docbook/relaxng/api/doc/html/docbook/api/code.html new file mode 100644 index 000000000..51594d656 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/code.html @@ -0,0 +1,92 @@ + + + +DocBook API Element code + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element code

+

+ code + — Mimics the code tag in HTML +

+
+
+

Synopsis

code ::= + (ANY) +
+
+

Description

+

Text within a code tag is generally typeset + in a different, monospaced font so that it stands out as code. The + code tag in api is transformed directly + into the computeroutput tag in DocBook.

+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/compile-fail-test.html b/docbook/relaxng/api/doc/html/docbook/api/compile-fail-test.html new file mode 100644 index 000000000..c6a3d7497 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/compile-fail-test.html @@ -0,0 +1,79 @@ + + + +DocBook API Element compile-fail-test + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element compile-fail-test

+

+ compile-fail-test + — A testcase that should fail to compile +

+
+
+

Synopsis

compile-fail-test ::= + (source*, lib*, requirement*, purpose, if-fails?) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
filename#REQUIREDCDATAThe name of the file associated with this element
name#IMPLIEDCDATAThe name of the element being declared to referenced
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/compile-test.html b/docbook/relaxng/api/doc/html/docbook/api/compile-test.html new file mode 100644 index 000000000..631b98ec8 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/compile-test.html @@ -0,0 +1,79 @@ + + + +DocBook API Element compile-test + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element compile-test

+

+ compile-test + — A testcase that should compile correctly +

+
+
+

Synopsis

compile-test ::= + (source*, lib*, requirement*, purpose, if-fails?) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
filename#REQUIREDCDATAThe name of the file associated with this element
name#IMPLIEDCDATAThe name of the element being declared to referenced
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/complexity.html b/docbook/relaxng/api/doc/html/docbook/api/complexity.html new file mode 100644 index 000000000..814f03a47 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/complexity.html @@ -0,0 +1,85 @@ + + + +DocBook API Element complexity + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element complexity

+

+ complexity + — The time/space/etc. complexity of a function +

+
+
+

Synopsis

complexity ::= + (ANY) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/constructor.html b/docbook/relaxng/api/doc/html/docbook/api/constructor.html new file mode 100644 index 000000000..686ea20eb --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/constructor.html @@ -0,0 +1,97 @@ + + + +DocBook API Element constructor + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element constructor

+

+ constructor + — Declares a constructor of the enclosing class +

+
+
+

Synopsis

constructor ::= + (template?, parameter*, purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) +
+
+

Description

+

General documentation on functions in api is provided in + the function + element documentation.

+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
specifiers#IMPLIEDCDATAThe specifiers for this function, e.g., inline, static, etc.
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/copy-assignment.html b/docbook/relaxng/api/doc/html/docbook/api/copy-assignment.html new file mode 100644 index 000000000..ace335667 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/copy-assignment.html @@ -0,0 +1,107 @@ + + + +DocBook API Element copy-assignment + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element copy-assignment

+

+ copy-assignment + — Declares a copy-assignment operator +

+
+
+

Synopsis

copy-assignment ::= + (template?, type?, parameter*, purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) +
+
+

Description

+

The return type of the copy-assignment operator does not need + to be specified. If left unspecified, it will default to an + unqualified reference to the enclosing class type.

+ +

General documentation on functions in api is provided in + the function + element documentation.

+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
cv#IMPLIEDCDATAcv-qualifiers for this method, e.g., const volatile
specifiers#IMPLIEDCDATAThe specifiers for this function, e.g., inline, static, etc.
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/data-member.html b/docbook/relaxng/api/doc/html/docbook/api/data-member.html new file mode 100644 index 000000000..50f743010 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/data-member.html @@ -0,0 +1,97 @@ + + + +DocBook API Element data-member + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element data-member

+

+ data-member + — Declares a data member of a class +

+
+
+

Synopsis

data-member ::= + (type, purpose?, description?) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
specifiers#IMPLIEDCDATAThe specifiers for this function, e.g., inline, static, etc.
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/default.html b/docbook/relaxng/api/doc/html/docbook/api/default.html new file mode 100644 index 000000000..6e10cf9a0 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/default.html @@ -0,0 +1,85 @@ + + + +DocBook API Element default + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element default

+

+ default + — The default value of a function or template parameter +

+
+
+

Synopsis

default ::= + (ANY) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/description.html b/docbook/relaxng/api/doc/html/docbook/api/description.html new file mode 100644 index 000000000..c8ac47827 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/description.html @@ -0,0 +1,95 @@ + + + +DocBook API Element description + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element description

+

+ description + — Detailed description of a construct +

+
+
+

Synopsis

description ::= + (ANY) +
+
+

Description

+

Although the context model for this element is + ANY, detailed descriptions should contain structured + DocBook elements that occur within sections, e.g., paragraphs + (para, simpara), lists + (orderedlist, itemizedlist), + tables (informaltable, table), + etc.

+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/destructor.html b/docbook/relaxng/api/doc/html/docbook/api/destructor.html new file mode 100644 index 000000000..f3825bd2f --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/destructor.html @@ -0,0 +1,97 @@ + + + +DocBook API Element destructor + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element destructor

+

+ destructor + — Declares a destructor for the enclosing class +

+
+
+

Synopsis

destructor ::= + (purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) +
+
+

Description

+

General documentation on functions in api is provided in + the function + element documentation.

+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
specifiers#IMPLIEDCDATAThe specifiers for this function, e.g., inline, static, etc.
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/effects.html b/docbook/relaxng/api/doc/html/docbook/api/effects.html new file mode 100644 index 000000000..ea67d4d32 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/effects.html @@ -0,0 +1,85 @@ + + + +DocBook API Element effects + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element effects

+

+ effects + — Declares the side effects of a function +

+
+
+

Synopsis

effects ::= + (ANY) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/enum.html b/docbook/relaxng/api/doc/html/docbook/api/enum.html new file mode 100644 index 000000000..84063ce5c --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/enum.html @@ -0,0 +1,91 @@ + + + +DocBook API Element enum + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element enum

+

+ enum + — Declares an enumeration type +

+
+
+

Synopsis

enum ::= + (enumvalue*, purpose?, description?) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/enumname.html b/docbook/relaxng/api/doc/html/docbook/api/enumname.html new file mode 100644 index 000000000..8f51268a1 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/enumname.html @@ -0,0 +1,85 @@ + + + +DocBook API Element enumname + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element enumname

+

+ enumname + — References an enumeration type with the given name +

+
+
+

Synopsis

enumname ::= + (#PCDATA) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
alt#IMPLIEDCDATA 
id#IMPLIEDCDATAA global identifier for this element
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/enumvalue.html b/docbook/relaxng/api/doc/html/docbook/api/enumvalue.html new file mode 100644 index 000000000..de9f8d112 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/enumvalue.html @@ -0,0 +1,91 @@ + + + +DocBook API Element enumvalue + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element enumvalue

+

+ enumvalue + — A single value of an enumeration +

+
+
+

Synopsis

enumvalue ::= + (default?, purpose?, description?) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/free-function-group.html b/docbook/relaxng/api/doc/html/docbook/api/free-function-group.html new file mode 100644 index 000000000..874a00fba --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/free-function-group.html @@ -0,0 +1,91 @@ + + + +DocBook API Element free-function-group + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element free-function-group

+

+ free-function-group + — A set of functions that are grouped together under one name +

+
+
+

Synopsis

free-function-group ::= + (function| overloaded-function)* +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/function.html b/docbook/relaxng/api/doc/html/docbook/api/function.html new file mode 100644 index 000000000..280b0984e --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/function.html @@ -0,0 +1,154 @@ + + + +DocBook API Element function + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element function

+

+ function + — Declares a function +

+
+
+

Synopsis

function ::= + (template?, type, parameter*, purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) +
+
+

Description

+

api functions are documented by specifying the + function's interface (e.g., its C++ signature) and its + behavior. Constructors, destructors, member functions, and free + functions all use the same documentation method, although the + top-level tags differ.

+ +

The behavior of functions in api is documenting using a + style similar to that of the C++ standard, with clauses describing + the requirements, effects, postconditions, exception behavior, and + return values of functions.

+ +

The following example illustrates some constructors and a + destructor for boost::any. Note that one of + the constructors takes a single parameter whose name is "other" and + whose type, const any& is contained in the + <paramtype> element; any number of parameters may be specified + in this way.

+ + 
<class name="any">
+  <constructor>
+    <postconditions><para><this->empty()></para></postconditions>
+  </constructor>
+
+  <constructor>
+    <parameter name="other">
+      <paramtype>const <classname>any</classname>&amp;</paramtype>
+    </parameter>
+
+    <effects>
+      <simpara> Copy constructor that copies
+        content of <code>other</code> into the new instance,
+        so that any content is equivalent in both type and value to the
+        content of <code>other</code>, or empty if
+        <code>other</code> is
+        empty.
+      </simpara>
+    </effects>
+
+    <throws>
+      <simpara>May fail with a
+        <classname>std::bad_alloc</classname> exception or any
+        exceptions arising from the copy constructor of the
+        contained type.
+      </simpara>
+    </throws>
+  </constructor>
+
+  <destructor>
+     <effects><simpara>Releases any and all resources used in
+     management of instance.</simpara></effects>
+
+     <throws><simpara>Nothing.</simpara></throws>
+  </destructor>
+</class>
+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
specifiers#IMPLIEDCDATAThe specifiers for this function, e.g., inline, static, etc.
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/functionname.html b/docbook/relaxng/api/doc/html/docbook/api/functionname.html new file mode 100644 index 000000000..810443c2c --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/functionname.html @@ -0,0 +1,100 @@ + + + +DocBook API Element functionname + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element functionname

+

+ functionname + — References a function with the given name +

+
+
+

Synopsis

functionname ::= + (#PCDATA) +
+
+

Description

+

If a function (or overloaded function) with the given, + possibly-qualified name is found, this generates a link to that + function. Lookups obey currently-active using-class + and using-namespace + directives to aid in the search, along with searching within the + current scope.

+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
alt#IMPLIEDCDATA 
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/globalname.html b/docbook/relaxng/api/doc/html/docbook/api/globalname.html new file mode 100644 index 000000000..7d9edbc23 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/globalname.html @@ -0,0 +1,85 @@ + + + +DocBook API Element globalname + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element globalname

+

+ globalname + — References a global with the given name +

+
+
+

Synopsis

globalname ::= + (#PCDATA) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
alt#IMPLIEDCDATA 
id#IMPLIEDCDATAA global identifier for this element
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/header.html b/docbook/relaxng/api/doc/html/docbook/api/header.html new file mode 100644 index 000000000..bd2a4aaca --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/header.html @@ -0,0 +1,91 @@ + + + +DocBook API Element header + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element header

+

+ header + — Declares a C++ header with the given name +

+
+
+

Synopsis

header ::= + (ANY) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/headername.html b/docbook/relaxng/api/doc/html/docbook/api/headername.html new file mode 100644 index 000000000..8bf8e0185 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/headername.html @@ -0,0 +1,85 @@ + + + +DocBook API Element headername + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element headername

+

+ headername + — References a C++ header with the given name +

+
+
+

Synopsis

headername ::= + (#PCDATA) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
alt#IMPLIEDCDATA 
id#IMPLIEDCDATAA global identifier for this element
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/if-fails.html b/docbook/relaxng/api/doc/html/docbook/api/if-fails.html new file mode 100644 index 000000000..576555a7a --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/if-fails.html @@ -0,0 +1,55 @@ + + + +DocBook API Element if-fails + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element if-fails

+

+ if-fails + — What it means when a testcase fails +

+
+
+

Synopsis

if-fails ::= + (ANY) +
+
+

Description

+

+ Describes to the user the effect a certain failing testcase will + have on the usefulness of a library. This field is useful in cases + where a failed testcase does not mean that the library won't be + useful, but may mean that certain library features will not be + available. +

+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/inherit.html b/docbook/relaxng/api/doc/html/docbook/api/inherit.html new file mode 100644 index 000000000..cb5600696 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/inherit.html @@ -0,0 +1,101 @@ + + + +DocBook API Element inherit + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element inherit

+

+ inherit + — Declares a base class of the enclosing class or struct +

+
+
+

Synopsis

inherit ::= + (type, purpose?) +
+
+

Description

+

This element contains the type of the class inherited.

+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
access#IMPLIEDCDATAThe access specifier ("public", "private", or "protected") of the inheritance.
id#IMPLIEDCDATAA global identifier for this element
pack#IMPLIEDCDATASet to '1' if this is a pack exapansion.
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/lib.html b/docbook/relaxng/api/doc/html/docbook/api/lib.html new file mode 100644 index 000000000..57f305351 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/lib.html @@ -0,0 +1,49 @@ + + + +DocBook API Element lib + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element lib

+

+ lib + — A library dependency +

+
+
+

Synopsis

lib ::= + (#PCDATA) +
+
+

Description

+

Declares a library dependency on the library named by the content of this element, to be emitted in a Jamfile.

+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/library-reference.html b/docbook/relaxng/api/doc/html/docbook/api/library-reference.html new file mode 100644 index 000000000..d0969dc84 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/library-reference.html @@ -0,0 +1,114 @@ + + + +DocBook API Element library-reference + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element library-reference

+

+ library-reference + — Declares the reference material for a library +

+
+
+

Synopsis

library-reference ::= + (title?, section*, (header| library-reference)*) +
+
+

Description

+

Reference documentation for a library is contained with a + <library-reference> element. The <library-reference> + element has no attributes, and contains as children only + <header> elements.

+ +

The <header> element defines a C++ header file. Within + each C++ header file lie the definitions of C++ constructs to be + documented. The name attribute of the <header> + element gives the name of the header, as one would specify when + including the header. For instance, the <library-reference> + for the <libraryname>Any</libraryname> library may look like + this:

+ + 
<library-reference>
+  <header name="boost/any.hpp">
+    <!-- C++ constructs in this header -->
+  </header>
+</library-reference>
+ +

If the <libraryname>Any</libraryname> library contained + multiple headers, we would list them all as children of the + <library-reference> element.

+ +

library-reference elements can be nested, + so that reference material can be divided into separate sections + that each contain different headers.

+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/library.html b/docbook/relaxng/api/doc/html/docbook/api/library.html new file mode 100644 index 000000000..fa3a9a0d3 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/library.html @@ -0,0 +1,109 @@ + + + +DocBook API Element library + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element library

+

+ library + — Top-level element for a library +

+
+
+

Synopsis

library ::= + (libraryinfo, (title, ((section| library-reference| testsuite))+)?) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
dirname#REQUIREDCDATA 
url#IMPLIEDCDATA 
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
html-only#IMPLIEDCDATA 
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/librarycategory.html b/docbook/relaxng/api/doc/html/docbook/api/librarycategory.html new file mode 100644 index 000000000..7384f65e2 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/librarycategory.html @@ -0,0 +1,91 @@ + + + +DocBook API Element librarycategory + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element librarycategory

+

+ librarycategory + — Declares that the enclosing library is in this category +

+
+
+

Synopsis

librarycategory ::= + (#PCDATA) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/librarycategorydef.html b/docbook/relaxng/api/doc/html/docbook/api/librarycategorydef.html new file mode 100644 index 000000000..28b235b53 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/librarycategorydef.html @@ -0,0 +1,95 @@ + + + +DocBook API Element librarycategorydef + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element librarycategorydef

+

+ librarycategorydef + — Defines a new library category +

+
+
+

Synopsis

librarycategorydef ::= + (#PCDATA) +
+
+

Description

+

All library category definitions should be in the main xml file, and the names of categories must be prefixed with "category:".

+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/librarycategorylist.html b/docbook/relaxng/api/doc/html/docbook/api/librarycategorylist.html new file mode 100644 index 000000000..0e481d86b --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/librarycategorylist.html @@ -0,0 +1,90 @@ + + + +DocBook API Element librarycategorylist + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element librarycategorylist

+

+ librarycategorylist + — Categorized listing of libraries +

+
+
+

Synopsis

librarycategorylist ::= + (librarycategorydef)* +
+
+

Description

+

This element is used by the main XML document as a + placeholder.

+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/libraryinfo.html b/docbook/relaxng/api/doc/html/docbook/api/libraryinfo.html new file mode 100644 index 000000000..5c7f8e43e --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/libraryinfo.html @@ -0,0 +1,85 @@ + + + +DocBook API Element libraryinfo + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element libraryinfo

+

+ libraryinfo + — Provides information about a library +

+
+
+

Synopsis

libraryinfo ::= + (author+, copyright*, legalnotice*, librarypurpose, librarycategory*) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/librarylist.html b/docbook/relaxng/api/doc/html/docbook/api/librarylist.html new file mode 100644 index 000000000..835ef2e5d --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/librarylist.html @@ -0,0 +1,89 @@ + + + +DocBook API Element librarylist + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element librarylist

+

+ librarylist + — Placeholder for an alphabetical list of libraries +

+
+
+

Synopsis

librarylist ::= + EMPTY +
+
+

Description

+

Its existence is mainly as a placeholder in the main XML document for the alphabetical list of libraries.

+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/libraryname.html b/docbook/relaxng/api/doc/html/docbook/api/libraryname.html new file mode 100644 index 000000000..1c4254591 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/libraryname.html @@ -0,0 +1,85 @@ + + + +DocBook API Element libraryname + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element libraryname

+

+ libraryname + — References a library of the given name +

+
+
+

Synopsis

libraryname ::= + (#PCDATA) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/librarypurpose.html b/docbook/relaxng/api/doc/html/docbook/api/librarypurpose.html new file mode 100644 index 000000000..6370f7163 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/librarypurpose.html @@ -0,0 +1,85 @@ + + + +DocBook API Element librarypurpose + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element librarypurpose

+

+ librarypurpose + — Describes in one short sentence or phrase the purpose of a library +

+
+
+

Synopsis

librarypurpose ::= + (#PCDATA| code| ulink| functionname| methodname| classname| macroname| headername| enumname| globalname)* +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/link-fail-test.html b/docbook/relaxng/api/doc/html/docbook/api/link-fail-test.html new file mode 100644 index 000000000..a33dc482f --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/link-fail-test.html @@ -0,0 +1,79 @@ + + + +DocBook API Element link-fail-test + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element link-fail-test

+

+ link-fail-test + — Declares a test that should compile but fail to link +

+
+
+

Synopsis

link-fail-test ::= + (source*, lib*, requirement*, purpose, if-fails?) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
filename#REQUIREDCDATAThe name of the file associated with this element
name#IMPLIEDCDATAThe name of the element being declared to referenced
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/link-test.html b/docbook/relaxng/api/doc/html/docbook/api/link-test.html new file mode 100644 index 000000000..827f4d6b8 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/link-test.html @@ -0,0 +1,79 @@ + + + +DocBook API Element link-test + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element link-test

+

+ link-test + — Declares a test that should compile and link +

+
+
+

Synopsis

link-test ::= + (source*, lib*, requirement*, purpose, if-fails?) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
filename#REQUIREDCDATAThe name of the file associated with this element
name#IMPLIEDCDATAThe name of the element being declared to referenced
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/macroname.html b/docbook/relaxng/api/doc/html/docbook/api/macroname.html new file mode 100644 index 000000000..3c096ab5a --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/macroname.html @@ -0,0 +1,85 @@ + + + +DocBook API Element macroname + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element macroname

+

+ macroname + — References a macro with the given name +

+
+
+

Synopsis

macroname ::= + (#PCDATA) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
alt#IMPLIEDCDATA 
id#IMPLIEDCDATAA global identifier for this element
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/method-group.html b/docbook/relaxng/api/doc/html/docbook/api/method-group.html new file mode 100644 index 000000000..89f5afadc --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/method-group.html @@ -0,0 +1,91 @@ + + + +DocBook API Element method-group + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element method-group

+

+ method-group + — A set of methods that are grouped together under one name +

+
+
+

Synopsis

method-group ::= + (method| overloaded-method)* +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/method.html b/docbook/relaxng/api/doc/html/docbook/api/method.html new file mode 100644 index 000000000..24f4c94f6 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/method.html @@ -0,0 +1,109 @@ + + + +DocBook API Element method + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element method

+

+ method + — Declares a method, i.e., a member function +

+
+
+

Synopsis

method ::= + (template?, type, parameter*, purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) +
+
+

Description

+

General documentation on functions in api is provided in + the function + element documentation.

+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
cv#IMPLIEDCDATAcv-qualifiers for this method, e.g., const volatile
specifiers#IMPLIEDCDATAThe specifiers for this function, e.g., inline, static, etc.
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/namespace.html b/docbook/relaxng/api/doc/html/docbook/api/namespace.html new file mode 100644 index 000000000..20601364f --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/namespace.html @@ -0,0 +1,108 @@ + + + +DocBook API Element namespace + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element namespace

+

+ namespace + — Declares a namespace +

+
+
+

Synopsis

namespace ::= + (class| class-specialization| struct| struct-specialization| union| union-specialization| typedef| enum| free-function-group| function| overloaded-function| namespace)* +
+
+

Description

+

api namespaces are declared via the <namespace> + element. As in C++, namespaces can be nested and contain other C++ + constructs, such as classes or functions. The name + attribute of a <namespace> element gives the namespace name + (e.g., "boost"). The <libraryname>Any</libraryname> library is + defined entirely within namespace boost by:

+ + 
<library-reference>
+  <header name="boost/any.hpp">
+    <namespace name="boost">
+      <!-- C++ constructs in the boost namespace -->
+    </namespace>
+  </header>
+</library-reference>
+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/notes.html b/docbook/relaxng/api/doc/html/docbook/api/notes.html new file mode 100644 index 000000000..3bd27039e --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/notes.html @@ -0,0 +1,85 @@ + + + +DocBook API Element notes + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element notes

+

+ notes + — Non-normative notes about a function's semantics +

+
+
+

Synopsis

notes ::= + (ANY) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/overloaded-function.html b/docbook/relaxng/api/doc/html/docbook/api/overloaded-function.html new file mode 100644 index 000000000..e7e102429 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/overloaded-function.html @@ -0,0 +1,97 @@ + + + +DocBook API Element overloaded-function + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element overloaded-function

+

+ overloaded-function + — An overloaded function +

+
+
+

Synopsis

overloaded-function ::= + (signature*, purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) +
+
+

Description

+

General documentation on functions in api is provided in + the function + element documentation.

+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/overloaded-method.html b/docbook/relaxng/api/doc/html/docbook/api/overloaded-method.html new file mode 100644 index 000000000..c958f942c --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/overloaded-method.html @@ -0,0 +1,97 @@ + + + +DocBook API Element overloaded-method + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element overloaded-method

+

+ overloaded-method + — An overloaded method +

+
+
+

Synopsis

overloaded-method ::= + (signature*, purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) +
+
+

Description

+

General documentation on functions in api is provided in + the function + element documentation.

+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/parameter.html b/docbook/relaxng/api/doc/html/docbook/api/parameter.html new file mode 100644 index 000000000..93c0771f9 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/parameter.html @@ -0,0 +1,79 @@ + + + +DocBook API Element parameter + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element parameter

+

+ parameter + — A function parameter +

+
+
+

Synopsis

parameter ::= + (paramtype, default?, description?) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
name#IMPLIEDCDATAThe name of the element being declared to referenced
pack#IMPLIEDCDATASet to '1' if the parameter is a parameter pack.
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/paramtype.html b/docbook/relaxng/api/doc/html/docbook/api/paramtype.html new file mode 100644 index 000000000..c19b16b16 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/paramtype.html @@ -0,0 +1,85 @@ + + + +DocBook API Element paramtype + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element paramtype

+

+ paramtype + — The type of a function parameter +

+
+
+

Synopsis

paramtype ::= + (ANY) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/postconditions.html b/docbook/relaxng/api/doc/html/docbook/api/postconditions.html new file mode 100644 index 000000000..b16502f3e --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/postconditions.html @@ -0,0 +1,85 @@ + + + +DocBook API Element postconditions + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element postconditions

+

+ postconditions + — Conditions that must hold after the function returns +

+
+
+

Synopsis

postconditions ::= + (ANY) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/precondition.html b/docbook/relaxng/api/doc/html/docbook/api/precondition.html new file mode 100644 index 000000000..030fa653e --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/precondition.html @@ -0,0 +1,85 @@ + + + +DocBook API Element precondition + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element precondition

+

+ precondition + — Conditions that must be met prior to executing a function +

+
+
+

Synopsis

precondition ::= + (ANY) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/programlisting.html b/docbook/relaxng/api/doc/html/docbook/api/programlisting.html new file mode 100644 index 000000000..67222773f --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/programlisting.html @@ -0,0 +1,71 @@ + + + +DocBook API Element programlisting + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element programlisting

+

+ programlisting + — A sample of program code +

+
+
+

Synopsis

programlisting ::= + (ANY) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + +
NameTypeValuePurpose
name#IMPLIEDCDATAThe name of the element being declared to referenced
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/purpose.html b/docbook/relaxng/api/doc/html/docbook/api/purpose.html new file mode 100644 index 000000000..57b7dc6b1 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/purpose.html @@ -0,0 +1,85 @@ + + + +DocBook API Element purpose + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element purpose

+

+ purpose + — A short description of an entity's use +

+
+
+

Synopsis

purpose ::= + (ANY) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/rationale.html b/docbook/relaxng/api/doc/html/docbook/api/rationale.html new file mode 100644 index 000000000..31a2162e9 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/rationale.html @@ -0,0 +1,85 @@ + + + +DocBook API element rationale + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API element rationale

+

+ rationale + — Describes the rationale for a particular function's design +

+
+
+

Synopsis

rationale ::= + (ANY) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/requirement.html b/docbook/relaxng/api/doc/html/docbook/api/requirement.html new file mode 100644 index 000000000..3dcfc7558 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/requirement.html @@ -0,0 +1,81 @@ + + + +DocBook API Element requirement + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element requirement

+

+ requirement + — A requirement/property in the Jamfile for a testcase +

+
+
+

Synopsis

requirement ::= + (#PCDATA) +
+
+

Description

+

A requirement is part of the dependencies of a target in a + Jamfile. The name attribute of a requirement element + gives the name of the Boost.Build feature and the content of the + requirement gives the value of that feature. A requirement such as + <includes>foo.hpp would be encoded as + <requirement + name="includes">foo.hpp</requirement>.

+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + +
NameTypeValuePurpose
name#REQUIREDCDATAThe name of the element being declared to referenced
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/requires.html b/docbook/relaxng/api/doc/html/docbook/api/requires.html new file mode 100644 index 000000000..25e37c337 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/requires.html @@ -0,0 +1,85 @@ + + + +DocBook API Element requires + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element requires

+

+ requires + — Declares the requirements of a function +

+
+
+

Synopsis

requires ::= + (ANY) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/returns.html b/docbook/relaxng/api/doc/html/docbook/api/returns.html new file mode 100644 index 000000000..a36553f52 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/returns.html @@ -0,0 +1,85 @@ + + + +DocBook API Element returns + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element returns

+

+ returns + — Description of the return value of a function +

+
+
+

Synopsis

returns ::= + (ANY) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/run-fail-test.html b/docbook/relaxng/api/doc/html/docbook/api/run-fail-test.html new file mode 100644 index 000000000..38d745a70 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/run-fail-test.html @@ -0,0 +1,79 @@ + + + +DocBook API Element run-fail-test + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element run-fail-test

+

+ run-fail-test + — A testcase that should compile and link, but fail on execution +

+
+
+

Synopsis

run-fail-test ::= + (source*, lib*, requirement*, purpose, if-fails?) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
filename#REQUIREDCDATAThe name of the file associated with this element
name#IMPLIEDCDATAThe name of the element being declared to referenced
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/run-test.html b/docbook/relaxng/api/doc/html/docbook/api/run-test.html new file mode 100644 index 000000000..c40a93c1c --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/run-test.html @@ -0,0 +1,79 @@ + + + +DocBook API Element run-test + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element run-test

+

+ run-test + — A testcase that should compile, link, and execute +

+
+
+

Synopsis

run-test ::= + (source*, lib*, requirement*, purpose, if-fails?) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
filename#REQUIREDCDATAThe name of the file associated with this element
name#IMPLIEDCDATAThe name of the element being declared to referenced
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/signature.html b/docbook/relaxng/api/doc/html/docbook/api/signature.html new file mode 100644 index 000000000..49f601ef9 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/signature.html @@ -0,0 +1,107 @@ + + + +DocBook API Element signature + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element signature

+

+ signature + — One signature of an overloaded function or method +

+
+
+

Synopsis

signature ::= + (template?, type, parameter*) +
+
+

Description

+

+ A signature refers to one declaration of an overloaded function or + method. The signature itself has no name, because the name of the + overloaded function or method is used. An overloaded function or + method will have several signatures that will generally be typeset + together. +

+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
cv#IMPLIEDCDATAcv-qualifiers for this method, e.g., const volatile
specifiers#IMPLIEDCDATAThe specifiers for this function, e.g., inline, static, etc.
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/snippet.html b/docbook/relaxng/api/doc/html/docbook/api/snippet.html new file mode 100644 index 000000000..d3ba0396f --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/snippet.html @@ -0,0 +1,71 @@ + + + +DocBook API Element snippet + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element snippet

+

+ snippet + — Pulls in a code snippet from a programlisting element +

+
+
+

Synopsis

snippet ::= + EMPTY +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + +
NameTypeValuePurpose
name#REQUIREDCDATAThe name of the programlisting element to insert
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/source.html b/docbook/relaxng/api/doc/html/docbook/api/source.html new file mode 100644 index 000000000..4c4c63cf7 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/source.html @@ -0,0 +1,61 @@ + + + +DocBook API Element source + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element source

+

+ source + — Defines source code for a test +

+
+
+

Synopsis

source ::= + (#PCDATA| snippet)* +
+
+

Description

+

This element will contain the source code for a testcase that + will be generated from the documentation. To reduce the amount of escaping in the text, it is recommended to use CDATA sections, which look like this: + +

+
<![CDATA[
+<your program text here: no escaping needed!>
+]]>
+

+

+ +

In addition to CDATA sections, code snippets can be pulled in + from programlisting elements using the snippet + element.

+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/specialization.html b/docbook/relaxng/api/doc/html/docbook/api/specialization.html new file mode 100644 index 000000000..93800395d --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/specialization.html @@ -0,0 +1,85 @@ + + + +DocBook API Element specialization + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element specialization

+

+ specialization + — Defines the specialization arguments for a class specialization +

+
+
+

Synopsis

specialization ::= + (template-arg)* +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/static-constant.html b/docbook/relaxng/api/doc/html/docbook/api/static-constant.html new file mode 100644 index 000000000..302513a10 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/static-constant.html @@ -0,0 +1,91 @@ + + + +DocBook API Element static-constant + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element static-constant

+

+ static-constant + — Declares a static constant, e.g., const int foo = 5;. +

+
+
+

Synopsis

static-constant ::= + (type, default, purpose?, description?) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/struct-specialization.html b/docbook/relaxng/api/doc/html/docbook/api/struct-specialization.html new file mode 100644 index 000000000..b4b5a0ef0 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/struct-specialization.html @@ -0,0 +1,91 @@ + + + +DocBook API Element struct-specialization + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element struct-specialization

+

+ struct-specialization + — A specialization (full or partial) of a struct template +

+
+
+

Synopsis

struct-specialization ::= + (template?, specialization?, inherit?, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/struct.html b/docbook/relaxng/api/doc/html/docbook/api/struct.html new file mode 100644 index 000000000..723245c2a --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/struct.html @@ -0,0 +1,91 @@ + + + +DocBook API Element struct + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element struct

+

+ struct + — Declares a C++ struct +

+
+
+

Synopsis

struct ::= + (template?, inherit*, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/template-arg.html b/docbook/relaxng/api/doc/html/docbook/api/template-arg.html new file mode 100644 index 000000000..efd5c5e8f --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/template-arg.html @@ -0,0 +1,91 @@ + + + +DocBook API Element template-arg + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element template-arg

+

+ template-arg + — A template argument in a specialization +

+
+
+

Synopsis

template-arg ::= + (ANY) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
pack#IMPLIEDCDATASet to '1' if this is a pack exapansion.
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/template-nontype-parameter.html b/docbook/relaxng/api/doc/html/docbook/api/template-nontype-parameter.html new file mode 100644 index 000000000..f72ffe2ee --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/template-nontype-parameter.html @@ -0,0 +1,97 @@ + + + +DocBook API Element template-nontype-parameter + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element template-nontype-parameter

+

+ template-nontype-parameter + — A nontype template parameter +

+
+
+

Synopsis

template-nontype-parameter ::= + (type, default?, purpose?) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
pack#IMPLIEDCDATASet to '1' if the parameter is a parameter pack.
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/template-type-parameter.html b/docbook/relaxng/api/doc/html/docbook/api/template-type-parameter.html new file mode 100644 index 000000000..c4c0283fb --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/template-type-parameter.html @@ -0,0 +1,97 @@ + + + +DocBook API Element template-type-parameter + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element template-type-parameter

+

+ template-type-parameter + — Declares a template type parameter +

+
+
+

Synopsis

template-type-parameter ::= + (default?, purpose?) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
pack#IMPLIEDCDATASet to '1' if the parameter is a parameter pack.
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/template-varargs.html b/docbook/relaxng/api/doc/html/docbook/api/template-varargs.html new file mode 100644 index 000000000..4c2265ef5 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/template-varargs.html @@ -0,0 +1,93 @@ + + + +DocBook API Element template-varargs + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element template-varargs

+

+ template-varargs + — Declares a variable-length list of template parameters +

+
+
+

Synopsis

template-varargs ::= + EMPTY +
+
+

Description

+

Variable-length template parameter lists are not allowed in + C++, but because they are sometimes needed in documentation they are + allowed in api. This element generally expands to "..." and + can be used anywhere any other template parameter can be + used.

+
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/template.html b/docbook/relaxng/api/doc/html/docbook/api/template.html new file mode 100644 index 000000000..814d4f763 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/template.html @@ -0,0 +1,85 @@ + + + +DocBook API Element template + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element template

+

+ template + — Declares the template parameters of a class or function +

+
+
+

Synopsis

template ::= + (template-type-parameter| template-nontype-parameter| template-varargs)* +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/testsuite.html b/docbook/relaxng/api/doc/html/docbook/api/testsuite.html new file mode 100644 index 000000000..382e866db --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/testsuite.html @@ -0,0 +1,85 @@ + + + +DocBook API Element testsuite + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element testsuite

+

+ testsuite + — Describes a library testsuite +

+
+
+

Synopsis

testsuite ::= + ((compile-test| link-test| run-test| compile-fail-test| link-fail-test| run-fail-test)+) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/throws.html b/docbook/relaxng/api/doc/html/docbook/api/throws.html new file mode 100644 index 000000000..c601f3b40 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/throws.html @@ -0,0 +1,85 @@ + + + +DocBook API Element throws + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element throws

+

+ throws + — Description of the exceptions thrown by a function +

+
+
+

Synopsis

throws ::= + (ANY) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/type.html b/docbook/relaxng/api/doc/html/docbook/api/type.html new file mode 100644 index 000000000..209363d98 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/type.html @@ -0,0 +1,85 @@ + + + +DocBook API Element type + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element type

+

+ type + — The type of an element or return type of a function +

+
+
+

Synopsis

type ::= + (ANY) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/typedef.html b/docbook/relaxng/api/doc/html/docbook/api/typedef.html new file mode 100644 index 000000000..6186edc93 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/typedef.html @@ -0,0 +1,91 @@ + + + +DocBook API Element typedef + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element typedef

+

+ typedef + — Declares a typedef +

+
+
+

Synopsis

typedef ::= + (type, purpose?, description?) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/union-specialization.html b/docbook/relaxng/api/doc/html/docbook/api/union-specialization.html new file mode 100644 index 000000000..c05a0ffc2 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/union-specialization.html @@ -0,0 +1,91 @@ + + + +DocBook API Element union-specialization + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element union-specialization

+

+ union-specialization + — A specialization (full or partial) of a union template +

+
+
+

Synopsis

union-specialization ::= + (template?, specialization?, inherit?, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/union.html b/docbook/relaxng/api/doc/html/docbook/api/union.html new file mode 100644 index 000000000..471393aa7 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/union.html @@ -0,0 +1,91 @@ + + + +DocBook API Element union + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element union

+

+ union + — Declares a C++ union or union template +

+
+
+

Synopsis

union ::= + (template?, inherit*, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/using-class.html b/docbook/relaxng/api/doc/html/docbook/api/using-class.html new file mode 100644 index 000000000..06f1f2770 --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/using-class.html @@ -0,0 +1,91 @@ + + + +DocBook API Element using-class + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element using-class

+

+ using-class + — Injects the method and function names of a class into the local scope +

+
+
+

Synopsis

using-class ::= + EMPTY +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/docbook/api/using-namespace.html b/docbook/relaxng/api/doc/html/docbook/api/using-namespace.html new file mode 100644 index 000000000..b12cdd57c --- /dev/null +++ b/docbook/relaxng/api/doc/html/docbook/api/using-namespace.html @@ -0,0 +1,91 @@ + + + +DocBook API Element using-namespace + + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+UpHome +
+
+
+ +
+

+ DocBook API Element using-namespace

+

+ using-namespace + — Injects the declared names from a namespace into the local scope +

+
+
+

Synopsis

using-namespace ::= + EMPTY +
+
+

Attributes

+ +
+ ++++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
NameTypeValuePurpose
last-revision#IMPLIEDCDATASet to $Date: 2009-10-10 14:01:30 +0100 (Sat, 10 Oct 2009) $ to keep "last revised" information in sync with CVS changes
name#REQUIREDCDATAThe name of the element being declared to referenced
id#IMPLIEDCDATAA global identifier for this element
xml:base#IMPLIEDCDATAImplementation detail used by XIncludes
+
+
+
+ + + +
+
+
+UpHome +
+ + diff --git a/docbook/relaxng/api/doc/html/index.html b/docbook/relaxng/api/doc/html/index.html new file mode 100644 index 000000000..cf4ea29cc --- /dev/null +++ b/docbook/relaxng/api/doc/html/index.html @@ -0,0 +1,422 @@ + + + +DocBook API Reference + + + + + + + + + +
DocBook API DcoumentationHomeProject
+
+
+
+
+

+DocBook API Reference

+
+
+
+

Table of Contents

+
+
+ + DocBook API Element class-specialization — A specialization (partial or full) of a class template +
+
+ + DocBook API Element link-test — Declares a test that should compile and link +
+
+ + DocBook API Element link-fail-test — Declares a test that should compile but fail to link +
+
+ + DocBook API Element typedef — Declares a typedef +
+
+ + DocBook API Element static-constant — Declares a static constant, e.g., const int foo = 5;. +
+
+ + DocBook API Element code — Mimics the code tag in HTML +
+
+ + DocBook API Element destructor — Declares a destructor for the enclosing class +
+
+ + DocBook API Element template-type-parameter — Declares a template type parameter +
+
+ + DocBook API Element description — Detailed description of a construct +
+
+ + DocBook API Element librarylist — Placeholder for an alphabetical list of libraries +
+
+ + DocBook API Element library-reference — Declares the reference material for a library +
+
+ + DocBook API Element api — Defines an API +
+
+ + DocBook API Element union — Declares a C++ union or union template +
+
+ + DocBook API Element inherit — Declares a base class of the enclosing class or struct +
+
+ + DocBook API Element template-varargs — Declares a variable-length list of template parameters +
+
+ + DocBook API Element source — Defines source code for a test +
+
+ + DocBook API Element function — Declares a function +
+
+ + DocBook API Element macroname — References a macro with the given name +
+
+ + DocBook API Element postconditions — Conditions that must hold after the function returns +
+
+ + DocBook API Element compile-test — A testcase that should compile correctly +
+
+ + DocBook API Element method — Declares a method, i.e., a member function +
+
+ + DocBook API Element snippet — Pulls in a code snippet from a programlisting element +
+
+ + DocBook API Element constructor — Declares a constructor of the enclosing class +
+
+ + DocBook API Element namespace — Declares a namespace +
+
+ + DocBook API Element if-fails — What it means when a testcase fails +
+
+ + DocBook API Element headername — References a C++ header with the given name +
+
+ + DocBook API Element free-function-group — A set of functions that are grouped together under one name +
+
+ + DocBook API Element functionname — References a function with the given name +
+
+ + DocBook API Element librarycategory — Declares that the enclosing library is in this category +
+
+ + DocBook API Element notes — Non-normative notes about a function's semantics +
+
+ + DocBook API Element data-member — Declares a data member of a class +
+
+ + DocBook API Element specialization — Defines the specialization arguments for a class specialization +
+
+ + DocBook API Element union-specialization — A specialization (full or partial) of a union template +
+
+ + DocBook API Element throws — Description of the exceptions thrown by a function +
+
+ + DocBook API Element template-arg — A template argument in a specialization +
+
+ + DocBook API Element globalname — References a global with the given name +
+
+ + DocBook API Element method-group — A set of methods that are grouped together under one name +
+
+ + DocBook API Element requirement — A requirement/property in the Jamfile for a testcase +
+
+ + DocBook API Element precondition — Conditions that must be met prior to executing a function +
+
+ + DocBook API Element paramtype — The type of a function parameter +
+
+ + DocBook API Element using-class — Injects the method and function names of a class into the local scope +
+
+ + DocBook API Element run-test — A testcase that should compile, link, and execute +
+
+ + DocBook API Element librarypurpose — Describes in one short sentence or phrase the purpose of a library +
+
+ + DocBook API Element copy-assignment — Declares a copy-assignment operator +
+
+ + DocBook API Element run-fail-test — A testcase that should compile and link, but fail on execution +
+
+ + DocBook API Element template — Declares the template parameters of a class or function +
+
+ + DocBook API Element compile-fail-test — A testcase that should fail to compile +
+
+ + DocBook API Element returns — Description of the return value of a function +
+
+ + DocBook API Element default — The default value of a function or template parameter +
+
+ + DocBook API Element parameter — A function parameter +
+
+ + DocBook API Element signature — One signature of an overloaded function or method +
+
+ + DocBook API Element overloaded-function — An overloaded function +
+
+ + DocBook API Element access — Declares an access specification for class members +
+
+ + DocBook API Element class — Declares a class or class template +
+
+ + DocBook API Element librarycategorydef — Defines a new library category +
+
+ + DocBook API Element type — The type of an element or return type of a function +
+
+ + DocBook API Element enumvalue — A single value of an enumeration +
+
+ + DocBook API Element overloaded-method — An overloaded method +
+
+ + DocBook API Element programlisting — A sample of program code +
+
+ + DocBook API Element complexity — The time/space/etc. complexity of a function +
+
+ + DocBook API Element purpose — A short description of an entity's use +
+
+ + DocBook API Element template-nontype-parameter — A nontype template parameter +
+
+ + DocBook API Element library — Top-level element for a library +
+
+ + DocBook API Element librarycategorylist — Categorized listing of libraries +
+
+ + DocBook API Element using-namespace — Injects the declared names from a namespace into the local scope +
+
+ + DocBook API Element enumname — References an enumeration type with the given name +
+
+ + DocBook API Element struct-specialization — A specialization (full or partial) of a struct template +
+
+ + DocBook API Element struct — Declares a C++ struct +
+
+ + DocBook API Element lib — A library dependency +
+
+ + DocBook API Element enum — Declares an enumeration type +
+
+ + DocBook API Element requires — Declares the requirements of a function +
+
+ + DocBook API Element effects — Declares the side effects of a function +
+
+ + DocBook API Element libraryname — References a library of the given name +
+
+ + DocBook API Element libraryinfo — Provides information about a library +
+
+ + DocBook API Element testsuite — Describes a library testsuite +
+
+ + DocBook API Element header — Declares a C++ header with the given name +
+
+ + DocBook API element rationale — Describes the rationale for a particular function's design +
+
+
+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
+ + + +
+
+
+ + diff --git a/docbook/relaxng/api/doc/reference.xml b/docbook/relaxng/api/doc/reference.xml index e9186b8f6..94432ed1c 100644 --- a/docbook/relaxng/api/doc/reference.xml +++ b/docbook/relaxng/api/doc/reference.xml @@ -1,10 +1,10 @@
DocBook API Reference - - + DocBook API Element class-specialization @@ -15,7 +15,7 @@ A specialization (partial or full) of a class template class-specialization ::= - (template?, specialization?, inherit?, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) + (template?, specialization?, inherit?, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) Attributes @@ -40,7 +40,7 @@ - + DocBook API Element link-test @@ -51,7 +51,7 @@ Declares a test that should compile and link link-test ::= - (source*, lib*, requirement*, purpose, if-fails?) + (source*, lib*, requirement*, purpose, if-fails?) Attributes @@ -74,7 +74,7 @@ - + DocBook API Element link-fail-test @@ -85,7 +85,7 @@ Declares a test that should compile but fail to link link-fail-test ::= - (source*, lib*, requirement*, purpose, if-fails?) + (source*, lib*, requirement*, purpose, if-fails?) Attributes @@ -108,7 +108,7 @@ - + DocBook API Element typedef @@ -119,7 +119,7 @@ Declares a typedef typedef ::= - (type, purpose?, description?) + (type, purpose?, description?) Attributes @@ -144,7 +144,7 @@ - + DocBook API Element static-constant @@ -155,7 +155,7 @@ Declares a static constant, e.g., const int foo = 5;. static-constant ::= - (type, default, purpose?, description?) + (type, default, purpose?, description?) Attributes @@ -180,7 +180,7 @@ - + DocBook API Element code @@ -221,7 +221,7 @@ - + DocBook API Element destructor @@ -232,11 +232,11 @@ Declares a destructor for the enclosing class destructor ::= - (purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) + (purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) Description General documentation on functions in api is provided in - the function + the function element documentation. Attributes @@ -262,7 +262,7 @@ - + DocBook API Element template-type-parameter @@ -273,7 +273,7 @@ Declares a template type parameter template-type-parameter ::= - (default?, purpose?) + (default?, purpose?) Attributes @@ -299,7 +299,7 @@ - + DocBook API Element description @@ -343,7 +343,7 @@ - + DocBook API Element librarylist @@ -357,7 +357,7 @@ EMPTY Description - Developers aren't generally expected to use this element. Its existence is mainly as a placeholder in boost.xml for the alphabetical list of libraries. + Its existence is mainly as a placeholder in the main XML document for the alphabetical list of libraries. Attributes @@ -381,7 +381,7 @@ - + DocBook API Element library-reference @@ -392,7 +392,7 @@ Declares the reference material for a library library-reference ::= - (title?, section*, (header| library-reference)*) + (title?, section*, (header| library-reference)*) Description Reference documentation for a library is contained with a @@ -444,7 +444,7 @@ - + DocBook API Element api @@ -452,15 +452,14 @@ api - Defines a api book + Defines an API api ::= - (title, (chapter| library)*) + (title, (chapter| library)*) Description This element is the topmost level defined by - boost.xml for all Boost documentation. It will - not generally be used by developers. + main XML file for all API documentation Attributes @@ -484,7 +483,7 @@ - + DocBook API Element union @@ -495,7 +494,7 @@ Declares a C++ union or union template union ::= - (template?, inherit*, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) + (template?, inherit*, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) Attributes @@ -520,7 +519,7 @@ - + DocBook API Element inherit @@ -531,7 +530,7 @@ Declares a base class of the enclosing class or struct inherit ::= - (type, purpose?) + (type, purpose?) Description This element contains the type of the class inherited. @@ -560,7 +559,7 @@ - + DocBook API Element template-varargs @@ -602,7 +601,7 @@ - + DocBook API Element source @@ -613,7 +612,7 @@ Defines source code for a test source ::= - (#PCDATA| snippet)* + (#PCDATA| snippet)* Description This element will contain the source code for a testcase that @@ -625,11 +624,11 @@ In addition to CDATA sections, code snippets can be pulled in - from programlisting elements using the snippet + from programlisting elements using the snippet element. - + DocBook API Element function @@ -640,7 +639,7 @@ Declares a function function ::= - (template?, type, parameter*, purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) + (template?, type, parameter*, purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) Description api functions are documented by specifying the @@ -722,7 +721,7 @@ - + DocBook API Element macroname @@ -730,7 +729,7 @@ macroname - + References a macro with the given name macroname ::= (#PCDATA) @@ -757,7 +756,7 @@ - + DocBook API Element postconditions @@ -792,7 +791,7 @@ - + DocBook API Element compile-test @@ -803,7 +802,7 @@ A testcase that should compile correctly compile-test ::= - (source*, lib*, requirement*, purpose, if-fails?) + (source*, lib*, requirement*, purpose, if-fails?) Attributes @@ -826,7 +825,7 @@ - + DocBook API Element method @@ -837,11 +836,11 @@ Declares a method, i.e., a member function method ::= - (template?, type, parameter*, purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) + (template?, type, parameter*, purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) Description General documentation on functions in api is provided in - the function + the function element documentation. Attributes @@ -869,7 +868,7 @@ - + DocBook API Element snippet @@ -902,7 +901,7 @@ - + DocBook API Element constructor @@ -913,11 +912,11 @@ Declares a constructor of the enclosing class constructor ::= - (template?, parameter*, purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) + (template?, parameter*, purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) Description General documentation on functions in api is provided in - the function + the function element documentation. Attributes @@ -943,7 +942,7 @@ - + DocBook API Element namespace @@ -954,7 +953,7 @@ Declares a namespace namespace ::= - (class| class-specialization| struct| struct-specialization| union| union-specialization| typedef| enum| free-function-group| function| overloaded-function| namespace)* + (class| class-specialization| struct| struct-specialization| union| union-specialization| typedef| enum| free-function-group| function| overloaded-function| namespace)* Description api namespaces are declared via the <namespace> @@ -995,7 +994,7 @@ - + DocBook API Element if-fails @@ -1018,7 +1017,7 @@ - + DocBook API Element headername @@ -1026,7 +1025,7 @@ headername - + References a C++ header with the given name headername ::= (#PCDATA) @@ -1053,7 +1052,7 @@ - + DocBook API Element free-function-group @@ -1064,7 +1063,7 @@ A set of functions that are grouped together under one name free-function-group ::= - (function| overloaded-function)* + (function| overloaded-function)* Attributes @@ -1089,7 +1088,7 @@ - + DocBook API Element functionname @@ -1105,8 +1104,8 @@ Description If a function (or overloaded function) with the given, possibly-qualified name is found, this generates a link to that - function. Lookups obey currently-active using-class - and using-namespace + function. Lookups obey currently-active using-class + and using-namespace directives to aid in the search, along with searching within the current scope. @@ -1133,7 +1132,7 @@ - + DocBook API Element librarycategory @@ -1169,7 +1168,7 @@ - + DocBook API Element notes @@ -1204,7 +1203,7 @@ - + DocBook API Element data-member @@ -1215,7 +1214,7 @@ Declares a data member of a class data-member ::= - (type, purpose?, description?) + (type, purpose?, description?) Attributes @@ -1241,7 +1240,7 @@ - + DocBook API Element specialization @@ -1252,7 +1251,7 @@ Defines the specialization arguments for a class specialization specialization ::= - (template-arg)* + (template-arg)* Attributes @@ -1276,7 +1275,7 @@ - + DocBook API Element union-specialization @@ -1287,7 +1286,7 @@ A specialization (full or partial) of a union template union-specialization ::= - (template?, specialization?, inherit?, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) + (template?, specialization?, inherit?, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) Attributes @@ -1312,7 +1311,7 @@ - + DocBook API Element throws @@ -1347,7 +1346,7 @@ - + DocBook API Element template-arg @@ -1383,7 +1382,7 @@ - + DocBook API Element globalname @@ -1391,7 +1390,7 @@ globalname - + References a global with the given name globalname ::= (#PCDATA) @@ -1418,7 +1417,7 @@ - + DocBook API Element method-group @@ -1429,7 +1428,7 @@ A set of methods that are grouped together under one name method-group ::= - (method| overloaded-method)* + (method| overloaded-method)* Attributes @@ -1454,7 +1453,7 @@ - + DocBook API Element requirement @@ -1496,7 +1495,7 @@ - + DocBook API Element precondition @@ -1531,7 +1530,7 @@ - + DocBook API Element paramtype @@ -1566,7 +1565,7 @@ - + DocBook API Element using-class @@ -1602,7 +1601,7 @@ - + DocBook API Element run-test @@ -1613,7 +1612,7 @@ A testcase that should compile, link, and execute run-test ::= - (source*, lib*, requirement*, purpose, if-fails?) + (source*, lib*, requirement*, purpose, if-fails?) Attributes @@ -1636,7 +1635,7 @@ - + DocBook API Element librarypurpose @@ -1647,7 +1646,7 @@ Describes in one short sentence or phrase the purpose of a library librarypurpose ::= - (#PCDATA| code| ulink| functionname| methodname| classname| macroname| headername| enumname| globalname)* + (#PCDATA| code| ulink| functionname| methodname| classname| macroname| headername| enumname| globalname)* Attributes @@ -1671,7 +1670,7 @@ - + DocBook API Element copy-assignment @@ -1682,7 +1681,7 @@ Declares a copy-assignment operator copy-assignment ::= - (template?, type?, parameter*, purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) + (template?, type?, parameter*, purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) Description The return type of the copy-assignment operator does not need @@ -1690,7 +1689,7 @@ unqualified reference to the enclosing class type. General documentation on functions in api is provided in - the function + the function element documentation. Attributes @@ -1717,7 +1716,7 @@ - + DocBook API Element run-fail-test @@ -1728,7 +1727,7 @@ A testcase that should compile and link, but fail on execution run-fail-test ::= - (source*, lib*, requirement*, purpose, if-fails?) + (source*, lib*, requirement*, purpose, if-fails?) Attributes @@ -1751,7 +1750,7 @@ - + DocBook API Element template @@ -1762,7 +1761,7 @@ Declares the template parameters of a class or function template ::= - (template-type-parameter| template-nontype-parameter| template-varargs)* + (template-type-parameter| template-nontype-parameter| template-varargs)* Attributes @@ -1786,7 +1785,7 @@ - + DocBook API Element compile-fail-test @@ -1797,7 +1796,7 @@ A testcase that should fail to compile compile-fail-test ::= - (source*, lib*, requirement*, purpose, if-fails?) + (source*, lib*, requirement*, purpose, if-fails?) Attributes @@ -1820,7 +1819,7 @@ - + DocBook API Element returns @@ -1855,7 +1854,7 @@ - + DocBook API Element default @@ -1890,7 +1889,7 @@ - + DocBook API Element parameter @@ -1901,7 +1900,7 @@ A function parameter parameter ::= - (paramtype, default?, description?) + (paramtype, default?, description?) Attributes @@ -1924,7 +1923,7 @@ - + DocBook API Element signature @@ -1935,7 +1934,7 @@ One signature of an overloaded function or method signature ::= - (template?, type, parameter*) + (template?, type, parameter*) Description @@ -1970,7 +1969,7 @@ - + DocBook API Element overloaded-function @@ -1981,11 +1980,11 @@ An overloaded function overloaded-function ::= - (signature*, purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) + (signature*, purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) Description General documentation on functions in api is provided in - the function + the function element documentation. Attributes @@ -2011,7 +2010,7 @@ - + DocBook API Element access @@ -2022,7 +2021,7 @@ Declares an access specification for class members access ::= - (static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| method| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)+ + (static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| method| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)+ Description The access specifications of class members (public, private, or protected) may be determined by enclosing them in an <access> element. @@ -2049,7 +2048,7 @@ - + DocBook API Element class @@ -2060,7 +2059,7 @@ Declares a class or class template class ::= - (template?, inherit*, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) + (template?, inherit*, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) Description C++ classes and class templates are described via the @@ -2130,7 +2129,7 @@ - + DocBook API Element librarycategorydef @@ -2144,7 +2143,7 @@ (#PCDATA) Description - All library category definitions should be in doc/src/boost.xml, and the names of categories must be prefixed with "category:". + All library category definitions should be in the main xml file, and the names of categories must be prefixed with "category:". Attributes @@ -2169,7 +2168,7 @@ - + DocBook API Element type @@ -2204,7 +2203,7 @@ - + DocBook API Element enumvalue @@ -2215,7 +2214,7 @@ A single value of an enumeration enumvalue ::= - (default?, purpose?, description?) + (default?, purpose?, description?) Attributes @@ -2240,7 +2239,7 @@ - + DocBook API Element overloaded-method @@ -2251,11 +2250,11 @@ An overloaded method overloaded-method ::= - (signature*, purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) + (signature*, purpose?, description?, requires?, effects?, postconditions?, returns?, throws?, complexity?, notes?, rationale?) Description General documentation on functions in api is provided in - the function + the function element documentation. Attributes @@ -2281,7 +2280,7 @@ - + DocBook API Element programlisting @@ -2314,7 +2313,7 @@ - + DocBook API Element complexity @@ -2349,7 +2348,7 @@ - + DocBook API Element purpose @@ -2384,7 +2383,7 @@ - + DocBook API Element template-nontype-parameter @@ -2395,7 +2394,7 @@ A nontype template parameter template-nontype-parameter ::= - (type, default?, purpose?) + (type, default?, purpose?) Attributes @@ -2421,7 +2420,7 @@ - + DocBook API Element library @@ -2432,7 +2431,7 @@ Top-level element for a library library ::= - (libraryinfo, (title, ((section| library-reference| testsuite))+)?) + (libraryinfo, (title, ((section| library-reference| testsuite))+)?) Attributes @@ -2460,7 +2459,7 @@ - + DocBook API Element librarycategorylist @@ -2471,11 +2470,10 @@ Categorized listing of libraries librarycategorylist ::= - (librarycategorydef)* + (librarycategorydef)* Description - This element is not intended for use by developers, but is - used by doc/src/boost.xml as a + This element is used by the main XML document as a placeholder. Attributes @@ -2500,7 +2498,7 @@ - + DocBook API Element using-namespace @@ -2536,7 +2534,7 @@ - + DocBook API Element enumname @@ -2544,7 +2542,7 @@ enumname - + References an enumeration type with the given name enumname ::= (#PCDATA) @@ -2571,7 +2569,7 @@ - + DocBook API Element struct-specialization @@ -2582,7 +2580,7 @@ A specialization (full or partial) of a struct template struct-specialization ::= - (template?, specialization?, inherit?, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) + (template?, specialization?, inherit?, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) Attributes @@ -2607,7 +2605,7 @@ - + DocBook API Element struct @@ -2618,7 +2616,7 @@ Declares a C++ struct struct ::= - (template?, inherit*, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) + (template?, inherit*, purpose?, description?, (access| static-constant| typedef| enum| copy-assignment| constructor| destructor| method-group| free-function-group| function| method| overloaded-function| overloaded-method| data-member| class| class-specialization| struct| struct-specialization| union| union-specialization)*) Attributes @@ -2643,7 +2641,7 @@ - + DocBook API Element lib @@ -2660,7 +2658,7 @@ Declares a library dependency on the library named by the content of this element, to be emitted in a Jamfile. - + DocBook API Element enum @@ -2671,7 +2669,7 @@ Declares an enumeration type enum ::= - (enumvalue*, purpose?, description?) + (enumvalue*, purpose?, description?) Attributes @@ -2696,7 +2694,7 @@ - + DocBook API Element requires @@ -2731,7 +2729,7 @@ - + DocBook API Element effects @@ -2766,7 +2764,7 @@ - + DocBook API Element libraryname @@ -2801,7 +2799,7 @@ - + DocBook API Element libraryinfo @@ -2812,7 +2810,7 @@ Provides information about a library libraryinfo ::= - (author+, copyright*, legalnotice*, librarypurpose, librarycategory*) + (author+, copyright*, legalnotice*, librarypurpose, librarycategory*) Attributes @@ -2836,7 +2834,7 @@ - + DocBook API Element testsuite @@ -2847,7 +2845,7 @@ Describes a library testsuite testsuite ::= - ((compile-test| link-test| run-test| compile-fail-test| link-fail-test| run-fail-test)+) + ((compile-test| link-test| run-test| compile-fail-test| link-fail-test| run-fail-test)+) Attributes @@ -2871,7 +2869,7 @@ - + DocBook API Element header @@ -2907,7 +2905,7 @@ - + DocBook API element rationale diff --git a/xsl/api/html-base.xsl b/xsl/api/html-base.xsl index c1e661b4d..272fc0aa8 100644 --- a/xsl/api/html-base.xsl +++ b/xsl/api/html-base.xsl @@ -14,19 +14,19 @@ xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" - - + + - boostbook.css + api.css - + - - + + @@ -36,7 +36,7 @@ xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" 1 - + @@ -49,13 +49,13 @@ xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" false yes US-ASCII - + 2 15 - - + + + select = "concat($api.graphics.root, 'callouts/')"/> @@ -185,7 +185,7 @@ set toc,title - +
@@ -208,7 +208,7 @@ set toc,title - + @@ -250,9 +250,9 @@ set toc,title
+ mode="api.footer"/> + mode="api.footer"/>
diff --git a/xsl/api/navbar.xsl b/xsl/api/navbar.xsl index 9857e920b..4479ecb6e 100644 --- a/xsl/api/navbar.xsl +++ b/xsl/api/navbar.xsl @@ -15,27 +15,27 @@ version="1.0"> - + - horizontal + horizontal none @@ -48,34 +48,34 @@ version="1.0"> --> - + - + - - - + + + - - + + - - + + - - + + - @@ -90,19 +90,19 @@ version="1.0"> - - boost-head + + api-head + + - - + + @@ -193,12 +193,12 @@ version="1.0"> - + @@ -210,18 +210,18 @@ version="1.0">
- + background-color: white; width: 50%; - - {$boost.image.alt} + + {$api.image.alt} - + @@ -143,43 +143,43 @@ version="1.0"> - + - + - - HomeHome ProjectProject Home
- - boost-toc + + api-toc