This guide uses the following typographical conventions to clarify the meaning of the text and to provide contextual information at a glance.
convention | description |
---|---|
Monospaced code font | Indicates a class name, function, or variable; also used for code examples, parameter
names and parameter values. When such an item corresponds to a class, function, macro or file in the API, it should be linked to the corresponding reference documentation. For example: ILBAddTriangleData(). |
Monospaced italics | When used in code examples or command-line syntax, italicized text indicates a variable that must be replaced with an appropriate value. Angle brackets are not used for this purpose, as the term may become confused with XML elements or markup tags. |
Italics | Denotes path and file names. May also be used to give additional emphasis to specific terminology or important parts of a phrase. |
square brackets [ ] | When used in command-line syntax, square brackets indicate optional parameters that may be omitted. |
bold text | Typically indicates an element in a graphical user interface, such as a button or menu label. |