Documentation | Manual: docformat

Documenation Format

The documentation for the Haiku API Bindings is written in standard markdown with a few extensions: admonitions, code fences, and tabbed fences. If you are unfamiliar with the syntax for these extensions, it is described below.

Admonitions

This:

!!! admonition "title"
    Each line of content must be indented by four spaces (or a tab)

    Content lines can be separated by blank lines.

    If no title is provided, then the admonition type will be title-cased and
    used as the title. You can provide an empty title (`""`).

   The first line not indented by four spaces (or a tab) will end the
   admonition, including this line indented by only three spaces.
   (The line will not be included in the admonition.)

will result in:

The first line not indented by four spaces (or a tab) will end the admonition, including this line indented by only three spaces. (The line will not be included in the admonition.)

Code fences

Code fences can optionally use syntaxhighlighter to color the code.

This:

```Perl
These are pretty standard, except for the optional language id. If an id is
present, it should be a syntaxhighlighter brush alias, and the code will then
be colored using syntaxhighlighter. (The id will be lower-cased before being
passed to syntaxhighlighter.)
```

```Python
Fences should be separated from other content (including other fences) by a
blank line.
```

will result in:

These are pretty standard, except for the optional language id. If an id is
present, it should be a syntaxhighlighter brush alias, and the code will then
be colored using syntaxhighlighter. (The id will be lower-cased before being
passed to syntaxhighlighter.)

Fences should be separated from other content (including other fences) by a
blank line.

Tabbed fences

This:

~~~Perl tab=Perl
These are standard code fences, with the addition of a `tab=TITLE` line.
(We use backticks for standard fences and tildes for tabbed fences, but this
is just a convention; the parser will recognize it either way.)
~~~

~~~Python tab=
If no title is supplied, the language id will be used. Any tabbed fences with
no other content between them will be considered part of the same group.
~~~

will result in:

These are standard code fences, with the addition of a `tab=TITLE` line.
(We use backticks for standard fences and tildes for tabbed fences, but this
is just a convention; the parser will recognize it either way.)

If no title is supplied, the language id will be used. Any tabbed fences with
no other content between them will be considered part of the same group.