From 7164ca374e08d6b2886581da28063cae79ccb0b6 Mon Sep 17 00:00:00 2001 From: SDL Wiki Bot Date: Wed, 22 May 2024 00:06:36 +0000 Subject: [PATCH] Sync SDL3 wiki -> header --- docs/README-documentation-rules.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/docs/README-documentation-rules.md b/docs/README-documentation-rules.md index f8e2e9e641..6cedafebbc 100644 --- a/docs/README-documentation-rules.md +++ b/docs/README-documentation-rules.md @@ -79,12 +79,13 @@ more: try not to markup text more than necessary. ## 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) - `\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) - `\since This function is available since SDL 3.0.0.` (one per Doxygen comment) - `\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 by wikiheaders.