View Mdoc internals of Class3

Branch constant_group

Array ( [1] => Array ( [source] => Array ( [comment] => /** * Constants declared in a group. * * All constant statements in groups must be on a single line, this is a * format which suits well constants defined as a serie. * * The inline comments are used to document constant individualy, these * subcomments are optional. * * Use the # inline comment to get subcomment ignored for documenting. */ [code] => define("CLAS_ONE", 1); // case flag ONE define("CLAS_TWO", 2); // case flag TWO define("CLAS_THREE", 3); # this comment should not appear in documentation [line] => 21 ) [description] => Array ( [short] => Constants declared in a group. [long] => All constant statements in groups must be on a single line, this is a format which suits well constants defined as a serie. The inline comments are used to document constant individualy, these subcomments are optional. Use the # inline comment to get subcomment ignored for documenting. ) [constant] => Array ( [CLAS_ONE] => Array ( [line] => 21 [comment] => case flag ONE [code] => define("CLAS_ONE", 1); [value] => 1 ) [CLAS_TWO] => Array ( [line] => 22 [comment] => case flag TWO [code] => define("CLAS_TWO", 2); [value] => 2 ) [CLAS_THREE] => Array ( [line] => 23 [comment] => [code] => define("CLAS_THREE", 3); [value] => 3 ) ) ) [2] => Array ( [source] => Array ( [comment] => /** * Constants can be declared in a group with no single comment. */ [code] => define("CLAS_GROUP2_ONE", 21); // Comment to break the "nice" group (ignored by Mdoc parser) define("CLAS_GROUP2_TWO", 22); // Another comment ignored by Mdoc parser define("CLAS_GROUP2_THREE", 23); [line] => 49 ) [description] => Array ( [short] => Constants can be declared in a group with no single comment. ) [constant] => Array ( [CLAS_GROUP2_ONE] => Array ( [line] => 49 [comment] => [code] => define("CLAS_GROUP2_ONE", 21); [value] => 21 ) [CLAS_GROUP2_TWO] => Array ( [line] => 51 [comment] => [code] => define("CLAS_GROUP2_TWO", 22); [value] => 22 ) [CLAS_GROUP2_THREE] => Array ( [line] => 53 [comment] => [code] => define("CLAS_GROUP2_THREE", 23); [value] => 23 ) ) ) [3] => Array ( [source] => Array ( [comment] => /** * New line chars. * * @warning These constants are referred to as Class3::NL_DOS, * Class3::NL_MAC, Class3::NL_NIX */ [code] => const NL_DOS = "\r\n"; // for Windows environment const NL_MAC = "\r"; // for Mac environment const NL_NIX = "\n"; // for Unix/Linux environment [line] => 101 ) [description] => Array ( [short] => New line chars. ) [info] => Array ( [warning] => These constants are referred to as Class3::NL_DOS, Class3::NL_MAC, Class3::NL_NIX ) [constant] => Array ( [Class3::NL_DOS] => Array ( [line] => 101 [comment] => for Windows environment [code] => const NL_DOS = "\r\n"; [value] => "\r\n" ) [Class3::NL_MAC] => Array ( [line] => 102 [comment] => for Mac environment [code] => const NL_MAC = "\r"; [value] => "\r" ) [Class3::NL_NIX] => Array ( [line] => 103 [comment] => for Unix/Linux environment [code] => const NL_NIX = "\n"; [value] => "\n" ) ) ) [4] => Array ( [source] => Array ( [comment] => /** * Odd/even test masks. * * @experimental */ [code] => const MASK_ODD = 1; // use this constant to test if value is odd const MASK_EVEN = 2; // use this constant to test if value is even [line] => 110 ) [description] => Array ( [short] => Odd/even test masks. ) [info] => Array ( [experimental] => yes ) [constant] => Array ( [Class3::MASK_ODD] => Array ( [line] => 110 [comment] => use this constant to test if value is odd [code] => const MASK_ODD = 1; [value] => 1 ) [Class3::MASK_EVEN] => Array ( [line] => 111 [comment] => use this constant to test if value is even [code] => const MASK_EVEN = 2; [value] => 2 ) ) ) )