mirror/Sunshine
1
0
Fork 0
mirror of https://github.com/LizardByte/Sunshine.git synced 2025-03-14 01:27:36 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs(source code): fix examples end alias (#2921)

Browse Source
This commit is contained in:
ReenigneArcher 2024-07-26 10:35:39 -04:00 committed by GitHub
parent 369158375f
commit 4afa0ee258
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
docs/source/source_code/source_code.rst
View File

@ -44,11 +44,11 @@ of a documentation block for the main function.
* @return The exit code.
* @examples
* main(1, const char* args[] = {"hello", "markdown", nullptr});
* @end_examples
* @examples_end
*/
int main(int argc, char *argv[]);
.. attention:: The `@examples` and `@end_examples` tags are not standard Doxygen tags. They are custom aliases
.. attention:: The `@examples` and `@examples_end` tags are not standard Doxygen tags. They are custom aliases
we have specified to simplify documenting examples. Do not confuse this with the standard `@example` tag.
In some cases, it could be valuable to have slightly different documentation for the definitions, especially when