DITA-OT_CXX_Plugin/cxxapiref/doc/html/cxxAPILayer.html
author Jonathan Harrington <jonathan.harrington@nokia.com>
Wed, 11 Aug 2010 14:49:30 +0100
changeset 4 468f4c8d3d5b
permissions -rw-r--r--
Orb version 0.2.0
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
4
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
     1
<?xml version="1.0" encoding="UTF-8"?>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
     2
<!DOCTYPE html
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
     3
  PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd">
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
     4
<html lang="en-us" xml:lang="en-us">
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
     5
<head>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
     6
<meta http-equiv="Content-Type" content="text/html; charset=utf-8"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
     7
<meta name="copyright" content="(C) Copyright 2005"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
     8
<meta name="DC.rights.owner" content="(C) Copyright 2005"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
     9
<meta name="DC.Type" content="reference"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    10
<meta name="DC.Title" content="C++ topic types"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    11
<meta name="abstract" content="The C++ API specialization provides a set of specific topic types that can describe a C++ application programming interface (API) library. The C++ language-specific API topic types are specialized from the generic API reference topic types. This specialization permits the sharing of the basic semantics and processing."/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    12
<meta name="description" content="The C++ API specialization provides a set of specific topic types that can describe a C++ application programming interface (API) library. The C++ language-specific API topic types are specialized from the generic API reference topic types. This specialization permits the sharing of the basic semantics and processing."/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    13
<meta name="DC.Relation" scheme="URI" content="cxxAPIDomain/cxxAPIDomain_module.html"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    14
<meta name="DC.Relation" scheme="URI" content="cxxAPIMap/cxxAPIMap_module.html"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    15
<meta name="DC.Relation" scheme="URI" content="cxxClass/cxxClass_module.html"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    16
<meta name="DC.Relation" scheme="URI" content="cxxDefine/cxxDefine_module.html"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    17
<meta name="DC.Relation" scheme="URI" content="cxxEnumeration/cxxEnumeration_module.html"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    18
<meta name="DC.Relation" scheme="URI" content="cxxFile/cxxFile_module.html"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    19
<meta name="DC.Relation" scheme="URI" content="cxxFunction/cxxFunction_module.html"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    20
<meta name="DC.Relation" scheme="URI" content="cxxStruct/cxxStruct_module.html"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    21
<meta name="DC.Relation" scheme="URI" content="cxxTypedef/cxxTypedef_module.html"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    22
<meta name="DC.Relation" scheme="URI" content="cxxUnion/cxxUnion_module.html"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    23
<meta name="DC.Relation" scheme="URI" content="cxxVariable/cxxVariable_module.html"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    24
<meta name="DC.Format" content="XHTML"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    25
<meta name="DC.Identifier" content="cxxAPILayer"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    26
<meta name="DC.Language" content="en-us"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    27
<link rel="stylesheet" type="text/css" href="commonltr.css"/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    28
<title>C++ topic types</title>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    29
<link rel="stylesheet" type="text/css" href="nokiacxxref.css"/></head>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    30
<body class="moduleset" id="cxxAPILayer"><a name="cxxAPILayer"><!-- --></a>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    31
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    32
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    33
<h1 class="topictitle1">C++ topic types</h1>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    34
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    35
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    36
<div><p>The C++ API specialization provides a set of specific topic types
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    37
that can describe a C++ application programming interface (API) library.
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    38
The C++ language-specific API topic types are specialized from the generic
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    39
API reference topic types. This specialization permits the sharing of the
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    40
basic semantics and processing. </p>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    41
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    42
<div class="section"><h2 class="sectiontitle">Description</h2><p>The C++ modules describe the C++ topic
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    43
types and their contained elements. For example, the cxxClass module describes
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    44
all the elements necessary to describe a C++ class.</p>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    45
</div>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    46
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    47
</div>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    48
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    49
<div>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    50
<ul class="ullinks">
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    51
<li class="ulchildlink"><strong><a href="cxxAPIDomain/cxxAPIDomain_module.html">cxxapi-domain module</a></strong><br/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    52
Provides the description of the elements that refer to the API items within C++ API      topics or other DITA topic types, such as concept or task.</li>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    53
<li class="ulchildlink"><strong><a href="cxxAPIMap/cxxAPIMap_module.html">cxxAPIMap module</a></strong><br/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    54
Provides the relationships among a set of C++ API topic types, and can be used to create a Table of Contents (TOC), aggregate C++ API topics into a PDF document, or to create links between topics in output.</li>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    55
<li class="ulchildlink"><strong><a href="cxxClass/cxxClass_module.html">cxxClass module</a></strong><br/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    56
Defines a top-level container for all the elements necessary to describe an C++ API class. </li>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    57
<li class="ulchildlink"><strong><a href="cxxDefine/cxxDefine_module.html">cxxDefine module</a></strong><br/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    58
Defines a top-level container for all the elements necessary to describe a define. </li>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    59
<li class="ulchildlink"><strong><a href="cxxEnumeration/cxxEnumeration_module.html">cxxEnumeration module</a></strong><br/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    60
Defines a top-level container for all the elements necessary to describe an C++ API enumeration. </li>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    61
<li class="ulchildlink"><strong><a href="cxxFile/cxxFile_module.html">cxxFile module</a></strong><br/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    62
The cxxFile module defines a top-level container for all the elements necessary to describe the global APIs of a component</li>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    63
<li class="ulchildlink"><strong><a href="cxxFunction/cxxFunction_module.html">cxxFunction module</a></strong><br/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    64
The cxxFunction module describes C++ functions, including member functions.</li>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    65
<li class="ulchildlink"><strong><a href="cxxStruct/cxxStruct_module.html">cxxStruct module</a></strong><br/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    66
Defines a top-level container for all the elements necessary to describe an C++ API struct. </li>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    67
<li class="ulchildlink"><strong><a href="cxxTypedef/cxxTypedef_module.html">cxxTypedef module</a></strong><br/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    68
Defines a top-level container for all the elements necessary to describe an C++ API typedef. </li>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    69
<li class="ulchildlink"><strong><a href="cxxUnion/cxxUnion_module.html">cxxUnion module</a></strong><br/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    70
Defines a top-level container for all the elements necessary to describe a C++ API union. </li>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    71
<li class="ulchildlink"><strong><a href="cxxVariable/cxxVariable_module.html">cxxVariable module</a></strong><br/>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    72
Defines a top-level container for all the elements necessary to describe a variable.</li>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    73
</ul>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    74
</div>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    75
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    76
</body>
468f4c8d3d5b Orb version 0.2.0
Jonathan Harrington <jonathan.harrington@nokia.com>
parents:
diff changeset
    77
</html>