Confirmed users
564
edits
Platform/GFX/DesignDocumentationGuidelines: Difference between revisions
Platform/GFX/DesignDocumentationGuidelines (view source)
Revision as of 20:13, 14 April 2014
, 14 April 2014→In a separate file in the gfx/docs directory
Msreckovic (talk | contribs) |
Msreckovic (talk | contribs) |
||
| Line 24: | Line 24: | ||
* Name the documentation file appropriately, use the .md extension (assuming it is markdown) | * Name the documentation file appropriately, use the .md extension (assuming it is markdown) | ||
* Use the markdown syntax (and if not, make sure you understand why not) | * Use the markdown syntax (and if not, make sure you understand why not) | ||
* | * Use === for the first top level header and give it a label. This label will be used for referencing from elsewhere. | ||
* The source file could/should contain a pointer to the documentation, and vice versa. | * The source file could/should contain a pointer to the documentation, and vice versa. | ||
* The documentation file may reference classes or files themselves: | * The documentation file may reference classes or files themselves: | ||
| Line 32: | Line 32: | ||
** SomeClassFile.h | ** SomeClassFile.h | ||
* The source (or other external files) may reference the documentation file: | * The source (or other external files) may reference the documentation file: | ||
** @ref | ** @ref pagelabel | ||
** [this way](@ref | ** [this way](@ref pagelabel) | ||
* Good because: | * Good because: | ||
** The documentation is versioned | ** The documentation is versioned | ||