6.9.4

Author: quantum-leaps

LICENSE.txt renamed to LICENSE

@@ -1,3 +1,10 @@
+[![Object-Oriented Programming in C](img/thumbnail.jpg)](https://www.state-machine.com/oop)
+
+
+## Brought to you by:
+[![Quantum Leaps](https://www.state-machine.com/attachments/logo_ql_400.png)](https://www.state-machine.co)
+
+---------------------------------------------------------------------
 ![QP-Arduino](https://www.state-machine.com/img/logo_qp-arduino.png)
 
 This README provides a quick overview of QP for Arduino.

README.md

@@ -4,7 +4,7 @@
 * @ingroup qep
 * @cond
 ******************************************************************************
-* Last updated for version 6.8.0
+* Last updated for version 6.8.2
 * Last updated on  2020-03-08
 *
 *                    Q u a n t u m  L e a P s
@@ -62,6 +62,7 @@ static int_fast8_t QHsm_tran_(QHsm * const me,
 
 /****************************************************************************/
 /**
+* @protected @memberof QHsm
 * @description
 * Performs the first step of HSM initialization by assigning the initial
 * pseudostate to the currently active state of the state machine.
@@ -92,6 +93,7 @@ void QHsm_ctor(QHsm * const me, QStateHandler initial) {
 
 /****************************************************************************/
 /**
+* @private @memberof QHsm
 * @description
 * Executes the top-most initial transition in a HSM.
 *
@@ -152,6 +154,7 @@ void QHsm_init_(QHsm * const me) {
 
 /****************************************************************************/
 /**
+* @protected @memberof QHsm
 * @description
 * QHsm_top() is the ultimate root of state hierarchy in all HSMs derived
 * from ::QHsm.
@@ -173,6 +176,7 @@ QState QHsm_top(void const * const me) {
 
 /****************************************************************************/
 /**
+* @private @memberof QHsm
 * @description
 * Dispatches an event for processing to a hierarchical state machine (HSM).
 * The processing of an event represents one run-to-completion (RTC) step.
@@ -274,6 +278,7 @@ void QHsm_dispatch_(QHsm * const me) {
 
 /****************************************************************************/
 /**
+* @private @memberof QHsm
 * @description
 * Static helper function to execute transition sequence in a hierarchical
 * state machine (HSM).
@@ -419,6 +424,7 @@ static int_fast8_t QHsm_tran_(QHsm * const me,
 
 /****************************************************************************/
 /**
+* @private @memberof QHsm
 * @description
 * Finds the child state of the given @c parent, such that this child state
 * is an ancestor of the currently active state. The main purpose of this

libraries/qpn_avr/src/qepn.c

@@ -224,7 +224,9 @@ struct QHsmVtable {
 #define QHSM_DISPATCH(me_) ((*(me_)->vptr->dispatch)((me_)))
 
 /* public methods */
-/*! protected "constructor" of a HSM. */
+/*! "constructor" of a HSM.
+* @protected @memberof QHsm
+*/
 void QHsm_ctor(QHsm * const me, QStateHandler initial);
 
 /*! Obtain the current active state from a HSM (read only). */
@@ -235,7 +237,9 @@ void QHsm_ctor(QHsm * const me, QStateHandler initial);
 */
 #define QHsm_state(me_) (Q_STATE_CAST(Q_HSM_UPCAST(me_)->state))
 
-/*! Obtain the current active child state of a given parent in QHsm */
+/*! Obtain the current active child state of a given parent in QHsm
+* @public @memberof QHsm
+*/
 /**
 * @param[in] me_     pointer (see @ref oop)
 * @param[in] parent_ pointer to the parent state-handler
@@ -249,13 +253,19 @@ void QHsm_ctor(QHsm * const me, QStateHandler initial);
 QStateHandler QHsm_childState_(QHsm * const me,
                                QStateHandler const parent);
 
-/*! Implementation of the top-most initial transition in QHsm. */
+/*! Implementation of the top-most initial transition in QHsm.
+* @private @memberof QHsm
+*/
 void QHsm_init_(QHsm * const me);
 
-/*! Implementation of dispatching events to QHsm. */
+/*! Implementation of dispatching events to QHsm.
+* @private @memberof QHsm
+*/
 void QHsm_dispatch_(QHsm * const me);
 
-/*! the top-state. */
+/*! the top-state.
+* @protected @memberof QHsm
+*/
 QState QHsm_top(void const * const me);
 
 

libraries/qpn_avr/src/qepn.h

@@ -4,7 +4,7 @@
 * @ingroup qfn
 * @cond
 ******************************************************************************
-* Last updated for version 6.8.0
+* Last updated for version 6.8.2
 * Last updated on  2020-03-08
 *
 *                    Q u a n t u m  L e a P s
@@ -93,6 +93,9 @@ uint8_t const Q_ROM QF_log2Lkup[16] = {
 #endif /* QF_LOG2 */
 
 /****************************************************************************/
+/**
+* @protected @memberof QActive
+*/
 void QActive_ctor(QActive * const me, QStateHandler initial) {
     static QActiveVtable const vtable = { /* QActive virtual table */
         { &QHsm_init_,
@@ -116,6 +119,7 @@ void QActive_ctor(QActive * const me, QStateHandler initial) {
 
 /****************************************************************************/
 /**
+* @private @memberof QActive
 * @description
 * Direct event posting is the simplest asynchronous communication method
 * available in QF-nano.
@@ -201,6 +205,7 @@ bool QActive_postX_(QActive * const me, uint_fast8_t margin,
 
 /****************************************************************************/
 /**
+* @private @memberof QActive
 * @description
 * Direct event posting is the simplest asynchronous communication method
 * available in QF-nano.
@@ -424,6 +429,7 @@ void QF_tickXISR(uint_fast8_t const tickRate) {
 
 /****************************************************************************/
 /**
+* @public @memberof QActive
 * @description
 * Arms a time event to fire in a specified number of clock ticks at the
 * specified tick rate. The timeout signal gets directly posted (using the
@@ -475,6 +481,7 @@ void QActive_armX(QActive * const me, uint_fast8_t const tickRate,
 
 /****************************************************************************/
 /**
+* @public @memberof QActive
 * @description
 * The time event of the active object gets disarmed (stopped).
 *

libraries/qpn_avr/src/qfn.c

@@ -4,7 +4,7 @@
 * @ingroup qfn
 * @cond
 ******************************************************************************
-* Last updated for version 6.8.0
+* Last updated for version 6.8.2
 * Last updated on  2020-03-08
 *
 *                    Q u a n t u m  L e a P s
@@ -97,7 +97,9 @@
 #endif
 
 /****************************************************************************/
-/*! QActive active object (based on QHsm-implementation) */
+/*! QActive active object (based on QHsm-implementation)
+* @extends QHsm
+*/
 /**
 * @description
 * QActive is the base structure for derivation of active objects. Active
@@ -141,7 +143,9 @@ typedef struct QActive {
 
 } QActive;
 
-/*! Virtual table for the QActive class */
+/*! Virtual table for the QActive class
+* @extends QHsmVtable
+*/
 typedef struct {
     QHsmVtable super; /*!< inherits QHsmVtable */
 
@@ -278,11 +282,15 @@ void QActive_ctor(QActive * const me, QStateHandler initial);
                 QF_ACTIVE_CAST((me_)), (margin_),          \
                 (enum_t)(sig_), (QParam)(par_)))
 
-    /*! Implementation of the task-level event posting */
+    /*! Implementation of the task-level event posting
+    * @private @memberof QActive
+    */
     bool QActive_postX_(QActive * const me, uint_fast8_t margin,
                         enum_t const sig, QParam const par);
 
-    /*! Implementation of the ISR-level event posting */
+    /*! Implementation of the ISR-level event posting
+    * @private @memberof QActive
+    */
     bool QActive_postXISR_(QActive * const me, uint_fast8_t margin,
                            enum_t const sig, QParam const par);
 
@@ -322,16 +330,22 @@ void QActive_ctor(QActive * const me, QStateHandler initial);
     void QF_tickXISR(uint_fast8_t const tickRate);
 
 #ifdef QF_TIMEEVT_PERIODIC
-    /*! Arm the QP-nano one-shot time event. */
+    /*! Arm the QP-nano one-shot time event.
+    * @public @memberof QActive
+    */
     void QActive_armX(QActive * const me, uint_fast8_t const tickRate,
                       QTimeEvtCtr const nTicks, QTimeEvtCtr const interval);
 #else
-    /*! Arm the QP-nano one-shot time event. */
+    /*! Arm the QP-nano one-shot time event.
+    * @public @memberof QActive
+    */
     void QActive_armX(QActive * const me, uint_fast8_t const tickRate,
                       QTimeEvtCtr const nTicks);
 #endif
 
-    /*! Disarm a time event. Since the tick counter */
+    /*! Disarm a time event. Since the tick counter
+    * @public @memberof QActive
+    */
     void QActive_disarmX(QActive * const me, uint_fast8_t const tickRate);
 
 #endif /* (QF_TIMEEVT_CTR_SIZE != 0U) */