Rotary Encoder handling library for mbed
Diff: REnc.h
- Revision:
- 5:3e6931797218
- Parent:
- 4:916992052518
- Child:
- 6:abd0d8d58fed
--- a/REnc.h Tue Aug 12 01:49:49 2014 +0000 +++ b/REnc.h Tue Aug 12 01:56:59 2014 +0000 @@ -69,26 +69,24 @@ class REnc { public: - unsigned char CMD; /// @brief CMD represents the state of rotation - /** @brief CMD represents the state of rotation - * - * @retval STOP - * @retval CLOCKWISE - * @retval COUNTERCLOCKWISE - */ - unsigned char STABLE; /// @brief STABLE represents the rotation stability, - /** @brief STABLE represents the rotation stability, - * @brief raises RENC_EXECUTION_DELAY counts after REnc STOPping - * - * @retval 1 - stable - */ + unsigned char CMD; /*!< @brief CMD represents the state of rotation + * @retval STOP + * @retval CLOCKWISE + * @retval COUNTERCLOCKWISE + */ + unsigned char STABLE; /*!< @brief STABLE represents the rotation stability, + * @brief raises RENC_EXECUTION_DELAY counts after REnc STOPping + * @retval 1 - stable + */ /** set callback function to Clockwise TURN */ void setHandleCC(void (*fptr)(void)); /** set callback function to Counterclockwise TURN */ void setHandleCCW(void (*fptr)(void)); + /// constructor REnc(PinName pina, PinName pinb); + /// destructor virtual ~REnc() { }; private: