Confirmed users
564
edits
Platform/GFX/DesignDocumentationGuidelines: Difference between revisions
Platform/GFX/DesignDocumentationGuidelines (view source)
Revision as of 19:18, 14 April 2014
, 14 April 2014→In the source code
Msreckovic (talk | contribs) |
Msreckovic (talk | contribs) |
||
| Line 14: | Line 14: | ||
* Use doxygen+markdown syntax; see [http://www.stack.nl/~dimitri/doxygen/manual/markdown.html here] for details | * Use doxygen+markdown syntax; see [http://www.stack.nl/~dimitri/doxygen/manual/markdown.html here] for details | ||
** For classes, you need to specify the namespace if it's different from the current class, at least to account for the differences in nested namespaces. (So, Skia referencing SurfaceStream has to use mozilla::gfx::SurfaceStream, but DrawBuffer referencing SurfaceStream can just use gfx::SurfaceStream.) | ** For classes, you need to specify the namespace if it's different from the current class, at least to account for the differences in nested namespaces. (So, Skia referencing SurfaceStream has to use mozilla::gfx::SurfaceStream, but DrawBuffer referencing SurfaceStream can just use gfx::SurfaceStream.) | ||
** You can reference external files (see section below.) | ** You can reference designs documented as external files (see section below.) | ||
* Good because: | * Good because: | ||
** The documentation is where the source is | ** The documentation is where the source is | ||