From 79508f8912ff5e3233daa8d0e052224c546f8f86 Mon Sep 17 00:00:00 2001 From: Jens True Date: Wed, 10 Nov 2021 09:35:27 +0000 Subject: [PATCH] File comments for all files --- lib/CommandHandler/CommandHandler.cpp | 10 ++++++++++ lib/CommandHandler/CommandHandler.h | 15 +++++++++++++-- lib/DisplayProxy/DisplayProxy.h | 10 ++++++++++ lib/DisplayProxy/DisplayProxyMAX7456.cpp | 10 ++++++++++ lib/DisplayProxy/DisplayProxyMAX7456.h | 10 ++++++++++ src/main.cpp | 13 ++++++++++++- 6 files changed, 65 insertions(+), 3 deletions(-) diff --git a/lib/CommandHandler/CommandHandler.cpp b/lib/CommandHandler/CommandHandler.cpp index 8b687c8..e1cdafe 100644 --- a/lib/CommandHandler/CommandHandler.cpp +++ b/lib/CommandHandler/CommandHandler.cpp @@ -1,3 +1,13 @@ +/** + * @file CommandHandler.cpp + * @author Jens True (jens.chr.true@gmail.com) + * @brief CommandHandler implementation + * @version 0.1 + * @date 2021-11-10 + * + * @copyright Copyright (c) 2021 + * + */ #include "CommandHandler.h" #include "Arduino.h" diff --git a/lib/CommandHandler/CommandHandler.h b/lib/CommandHandler/CommandHandler.h index 8ee1f44..d9756c3 100644 --- a/lib/CommandHandler/CommandHandler.h +++ b/lib/CommandHandler/CommandHandler.h @@ -1,11 +1,20 @@ +/** + * @file CommandHandler.h + * @author Jens True (jens.chr.true@gmail.com) + * @brief CommandHandler Header + * @version 0.1 + * @date 2021-11-10 + * + * @copyright Copyright (c) 2021 + * + */ + #ifndef COMMANDHANDLER_H #define COMMANDHANDLER_H #include "DisplayProxy.h" /** * Parse a JSON command and convert it into display command(s). - * - * */ class CommandHandler { @@ -32,6 +41,8 @@ public: * @return True if the input was parsed correctly. */ bool parseJSON(const char *cmd); + + bool parse private: /** * Internal helpers for printing debug strings diff --git a/lib/DisplayProxy/DisplayProxy.h b/lib/DisplayProxy/DisplayProxy.h index 0c0d92d..b2cabc5 100644 --- a/lib/DisplayProxy/DisplayProxy.h +++ b/lib/DisplayProxy/DisplayProxy.h @@ -1,3 +1,13 @@ +/** + * @file DisplayProxy.h + * @author Jens True (jens.chr.true@gmail.com) + * @brief DisplayProxy header + * @version 0.1 + * @date 2021-11-10 + * + * @copyright Copyright (c) 2021 + * + */ #ifndef DISPLAYPROXY_H #define DISPLAYPROXY_H diff --git a/lib/DisplayProxy/DisplayProxyMAX7456.cpp b/lib/DisplayProxy/DisplayProxyMAX7456.cpp index 69a7dbf..13b7786 100644 --- a/lib/DisplayProxy/DisplayProxyMAX7456.cpp +++ b/lib/DisplayProxy/DisplayProxyMAX7456.cpp @@ -1,3 +1,13 @@ +/** + * @file DisplayProxyMAX7456.cpp + * @author Jens True (jens.chr.true@gmail.com) + * @brief DisplayProxyMAX7456 Implementation + * @version 0.1 + * @date 2021-11-10 + * + * @copyright Copyright (c) 2021 + * + */ #include "DisplayProxyMAX7456.h" DisplayProxyMAX7456::DisplayProxyMAX7456() diff --git a/lib/DisplayProxy/DisplayProxyMAX7456.h b/lib/DisplayProxy/DisplayProxyMAX7456.h index 3a3d442..44ca5ec 100644 --- a/lib/DisplayProxy/DisplayProxyMAX7456.h +++ b/lib/DisplayProxy/DisplayProxyMAX7456.h @@ -1,3 +1,13 @@ +/** + * @file DisplayProxyMAX7456.h + * @author Jens True (jens.chr.true@gmail.com) + * @brief DisplayProxyMAX7456 header + * @version 0.1 + * @date 2021-11-10 + * + * @copyright Copyright (c) 2021 + * + */ #ifndef DISPLAYPROXYMAX7456_H #define DISPLAYPROXYMAX7456_H diff --git a/src/main.cpp b/src/main.cpp index 1ca66f6..0ed27a9 100644 --- a/src/main.cpp +++ b/src/main.cpp @@ -1,9 +1,20 @@ /** - * \file + * @file main.cpp + * @author Jens True (jens.chr.true@gmail.com) + * @brief + * @version 0.1 + * @date 2021-11-10 + * @copyright Copyright (c) 2021 + * * Main application entry point. * Arduino Style but still a .cpp file */ +/** + * \file + + */ + #include "Arduino.h" #include "config.h"