Added comments to functions, menu link to online manual, updated vers…

…ion number location

SPIERSalign.pro

@@ -27,10 +27,9 @@ HEADERS += src/mainwindowimpl.h \
     src/globals.h \
     src/scene.h \
     src/darkstyletheme.h \
-    src/version.h \
     src/about.h \
     ../SPIERScommon/netmodule.h \
-    ../SPIERScommon/semanticversion.h \
+    ../SPIERScommon/semanticglobals.h \
     ../SPIERScommon/prereleasecomponent.h
 
 SOURCES += src/mainwindowimpl.cpp \

src/about.cpp

@@ -2,10 +2,10 @@
  * @file
  * About Dialog
  *
- * All REvoSim code is released under the GNU General Public License.
+ * All SPIERSview code is released under the GNU General Public License.
  * See LICENSE.md files in the programme directory.
  *
- * All REvoSim code is Copyright 2008-2018 by Mark D. Sutton, Russell J. Garwood,
+ * All SPIERSview code is Copyright 2008-2018 by Russell J. Garwood, Mark D. Sutton,
  * and Alan R.T. Spencer.
  *
  * This program is free software; you can redistribute it and/or modify
@@ -16,11 +16,15 @@
  */
 
 #include "about.h"
-#include "version.h"
+#include "globals.h"
 #include "mainwindowimpl.h"
 
 #include <QString>
 
+/**
+ * @brief About::About
+ * @param parent
+ */
 About::About(QWidget *parent) :
     QDialog(parent),
     ui(new Ui::About)
@@ -41,7 +45,7 @@ About::About(QWidget *parent) :
     ui->textLabel_2->setWordWrap(true);
     ui->textLabel_2->setText("This  software is " + QString(PRODUCTNAME) +
                              ". It was coded by"
-                             " Russell Garwood (russell.garwood@gmail.com), with advice and assistance from Mark Sutton (m.sutton@imperial.ac.uk) and a GUI theme by  Alan R.T. Spencer (alan.spencer@imperial.ac.uk)"
+                             " Russell Garwood (russell.garwood@gmail.com), with advice and assistance from Mark Sutton (m.sutton@imperial.ac.uk) and additional code by Alan R.T. Spencer (alan.spencer@imperial.ac.uk)"
                              "<br><br>Reports are appreciated, and comments, suggestions, and feature requests are welcome.");
     ui->textLabel_2->setAlignment(Qt::AlignCenter);
 
@@ -67,11 +71,18 @@ About::About(QWidget *parent) :
     ui->buttonBox->setStandardButtons(QDialogButtonBox::Close);
 }
 
+/**
+ * @brief About::~About
+ */
 About::~About()
 {
     delete ui;
 }
 
