Confirmed users
564
edits
Platform/GFX/DesignDocumentationGuidelines: Difference between revisions
Jump to navigation
Jump to search
Platform/GFX/DesignDocumentationGuidelines (view source)
Revision as of 20:05, 10 April 2014
, 10 April 2014→In the source code
Msreckovic (talk | contribs) |
Msreckovic (talk | contribs) |
||
| Line 12: | Line 12: | ||
* Document the design for class Foo in Foo.h | * Document the design for class Foo in Foo.h | ||
* | * Use doxygen+markdown syntax; see [http://www.stack.nl/~dimitri/doxygen/manual/markdown.html here] for details | ||
* This is good because: | |||
** The documentation is where the source is | |||
** The documentation is versioned | |||
** The documentation is subject to reviews | |||
=== In a separate file in the gfx/docs directory === | === In a separate file in the gfx/docs directory === | ||