Index: sources/view/VCreateTreatment.h =================================================================== diff -u -r2c35a3fa17eef76c7a47578974b928c03f67c83d -r1cedf9bd892c07399551d7d46048bb5079d784ae --- sources/view/VCreateTreatment.h (.../VCreateTreatment.h) (revision 2c35a3fa17eef76c7a47578974b928c03f67c83d) +++ sources/view/VCreateTreatment.h (.../VCreateTreatment.h) (revision 1cedf9bd892c07399551d7d46048bb5079d784ae) @@ -24,6 +24,29 @@ namespace View { +/*! + * \brief The VCreateTreatment class + * + * The Create Treatment View manages the treatment parameter selection entry and validation. + * + * The Create Treatment View manages data display and translation between the user interface + * and treatment parameter and treatment parameter response models. + * + * Upon HD messaging with confirmation of the current parameter selection, + * the Create Treatment View segues to the Create Treatment confirmation screen. + * + * Upon HD messaging with a list of one or more invalid parameters, the Create Treatment View + * will signal the invalid parameters to the GUI so the user can make adjustments. + * + * The Create Treatment View replicates the validation function used by FW to mitigate + * incompatible parameter selection situations. + * + * When a user modifies treatment parameters: + * - The treatment parameters model is populated with the data + * - The data is validated for correctness and compatibility + * - The continue button is enabled upon success so FW can validate the parameter selection + * + */ class VCreateTreatment : public QObject { Q_OBJECT