documentation: Breaking the API Reference documentation ice
[sdk] / doc / ecereCOM / byte.econ
1 {
2    name = "byte",
3    description = "An unsigned integer data type representing a single byte of data (equivalent to C 'unsigned char' and expected to be equivalent to C99 'uint8_t'). A byte can range from 0 to 255. Often used to allocate and address memory.",
4    usage = "Used in the declaration section of code, which is before any statements.",
5    example = "byte a = 3; // binary form: 00000011\n"
6       "byte b = 6; // binary form: 00000110\n"
7       "byte c;\n"
8       "c = a & b; // c will be 2  (00000010)\n"
9       "c = a | b; // c will be 7  (00000111)\n"
10       "c = a ^ b; // c will be 5  (00000101)\n"
11       "c = ~b;    // c will be 249(11111001)",
12    remarks = "Unlike other languages the byte data type is actually a class.\n"
13       "\n"
14       "byte is equivalent to an unsigned char in C.",
15    also = "bool, char, char *, double, enum, float, int, int64, uint, uint16, uint32, uint64, OnCompare(), OnCopy(), OnDisplay(), OnEdit(), OnFree(), OnGetDataFromString(), OnGetString(), OnSaveEdit(), OnSerialize(), OnUnserialize()"
16 }