Index: firmware/App/Modes/ModeTreatment.h =================================================================== diff -u -rdb291cc22fd8f10e6e47cad468e14ed5590a94f2 -rbb643418e1f0c59ca3ee75c642aaa1f31850069e --- firmware/App/Modes/ModeTreatment.h (.../ModeTreatment.h) (revision db291cc22fd8f10e6e47cad468e14ed5590a94f2) +++ firmware/App/Modes/ModeTreatment.h (.../ModeTreatment.h) (revision bb643418e1f0c59ca3ee75c642aaa1f31850069e) @@ -36,59 +36,59 @@ /// Payload record structure for a treatment time status message. typedef struct { - U32 treatmentTimePrescribedinSec; - U32 treatmentTimeElapsedinSec; - U32 treatmentTimeRemaininginSec; + U32 treatmentTimePrescribedinSec; ///< Treatment time prescribed in seconds. + U32 treatmentTimeElapsedinSec; ///< Treatment time elapsed in seconds. + U32 treatmentTimeRemaininginSec; ///< Treatment time remaining in seconds. } TREATMENT_TIME_DATA_T; /// Payload record structure for a treatment state message. typedef struct { - U32 treatmentSubMode; - U32 uFState; - U32 salineBolusState; - U32 heparinState; - U32 rinsebackState; - U32 txRecircState; - U32 bldPrimeState; - U32 txEndState; - U32 txStopState; - U32 dialysisState; + U32 treatmentSubMode; ///< Treatment submode. + U32 uFState; ///< Ultrafiltration state. + U32 salineBolusState; ///< Saline bolus state. + U32 heparinState; ///< Heparin state. + U32 rinsebackState; ///< Rinse back state. + U32 txRecircState; ///< Treatment recirc state. + U32 bldPrimeState; ///< Blood prime state. + U32 txEndState; ///< Treatment end state. + U32 txStopState; ///< Treatment stop state. + U32 dialysisState; ///< Dialysis state. } TREATMENT_STATE_DATA_T; /// Payload record structure for an ultrafiltration volume change confirmation message. typedef struct { - F32 volume_mL; - U32 adjustType; + F32 volume_mL; ///< Volume in mL. + U32 adjustType; ///< Adjust type. } UF_SETTINGS_CHANGE_CONFIRMATION_PAYLOAD_T; /// Payload record structure for the in-line pressure limits change request. typedef struct { - S32 artPresLimitWindowmmHg; - S32 venPresLimitWindowmmHg; - S32 venPresLimitAsymmetricmmHg; + S32 artPresLimitWindowmmHg; ///< Arterial pressure limit window in mmHg. + S32 venPresLimitWindowmmHg; ///< Venous pressure limit window in mmHg. + S32 venPresLimitAsymmetricmmHg; ///< Venous pressure limit asymmetric in mmHg. } PRESSURE_LIMIT_CHANGE_REQUEST_T; /// Payload record structure for the in-line pressure limits change response. typedef struct { - BOOL accepted; - U32 rejReasonCode; - S32 artPresLimitWindowmmHg; - S32 venPresLimitWindowmmHg; - S32 venPresLimitAsymmetricmmHg; + BOOL accepted; ///< Accepted. + U32 rejReasonCode; ///< Rejection reason code number. + S32 artPresLimitWindowmmHg; ///< Arterial pressure limit window in mmHg. + S32 venPresLimitWindowmmHg; ///< Venous pressure limit window in mmHg. + S32 venPresLimitAsymmetricmmHg; ///< Venous pressure limit asymmetric in mmHg. } PRESSURE_LIMIT_CHANGE_RESPONSE_T; /// Payload record structure for the treatment log 30 minutes periodic data. typedef struct { - F32 avgBloodFlowRate; - F32 avgDialysateFlowRate; - F32 avgUFRate; - F32 avgArterialPressure; - F32 avgVenousPressure; + F32 avgBloodFlowRate; ///< Average blood flow rate in mL/min. + F32 avgDialysateFlowRate; ///< Average dialysate flow rate in mL/min. + F32 avgUFRate; ///< Average ultrafiltration rate. + F32 avgArterialPressure; ///< Average arterial pressure in mmHg. + F32 avgVenousPressure; ///< Average venous pressure in mmHg. } TREATMENT_LOG_DATA_PERIODIC_T; /// Maximum time in this mode before blood sitting alarm given (in general task intervals).