mirrors/SDL
1
0
Fork 0
mirror of https://github.com/libsdl-org/SDL.git synced 2025-09-07 11:58:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Sync SDL3 wiki -> header

Browse Source
This commit is contained in:
SDL Wiki Bot
2024-05-22 00:06:36 +00:00
parent 1f0884ffef
commit 7164ca374e
1 changed files with 2 additions and 1 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -79,12 +79,13 @@ more: try not to markup text more than necessary.
## Doxygen tags we support: ## Doxygen tags we support:
- `\brief one-line description` (Not required, and wikiheaders will remove them). - `\brief one-line description` (Not required, and wikiheaders will remove tag).
- `\param varname description` (One for each function/macro parameter) - `\param varname description` (One for each function/macro parameter)
- `\returns description` (One for each function, don't use on `void` returns). - `\returns description` (One for each function, don't use on `void` returns).
- `\sa` (each of these get tucked into a "See Also" section on the wiki) - `\sa` (each of these get tucked into a "See Also" section on the wiki)
- `\since This function is available since SDL 3.0.0.` (one per Doxygen comment) - `\since This function is available since SDL 3.0.0.` (one per Doxygen comment)
- `\threadsafety description` (one per function/macro). - `\threadsafety description` (one per function/macro).
- '\deprecated description` (one per symbol, if symbol is deprecated!)
Other Doxygen things might exist in the headers, but they aren't understood Other Doxygen things might exist in the headers, but they aren't understood
by wikiheaders. by wikiheaders.