+/**
+ * @brief About::returnLicense
+ * @return
+ */
 QString About::returnLicense()
 {
     QString license;

src/about.h

@@ -1,7 +1,25 @@
+/**
+ * @file
+ * Header: About
+ *
+ * All SPIERSview code is released under the GNU General Public License.
+ * See LICENSE.md files in the programme directory.
+ *
+ * All SPIERSview code is Copyright 2008-2018 by Russell J. Garwood, Mark D. Sutton,
+ * and Alan R.T. Spencer.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or (at
+ * your option) any later version. This program is distributed in the
+ * hope that it will be useful, but WITHOUT ANY WARRANTY.
+ */
+
 #ifndef ABOUT_H
 #define ABOUT_H
 
 #include <QDialog>
+
 #include "ui_about.h"
 
 namespace Ui {

src/darkstyletheme.cpp

@@ -2,10 +2,10 @@
  * @file
  * Dark Style Theme
  *
- * All REvoSim code is released under the GNU General Public License.
+ * All SPIERSview code is released under the GNU General Public License.
  * See LICENSE.md files in the programme directory.
  *
- * All REvoSim code is Copyright 2008-2018 by Mark D. Sutton, Russell J. Garwood,
+ * All SPIERSview code is Copyright 2008-2018 by Russell J. Garwood, Mark D. Sutton,
  * and Alan R.T. Spencer.
  *
  * This program is free software; you can redistribute it and/or modify

src/darkstyletheme.h

@@ -2,10 +2,10 @@
  * @file
  * Header: Dark Style Theme
  *
- * All REvoSim code is released under the GNU General Public License.
+ * All SPIERSview code is released under the GNU General Public License.
  * See LICENSE.md files in the programme directory.
  *
- * All REvoSim code is Copyright 2008-2018 by Mark D. Sutton, Russell J. Garwood,
+ * All SPIERSview code is Copyright 2008-2018 by Russell J. Garwood, Mark D. Sutton,
  * and Alan R.T. Spencer.
  *
  * This program is free software; you can redistribute it and/or modify

src/globals.cpp

@@ -1,11 +1,36 @@
+/**
+ * @file
+ * Globals
+ *
+ * All SPIERSview code is released under the GNU General Public License.
+ * See LICENSE.md files in the programme directory.
+ *
+ * All SPIERSview code is Copyright 2008-2018 by Russell J. Garwood, Mark D. Sutton,
+ * and Alan R.T. Spencer.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or (at
+ * your option) any later version. This program is distributed in the
+ * hope that it will be useful, but WITHOUT ANY WARRANTY.
+ */
+
 #include "globals.h"
 
-//ImageData Constructor
+/**
+ * @brief ImageData::ImageData
+ * @param fn
+ */
 ImageData::ImageData(QString fn)
 {
     fileName = fn;
 }
 
+/**
+ * @brief MarkerData::MarkerData
+ * @param startRectangle
+ * @param shp
+ */
 MarkerData::MarkerData(QRectF *startRectangle, int shp)
 {
     markerRect = startRectangle;

src/globals.h

@@ -1,3 +1,20 @@
+/**
+ * @file
+ * Header: Globals
+ *
+ * All SPIERSview code is released under the GNU General Public License.
+ * See LICENSE.md files in the programme directory.
+ *
+ * All SPIERSview code is Copyright 2008-2018 by Russell J. Garwood, Mark D. Sutton,
+ * and Alan R.T. Spencer.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or (at
+ * your option) any later version. This program is distributed in the
+ * hope that it will be useful, but WITHOUT ANY WARRANTY.
+ */
+
 #ifndef __GLOBALS_H__
 #define __GLOBALS_H__
 
@@ -13,6 +30,27 @@
 #include <QString>
 #include <QTransform>
 
+//Legal Stuff
+#define COPYRIGHT "Copyright © 2018 Mark D. Sutton, Russell J. Garwood, Alan R.T.Spencer"
+#define LICENCE "This program comes with ABSOLUTELY NO WARRANTY. This is free software, and you are welcome to redistribute it under the conditions of the GPL v3  license"
+
+//Programme Name
+#define PRODUCTNAME "SPIERSalign"
+
+//Email
+#define EMAIL "palaeoware@gmail.com"
+
+//Github
+#define GITURL "https://github.com/"
+#define GITREPOSITORY "palaeoware/SPIERSalign"
+#define GITISSUE "/issues"
+
+//Readthedocs
+#define READTHEDOCS "https://spiersalign.readthedocs.io/en/latest/"
+
+/**
+ * @brief The ImageData class
+ */
 class ImageData
 {
 public:
@@ -23,13 +61,19 @@ class ImageData
     int format;
 };
 
+/**
+ * @brief The PropogationData class
+ */
 class PropogationData
 {
 public:
     int transformation;
     qreal value;
 };
 
+/**
+ * @brief The MarkerData class
+ */
 class MarkerData
 {
 public:

src/main.cpp

@@ -1,3 +1,20 @@
+/**
+ * @file
+ * Main
+ *
+ * All SPIERSview code is released under the GNU General Public License.
+ * See LICENSE.md files in the programme directory.
+ *
+ * All SPIERSview code is Copyright 2008-2018 by Russell J. Garwood, Mark D. Sutton,
+ * and Alan R.T. Spencer.
+ *
+ * This program is free software; you can redistribute it and/or modify
+ * it under the terms of the GNU General Public License as published by
+ * the Free Software Foundation; either version 3 of the License, or (at
+ * your option) any later version. This program is distributed in the
+ * hope that it will be useful, but WITHOUT ANY WARRANTY.
+ */
+
 #include <QApplication>
 #include <QDesktopWidget>
 #include <QSplashScreen>
@@ -6,10 +23,15 @@
 
 #include "darkstyletheme.h"
 #include "mainwindowimpl.h"
-#include "version.h"
+#include "globals.h"
 #include "../SPIERScommon/netmodule.h"
 
-
+/**
+ * @brief qMain
+ * @param argc
+ * @param argv
+ * @return
+ */
 int main(int argc, char **argv)
 {
     //This has the app draw at HiDPI scaling on HiDPI displays, usually two pixels for every one logical pixel