DocBook API Reference

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/api.html b/docbook/relaxng/api/doc/html/docbook/api/api.html index 1fd85e6b8..9136f1c95 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/api.html +++ b/docbook/relaxng/api/doc/html/docbook/api/api.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,12 +29,12 @@ (title, (chapter| library)*)

Description

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

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/class-specialization.html b/docbook/relaxng/api/doc/html/docbook/api/class-specialization.html index 7ff4f61ed..5832edb49 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/class-specialization.html +++ b/docbook/relaxng/api/doc/html/docbook/api/class-specialization.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/class.html b/docbook/relaxng/api/doc/html/docbook/api/class.html index 4da88851f..8dea1a848 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/class.html +++ b/docbook/relaxng/api/doc/html/docbook/api/class.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

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 @@ -79,7 +75,7 @@ <template> child element at the beginning.

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/code.html b/docbook/relaxng/api/doc/html/docbook/api/code.html index cc69e7689..1ec5a1f11 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/code.html +++ b/docbook/relaxng/api/doc/html/docbook/api/code.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,14 +29,14 @@ (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

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 index a463077fa..78733b43b 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/compile-fail-test.html +++ b/docbook/relaxng/api/doc/html/docbook/api/compile-fail-test.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (source*, lib*, requirement*, purpose, if-fails?)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/compile-test.html b/docbook/relaxng/api/doc/html/docbook/api/compile-test.html index c1098524a..f2c5e5332 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/compile-test.html +++ b/docbook/relaxng/api/doc/html/docbook/api/compile-test.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (source*, lib*, requirement*, purpose, if-fails?)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/complexity.html b/docbook/relaxng/api/doc/html/docbook/api/complexity.html index c53692ab9..60cabfdd9 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/complexity.html +++ b/docbook/relaxng/api/doc/html/docbook/api/complexity.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (ANY)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/constructor.html b/docbook/relaxng/api/doc/html/docbook/api/constructor.html index 966a9e9bb..41d453c10 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/constructor.html +++ b/docbook/relaxng/api/doc/html/docbook/api/constructor.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,13 +29,13 @@ (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

diff --git a/docbook/relaxng/api/doc/html/docbook/api/copy-assignment.html b/docbook/relaxng/api/doc/html/docbook/api/copy-assignment.html index e742e25a7..ae260ebd4 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/copy-assignment.html +++ b/docbook/relaxng/api/doc/html/docbook/api/copy-assignment.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (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.

@@ -43,7 +39,7 @@ element documentation.

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/data-member.html b/docbook/relaxng/api/doc/html/docbook/api/data-member.html index d2fa21a1b..ad2495733 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/data-member.html +++ b/docbook/relaxng/api/doc/html/docbook/api/data-member.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (type, purpose?, description?)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/default.html b/docbook/relaxng/api/doc/html/docbook/api/default.html index f997f90d0..11e3ace49 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/default.html +++ b/docbook/relaxng/api/doc/html/docbook/api/default.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (ANY)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/description.html b/docbook/relaxng/api/doc/html/docbook/api/description.html index 8a14068dc..c69b2dbd8 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/description.html +++ b/docbook/relaxng/api/doc/html/docbook/api/description.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (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 @@ -43,7 +39,7 @@ etc.

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/destructor.html b/docbook/relaxng/api/doc/html/docbook/api/destructor.html index 3e9246c74..8320beff4 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/destructor.html +++ b/docbook/relaxng/api/doc/html/docbook/api/destructor.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,13 +29,13 @@ (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

diff --git a/docbook/relaxng/api/doc/html/docbook/api/effects.html b/docbook/relaxng/api/doc/html/docbook/api/effects.html index e037a2154..08b3f80e1 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/effects.html +++ b/docbook/relaxng/api/doc/html/docbook/api/effects.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (ANY)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/enum.html b/docbook/relaxng/api/doc/html/docbook/api/enum.html index ff420182c..d50e1b8aa 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/enum.html +++ b/docbook/relaxng/api/doc/html/docbook/api/enum.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (enumvalue*, purpose?, description?)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/enumname.html b/docbook/relaxng/api/doc/html/docbook/api/enumname.html index 4be9fb2c2..709369b0f 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/enumname.html +++ b/docbook/relaxng/api/doc/html/docbook/api/enumname.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (#PCDATA)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/enumvalue.html b/docbook/relaxng/api/doc/html/docbook/api/enumvalue.html index f04a920b7..e142574e5 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/enumvalue.html +++ b/docbook/relaxng/api/doc/html/docbook/api/enumvalue.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (default?, purpose?, description?)

Attributes

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 index f96ad4c32..d43b41d8c 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/free-function-group.html +++ b/docbook/relaxng/api/doc/html/docbook/api/free-function-group.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (function| overloaded-function)*

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/function.html b/docbook/relaxng/api/doc/html/docbook/api/function.html index 561f2540f..771120467 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/function.html +++ b/docbook/relaxng/api/doc/html/docbook/api/function.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (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 @@ -90,7 +86,7 @@ </class>

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/functionname.html b/docbook/relaxng/api/doc/html/docbook/api/functionname.html index ec356c815..269f72eb2 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/functionname.html +++ b/docbook/relaxng/api/doc/html/docbook/api/functionname.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (#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 @@ -42,7 +38,7 @@ current scope.

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/globalname.html b/docbook/relaxng/api/doc/html/docbook/api/globalname.html index 4042c58ef..6eb0d936f 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/globalname.html +++ b/docbook/relaxng/api/doc/html/docbook/api/globalname.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (#PCDATA)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/header.html b/docbook/relaxng/api/doc/html/docbook/api/header.html index df4d8db0a..ce3bea039 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/header.html +++ b/docbook/relaxng/api/doc/html/docbook/api/header.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (ANY)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/headername.html b/docbook/relaxng/api/doc/html/docbook/api/headername.html index 9b35d6ae7..ff2394842 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/headername.html +++ b/docbook/relaxng/api/doc/html/docbook/api/headername.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (#PCDATA)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/if-fails.html b/docbook/relaxng/api/doc/html/docbook/api/if-fails.html index 10f83e728..40b0bf456 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/if-fails.html +++ b/docbook/relaxng/api/doc/html/docbook/api/if-fails.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (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 diff --git a/docbook/relaxng/api/doc/html/docbook/api/inherit.html b/docbook/relaxng/api/doc/html/docbook/api/inherit.html index 630cc5a05..323b55c88 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/inherit.html +++ b/docbook/relaxng/api/doc/html/docbook/api/inherit.html @@ -8,11 +8,7 @@ - - - - -
DocBook API Dcoumentation Home Project
+

@@ -33,11 +29,11 @@ (type, purpose?)

Description

This element contains the type of the class inherited.

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/lib.html b/docbook/relaxng/api/doc/html/docbook/api/lib.html index 5c52120c4..43edf718d 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/lib.html +++ b/docbook/relaxng/api/doc/html/docbook/api/lib.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (#PCDATA)

Description

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

diff --git a/docbook/relaxng/api/doc/html/docbook/api/library-reference.html b/docbook/relaxng/api/doc/html/docbook/api/library-reference.html index 34fcd2576..c88345f56 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/library-reference.html +++ b/docbook/relaxng/api/doc/html/docbook/api/library-reference.html @@ -8,11 +8,7 @@ - - - - -

Home

Project

@@ -33,7 +29,7 @@ (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 @@ -62,7 +58,7 @@ that each contain different headers.

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/library.html b/docbook/relaxng/api/doc/html/docbook/api/library.html index b2bb06457..71208b523 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/library.html +++ b/docbook/relaxng/api/doc/html/docbook/api/library.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (libraryinfo, (title, ((section| library-reference| testsuite))+)?)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/librarycategory.html b/docbook/relaxng/api/doc/html/docbook/api/librarycategory.html index 809eb14e8..cc1cfc9d8 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/librarycategory.html +++ b/docbook/relaxng/api/doc/html/docbook/api/librarycategory.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (#PCDATA)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/librarycategorydef.html b/docbook/relaxng/api/doc/html/docbook/api/librarycategorydef.html index a1db69d90..dd782001b 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/librarycategorydef.html +++ b/docbook/relaxng/api/doc/html/docbook/api/librarycategorydef.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,11 +29,11 @@ (#PCDATA)

Description

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

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/librarycategorylist.html b/docbook/relaxng/api/doc/html/docbook/api/librarycategorylist.html index d6d8835e6..713613e0c 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/librarycategorylist.html +++ b/docbook/relaxng/api/doc/html/docbook/api/librarycategorylist.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,12 +29,12 @@ (librarycategorydef)*

Description

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

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/libraryinfo.html b/docbook/relaxng/api/doc/html/docbook/api/libraryinfo.html index cbbce5e7f..3e1adb9bd 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/libraryinfo.html +++ b/docbook/relaxng/api/doc/html/docbook/api/libraryinfo.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (author+, copyright*, legalnotice*, librarypurpose, librarycategory*)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/librarylist.html b/docbook/relaxng/api/doc/html/docbook/api/librarylist.html index bb94a4a9e..9c3492949 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/librarylist.html +++ b/docbook/relaxng/api/doc/html/docbook/api/librarylist.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,11 +29,11 @@ EMPTY

Description

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

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/libraryname.html b/docbook/relaxng/api/doc/html/docbook/api/libraryname.html index 329d65b30..5f8d11b60 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/libraryname.html +++ b/docbook/relaxng/api/doc/html/docbook/api/libraryname.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (#PCDATA)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/librarypurpose.html b/docbook/relaxng/api/doc/html/docbook/api/librarypurpose.html index 9f2eea5bd..cc2b6de45 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/librarypurpose.html +++ b/docbook/relaxng/api/doc/html/docbook/api/librarypurpose.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

Attributes

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 index e6c73aeae..e987d32b7 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/link-fail-test.html +++ b/docbook/relaxng/api/doc/html/docbook/api/link-fail-test.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (source*, lib*, requirement*, purpose, if-fails?)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/link-test.html b/docbook/relaxng/api/doc/html/docbook/api/link-test.html index 6af8b5197..536ab3749 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/link-test.html +++ b/docbook/relaxng/api/doc/html/docbook/api/link-test.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (source*, lib*, requirement*, purpose, if-fails?)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/macroname.html b/docbook/relaxng/api/doc/html/docbook/api/macroname.html index 8d8fbb54d..185c533c7 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/macroname.html +++ b/docbook/relaxng/api/doc/html/docbook/api/macroname.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (#PCDATA)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/method-group.html b/docbook/relaxng/api/doc/html/docbook/api/method-group.html index 55e892d55..d50ed0856 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/method-group.html +++ b/docbook/relaxng/api/doc/html/docbook/api/method-group.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (method| overloaded-method)*

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/method.html b/docbook/relaxng/api/doc/html/docbook/api/method.html index afd966ebf..fd80c05bb 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/method.html +++ b/docbook/relaxng/api/doc/html/docbook/api/method.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,13 +29,13 @@ (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

diff --git a/docbook/relaxng/api/doc/html/docbook/api/namespace.html b/docbook/relaxng/api/doc/html/docbook/api/namespace.html index a0193cb83..b2d8230e7 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/namespace.html +++ b/docbook/relaxng/api/doc/html/docbook/api/namespace.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

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 @@ -50,7 +46,7 @@ </library-reference>

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/notes.html b/docbook/relaxng/api/doc/html/docbook/api/notes.html index b3194a6f3..ca337d248 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/notes.html +++ b/docbook/relaxng/api/doc/html/docbook/api/notes.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (ANY)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/overloaded-function.html b/docbook/relaxng/api/doc/html/docbook/api/overloaded-function.html index f27422c6a..8ce25f4c5 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/overloaded-function.html +++ b/docbook/relaxng/api/doc/html/docbook/api/overloaded-function.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,13 +29,13 @@ (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

diff --git a/docbook/relaxng/api/doc/html/docbook/api/overloaded-method.html b/docbook/relaxng/api/doc/html/docbook/api/overloaded-method.html index 83cba4ca1..8a5986d6a 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/overloaded-method.html +++ b/docbook/relaxng/api/doc/html/docbook/api/overloaded-method.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,13 +29,13 @@ (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

diff --git a/docbook/relaxng/api/doc/html/docbook/api/parameter.html b/docbook/relaxng/api/doc/html/docbook/api/parameter.html index df0aab746..42a7cbeff 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/parameter.html +++ b/docbook/relaxng/api/doc/html/docbook/api/parameter.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (paramtype, default?, description?)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/paramtype.html b/docbook/relaxng/api/doc/html/docbook/api/paramtype.html index c5eb952be..1006f0525 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/paramtype.html +++ b/docbook/relaxng/api/doc/html/docbook/api/paramtype.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (ANY)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/postconditions.html b/docbook/relaxng/api/doc/html/docbook/api/postconditions.html index 956f7c2cf..d9754030f 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/postconditions.html +++ b/docbook/relaxng/api/doc/html/docbook/api/postconditions.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (ANY)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/precondition.html b/docbook/relaxng/api/doc/html/docbook/api/precondition.html index c00b90c88..450f715d6 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/precondition.html +++ b/docbook/relaxng/api/doc/html/docbook/api/precondition.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (ANY)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/programlisting.html b/docbook/relaxng/api/doc/html/docbook/api/programlisting.html index a783cd679..d09b41bc8 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/programlisting.html +++ b/docbook/relaxng/api/doc/html/docbook/api/programlisting.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (ANY)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/purpose.html b/docbook/relaxng/api/doc/html/docbook/api/purpose.html index fef34eef3..7946ac4ab 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/purpose.html +++ b/docbook/relaxng/api/doc/html/docbook/api/purpose.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (ANY)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/rationale.html b/docbook/relaxng/api/doc/html/docbook/api/rationale.html index 670290e8c..9a4afb4cd 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/rationale.html +++ b/docbook/relaxng/api/doc/html/docbook/api/rationale.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (ANY)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/requirement.html b/docbook/relaxng/api/doc/html/docbook/api/requirement.html index c24e31e0e..420572b2d 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/requirement.html +++ b/docbook/relaxng/api/doc/html/docbook/api/requirement.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (#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 @@ -43,7 +39,7 @@ name="includes">foo.hpp</requirement>.

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/requires.html b/docbook/relaxng/api/doc/html/docbook/api/requires.html index 26b0efc72..61c1c9c91 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/requires.html +++ b/docbook/relaxng/api/doc/html/docbook/api/requires.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (ANY)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/returns.html b/docbook/relaxng/api/doc/html/docbook/api/returns.html index 982893330..48e831809 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/returns.html +++ b/docbook/relaxng/api/doc/html/docbook/api/returns.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (ANY)

Attributes

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 index efd96d60b..a90b7e795 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/run-fail-test.html +++ b/docbook/relaxng/api/doc/html/docbook/api/run-fail-test.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (source*, lib*, requirement*, purpose, if-fails?)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/run-test.html b/docbook/relaxng/api/doc/html/docbook/api/run-test.html index 3d1a6222f..1858b41bb 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/run-test.html +++ b/docbook/relaxng/api/doc/html/docbook/api/run-test.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (source*, lib*, requirement*, purpose, if-fails?)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/signature.html b/docbook/relaxng/api/doc/html/docbook/api/signature.html index bdea042d9..a90aa0e4e 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/signature.html +++ b/docbook/relaxng/api/doc/html/docbook/api/signature.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (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 @@ -43,7 +39,7 @@

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/snippet.html b/docbook/relaxng/api/doc/html/docbook/api/snippet.html index 68c1b4743..0d60ae7be 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/snippet.html +++ b/docbook/relaxng/api/doc/html/docbook/api/snippet.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ EMPTY

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/source.html b/docbook/relaxng/api/doc/html/docbook/api/source.html index 173ca1844..6d530dadd 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/source.html +++ b/docbook/relaxng/api/doc/html/docbook/api/source.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (#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: diff --git a/docbook/relaxng/api/doc/html/docbook/api/specialization.html b/docbook/relaxng/api/doc/html/docbook/api/specialization.html index 2897841c3..b2c600010 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/specialization.html +++ b/docbook/relaxng/api/doc/html/docbook/api/specialization.html @@ -8,11 +8,7 @@ - - - - -
DocBook API Dcoumentation Home Project
+

@@ -33,7 +29,7 @@ (template-arg)*

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/static-constant.html b/docbook/relaxng/api/doc/html/docbook/api/static-constant.html index 55cd4a501..d66929c4c 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/static-constant.html +++ b/docbook/relaxng/api/doc/html/docbook/api/static-constant.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (type, default, purpose?, description?)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/struct-specialization.html b/docbook/relaxng/api/doc/html/docbook/api/struct-specialization.html index e138c28d0..cc14edc1c 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/struct-specialization.html +++ b/docbook/relaxng/api/doc/html/docbook/api/struct-specialization.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/struct.html b/docbook/relaxng/api/doc/html/docbook/api/struct.html index b7c752fb0..f35d65392 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/struct.html +++ b/docbook/relaxng/api/doc/html/docbook/api/struct.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/template-arg.html b/docbook/relaxng/api/doc/html/docbook/api/template-arg.html index b17085921..624f05861 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/template-arg.html +++ b/docbook/relaxng/api/doc/html/docbook/api/template-arg.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (ANY)

Attributes

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 index 24a8bd43f..2e64b18f9 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/template-nontype-parameter.html +++ b/docbook/relaxng/api/doc/html/docbook/api/template-nontype-parameter.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (type, default?, purpose?)

Attributes

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 index 5523eada4..18f79e146 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/template-type-parameter.html +++ b/docbook/relaxng/api/doc/html/docbook/api/template-type-parameter.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (default?, purpose?)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/template-varargs.html b/docbook/relaxng/api/doc/html/docbook/api/template-varargs.html index 74201dc6b..456d5a368 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/template-varargs.html +++ b/docbook/relaxng/api/doc/html/docbook/api/template-varargs.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ 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 @@ -41,7 +37,7 @@ used.

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/template.html b/docbook/relaxng/api/doc/html/docbook/api/template.html index cd9d0125c..4cc68599a 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/template.html +++ b/docbook/relaxng/api/doc/html/docbook/api/template.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (template-type-parameter| template-nontype-parameter| template-varargs)*

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/testsuite.html b/docbook/relaxng/api/doc/html/docbook/api/testsuite.html index c2d33bf84..0e8143d8e 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/testsuite.html +++ b/docbook/relaxng/api/doc/html/docbook/api/testsuite.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/throws.html b/docbook/relaxng/api/doc/html/docbook/api/throws.html index 694d2d317..a7c91eaa3 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/throws.html +++ b/docbook/relaxng/api/doc/html/docbook/api/throws.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (ANY)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/type.html b/docbook/relaxng/api/doc/html/docbook/api/type.html index 2428c7e37..4a8ab4afe 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/type.html +++ b/docbook/relaxng/api/doc/html/docbook/api/type.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (ANY)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/typedef.html b/docbook/relaxng/api/doc/html/docbook/api/typedef.html index 204cf4f41..c66266577 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/typedef.html +++ b/docbook/relaxng/api/doc/html/docbook/api/typedef.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ (type, purpose?, description?)

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/union-specialization.html b/docbook/relaxng/api/doc/html/docbook/api/union-specialization.html index 1baecc4f4..286c8fad6 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/union-specialization.html +++ b/docbook/relaxng/api/doc/html/docbook/api/union-specialization.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/union.html b/docbook/relaxng/api/doc/html/docbook/api/union.html index e4f7e182f..71348941b 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/union.html +++ b/docbook/relaxng/api/doc/html/docbook/api/union.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/using-class.html b/docbook/relaxng/api/doc/html/docbook/api/using-class.html index dec7bad5d..013623957 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/using-class.html +++ b/docbook/relaxng/api/doc/html/docbook/api/using-class.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ EMPTY

Attributes

diff --git a/docbook/relaxng/api/doc/html/docbook/api/using-namespace.html b/docbook/relaxng/api/doc/html/docbook/api/using-namespace.html index 6503522c5..f69e73a7c 100644 --- a/docbook/relaxng/api/doc/html/docbook/api/using-namespace.html +++ b/docbook/relaxng/api/doc/html/docbook/api/using-namespace.html @@ -8,11 +8,7 @@ -

- - - -

Home

Project

@@ -33,7 +29,7 @@ EMPTY

Attributes

diff --git a/docbook/relaxng/api/doc/html/images/db-api.png b/docbook/relaxng/api/doc/html/images/db-api.png new file mode 100644 index 000000000..001a168dd Binary files /dev/null and b/docbook/relaxng/api/doc/html/images/db-api.png differ diff --git a/docbook/relaxng/api/doc/html/index.html b/docbook/relaxng/api/doc/html/index.html index 64d854931..2dd6cc6f1 100644 --- a/docbook/relaxng/api/doc/html/index.html +++ b/docbook/relaxng/api/doc/html/index.html @@ -7,333 +7,95 @@ -

- - - -

Home

Project

-DocBook API Reference

+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 -

- +

Elements:

diff --git a/docbook/relaxng/api/doc/reference.xml b/docbook/relaxng/api/doc/reference.xml index 3472b3e98..f1c841af5 100644 --- a/docbook/relaxng/api/doc/reference.xml +++ b/docbook/relaxng/api/doc/reference.xml @@ -1,9 +1,7 @@

DocBook API Reference - diff --git a/xsl/api/html-base.xsl b/xsl/api/html-base.xsl index 272fc0aa8..83f6a6ec2 100644 --- a/xsl/api/html-base.xsl +++ b/xsl/api/html-base.xsl @@ -46,7 +46,7 @@ xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" - false + true yes US-ASCII @@ -68,7 +68,6 @@ xmlns:rev="http://www.cs.rpi.edu/~gregod/boost/tools/doc/revision" appendix toc,title article/appendix nop -article toc,title book toc,title chapter toc,title part toc,title diff --git a/xsl/api/navbar.xsl b/xsl/api/navbar.xsl index 4479ecb6e..d517c5ee8 100644 --- a/xsl/api/navbar.xsl +++ b/xsl/api/navbar.xsl @@ -29,7 +29,7 @@ version="1.0"> --> - horizontal + none none @@ -38,7 +38,7 @@ version="1.0"> API - place the old-API border around the header *none - do not place a border around the header --> - + - + @@ -65,12 +65,12 @@ version="1.0"> - + - +