|
@@ -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.
|
SDL Wiki Bot