diff options
| author |   Romain Forlot <romain.forlot@iot.bzh> | 2017-03-08 22:59:43 +0100 |
|---|---|---|
| committer | Romain Forlot <romain.forlot@iot.bzh> | 2017-03-16 17:10:40 +0100 |
| commit | 966a1cd8e6bea71ebadc20a38b1d46482d5cff2a (patch) | |
| tree | abfefe90dd242bef8fcd2039cab4074b818230cf /src/can/can-command.hpp | |
| parent | 1ed2a620b5ac6272de01be7f1830715f7f0d280d (diff) | |
Fix all doxygen comments about parameters.
Change-Id: Idbe268d07ebf53a63c9543d9cca94ded34a29731
Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'src/can/can-command.hpp')
| -rw-r--r-- | src/can/can-command.hpp | 16 |
1 files changed, 8 insertions, 8 deletions
diff --git a/src/can/can-command.hpp b/src/can/can-command.hpp index 62b56c1e..a11c2b99 100644 --- a/src/can/can-command.hpp +++ b/src/can/can-command.hpp @@ -23,13 +23,13 @@ /** * @brief The type signature for a function to handle a custom OpenXC command. * - * @param[in] char* name - the name of the received command. - * @param[in] openxc_DynamicField* value - the value of the received command, in a DynamicField. The actual type + * @param[in] name - the name of the received command. + * @param[in] value - the value of the received command, in a DynamicField. The actual type * may be a number, string or bool. - * @param[in] openxc_DynamicField* event - an optional event from the received command, in a DynamicField. The + * @param[in] event - an optional event from the received command, in a DynamicField. The * actual type may be a number, string or bool. - * @param[in] CanSignal* signals - The list of all signals. - * @param[in] int signalCount - The length of the signals array. + * @param[in] signals - The list of all signals. + * @param[in] signalCount - The length of the signals array. */ typedef void (*CommandHandler)(const char* name, openxc_DynamicField* value, openxc_DynamicField* event, CanSignal* signals, int signalCount); @@ -51,15 +51,15 @@ typedef void (*CommandHandler)(const char* name, openxc_DynamicField* value, typedef struct { const char* generic_name; /*!< generic_name - The name of the command.*/ CommandHandler handler; /*!< handler - An function to process the received command's data and perform some - * action.*/ + * action.*/ } CanCommand; /* Public: Return an array of all OpenXC CAN commands enabled in the active * configuration that can write back to CAN with a custom handler. * - * * Commands not defined here are handled using a 1-1 mapping from the signals + * Commands not defined here are handled using a 1-1 mapping from the signals * list. - * */ + */ CanCommand* getCommands(); /* Public: Return the length of the array returned by getCommandCount(). */ |