From 4afa0ee25867cd7a4be3e20c540efd9167abcef4 Mon Sep 17 00:00:00 2001 From: ReenigneArcher <42013603+ReenigneArcher@users.noreply.github.com> Date: Fri, 26 Jul 2024 10:35:39 -0400 Subject: [PATCH] docs(source code): fix examples end alias (#2921) --- docs/source/source_code/source_code.rst | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/source/source_code/source_code.rst b/docs/source/source_code/source_code.rst index 58d0388bfd8..6d43239bb55 100644 --- a/docs/source/source_code/source_code.rst +++ b/docs/source/source_code/source_code.rst @@ -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