Index: firmware/App/Modes/Dialysis.h =================================================================== diff -u -r57ee0134869672b53ab5b7146b8988ede8f828d6 -r7a14f1cc62ad1cb1d7d694f632ff3ddb90ca4717 --- firmware/App/Modes/Dialysis.h (.../Dialysis.h) (revision 57ee0134869672b53ab5b7146b8988ede8f828d6) +++ firmware/App/Modes/Dialysis.h (.../Dialysis.h) (revision 7a14f1cc62ad1cb1d7d694f632ff3ddb90ca4717) @@ -1,4 +1,4 @@ -/************************************************************************** +/**********************************************************************//** * * Copyright (c) 2020 Diality Inc. - All Rights Reserved. * @@ -17,15 +17,25 @@ #ifndef __DIALYSIS_H__ #define __DIALYSIS_H__ +/** + * @defgroup Dialysis Dialysis + * @brief Dialysis sub-mode of treatment mode. + * + * @addtogroup Dialysis + * @{ + */ + // ********** private function prototypes ********** -void initDialysis( void ); // initialize this module -void transitionToDialysis( void ); // prepares for transition to dialysis sub-mode -void execDialysis( void ); // execute the dialysis sub-mode state machine (call from ModeTreatment) +void initDialysis( void ); +void transitionToDialysis( void ); +void execDialysis( void ); void setDialysisParams( U32 bPFlow, U32 dPFlow, F32 maxUFVol, F32 uFRate ); void startDialysis( void ); void stopDialysis( void ); +/**@}*/ + #endif