jyapayne/Sunshine
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

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
commit 4afa0ee258
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
1 changed files with 2 additions and 2 deletions
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. * @return The exit code.
* @examples * @examples
* main(1, const char* args[] = {"hello", "markdown", nullptr}); * main(1, const char* args[] = {"hello", "markdown", nullptr});
* @end_examples * @examples_end
*/ */
int main(int argc, char *argv[]); 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. 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 In some cases, it could be valuable to have slightly different documentation for the definitions, especially when