doc: Fixed newlines (specified by <BR> rather than \n)
[sdk] / doc / ecereCOM / bool.econ
1 {
2    name = "bool",
3    description = "Boolean value (true or false) stored as a 32 bit unsigned integer",
4    usage = "Used in the declaration section of code, which is before any statements.",
5    example = "bool thisBool; // A stand alone declaration of a bool.<br>"
6       "bool a, b; // Declaring two bools at the same time.<br>"
7       "bool c = true, d = false; // Declaring two bools, and initializing them both at the same time.",
8    remarks = "A bool type describes a boolean type variable and can only store a true or false value.<br>"
9       "<br>"
10       "bool is equivalent to a bool in C.",
11    also = "byte, char, char *, double, enum, float, int, int64, uint, uint16, uint32, uint64, OnCompare(), OnCopy(), OnDisplay(), OnEdit(), OnFree(), OnGetDataFromString(), OnGetString(), OnSaveEdit(), OnSerialize(), OnUnserialize()",
12    values = [
13       {
14          "false",
15          {
16             description = "One of the only two values that a boolean can be set to."
17          }
18       },
19       {
20          "true",
21          {
22             description = "One of the only two values that a boolean can be set to."
23          }
24       }
25    ]
26 }