From f0ff7323297cf888254d89feac4b15df9e00e390 Mon Sep 17 00:00:00 2001
From: Anika Raemer <anika@raemer.net>
Date: Thu, 4 Apr 2019 13:38:56 +0200
Subject: [PATCH] added documentation

---
 LenaPi/EnergySaver.cpp                 | 7 ++++++-
 LenaPi/EnergySaver.h                   | 9 ++++++++-
 LenaPi/MouseEventSpy.h                 | 2 +-
 LenaPi/controllers/MusicController.cpp | 1 +
 LenaPi/main.cpp                        | 5 +++--
 5 files changed, 19 insertions(+), 5 deletions(-)

diff --git a/LenaPi/EnergySaver.cpp b/LenaPi/EnergySaver.cpp
index 9fa35de..2f66403 100644
--- a/LenaPi/EnergySaver.cpp
+++ b/LenaPi/EnergySaver.cpp
@@ -7,10 +7,15 @@ 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();
-    saver->initTimer(interval);
+    saver->initTimer(interval*1000);
     saver->restartTimer();
 }
 
diff --git a/LenaPi/EnergySaver.h b/LenaPi/EnergySaver.h
index 171a57d..1e2aa0d 100644
--- a/LenaPi/EnergySaver.h
+++ b/LenaPi/EnergySaver.h
@@ -4,6 +4,12 @@
 #include <QObject>
 #include <QTimer>
 
+/**
+ * @brief Class handling energy saving options.
+ *
+ * Shut down RaspberryPi if no mouse input is detected and music player
+ * has not been active or a certain time interval.
+ */
 class EnergySaver : public QObject
 {
     Q_OBJECT
@@ -12,7 +18,8 @@ protected:
     EnergySaver(QObject *parent = 0);
 
 public:
-    static void init(int intervall);
+
+    static void init(int interval);
     static EnergySaver *instance();
 
 public slots:
diff --git a/LenaPi/MouseEventSpy.h b/LenaPi/MouseEventSpy.h
index 6c6db15..c5ca319 100644
--- a/LenaPi/MouseEventSpy.h
+++ b/LenaPi/MouseEventSpy.h
@@ -5,7 +5,7 @@
 #include <QEvent>
 
 /**
- * @brief Catches all mouse event and reports them via signal.
+ * @brief Catches all mouse events and reports them via signal.
  *
  * Based on
  * https://stackoverflow.com/questions/46173105/how-can-i-reset-a-timer-every-time-i-receive-a-touch-event-from-a-qml-page
diff --git a/LenaPi/controllers/MusicController.cpp b/LenaPi/controllers/MusicController.cpp
index e5c256a..47a23c2 100644
--- a/LenaPi/controllers/MusicController.cpp
+++ b/LenaPi/controllers/MusicController.cpp
@@ -26,6 +26,7 @@ MusicController::MusicController(QObject *parent) : QObject(parent)
     connect(mPlayer->mediaPlayer(), &VlcMediaPlayer::lengthChanged, mModel, &MusicModel::onLengthChanged);
     connect(mPlayer->mediaPlayer(), &VlcMediaPlayer::timeChanged, mModel, &MusicModel::onTimeChanged);
 
+    // hand over player signals to energy saver in order to determine player activity.
     connect(mPlayer->mediaPlayer(), &VlcMediaPlayer::timeChanged, EnergySaver::instance(), &EnergySaver::restartTimer);
 }
 
diff --git a/LenaPi/main.cpp b/LenaPi/main.cpp
index b05cf46..5d7e419 100644
--- a/LenaPi/main.cpp
+++ b/LenaPi/main.cpp
@@ -33,8 +33,9 @@ int main(int argc, char *argv[])
     // install MouseEventSpy and energy saver used for auto
     // shut down of RaspberryPi if not used for a predefined time.
     MouseEventSpy::init();
-    EnergySaver::init(10000);
-    QObject::connect(MouseEventSpy::instance(), &MouseEventSpy::mouseEventDetected, EnergySaver::instance(), &EnergySaver::restartTimer);
+    EnergySaver::init(10);
+    QObject::connect(MouseEventSpy::instance(), &MouseEventSpy::mouseEventDetected,
+                     EnergySaver::instance(), &EnergySaver::restartTimer);
     engine.load(QUrl("qrc:/main.qml"));