How this API document is organized
This API (Application Programming Interface) document has pages corresponding to the items in the navigation bar, described as follows.
Each file has its own separate page. Each of these pages has three sections consisting of a file description, summary tables, and detailed member descriptions:
Each summary entry contains the first sentence from the detailed description for that item. The summary entries are alphabetical, as in the detailed descriptions.
- File name
- File description
- Variable summary
- Structure summary
- Macro summary
- Function summary
- Variable details
- Structure details
- Macro details
- Function details
The deprecated list page lists all of the API that have been deprecated. A deprecated API is not recommended for use, generally due to improvements, and a replacement API is usually given. Deprecated APIs may be removed in future implementations.
The index contains an alphabetic list of all files, functions, and variables.
The constant values page lists the constants and their values.