summaryrefslogtreecommitdiffstats
path: root/src/diagnostic/diagnostic-manager.hpp
diff options
context:
space:
mode:
authorRomain Forlot <romain.forlot@iot.bzh>2017-03-17 12:48:46 +0100
committerRomain Forlot <romain.forlot@iot.bzh>2017-03-17 12:48:46 +0100
commit7591838644a3fcb5145b9ccc7200166debe7ba87 (patch)
tree90336690ab6e294e9d1937beb98a1d50a0b327c4 /src/diagnostic/diagnostic-manager.hpp
parentf05cdb00aff6ba1d41a6d705d34bce42122f971f (diff)
Comments fixes, typo and formating.
No more warning when generate the docs and all comments follow the same formating. Change-Id: I80d4c5c2d64401c2e53a550c60155680c4f968ce Signed-off-by: Romain Forlot <romain.forlot@iot.bzh>
Diffstat (limited to 'src/diagnostic/diagnostic-manager.hpp')
-rw-r--r--src/diagnostic/diagnostic-manager.hpp18
1 files changed, 9 insertions, 9 deletions
diff --git a/src/diagnostic/diagnostic-manager.hpp b/src/diagnostic/diagnostic-manager.hpp
index c66e21a..bd5cefb 100644
--- a/src/diagnostic/diagnostic-manager.hpp
+++ b/src/diagnostic/diagnostic-manager.hpp
@@ -26,20 +26,20 @@
#include "../can/can-bus.hpp"
#include "active-diagnostic-request.hpp"
-/* Each CAN bus needs its own set of shim functions, so this should
- * match the maximum CAN controller count.
- */
+/// Each CAN bus needs its own set of shim functions, so this should
+/// match the maximum CAN controller count.
+///
#define MAX_SHIM_COUNT can_bus_t.get_can_devices().size()
#define DIAGNOSTIC_RESPONSE_ARBITRATION_ID_OFFSET 0x8
class active_diagnostic_request_t;
-/**
- * @brief The core structure for running the diagnostics module by the binding.
- *
- * @desc This stores details about the active requests and shims required to connect
- * the diagnostics library to the CAN device.
- */
+///
+/// @brief The core structure for running the diagnostics module by the binding.
+///
+/// This stores details about the active requests and shims required to connect
+/// the diagnostics library to the CAN device.
+///
class diagnostic_manager_t {
protected:
static bool shims_send(const uint32_t arbitration_id, const uint8_t* data, const uint8_t size);