🚧 Started on doxygen documentation

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 = "";

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
+ * ```
+ */ 

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