mirror
/
SDL
mirror of https://github.com/libsdl-org/SDL.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

README-documentation-rules: Add a note about being UTF-8 only!

This commit is contained in:
Ryan C. Gordon 2025-05-22 15:41:05 -04:00
parent 56bb73a8d2
commit dcdbc0bf9f
No known key found for this signature in database
GPG Key ID: FA148B892AB48044
1 changed files with 6 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

6
docs/README-documentation-rules.md
View File

@ -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. 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. ## We _sort of_ write in Doxygen format.
To document a symbol, we use something that looks like Doxygen (and Javadoc) To document a symbol, we use something that looks like Doxygen (and Javadoc)