Skip to content

Commit d6375ec

Browse files
committed
Fix some documentation comments
1 parent 4c38a89 commit d6375ec

File tree

1 file changed

+6
-2
lines changed

1 file changed

+6
-2
lines changed

ArduinoExtra/Functional.h

+6-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,8 @@
55
*
66
* @copyright Copyright (c) 2023 Vanier Robotics (MIT License)
77
*
8-
* @example
8+
* Example Usage:
9+
* @code
910
* class ExampleClass
1011
* {
1112
* public:
@@ -45,6 +46,7 @@
4546
* aex::Function<void()> exampleFunction2([]() -> void { Serial.println("Lambda Function"); };
4647
* exampleFunction2(); // Will write "Lambda Function" to the console
4748
* }
49+
* @endcode
4850
*/
4951

5052
#ifndef _INCLUDE_AEX_FUNCTIONAL_H_
@@ -57,6 +59,8 @@ namespace aex
5759

5860
/**
5961
* @brief Allow for template specialization of the Function class
62+
*
63+
* @see Function<R(Args...)>
6064
*/
6165
template<class... Args> class Function;
6266

@@ -66,7 +70,7 @@ namespace priv
6670
/**
6771
* @brief Allow for template specialization of the Callable classes
6872
*
69-
* @todo: Add a callable for const functions?
73+
* Todo: Add a callable for const functions?
7074
*/
7175
template<class...> class Callable;
7276
template<class...> class FunctionCallable;

0 commit comments

Comments
 (0)