diff options
| author |   Romain Forlot <romain.forlot@iot.bzh> | 2017-03-17 12:48:46 +0100 |
|---|---|---|
| committer | Romain Forlot <romain.forlot@iot.bzh> | 2017-03-17 12:48:46 +0100 |
| commit | 7591838644a3fcb5145b9ccc7200166debe7ba87 (patch) | |
| tree | 90336690ab6e294e9d1937beb98a1d50a0b327c4 /src/low-can-binding.cpp | |
| parent | f05cdb00aff6ba1d41a6d705d34bce42122f971f (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/low-can-binding.cpp')
| -rw-r--r-- | src/low-can-binding.cpp | 42 |
1 files changed, 20 insertions, 22 deletions
diff --git a/src/low-can-binding.cpp b/src/low-can-binding.cpp index 2b04fa8..d88ac99 100644 --- a/src/low-can-binding.cpp +++ b/src/low-can-binding.cpp @@ -45,11 +45,11 @@ extern "C" // Interface between the daemon and the binding const struct afb_binding_interface *binder_interface; -/******************************************************************************** -* -* Subscription and unsubscription -* -*********************************************************************************/ +///****************************************************************************** +/// +/// Subscription and unsubscription +/// +///*******************************************************************************/ static int make_subscription_unsubscription(struct afb_req request, const std::string& sig_name, std::map<std::string, struct afb_event>& s, bool subscribe) { @@ -109,16 +109,16 @@ static int subscribe_unsubscribe_signal(struct afb_req request, bool subscribe, return make_subscription_unsubscription(request, sig, s, subscribe); } -/** - * @fn static int subscribe_unsubscribe_signals(struct afb_req request, bool subscribe, const std::vector<can_signal_t>& signals) - * @brief subscribe to all signals in the vector signals - * - * @param[in] afb_req request : contain original request use to subscribe or unsubscribe - * @param[in] subscribe boolean value used to chose between a subscription operation or an unsubscription - * @param[in] can_signal_t vector with can_signal_t to subscribe - * - * @return Number of correctly subscribed signal - */ +/// +/// @fn static int subscribe_unsubscribe_signals(struct afb_req request, bool subscribe, const std::vector<can_signal_t>& signals) +/// @brief subscribe to all signals in the vector signals +/// +/// @param[in] afb_req request : contain original request use to subscribe or unsubscribe +/// @param[in] subscribe boolean value used to chose between a subscription operation or an unsubscription +/// @param[in] can_signal_t vector with can_signal_t to subscribe +/// +/// @return Number of correctly subscribed signal +/// static int subscribe_unsubscribe_signals(struct afb_req request, bool subscribe, const std::vector<std::string>& signals) { int rets = 0; @@ -243,13 +243,11 @@ extern "C" return &binding_desc; } - /** - * @brief Initialize the binding. - * - * @param[in] service Structure which represent the Application Framework Binder. - * - * @return Exit code, zero if success. - */ + /// @brief Initialize the binding. + /// + /// @param[in] service Structure which represent the Application Framework Binder. + /// + /// @return Exit code, zero if success. int afbBindingV1ServiceInit(struct afb_service service) { can_bus_t& can_bus_manager = configuration_t::instance().get_can_bus_manager(); |