Hide navigation sidebar
Hide table of contents sidebar
Skip to content
Back to top
Toggle table of contents sidebar

# Naming conventions

For the sake of clarity in this multi-language documentation, the following naming conventions have been adopted.

- Class, struct and enumeration names are written in PascalCase. Example: `License`.

- Class and struct member names are written in lowerCamelCase. Example: `activateSerialKey`

- Enumeration fields are written in lowerCamelCase. Example : `LicenseError.invalidLicense`.

Warning

The naming convention adopted in this documentation does not necessarily reflect the convention for a given programming language. More information is given below.

## Examples

Python

- Class name: `DocumentLicense`

- Function name: `activate_serial_key`

- Structure: `DocumentPoint`

- Enumeration field: `LicenseError.INVALID_LICENSE`

Dart

- Class name: `DocumentLicense`

- Function name: `activateSerialKey`

- Structure: `DocumentPoint`

- Enumeration field: `LicenseError.invalidLicense`

C#

- Class name: `DocumentLicense`

- Function name: `ActivateSerialKey`

- Structure: `DocumentPoint`

- Enumeration field: `LicenseError.InvalidLicense`

Java

- Class name: `DocumentLicense`

- Function name: `activateSerialKey`

- Structure: `DocumentPoint`

- Enumeration field: `LicenseError.INVALID_LICENSE`

Kotlin

- Class name: `DocumentLicense`

- Function name: `activateSerialKey`

- Structure: `DocumentPoint`

- Enumeration field: `LicenseError.INVALID_LICENSE`

Swift

- Class name: `DocumentLicense`

- Function name: `activateSerialKey`

- Structure: `DocumentPoint`

- Enumeration field: `LicenseError.invalidLicense`

C

- Class name: `id3DocumentLicense_`

- Function name: `id3DocumentLicense_ActivateSerialKey`

- Structure: `id3DocumentPoint`

- Enumeration field: `id3LicenseError_InvalidLicense`

Note

The C API implements pseudo object-oriented programming concepts where the object is passed explicitly to a member function as first parameter.