Confirmed users
564
edits
Platform/GFX/DesignDocumentationGuidelines: Difference between revisions
Platform/GFX/DesignDocumentationGuidelines (view source)
Revision as of 21:52, 11 April 2014
, 11 April 2014→In a separate file in the gfx/docs directory
Msreckovic (talk | contribs) No edit summary |
Msreckovic (talk | contribs) |
||
| Line 24: | Line 24: | ||
* Name the documentation file appropriately, use the .md extension (assuming it is markdown, and if not, why not?) | * Name the documentation file appropriately, use the .md extension (assuming it is markdown, and if not, why not?) | ||
* Use the markdown syntax (and if not, why not?) | * Use the markdown syntax (and if not, why not?) | ||
* Put \page alllowercasenameofthefile at the top | |||
* The source file should contain a pointer to the documentation, and vice versa. | * The source file 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 30: | Line 31: | ||
** [link text](@ref mozilla::gfx::SomeClass) | ** [link text](@ref mozilla::gfx::SomeClass) | ||
** SomeClassFile.h | ** SomeClassFile.h | ||
* The source may reference the documentation file: | * The source (or other external files) may reference the documentation file: | ||
** | ** [this way](@ref alllowercasenameofthefile) | ||
* Good because: | * Good because: | ||
** The documentation is versioned | ** The documentation is versioned | ||