Generic apidocs API types

This article explains which elements are managed by each generic API type.

Overview

The "apidocs" property specifies a custom internal API documentations. It specifies the structure of any language API which can be used in the apidoc syntax element.

Each api element in this configuration file specifies one language API. The type attribute for an API represents the generic type to use for your own API. Elements which are not managed by this generic API type won't be rendered by your own API. For example, "event" elements will not appear in your "apidoc" element if you use the java generic API type.

Generic language APIs

Several generic APIs are provided:

• "java": The Java API, similar to the API generated by the javadoc tool
• "python": The Python API, similar to the pdoc-generated API "pdoc-like" API for a Python class^[1]
  See pdoc3.github.io
• "csharp": The C# API, similar to the one generated by Visual Studio
• "doxygen": The Doxygen API, allowing to be used with a C or C++ API

Each API you define must refer to one of these generic APIs. Note that there are limitations for each of these APIs. For example a "java" API don't handle "header" elements.

List of all types

The list for all types is described in the following table. The "Parent Type" column specifies on which kind of element the type is modelled. For example, class, interface, and module are similar kinds of elements, which all have arguments, and have a type.

Type	Parent Type	Comment
header	class	Represents a C header
class	class	Represents a class
interface	class	Represents an interface
module	class	Represents a module (for example in Python)
struct	struct	Represents a structure
enum	enum	Represents an enum
method	method	Represents a method
constructor	method	Represents a constructor
destructor	method	Represents a destructor
operation	method	Represents an operation
field	field	Represents a field
typedef	typedef	Represents a typedef declaration
macro	macro	Represents a macro declaration
constant	constant	Represents a constant (used for example for enum states)
property	field	Represents a property
event	field	Represents an event
argument	argument	Represents an argument
function	function	Represents a C function

List of generic API types

The list of the generic API types is:

• "java": The Java generic API type
• "python": The Python generic API type
• "csharp": The C# generic API type
• "doxygen": The Doxygen generic API type, modelling a C or C++ API

List of managed elements

The following table presents the elements, and the possible top-level elements, for each generic API type:

Managed Elements

API	Elements	Top-level elements
java	class interface enum property field constructor method argument constant	class interface enum
csharp	class struct property event enum field operator method argument constant	class struct
python	module method	module
doxygen	class constructor destructor setter getter method argument header struct constant typedef macro	class header struct