Skip to content

Commit 20f7835

Browse files
committed
Sync SDL3 wiki -> header
[ci skip]
1 parent bbd973c commit 20f7835

File tree

1 file changed

+10
-0
lines changed

1 file changed

+10
-0
lines changed

docs/README-documentation-rules.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -327,6 +327,16 @@ If you add Doxygen with a `##` (`###`, etc) section header, it'll
327327
migrate to the wiki and be _removed_ from the headers. Generally
328328
the correct thing to do is _never use section headers in the Doxygen_.
329329

330+
## wikiheaders will reorder standard sections.
331+
332+
The standard sections are always kept in a consistent order by
333+
wikiheaders, both in the headers and the wiki. If they're placed in
334+
a non-standard order, wikiheaders will reorder them.
335+
336+
For sections that aren't standard, wikiheaders will place them at
337+
the end of the wiki page, in the order they were seen when it loaded
338+
the page for processing.
339+
330340
## It's okay to repeat yourself.
331341

332342
Each individual piece of documentation becomes a separate page on the wiki, so

0 commit comments

Comments
 (0)