add doxygen

Documentin makes it easier to remember

.gitignore

@@ -1,2 +1,3 @@
+CMakeLists.txt.user
 build-Debug
 build

src/TombRaiderLinuxLauncher.cpp

@@ -11,12 +11,6 @@
 #include "worker.h"
 #include "ui_TombRaiderLinuxLauncher.h"
 
-/*
- *
- *
- *
- *
- */
 TombRaiderLinuxLauncher::TombRaiderLinuxLauncher(QWidget *parent)
     : QMainWindow(parent)
     , ui(new Ui::TombRaiderLinuxLauncher)
@@ -41,14 +35,10 @@ TombRaiderLinuxLauncher::TombRaiderLinuxLauncher(QWidget *parent)
 
 }
 /*
- * 0 Game dose not exist.
- * 1 The path is a symbolic link.
- * 2 The path is not a symbolic link.
- * 3 value 3:The path is not a directory.
  */
 int TombRaiderLinuxLauncher::checkGameDirectory(int game)
 {
-    struct folderNames folder;
+    struct FolderNames folder;
     QString name;
     switch (game)
     {
@@ -104,7 +94,7 @@ int TombRaiderLinuxLauncher::checkGameDirectory(int game)
 void TombRaiderLinuxLauncher::checkCommonFiles()
 {
     int dirStaus = checkGameDirectory(TR3); // we only setup tr3 for now
-    folderNames folder;
+    FolderNames folder;
     if (dirStaus)
     {
         if(dirStaus == 1)// The path is a symbolic link.
@@ -256,7 +246,7 @@ void TombRaiderLinuxLauncher::setOptionsClicked()
 
 void TombRaiderLinuxLauncher::linkClicked()
 {
-    struct folderNames folder;
+    struct FolderNames folder;
     const QString gamePath = settings.value("gamePath").toString() + folder.TR3;
     qDebug() << "Read game path value:" << gamePath;
     const QString levelPath = settings.value("levelPath").toString();

src/TombRaiderLinuxLauncher.h

@@ -3,30 +3,66 @@
 
 #include <QMainWindow>
 #include <QSettings>
-//#include "controller.h"
+#include "controller.h"
 
 QT_BEGIN_NAMESPACE
 namespace Ui { class TombRaiderLinuxLauncher; }
 QT_END_NAMESPACE
 
+/**
+ * 
+ */
 class TombRaiderLinuxLauncher : public QMainWindow
 {
     Q_OBJECT
 public:
+    /**
+     * 
+     */
     TombRaiderLinuxLauncher(QWidget *parent = nullptr);
+    /**
+     * 
+     */
     ~TombRaiderLinuxLauncher();
 
 public slots:
+    /**
+     * 
+     */
     void linkClicked();
+    /**
+     * 
+     */
     void downloadClicked();
+    /**
+     * 
+     */
     void setOptionsClicked();
 
 private:
+    /**
+     * 
+     */
     void setup();
+    /**
+     * 
+     */
     void readSavedSettings();
+    /**
+     * 
+     */
     void checkCommonFiles();
+    /**
+     * 
+     */
     void generateList();
-
+
+    /**
+     * 0 Game dose not exist.
+     * 1 The path is a symbolic link.
+     * 2 The path is not a symbolic link.
+     * 3 value 3:The path is not a directory.
+     */
     int checkGameDirectory(int game);
     QString selected;
     QSettings settings;

src/controller.h

@@ -2,15 +2,31 @@
 #define CONTROLLER_H
 #include <QObject>
 #include "worker.h"
+/**
+ * @brief The controller is the way for the UI to with blocking thread work
+ * 
+ */
 class Controller : public QObject
 {
     Q_OBJECT
 public:
+    /**
+     * 
+     */
     explicit Controller(QObject *parent = nullptr);
+    /**
+     * 
+     */
     void startWorkerThread();
+    /**
+     * 
+     */
     void stopWorkerThread();
 
 private slots:
+    /**
+     * 
+     */
     void onWorkerThreadFinished();
 
 private:

src/main.cpp

@@ -3,6 +3,9 @@
 #include <QApplication>
 
 
+/**
+ * 
+ */
 int main(int argc, char *argv[])
 {
     QApplication a(argc, argv);

src/network.h

@@ -6,11 +6,24 @@
 #include <QFile>
 #include <QDebug>
 
+/**
+ * //Example usage
+ * FileDownloader downloader;
+ * QUrl url("https://example.com/sample.txt");
+ * QString localFilePath = "downloaded_file.txt";
+ * downloader.downloadFile(url, localFilePath);
+ */
 class FileDownloader : public QObject
 {
     Q_OBJECT
 public:
+    /**
+     * 
+     */
     explicit FileDownloader(QObject *parent = nullptr) : QObject(parent) {}
+    /**
+     * 
+     */
     void downloadFile(const QUrl &url, const QString &localFilePath)
     {
         // Create a QNetworkAccessManager
@@ -39,6 +52,9 @@ class FileDownloader : public QObject
         });
     }
 private:
+    /**
+     * 
+     */
     void saveToFile(QIODevice *data, const QString &filePath)
     {
         // Open the local file for writing
@@ -50,15 +66,3 @@ class FileDownloader : public QObject
         }
     }
 };
-
-
-
-
-/**Example usage**********************************
- *
- * FileDownloader downloader;
- * QUrl url("https://example.com/sample.txt");
- * QString localFilePath = "downloaded_file.txt";
- * downloader.downloadFile(url, localFilePath);
- *************************************************/
-