📝 Added documentation to source files

ThinkPink/main.cpp

@@ -1,3 +1,8 @@
+/*!
+ * \file main.cpp
+ * \brief Location of the #main-function. Reads QSettings object from `ThinkPink.ini` and resets unique_ptr.
+ */
+
 #include "mainwindow.hpp"
 
 #include <QApplication>
@@ -35,6 +40,9 @@ void initialise_settings() {
     settings.reset( new QSettings( config_path, QSettings::IniFormat ) );
 }
 
+/*!
+ * \brief Sets up the #QApplication, then calls #initialise_settings and finally starts the #MainWindow.
+ */
 int main(int argc, char *argv[])
 {
     QApplication a(argc, argv);

ThinkPink/mainwindow.cpp

@@ -1,3 +1,8 @@
+/*!
+ * \file mainwindow.cpp
+ * \brief Implementation of the #MainWindow class
+ */
+
 #include "mainwindow.hpp"
 #include "ui_mainwindow.h"
 

ThinkPink/mainwindow.hpp

@@ -1,3 +1,8 @@
+/*!
+ * \file mainwindow.hpp
+ * \brief Includes the #MainWindow class header, inherited from #QMainWindow.
+ */
+
 #ifndef MAINWINDOW_H
 #define MAINWINDOW_H
 #include <stdlib.h>

ThinkPink/samegame.cpp

@@ -1,3 +1,8 @@
+/*!
+ * \file samegame.cpp
+ * \brief Implementation of the #SameGame class.
+ */
+
 #include "samegame.hpp"
 
 void SameGame::initialiseGameMatrix(int rows, int columns) {

ThinkPink/samegame.hpp

@@ -1,3 +1,8 @@
+/*!
+ * \file samegame.hpp
+ * \brief Includes the #SameGame class header.
+ */
+
 #ifndef SAMEGAME_H
 #define SAMEGAME_H
 

ThinkPink/settings.hpp

@@ -1,6 +1,6 @@
 /*!
  * \file settings.hpp
- * \ingroup Settings_src
+ * \brief Includes the external #settings `unique_ptr`.
  */
 
 #ifndef SETTINGS_HPP