mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2026-04-21 14:55:39 +00:00
Code Issues Packages Projects Releases Wiki Activity

SDL_platform_defines.h: Added documentation, and a little whitespace.

Browse Source 
wikiheaders needs the documentation in the first row of the line, at least
currently, so I've only indented things I could get away with, but it might
be a little easier to follow the preprocessor logic now.
This commit is contained in:
Ryan C. Gordon
2024-09-06 15:09:29 -04:00
parent 4c8357a37d
commit 73b294cb1c
2 changed files with 328 additions and 53 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -64,6 +64,10 @@ Note the `/**` at the start of the comment. That's a "Doxygen-style" comment,
and wikiheaders will treat this differently than a comment with one `*`, as
this signifies that this is not just a comment, but _documentation_.
These comments _must_ start in the first column of the line, or wikiheaders
will ignore them, even with the "/**" start (we should improve the script
someday to handle this, but currently this is a requirement).
We do _not_ parse every magic Doxygen tag, and we don't parse them in `@param`
format. The goal here was to mostly coexist with people that might want
to run Doxygen on the SDL headers, not to build Doxygen from scratch. That