Change binder to binding in title in use with gitbook

[apps/agl-service-can-low-level.git] / src / can / can-command.hpp

diff --git a/src/can/can-command.hpp b/src/can/can-command.hpp
index 8324d32..4cf20cb 100644 (file)
--- a/src/can/can-command.hpp
+++ b/src/can/can-command.hpp
@@ -20,34 +20,34 @@
 #include "openxc.pb.h"
 #include "can-signals.hpp"
 
-/**
- * @brief The type signature for a function to handle a custom OpenXC command.
- *
- * @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] event - an optional event from the received command, in a DynamicField. The
- *             actual type may be a number, string or bool.
- * @param[in] signals - The list of all signals.
- * @param[in] signalCount - The length of the signals array.
- */
+///
+/// @brief The type signature for a function to handle a custom OpenXC command.
+///
+/// @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] event - an optional event from the received command, in a DynamicField. The
+///            actual type may be a number, string or bool.
+/// @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, can_signal_t* signals, int signalCount);
 
-/* @struct CanCommand
- * @brief The structure to represent a supported custom OpenXC command.
- *
- * @desc For completely customized CAN commands without a 1-1 mapping between an
- * OpenXC message from the host and a CAN signal, you can define the name of the
- * command and a custom function to handle it in the VI. An example is
- * the "turn_signal_status" command in OpenXC, which has a value of "left" or
- * "right". The vehicle may have separate CAN signals for the left and right
- * turn signals, so you will need to implement a custom command handler to send
- * the correct signals.
- *
- * Command handlers are also useful if you want to trigger multiple CAN messages
- * or signals from a signal OpenXC message.
- */
+/// @struct CanCommand
+/// @brief The structure to represent a supported custom OpenXC command.
+///
+/// For completely customized CAN commands without a 1-1 mapping between an
+/// OpenXC message from the host and a CAN signal, you can define the name of the
+/// command and a custom function to handle it in the VI. An example is
+/// the "turn_signal_status" command in OpenXC, which has a value of "left" or
+/// "right". The vehicle may have separate CAN signals for the left and right
+/// turn signals, so you will need to implement a custom command handler to send
+/// the correct signals.
+///
+/// Command handlers are also useful if you want to trigger multiple CAN messages
+/// or signals from a signal OpenXC message.
+///
 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