From 20f783532b536bd01d83548f20e396ec531bdb91 Mon Sep 17 00:00:00 2001 From: SDL Wiki Bot Date: Tue, 6 May 2025 17:21:29 +0000 Subject: [PATCH] Sync SDL3 wiki -> header [ci skip] --- docs/README-documentation-rules.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/docs/README-documentation-rules.md b/docs/README-documentation-rules.md index 793acdb336..bf82be2a04 100644 --- a/docs/README-documentation-rules.md +++ b/docs/README-documentation-rules.md @@ -327,6 +327,16 @@ If you add Doxygen with a `##` (`###`, etc) section header, it'll migrate to the wiki and be _removed_ from the headers. Generally the correct thing to do is _never use section headers in the Doxygen_. +## wikiheaders will reorder standard sections. + +The standard sections are always kept in a consistent order by +wikiheaders, both in the headers and the wiki. If they're placed in +a non-standard order, wikiheaders will reorder them. + +For sections that aren't standard, wikiheaders will place them at +the end of the wiki page, in the order they were seen when it loaded +the page for processing. + ## It's okay to repeat yourself. Each individual piece of documentation becomes a separate page on the wiki, so