diff --git a/gui/AboutWindow.h b/gui/AboutWindow.h index 8e05a10..66c22a0 100644 --- a/gui/AboutWindow.h +++ b/gui/AboutWindow.h @@ -7,6 +7,12 @@ namespace Ui { class AboutWindow; } +/** + * @brief The AboutWindow class + * + * The AboutWindow just displays some copyright information. + * + */ class AboutWindow : public QDialog { Q_OBJECT diff --git a/gui/AnalysisWindow.h b/gui/AnalysisWindow.h index bddb0bd..70c6d88 100644 --- a/gui/AnalysisWindow.h +++ b/gui/AnalysisWindow.h @@ -7,6 +7,12 @@ namespace Ui { class AnalysisWindow; } +/** + * @brief The AnalysisWindow class. + * + * The Analysis Windows class shows a plot of data. This allows visual inspection of + * data + */ class AnalysisWindow : public QDialog { Q_OBJECT diff --git a/gui/MainWindow.h b/gui/MainWindow.h index 740ea1e..041e23f 100644 --- a/gui/MainWindow.h +++ b/gui/MainWindow.h @@ -10,6 +10,13 @@ QT_BEGIN_NAMESPACE namespace Ui { class MainWindow; } QT_END_NAMESPACE +/** + * @brief The MainWindow class + * + * The MainWindow class holds the primary GUI window of the application. All user interactions + * with QtRocket begin with interactions in this window. This window can spawn other windows. + */ + class MainWindow : public QMainWindow { Q_OBJECT diff --git a/gui/RocketTreeView.h b/gui/RocketTreeView.h index 82b72d8..af2ea36 100644 --- a/gui/RocketTreeView.h +++ b/gui/RocketTreeView.h @@ -6,6 +6,9 @@ /** * @brief RocketTreeView basically just renames QTreeView with a specific * memorable name. + * + * The purpose is to provide an exploded view of the components that make up the + * rocket design, and their relationships. */ class RocketTreeView : public QTreeView { diff --git a/gui/ThrustCurveMotorSelector.h b/gui/ThrustCurveMotorSelector.h index 94be155..ccecf1e 100644 --- a/gui/ThrustCurveMotorSelector.h +++ b/gui/ThrustCurveMotorSelector.h @@ -11,6 +11,9 @@ namespace Ui { class ThrustCurveMotorSelector; } +/** + * @brief The ThrustCurveMotorSelector class is a Window that provides an interface to Thrustcurve.org + */ class ThrustCurveMotorSelector : public QDialog { Q_OBJECT