APIs elements

There are two types of elements for APIs:

• A first type of elements act like external references and link to an existing API (for example, to a resource on the web)
• A second type of elements embed the API in the wiki

Link to an existing API

The elements which link to an existing API are:

• javadoc: link to a Java API
• qtdoc: link to a Qt API
• pydoc: link to a Python API
• dotnetdoc: link to a .NET API
• doxygen: link to an API produced by Doxygen

The location of APIs can be configured by the APIs property in the configuration file.

For example:

   This is a link to <javadoc path="java.awt.Button" />

Has the following result: This is a link to Button

Embed an API

There are several elements which allow to embed an existing API:

• javaAPI: embed a Java API
• pythonAPI: embed a Python API
• apidoc: embed any language API. The model for the languages can be configured by the API documentation configuration

For example:

  <apidoc lang="python" type="module" path="Class">Representation of a class documentation
     <element type="field" path="doc">A mapping from identifier name to a Doc objects</element>
     <element type="method" path="class_variables(self, include_inherited=True, sort=True)">
  Returns an optionaly-sorted list of Variable objects that represent this class class variables.</element>
  </apidoc>

Has the following result:

module Class

Representation of a class documentation

def	doc A mapping from identifier name to a Doc objects

def	class_variables(self, include_inherited=True, sort=True) Returns an optionaly-sorted list of Variable objects that represent this class class variables.

APIs provided by default

The APIs provided by default with the apidoc element are:

• Java APIs
• Python APIs. It is a "pdoc-like" API (See pdoc3.github.io)
• C# APIs
• Doxygen APIs (for both C and C++ programs)

However it is possible to configure to model any kind of language.