Burnout Wiki:Format documentation specification: Difference between revisions

m
Lower-level section details.
(Add naming conventions.)
m (Lower-level section details.)
Line 16:
Formats should be documented with at least the top-level section ''Structures''. ''Unions'', ''Typedefs'' and ''Enumerations'' are optional top-level sections. Other top-level sections may be added as necessary.
 
Generally, individual structures, unions, typedefs, and enumerations are third-level sections while variants (such as 32 and 64 bit) are second-level or fourth-level. ThisWhile this page structure is preferred, it is not strictlya definedstrict andrequirement; all lower-level sections may be chosen at the editor's discretion.
 
Sections should be named the full name of the type with all namespaces included, e.g., BrnVehicle::GraphicsSpec. If the full name is unknown, use a name relevant to its purpose. Never title a section "unknown" unless the content's purpose is truly unknown.