API Reference

Common API Concepts

The functions of this reference are specified using Floyd-Hoare logic, as P{Q}R, where:

The following order is imposed between these elements:

The following examples showcase the format used by the API Reference:

[Lang] Example Function: return type function_example (ParamType value, …) extra_qualifiers ¶


Preconditions:

Conditions to be met at the call point.

<-- This number is for reference purposes, all preconditions must be
met at the call point.


Effects:

Another effect produced by the call when value has the special
value foobar.

<-- This number is for reference purposes.  It does not impose an
order on the effects unless specified otherwise.


Postconditions:

Another condition provided after the call when ParamType is
something.

<-- This number is for reference purposes, all postconditions must be
provided at the return point.


General comments regarding the function come after the formal
definition.

[Lang] Example Function: dynamic_example param … ¶


Preconditions:
…

Note:

The rules of each language apply either implicitly to the definitions provided on such language—e.g. NULL doesn’t point to a valid object in C.
General rules for a language binding may be specified at the start of each chapter or section.
A type definition may include general rules for the usage of such type.