documentation: Breaking the API Reference documentation ice
[sdk] / doc / ecereCOM / int.econ
1 {
2    name = "int",
3    description = "Core C signed integer data type (expected to be equivalent to C99 'int32_t'). A signed 32 bit integer ranges from (-2,147,483,647 to 2,147,483,647. One some platform a negative value one less is valid.",
4    usage = "Used in the declaration section of code, which is before any statements.",
5    example = "int thisInt; // A stand alone declaration of an int.\n"
6       "int a, b; // Declaring two ints at the same time.\n"
7       "int c = 64000, d = -10; // Declaring two ints, and initializing them both at the same time.\n"
8       "int anotherInt = 0x54DA; //Declaring and initializing an int with a hexadecimal value.",
9    remarks = "Unlike C or C++ where the int memory space can be either 16 or 32 bits depending on the platform, the eC int is guaranteed to be 32 bits on all platforms. Additionally, unlike other languages the int data type is actually a class.\n"
10       "\n"
11       "int is otherwise equivalent to an int in C.",
12    also = "bool, byte, char, char *, double, enum, float, int64, uint, uint16, uint32, uint64, OnCompare(), OnCopy(), OnDisplay(), OnEdit(), OnFree(), OnGetDataFromString(), OnGetString(), OnSaveEdit(), OnSerialize(), OnUnserialize()"
13 }