Skip to content

Commit

Permalink
docs(source code): fix examples end alias (LizardByte#2921)
Browse files Browse the repository at this point in the history
  • Loading branch information
ReenigneArcher authored Jul 26, 2024
1 parent 3691583 commit 4afa0ee
Showing 1 changed file with 2 additions and 2 deletions.
4 changes: 2 additions & 2 deletions docs/source/source_code/source_code.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down

0 comments on commit 4afa0ee

Please sign in to comment.