Confirmed users
564
edits
Platform/GFX/DesignDocumentationGuidelines: Difference between revisions
Platform/GFX/DesignDocumentationGuidelines (view source)
Revision as of 21:58, 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. | * Use === for the first top level header and give it a label (all lower case.) 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 37: | Line 37: | ||
** The documentation is versioned | ** The documentation is versioned | ||
** The documentation is subject to reviews | ** The documentation is subject to reviews | ||
* For example: Create MyExampleDesign.md that starts with: | |||
<code> | |||
My Example Design {#myexampledesign} | |||
================== | |||
Some awesome design description and details | |||
... | |||
</code> | |||
Elsewhere, you would use @ref myexampledesign to reference this external design doc. | |||
=== In wiki, blog, random web page, etc. === | === In wiki, blog, random web page, etc. === | ||