documentation:tiny2
Differences
This shows you the differences between two versions of the page.
| Both sides previous revisionPrevious revisionNext revision | Previous revisionLast revisionBoth sides next revision | ||
| documentation:tiny2 [2023/09/13 18:09] – ↷ Page moved from specification:mappings:tiny2 to documentation:tiny2 nebelnidas | documentation:tiny2 [2023/09/16 21:09] – Clarify <safe-string> explanation nebelnidas | ||
|---|---|---|---|
| Line 3: | Line 3: | ||
| Tiny v2 consists of a list of hierarchical sections. Every line starts a new section, whether it continues an existing section is determined by the indentation level. A section' | Tiny v2 consists of a list of hierarchical sections. Every line starts a new section, whether it continues an existing section is determined by the indentation level. A section' | ||
| - | The child-to-parent relationships form the paths to uniquely identify any element globally. For example, all method and field sections that are children of a class section represent members of the represented class. | + | The child-to-parent relationships form the paths to uniquely identify any element globally. For example, all field and method |
| Sections need to be unique within their level. For example a specific class may only be recorded once, a comment can't be redefined or the same parameter listed twice. | Sections need to be unique within their level. For example a specific class may only be recorded once, a comment can't be redefined or the same parameter listed twice. | ||
| Line 13: | Line 13: | ||
| anotherProperty | anotherProperty | ||
| c a class_123 pkg/ | c a class_123 pkg/ | ||
| + | f [I a field_789 someField | ||
| m (III)V a method_456 someMethod | m (III)V a method_456 someMethod | ||
| p 1 param_0 x | p 1 param_0 x | ||
| Line 18: | Line 19: | ||
| p 3 param_2 z | p 3 param_2 z | ||
| c Just a method for demonstrating the format. | c Just a method for demonstrating the format. | ||
| - | f [I a field_789 someField | ||
| c b class_234 pkg/ | c b class_234 pkg/ | ||
| m (Ljava/ | m (Ljava/ | ||
| Line 26: | Line 26: | ||
| ===== Grammar ===== | ===== Grammar ===== | ||
| < | < | ||
| - | < | + | < |
| < | < | ||
| Line 33: | Line 33: | ||
| < | < | ||
| < | < | ||
| - | < | + | < |
| - | < | + | < |
| < | < | ||
| < | < | ||
| < | < | ||
| - | < | + | < |
| - | <sections> ::= '' | + | <content> |
| < | < | ||
| Line 49: | Line 49: | ||
| < | < | ||
| < | < | ||
| - | < | + | < |
| + | |||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| + | < | ||
| < | < | ||
| Line 59: | Line 69: | ||
| < | < | ||
| < | < | ||
| - | < | + | < |
| < | < | ||
| Line 75: | Line 85: | ||
| < | < | ||
| < | < | ||
| - | |||
| - | < | ||
| - | < | ||
| - | < | ||
| - | < | ||
| - | < | ||
| - | < | ||
| - | < | ||
| - | < | ||
| - | < | ||
| < | < | ||
| Line 98: | Line 98: | ||
| * '' | * '' | ||
| * '' | * '' | ||
| - | * '' | + | * '' |
| - | * '' | + | * '' |
| - | * '' | + | * '' |
| - | * '' | + | * '' |
| * '' | * '' | ||
| - | * '' | + | * '' |
| - | * | + | |
| - | * ''" | + | |
| - | * ''" | + | |
| - | * ''" | + | |
| - | * ''" | + | |
| * '' | * '' | ||
| * '' | * '' | ||
| - | * '' | + | * '' |
| - | * '' | + | |
| * '' | * '' | ||
| + | * '' | ||
| * '' | * '' | ||
| * '' | * '' | ||
| Line 123: | Line 118: | ||
| * Indenting uses tab characters exclusively, | * Indenting uses tab characters exclusively, | ||
| * Sections or properties with unknown types/keys should be skipped without generating an error. | * Sections or properties with unknown types/keys should be skipped without generating an error. | ||
| - | * The amount of extra namespaces defined in the header and the amount of names in every '' | + | * The amount of extra namespaces defined in the header and the amount of names in every '' |
| * Sections representing the same element must not be repeated, e.g. there can be only one top-level section for a specific class or one class-level section for a specific member. | * Sections representing the same element must not be repeated, e.g. there can be only one top-level section for a specific class or one class-level section for a specific member. | ||
| - | * If any variable mapping doesn' | + | * If any variable mapping doesn' |
| - | * Mappings without any useful names or sub-sections should be omitted. | + | * Mappings without any (useful) names should be omitted. |
| + | * Sections without any (useful) mappings | ||
| * Comments should be without their enclosing syntax elements, indentation or decoration. For example, the comment < | * Comments should be without their enclosing syntax elements, indentation or decoration. For example, the comment < | ||
| /** | /** | ||
documentation/tiny2.txt · Last modified: 2023/09/16 21:23 by nebelnidas