Index: sources/model/hd/alarm/MAlarmCleared.h =================================================================== diff -u -r6ae83fa9a1a3204864fc5b50fe906ac09e9c1ea5 -r4d969a04e6d80a6d2f6b756a4b87aecd6356e6a9 --- sources/model/hd/alarm/MAlarmCleared.h (.../MAlarmCleared.h) (revision 6ae83fa9a1a3204864fc5b50fe906ac09e9c1ea5) +++ sources/model/hd/alarm/MAlarmCleared.h (.../MAlarmCleared.h) (revision 4d969a04e6d80a6d2f6b756a4b87aecd6356e6a9) @@ -2,13 +2,14 @@ * * Copyright (c) 2019-2020 Diality Inc. - All Rights Reserved. * \copyright - * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, - * IN PART OR IN WHOLE, - * WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. + * THIS CODE MAY NOT BE COPIED OR REPRODUCED IN ANY FORM, IN PART OR IN + * WHOLE, WITHOUT THE EXPLICIT PERMISSION OF THE COPYRIGHT OWNER. * - * \file MAlarmCleared.h - * \date 6/28/2020 - * \author Behrouz NematiPour + * \file MAlarmCleared.h + * \author (last) Behrouz NemaiPour + * \date (last) 02-Jul-2020 + * \author (original) Behrouz NemaiPour + * \date (original) 02-Jul-2020 * */ #pragma once @@ -24,6 +25,28 @@ namespace Model { +/*! + * \brief The MAlarmCleared class + * \details The alarm cleared model + * + * | MSG | CAN ID | Box | Type | Ack | Src | Dst | Description | + * |:----:|:------:|:---:|:------:|:---:|:---:|:---:|:-----------: | + * |0x0400| 0x001 | 1 | Event | Y | HD | All | Alarm Cleared | + * + * | Payload || + * | || + * | #1:(U32) | \ref Data::mAlarmID | + * + * \sa Data + * + *

Logging info

+ * | || + * | || + * | typeText | Event | + * | unitText | HD | + * | infoText | Alarm Cleared | + * + */ class MAlarmCleared { // friends @@ -32,7 +55,7 @@ public: QString stringPrefix = "Alarm Cleared"; struct Data { - quint32 mAlarmID = 0; /*!< Alarm ID value of type quint32 extracted out */ + quint32 mAlarmID = 0; ///< Alarm ID }; private: @@ -49,7 +72,6 @@ Data data() const; }; - } typedef Model::MAlarmCleared::Data AlarmClearedData;