Platform/GFX/DesignDocumentationGuidelines: Difference between revisions

Line 53: Line 53:


=== What kind of a bike shed would you like? ===
=== What kind of a bike shed would you like? ===
 
Using ====== for level 1 headers instead of # seems to play better with Doxygen when using the labels:
I personally prefer using ====== for level 1 and ------- for level two headers over # and ##:
  This is header level 1 {#nameofthefileinlowercase}
  This is header level 1
  ======================
  ======================
This is header level 2
rather than
----------------------
# This is header level 1 {#nameofthefileinlowercase}
Rather than
# This is header level 1
## This is header level 2
but that's just a random preference.


== Results ==
== Results ==


If we follow the above rules, everything should nicely get extracted to html, for those browsing graphics documentation pages, while also providing in source information for those browsing the source.
If we follow the above rules, everything should nicely get extracted to html, for those browsing graphics documentation pages, while also providing in source information for those browsing the source.
Confirmed users
564

edits