Index: sources/model/MAbstract.h =================================================================== diff -u -r12e7b6dda53cf8db7707c7fa55dcf6137e7d6997 -r84c5373209a1a488c00917995f5553d442d159a4 --- sources/model/MAbstract.h (.../MAbstract.h) (revision 12e7b6dda53cf8db7707c7fa55dcf6137e7d6997) +++ sources/model/MAbstract.h (.../MAbstract.h) (revision 84c5373209a1a488c00917995f5553d442d159a4) @@ -24,10 +24,34 @@ namespace Model { /*! + * \page GeneralModelsDescription General Models Description + * The Models are the entities which keep the data and methods to manipulate the data. + * The UI Application is using different types of models in different situations. + * One use case, as the Denali Device is using the Denali Message Protocol over the CANBus for all the messaging transactions + * and almost all the Messages carrying data payloads of a model object for each message, + * is keeping the data for that specific message. + * So for each message there is a model to keep the structured data. + * Each model has been described in its class. + * + * The Models using for Denali Messaging depending on the Unit on the CANBus and the type of the messages categorized into : + * + * **Units on the CANBus :** + * | | | | + * |:-----:|:-----:|:---:| + * | UI | HD | DG | + * + * **Type of messages known at the moment :** + * | | | | | + * |:------:|:----:|:-----------:|:------:| + * | Events | Data | Adjustments | Alarms | + * + */ + +/*! * \brief The MAbstract class - * \details All the Message Models has to be inherited from MAbstract + * \details All the Message Models has to be inherited from MAbstract. * As this class is abstract it dictates children to implement required methods. - * And also implements some some share methods to ease implementing Models. + * And also implements some share methods to ease implementing Models. */ class MAbstract {