mirror of https://github.com/libsdl-org/SDL
docs/README-documentation-rules.md: Added more content, fixed a typo.
This commit is contained in:
parent
661f2fc1fc
commit
d57f2afcaf
|
@ -50,7 +50,7 @@ to that symbol.
|
||||||
wikiheaders will include those defines in the syntax section of the wiki
|
wikiheaders will include those defines in the syntax section of the wiki
|
||||||
page, and generate stub pages for each define that simply says "please refer
|
page, and generate stub pages for each define that simply says "please refer
|
||||||
to (The Actual Symbol You Care About)" with a link. It will also pull in
|
to (The Actual Symbol You Care About)" with a link. It will also pull in
|
||||||
any blank lines or most preprocessor directives for the syntax text, too.
|
any blank lines and most preprocessor directives for the syntax text, too.
|
||||||
|
|
||||||
Sometimes an unrelated define, by itself, just happens to be right below one
|
Sometimes an unrelated define, by itself, just happens to be right below one
|
||||||
of these symbols in the header. The easiest way to deal with this is either
|
of these symbols in the header. The easiest way to deal with this is either
|
||||||
|
@ -263,6 +263,34 @@ examples into discrete C files and attempts to compile them, and complains
|
||||||
if they don't work.
|
if they don't work.
|
||||||
|
|
||||||
|
|
||||||
|
## Unrecognized sections are left alone in the wiki.
|
||||||
|
|
||||||
|
A wiki section that starts with `## Section Name` (or `== Section Name ==` in
|
||||||
|
MediaWiki format) that isn't one of the recognized names will be left alone
|
||||||
|
by wikiheaders. Recognized sections might get overwritten with new content
|
||||||
|
from the headers, but the wiki file will not have other sections cleaned out
|
||||||
|
(this is how Code Examples remain wiki only, for example). You can use this
|
||||||
|
to add Wiki-specific text, or stuff that doesn't make sense in a header, or
|
||||||
|
would merely clutter it up.
|
||||||
|
|
||||||
|
A possibly-incomplete list of sections that will be overwritten by changes
|
||||||
|
to the headers:
|
||||||
|
|
||||||
|
- The page title line, and the "brief" one-sentence description section.
|
||||||
|
- "Deprecated"
|
||||||
|
- "Header File"
|
||||||
|
- "Syntax"
|
||||||
|
- "Function Parameters"
|
||||||
|
- "Macro Parameters"
|
||||||
|
- "Fields"
|
||||||
|
- "Values"
|
||||||
|
- "Return Value"
|
||||||
|
- "Remarks"
|
||||||
|
- "Thread Safety"
|
||||||
|
- "Version"
|
||||||
|
- "See Also"
|
||||||
|
|
||||||
|
|
||||||
## It's okay to repeat yourself.
|
## It's okay to repeat yourself.
|
||||||
|
|
||||||
Each individual piece of documentation becomes a separate page on the wiki, so
|
Each individual piece of documentation becomes a separate page on the wiki, so
|
||||||
|
|
Loading…
Reference in New Issue