Adding some doxygen comments

This commit is contained in:
Travis Hunter 2023-04-22 11:23:52 -06:00
parent 9674018a87
commit 42832f40cf
5 changed files with 25 additions and 0 deletions

View File

@ -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

View File

@ -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

View File

@ -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

View File

@ -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
{

View File

@ -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