1
0

File comments for all files
Some checks failed
continuous-integration/drone/push Build is failing

This commit is contained in:
Jens True 2021-11-10 09:35:27 +00:00
parent 353f04fba5
commit 79508f8912
6 changed files with 65 additions and 3 deletions

@ -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 "CommandHandler.h"
#include "Arduino.h" #include "Arduino.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 #ifndef COMMANDHANDLER_H
#define COMMANDHANDLER_H #define COMMANDHANDLER_H
#include "DisplayProxy.h" #include "DisplayProxy.h"
/** /**
* Parse a JSON command and convert it into display command(s). * Parse a JSON command and convert it into display command(s).
*
*
*/ */
class CommandHandler class CommandHandler
{ {
@ -32,6 +41,8 @@ public:
* @return True if the input was parsed correctly. * @return True if the input was parsed correctly.
*/ */
bool parseJSON(const char *cmd); bool parseJSON(const char *cmd);
bool parse
private: private:
/** /**
* Internal helpers for printing debug strings * Internal helpers for printing debug strings

@ -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 #ifndef DISPLAYPROXY_H
#define DISPLAYPROXY_H #define DISPLAYPROXY_H

@ -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" #include "DisplayProxyMAX7456.h"
DisplayProxyMAX7456::DisplayProxyMAX7456() DisplayProxyMAX7456::DisplayProxyMAX7456()

@ -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 #ifndef DISPLAYPROXYMAX7456_H
#define DISPLAYPROXYMAX7456_H #define DISPLAYPROXYMAX7456_H

@ -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. * Main application entry point.
* Arduino Style but still a .cpp file * Arduino Style but still a .cpp file
*/ */
/**
* \file
*/
#include "Arduino.h" #include "Arduino.h"
#include "config.h" #include "config.h"