mirror of
https://github.com/love2d/megasource.git
synced 2026-08-16 08:11:25 +02:00
update SDL3 to libsdl-org/SDL@038a380 (3.3 development)
This commit is contained in:
@@ -34,6 +34,12 @@ things, you might confuse it. This is to the benefit of documentation, though,
|
||||
where we would rather you not do surprising things.
|
||||
|
||||
|
||||
## UTF-8 only!
|
||||
|
||||
All text must be UTF-8 encoded. The wiki will refuse to update files that are
|
||||
malformed.
|
||||
|
||||
|
||||
## We _sort of_ write in Doxygen format.
|
||||
|
||||
To document a symbol, we use something that looks like Doxygen (and Javadoc)
|
||||
@@ -156,6 +162,23 @@ wikiheaders will wordwrap header comments so they fit in 80 columns, so if you
|
||||
don't leave a blank line between paragraphs, they will smush into a single
|
||||
block of text when wordwrapping.
|
||||
|
||||
## Lists must be the start of a new paragraph.
|
||||
|
||||
If you write this:
|
||||
|
||||
```
|
||||
Here is some text without a blank line
|
||||
before an unordered list!
|
||||
- item a
|
||||
- item b
|
||||
- item c
|
||||
```
|
||||
|
||||
...then wikiheaders will word wrap this as a single paragraph, mangling the list.
|
||||
|
||||
Put a blank line before the list, and everything will format and wrap correctly.
|
||||
|
||||
This is a limitation of wikiheaders. Don't get bit by it!
|
||||
|
||||
## Don't worry about word wrapping.
|
||||
|
||||
@@ -304,6 +327,21 @@ to the headers:
|
||||
- "Version"
|
||||
- "See Also"
|
||||
|
||||
## Unrecognized sections are removed from the headers!
|
||||
|
||||
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.
|
||||
|
||||
@@ -318,7 +356,7 @@ through, header users can search for the function name.
|
||||
|
||||
You might be reading this document on the wiki! Any `README-*.md` files in
|
||||
the docs directory are bridged to the wiki, so `docs/README-linux.md` lands
|
||||
at https://wiki.libsdl.org/SDL3/README/linux ...these are just copied directly
|
||||
at https://wiki.libsdl.org/SDL3/README-linux ...these are just copied directly
|
||||
without any further processing by wikiheaders, and changes go in both
|
||||
directions.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user