From a0ae564ada460fd564d2d17dbfd1439bf77fb3e0 Mon Sep 17 00:00:00 2001
From: Isabell Pflug <isabell.pflug@floating-in.space>
Date: Mon, 5 Jun 2023 13:11:29 +0200
Subject: [PATCH] :construction: Started on doxygen documentation

---
 ThinkPink/main.cpp     |  4 ++++
 ThinkPink/mainpage.dox | 16 ++++++++++++++++
 ThinkPink/mainwindow.h |  4 ++--
 3 files changed, 22 insertions(+), 2 deletions(-)
 create mode 100644 ThinkPink/mainpage.dox

diff --git a/ThinkPink/main.cpp b/ThinkPink/main.cpp
index d8f8e1c..0e70808 100644
--- a/ThinkPink/main.cpp
+++ b/ThinkPink/main.cpp
@@ -7,6 +7,10 @@
 
 std::unique_ptr<QSettings> settings;
 
+/**
+ * @file main.cpp
+ */
+
 void initialise_settings() {
     QString config_filename = "ThinkPink.ini";
     QString config_path = "";
diff --git a/ThinkPink/mainpage.dox b/ThinkPink/mainpage.dox
new file mode 100644
index 0000000..849c292
--- /dev/null
+++ b/ThinkPink/mainpage.dox
@@ -0,0 +1,16 @@
+/*! @mainpage ThinkPink | SameGame in PINK by Isifluff
+ *
+ * @section intro_sec Introduction
+ *
+ * This application is an implementation of the [SameGame](https://de.wikipedia.org/wiki/SameGame)
+ *
+ * @section install_sec Installation
+ *
+ * @subsection install_linux On Linux/Unix
+ *
+ * ```
+ * git clone https://git.floating-in.space/isabell/ThinkPink.git && cd ThinkPink/ThinkPink
+ * qmake
+ * make -j
+ * ```
+ */ 
diff --git a/ThinkPink/mainwindow.h b/ThinkPink/mainwindow.h
index 2d46b3f..f8a0209 100644
--- a/ThinkPink/mainwindow.h
+++ b/ThinkPink/mainwindow.h
@@ -29,7 +29,7 @@ class MainWindow : public QMainWindow
 public:
     MainWindow(QWidget *parent = nullptr);
     ~MainWindow();
-    // initialisation functions
+
     void initialiseGame();
     void initialiseGameGrid();
     void initialiseWindow();
@@ -45,7 +45,6 @@ public:
     void setPalettes();
     void gameOver();
 
-    // highscore functions
     void processHighscore();
     void readHighscore();
     QMap<QPair<QString, QDateTime>, int> newEntry();
@@ -66,4 +65,5 @@ private:
     std::vector<std::vector<QPushButton *>> buttonGrid;
     QMap<QPair<QString, QDateTime>, int> highscore;
 };
+
 #endif // MAINWINDOW_H