Added watchdog stop feature and refactored a bit the H-Bridge driver. Untested, might...

[pes-rpp/rpp-lib.git] / rpp / include / rpp / hbr.h

diff --git a/rpp/include/rpp/hbr.h b/rpp/include/rpp/hbr.h
index 5fc5411fa01fcb4ce2f21ad4c4fb1fa1a8465bb6..09abf7c6507204217b8db44adadcd53ddd59bd5c 100644 (file)
--- a/rpp/include/rpp/hbr.h
+++ b/rpp/include/rpp/hbr.h
@@ -18,7 +18,7 @@
  * Call this method before using this module.
  *
  * @return SUCCESS if initialization successful.\n
- *          FAILURE if module already initialized.
+ *         FAILURE if module already initialized.
  */
 int8_t rpp_hbr_init();
 
@@ -36,7 +36,8 @@ int8_t rpp_hbr_init();
  *                      ~18kHz (18181.818181818 Hz to be precise) is used.
  *
  * @return SUCCESS if successful.\n
- *          FAILURE if H-Bridge was already enabled.
+ *         FAILURE if H-Bridge was already enabled or watchdog task could not
+ *                 be created.
  *
  * @note Period considerations from Software perspective (hardware verification
  * required):
@@ -93,7 +94,7 @@ int8_t rpp_hbr_control(double cmd);
  * controlled again until another call to rpp_hbr_enable() is made.
  *
  * @return SUCCESS if successful.\n
- *          FAILURE if H-Bridge was disabled already.
+ *         FAILURE if H-Bridge was disabled already.
  */
 int8_t rpp_hbr_disable();