From d6375ec4150abe1cf8a0344215b2dab289aafd15 Mon Sep 17 00:00:00 2001 From: efondere Date: Sun, 4 Jun 2023 17:07:29 -0400 Subject: [PATCH] Fix some documentation comments --- ArduinoExtra/Functional.h | 8 ++++++-- 1 file changed, 6 insertions(+), 2 deletions(-) diff --git a/ArduinoExtra/Functional.h b/ArduinoExtra/Functional.h index 3d07d17..e0fb539 100644 --- a/ArduinoExtra/Functional.h +++ b/ArduinoExtra/Functional.h @@ -5,7 +5,8 @@ * * @copyright Copyright (c) 2023 Vanier Robotics (MIT License) * - * @example + * Example Usage: + * @code * class ExampleClass * { * public: @@ -45,6 +46,7 @@ * aex::Function exampleFunction2([]() -> void { Serial.println("Lambda Function"); }; * exampleFunction2(); // Will write "Lambda Function" to the console * } + * @endcode */ #ifndef _INCLUDE_AEX_FUNCTIONAL_H_ @@ -57,6 +59,8 @@ namespace aex /** * @brief Allow for template specialization of the Function class + * + * @see Function */ template class Function; @@ -66,7 +70,7 @@ namespace priv /** * @brief Allow for template specialization of the Callable classes * - * @todo: Add a callable for const functions? + * Todo: Add a callable for const functions? */ template class Callable; template class FunctionCallable;