From a69f2889bf7a85334413b84ee97e2aefecd6ca30 Mon Sep 17 00:00:00 2001 From: Patrick Fallberg Date: Thu, 24 Sep 2015 09:59:36 +0200 Subject: [PATCH] Better file documentation for the MySigning group --- .gitignore | 1 + .../SecureActuator/SecureActuator.ino | 22 ++++++++++++++----- .../Sha204Personalizer/Sha204Personalizer.ino | 11 ++++++---- 3 files changed, 24 insertions(+), 10 deletions(-) diff --git a/.gitignore b/.gitignore index 5e5b644..980b4fc 100644 --- a/.gitignore +++ b/.gitignore @@ -3,3 +3,4 @@ stino.settings *bak MyPrivateConfig.h Documentation/html +doxygen_sqlite3.db diff --git a/libraries/MySensors/examples/SecureActuator/SecureActuator.ino b/libraries/MySensors/examples/SecureActuator/SecureActuator.ino index b0e649c..a577e67 100644 --- a/libraries/MySensors/examples/SecureActuator/SecureActuator.ino +++ b/libraries/MySensors/examples/SecureActuator/SecureActuator.ino @@ -17,13 +17,17 @@ * version 2 as published by the Free Software Foundation. * ******************************* + */ +/** + * @ingroup MySigninggrp + * @{ + * @file SecureActuator.ino + * @brief Example sketch showing how to securely control locks. + * + * This example will remember lock state even after power failure. * * REVISION HISTORY - * Version 1.0 - Patrick "Anticimex" Fallberg - * - * DESCRIPTION - * Example sketch showing how to securely control locks. - * This example will remember lock state even after power failure. + * - See git log (git log libraries/MySensors/examples/SecureActuator/SecureActuator.ino) */ /** @@ -95,10 +99,16 @@ void presentation() } } +/** @brief Sketch execution code */ void loop() { } +/** + * @brief Incoming message handler + * + * @param message The message to handle. + */ void receive(const MyMessage &message) { // We only expect one type of message from controller. But we better check anyway. if (message.type==V_LOCK_STATUS && message.sensor<=NOF_LOCKS) { @@ -113,4 +123,4 @@ void receive(const MyMessage &message) { Serial.println(message.getBool()); } } - +/** @}*/ \ No newline at end of file diff --git a/libraries/MySensors/examples/Sha204Personalizer/Sha204Personalizer.ino b/libraries/MySensors/examples/Sha204Personalizer/Sha204Personalizer.ino index ed3a6b2..0634283 100644 --- a/libraries/MySensors/examples/Sha204Personalizer/Sha204Personalizer.ino +++ b/libraries/MySensors/examples/Sha204Personalizer/Sha204Personalizer.ino @@ -17,12 +17,15 @@ * version 2 as published by the Free Software Foundation. * ******************************* + */ +/** + * @ingroup MySigninggrp + * @{ + * @file Sha204Personalizer.ino + * @brief SHA204 personalization sketch * * REVISION HISTORY - * Version 1.0 - Patrick Fallberg, January 10, 2015 - * - * DESCRIPTION - * SHA204 personalization sketch + * - See git log (git log libraries/MySensors/examples/Sha204Personalizer/Sha204Personalizer.ino) */ /**