more documentation and exportthread restructure

2019-03-21 14:01:10 +11:00
parent f126c4ebc7
commit be22e5fbfa
29 changed files with 743 additions and 376 deletions
@@ -23,11 +23,22 @@

 #include <QDialog>

+/**
+ * @brief The DemoNotice class
+ *
+ * Simple dialog shown on startup to introduce Olive as alpha software (in release builds).
+ */
 class DemoNotice : public QDialog
 {
-	Q_OBJECT
+  Q_OBJECT
 public:
-	explicit DemoNotice(QWidget *parent = 0);
+  /**
+   * @brief DemoNotice Constructor
+   * @param parent
+   *
+   * QWidget parent. Usually MainWindow.
+   */
+  explicit DemoNotice(QWidget *parent = nullptr);
 };

 #endif // DEMONOTICE_H