Refactoring and documentation

This commit is contained in:
Anika Raemer 2021-08-28 14:08:02 +02:00
parent 87a208d305
commit 3fb5be5a74
10 changed files with 149 additions and 75 deletions

View file

@ -4,16 +4,6 @@
#include <QProcess>
#include <iostream>
EnergySaver::EnergySaver(QObject *parent) : QObject(parent)
{
}
/**
* @brief Create instance if necessary and set timeout interval.
* @param interval Timer interval in seconds
* @see EnergySaver::instance
*/
void EnergySaver::init(int interval)
{
EnergySaver* saver = instance();
@ -22,12 +12,7 @@ void EnergySaver::init(int interval)
}
/**
* @brief Implements the singleton pattern.
* @return Instance
*
* If no instance has been created yet, create new instance.
*/
EnergySaver *EnergySaver::instance()
{
static EnergySaver* inst;
@ -46,10 +31,7 @@ void EnergySaver::restartTimer()
mTimer.start();
}
/**
* @brief Initialize and connect timer.
* @param interval Timeout interval in millisecond.
*/
void EnergySaver::initTimer(int interval)
{
connect(&mTimer, &QTimer::timeout, this, &EnergySaver::onTimeout);
@ -57,9 +39,7 @@ void EnergySaver::initTimer(int interval)
mTimer.setSingleShot(true);
}
/**
* @brief Behavior on timeout: shut down RaspberryPi.
*/
void EnergySaver::onTimeout()
{
std::cout << "Shutting down.";