diff --git a/Doxyfile b/Doxyfile index a2d8c27..66dc6d1 100644 --- a/Doxyfile +++ b/Doxyfile @@ -973,7 +973,9 @@ RECURSIVE = YES # Note that relative paths are relative to the directory from which doxygen is # run. -EXCLUDE = docs +EXCLUDE = docs \ + gui/qcustomplot.h \ + gui/qcustomplot.cpp # The EXCLUDE_SYMLINKS tag can be used to select whether or not files or # directories that are symbolic links (a Unix file system feature) are excluded diff --git a/QtRocket.cpp b/QtRocket.cpp index d8c3afd..6e9b60a 100644 --- a/QtRocket.cpp +++ b/QtRocket.cpp @@ -1,12 +1,18 @@ -#include "QtRocket.h" -#include "gui/MainWindow.h" +/// \cond +// C headers +// C++ headers +#include + +// 3rd party headers #include #include #include +/// \endcond -#include - +// qtrocket headers +#include "QtRocket.h" +#include "gui/MainWindow.h" #include "sim/ConstantAtmosphere.h" #include "sim/ConstantGravityModel.h" diff --git a/QtRocket.h b/QtRocket.h index 299abc9..c773f29 100644 --- a/QtRocket.h +++ b/QtRocket.h @@ -1,17 +1,22 @@ #ifndef QTROCKET_H #define QTROCKET_H +/// \cond +// C headers +// C++ headers +#include #include #include -#include -#include "utils/Logger.h" +// 3rd party headers +/// \endcond + +// qtrocket headers +#include "model/MotorModel.h" #include "model/Rocket.h" - #include "sim/AtmosphericModel.h" #include "sim/GravityModel.h" - -#include "model/MotorModel.h" +#include "utils/Logger.h" /** * @brief The QtRocket class is the master controller for the QtRocket application. diff --git a/gui/AboutWindow.cpp b/gui/AboutWindow.cpp index 4fc59fe..9c3270a 100644 --- a/gui/AboutWindow.cpp +++ b/gui/AboutWindow.cpp @@ -1,4 +1,5 @@ #include "AboutWindow.h" + #include "ui_AboutWindow.h" AboutWindow::AboutWindow(QWidget *parent) : diff --git a/gui/AboutWindow.h b/gui/AboutWindow.h index 66c22a0..6b886c8 100644 --- a/gui/AboutWindow.h +++ b/gui/AboutWindow.h @@ -1,7 +1,14 @@ #ifndef ABOUTWINDOW_H #define ABOUTWINDOW_H +/// \cond +// C headers +// C++ headers +// 3rd party headers #include +/// \endcond + +// qtrocket headers namespace Ui { class AboutWindow; diff --git a/gui/AnalysisWindow.h b/gui/AnalysisWindow.h index 70c6d88..cab9953 100644 --- a/gui/AnalysisWindow.h +++ b/gui/AnalysisWindow.h @@ -1,7 +1,15 @@ #ifndef ANALYSISWINDOW_H #define ANALYSISWINDOW_H +/// \cond + +// C +// C++ +// 3rd party #include +/// \endcond + +// qtrocket headers namespace Ui { class AnalysisWindow; diff --git a/gui/MainWindow.cpp b/gui/MainWindow.cpp index 6a19601..540fed2 100644 --- a/gui/MainWindow.cpp +++ b/gui/MainWindow.cpp @@ -1,19 +1,28 @@ -#include "gui/MainWindow.h" -#include "ui_MainWindow.h" -#include "gui/AboutWindow.h" -#include "gui/AnalysisWindow.h" -#include "gui/ThrustCurveMotorSelector.h" -#include "sim/RK4Solver.h" -#include "model/Rocket.h" - -#include "utils/RSEDatabaseLoader.h" +/// \cond +// C headers +// C++ headers +#include +#include +#include +// 3rd party headers #include -#include -#include -#include +/// \endcond + + +// qtrocket headers +#include "ui_MainWindow.h" + +#include "gui/AboutWindow.h" +#include "gui/AnalysisWindow.h" +#include "gui/MainWindow.h" +#include "gui/ThrustCurveMotorSelector.h" +#include "model/Rocket.h" +#include "utils/RSEDatabaseLoader.h" + + MainWindow::MainWindow(QtRocket* _qtRocket, QWidget *parent) : QMainWindow(parent), diff --git a/gui/MainWindow.h b/gui/MainWindow.h index 041e23f..7eb286d 100644 --- a/gui/MainWindow.h +++ b/gui/MainWindow.h @@ -1,8 +1,14 @@ #ifndef MAINWINDOW_H #define MAINWINDOW_H +/// \cond +// C headers +// C++ headers +// 3rd Party headers #include +/// \endcond +// qtrocket headers #include "QtRocket.h" diff --git a/gui/RocketTreeView.h b/gui/RocketTreeView.h index af2ea36..b24c51f 100644 --- a/gui/RocketTreeView.h +++ b/gui/RocketTreeView.h @@ -1,7 +1,14 @@ #ifndef ROCKETTREEVIEW_H #define ROCKETTREEVIEW_H +/// \cond +// C headers +// C++ headers +// 3rd party headers #include +/// \endcond + +// qtrocket headers /** * @brief RocketTreeView basically just renames QTreeView with a specific diff --git a/gui/ThrustCurveMotorSelector.cpp b/gui/ThrustCurveMotorSelector.cpp index 0884309..4e37a79 100644 --- a/gui/ThrustCurveMotorSelector.cpp +++ b/gui/ThrustCurveMotorSelector.cpp @@ -1,3 +1,5 @@ + +// qtrocket headers #include "ThrustCurveMotorSelector.h" #include "ui_ThrustCurveMotorSelector.h" diff --git a/gui/ThrustCurveMotorSelector.h b/gui/ThrustCurveMotorSelector.h index ccecf1e..b123651 100644 --- a/gui/ThrustCurveMotorSelector.h +++ b/gui/ThrustCurveMotorSelector.h @@ -1,10 +1,16 @@ #ifndef THRUSTCURVEMOTORSELECTOR_H #define THRUSTCURVEMOTORSELECTOR_H -#include - +/// \cond +// C headers +// C++ headers #include +// 3rd party headers +#include +/// \endcond + +// qtrocket headers #include "utils/ThrustCurveAPI.h" namespace Ui { diff --git a/main.cpp b/main.cpp index 7e3d40c..0ce1027 100644 --- a/main.cpp +++ b/main.cpp @@ -1,3 +1,11 @@ + +/// \cond +// C headers +// C++ headers +// 3rd party headers +/// \endcond + + #include "QtRocket.h" #include "utils/Logger.h" diff --git a/model/MotorModel.h b/model/MotorModel.h index bd4e628..51168ec 100644 --- a/model/MotorModel.h +++ b/model/MotorModel.h @@ -1,13 +1,19 @@ #ifndef MODEL_MOTORMODEL_H #define MODEL_MOTORMODEL_H +/// \cond +// C headers +// C++ headers +#include + +// 3rd party headers // For boost serialization. We're using boost::serialize to save // and load Motor data to file #include #include +/// \endcond -#include - +// qtrocke theaders #include "Thrustcurve.h" class MotorModel diff --git a/model/Rocket.h b/model/Rocket.h index 05a9bba..066dc61 100644 --- a/model/Rocket.h +++ b/model/Rocket.h @@ -1,11 +1,18 @@ #ifndef ROCKET_H #define ROCKET_H -#include "sim/Propagator.h" -#include "model/Thrustcurve.h" - -#include // std::move +/// \cond +// C headers +// C++ headers #include +#include // std::move + +// 3rd party headers +/// \endcond + +// qtrocket headers +#include "model/Thrustcurve.h" +#include "sim/Propagator.h" class Rocket { diff --git a/model/Thrustcurve.cpp b/model/Thrustcurve.cpp index d693c84..70721a9 100644 --- a/model/Thrustcurve.cpp +++ b/model/Thrustcurve.cpp @@ -1,6 +1,14 @@ + +/// \cond +// C headers +// C++ headers +#include + +// 3rd party headers +/// \endcond + #include "Thrustcurve.h" -#include Thrustcurve::Thrustcurve(std::vector>& tc) : thrustCurve(tc), diff --git a/model/Thrustcurve.h b/model/Thrustcurve.h index 6a4408c..e0d28de 100644 --- a/model/Thrustcurve.h +++ b/model/Thrustcurve.h @@ -1,11 +1,15 @@ #ifndef MODEL_THRUSTCURVE_H #define MODEL_THRUSTCURVE_H +/// \cond +// C headers +// C++ headers #include -#include +// 3rd party headers #include #include +/// \endcond class Thrustcurve { diff --git a/sim/ConstantAtmosphere.h b/sim/ConstantAtmosphere.h index 568b140..c37ad43 100644 --- a/sim/ConstantAtmosphere.h +++ b/sim/ConstantAtmosphere.h @@ -1,6 +1,7 @@ #ifndef SIM_CONSTANTATMOSPHERE_H #define SIM_CONSTANTATMOSPHERE_H +// qtrocket headers #include "AtmosphericModel.h" namespace sim { diff --git a/sim/ConstantGravityModel.h b/sim/ConstantGravityModel.h index 5b22a55..74a83af 100644 --- a/sim/ConstantGravityModel.h +++ b/sim/ConstantGravityModel.h @@ -1,7 +1,8 @@ #ifndef SIM_CONSTANTGRAVITYMODEL_H #define SIM_CONSTANTGRAVITYMODEL_H -#include "GravityModel.h" +// qtrocket headers +#include "sim/GravityModel.h" #include "utils/Triplet.h" namespace sim { diff --git a/sim/DESolver.h b/sim/DESolver.h index 2ee33e9..a20c2ad 100644 --- a/sim/DESolver.h +++ b/sim/DESolver.h @@ -1,8 +1,14 @@ #ifndef SIM_DESOLVER_H #define SIM_DESOLVER_H +/// \cond +// C headers +// C++ headers #include +// 3rd party headers +/// \endcond + namespace sim { diff --git a/sim/GravityModel.h b/sim/GravityModel.h index 5ad73c6..da666ba 100644 --- a/sim/GravityModel.h +++ b/sim/GravityModel.h @@ -1,6 +1,7 @@ #ifndef SIM_GRAVITYMODEL_H #define SIM_GRAVITYMODEL_H +// qtrocket headers #include "utils/Triplet.h" namespace sim diff --git a/sim/Propagator.cpp b/sim/Propagator.cpp index 7df4dbe..dbdc69a 100644 --- a/sim/Propagator.cpp +++ b/sim/Propagator.cpp @@ -1,14 +1,23 @@ + +/// \cond +// C headers +// C++ headers +#include #include +#include +#include + +// 3rd party headers +/// \endcond + +// qtrocket headers #include "Propagator.h" -#include "sim/RK4Solver.h" -#include "model/Rocket.h" -#include "utils/Logger.h" #include "QtRocket.h" +#include "model/Rocket.h" +#include "sim/RK4Solver.h" +#include "utils/Logger.h" -#include -#include -#include namespace sim { diff --git a/sim/Propagator.h b/sim/Propagator.h index 9022de7..1f7515a 100644 --- a/sim/Propagator.h +++ b/sim/Propagator.h @@ -1,11 +1,19 @@ #ifndef SIM_PROPAGATOR_H #define SIM_PROPAGATOR_H -#include "sim/DESolver.h" - +/// \cond +// C headers +// C++ headers #include #include +// 3rd party headers +/// \endcond + +// qtrocket headers +#include "sim/DESolver.h" + + // Forward declare class Rocket; class QtRocket; diff --git a/sim/RK4Solver.h b/sim/RK4Solver.h index ec065bc..26a7e93 100644 --- a/sim/RK4Solver.h +++ b/sim/RK4Solver.h @@ -1,13 +1,21 @@ #ifndef SIM_RK4SOLVER_H #define SIM_RK4SOLVER_H -#include -#include -#include +/// \cond +// C headers +// C++ headers #include +#include +#include +#include -#include "utils/Logger.h" +// 3rd party headers + +/// \endcond + +// qtrocket headers #include "sim/DESolver.h" +#include "utils/Logger.h" namespace sim { diff --git a/sim/SphericalGeoidModel.cpp b/sim/SphericalGeoidModel.cpp index eaa347a..0e03b60 100644 --- a/sim/SphericalGeoidModel.cpp +++ b/sim/SphericalGeoidModel.cpp @@ -1,4 +1,6 @@ -#include "SphericalGeoidModel.h" + +// qtrocket headers +#include "sim/SphericalGeoidModel.h" #include "utils/math/Constants.h" namespace sim @@ -18,4 +20,4 @@ double SphericalGeoidModel::getGroundLevel(double, double) return utils::math::Constants::meanEarthRadiusWGS84; } -} // namespace sim \ No newline at end of file +} // namespace sim diff --git a/sim/SphericalGeoidModel.h b/sim/SphericalGeoidModel.h index 2bfc88e..e5c0be4 100644 --- a/sim/SphericalGeoidModel.h +++ b/sim/SphericalGeoidModel.h @@ -1,6 +1,7 @@ #ifndef SIM_SPHERICALGEOIDMODEL_H #define SIM_SPHERICALGEOIDMODEL_H +// qtrocket headers #include "GeoidModel.h" namespace sim @@ -24,4 +25,4 @@ public: } // namespace sim -#endif // SIM_SPHERICALGEOIDMODEL_H \ No newline at end of file +#endif // SIM_SPHERICALGEOIDMODEL_H diff --git a/sim/SphericalGravityModel.cpp b/sim/SphericalGravityModel.cpp index e495eff..24a9353 100644 --- a/sim/SphericalGravityModel.cpp +++ b/sim/SphericalGravityModel.cpp @@ -1,8 +1,16 @@ -#include "SphericalGravityModel.h" +/// \cond +// C headers +// C++ headers +#include + +// 3rd party headers +/// \endcond + +// qtrocket headers +#include "sim/SphericalGravityModel.h" #include "utils/math/Constants.h" -#include namespace sim { diff --git a/sim/SphericalGravityModel.h b/sim/SphericalGravityModel.h index f716509..8b28d31 100644 --- a/sim/SphericalGravityModel.h +++ b/sim/SphericalGravityModel.h @@ -1,6 +1,7 @@ #ifndef SIM_SPHERICALGRAVITYMODEL_H #define SIM_SPHERICALGRAVITYMODEL_H +// qtrocket headers #include "GravityModel.h" namespace sim diff --git a/sim/StateData.h b/sim/StateData.h index 33ea7ef..fc27e8a 100644 --- a/sim/StateData.h +++ b/sim/StateData.h @@ -1,6 +1,7 @@ #ifndef STATEDATA_H #define STATEDATA_H +// qtrocket headers #include "utils/math/Vector3.h" #include "utils/math/Quaternion.h" diff --git a/sim/USStandardAtmosphere.cpp b/sim/USStandardAtmosphere.cpp index 3432a56..c73d729 100644 --- a/sim/USStandardAtmosphere.cpp +++ b/sim/USStandardAtmosphere.cpp @@ -1,8 +1,16 @@ -#include "USStandardAtmosphere.h" -#include "utils/math/Constants.h" +/// \cond +// C headers +// C++ headers #include +// 3rd party headers +/// \endcond + +// qtrocket headers +#include "sim/USStandardAtmosphere.h" +#include "utils/math/Constants.h" + using namespace utils::math; namespace sim diff --git a/sim/USStandardAtmosphere.h b/sim/USStandardAtmosphere.h index 18c817a..2835d81 100644 --- a/sim/USStandardAtmosphere.h +++ b/sim/USStandardAtmosphere.h @@ -1,7 +1,8 @@ #ifndef SIM_USSTANDARDATMOSPHERE_H #define SIM_USSTANDARDATMOSPHERE_H -#include "AtmosphericModel.h" +// qtrocket headers +#include "sim/AtmosphericModel.h" #include "utils/BinMap.h" namespace sim @@ -36,4 +37,4 @@ private: }; } // namespace sim -#endif // SIM_USSTANDARDATMOSPHERE_H \ No newline at end of file +#endif // SIM_USSTANDARDATMOSPHERE_H diff --git a/sim/WindModel.cpp b/sim/WindModel.cpp index bac2698..b98811c 100644 --- a/sim/WindModel.cpp +++ b/sim/WindModel.cpp @@ -1,3 +1,5 @@ + +// qtrocket headers #include "WindModel.h" namespace sim diff --git a/sim/WindModel.h b/sim/WindModel.h index c8e4f1a..d01046b 100644 --- a/sim/WindModel.h +++ b/sim/WindModel.h @@ -1,6 +1,7 @@ #ifndef SIM_WINDMODEL_H #define SIM_WINDMODEL_H +// qtrocket headers #include "utils/Triplet.h" namespace sim diff --git a/utils/BinMap.cpp b/utils/BinMap.cpp index 98509b5..95d17d6 100644 --- a/utils/BinMap.cpp +++ b/utils/BinMap.cpp @@ -1,11 +1,17 @@ -#include "BinMap.h" +/// \cond +// C headers +// C++ headers #include - -#include #include +#include +// 3rd party headers #include +/// \endcond + +// qtrocket headers +#include "BinMap.h" // TODO: Check on the availability of this in Clang. // Replace libfmt with format when LLVM libc++ supports it diff --git a/utils/BinMap.h b/utils/BinMap.h index cd6e2a6..216cd7d 100644 --- a/utils/BinMap.h +++ b/utils/BinMap.h @@ -1,8 +1,14 @@ #ifndef UTILS_BINMAP_H #define UTILS_BINMAP_H -#include +/// \cond +// C headers +// C++ headers #include +#include + +// 3rd party headers +/// \endcond namespace utils { diff --git a/utils/CurlConnection.cpp b/utils/CurlConnection.cpp index 83ec61a..2c47d7d 100644 --- a/utils/CurlConnection.cpp +++ b/utils/CurlConnection.cpp @@ -1,7 +1,16 @@ -#include "CurlConnection.h" +/// \cond +// C headers +// C++ headers #include +// 3rd party headers +/// \endcond + +// qtrocket headers +#include "utils/CurlConnection.h" + + namespace { size_t curlCallback(void* content, size_t size, size_t nmemb, std::string* buffer) diff --git a/utils/CurlConnection.h b/utils/CurlConnection.h index a4af7da..a7b1cbc 100644 --- a/utils/CurlConnection.h +++ b/utils/CurlConnection.h @@ -1,10 +1,17 @@ #ifndef UTILS_CURLCONNECTION_H #define UTILS_CURLCONNECTION_H -#include -#include +/// \cond +// C headers #include +// C++ headers +#include +#include + +// 3rd party headers +/// \endcond + namespace utils { class CurlConnection diff --git a/utils/Logger.cpp b/utils/Logger.cpp index 879ac89..c4f6880 100644 --- a/utils/Logger.cpp +++ b/utils/Logger.cpp @@ -1,7 +1,15 @@ -#include "Logger.h" +/// \cond +// C headers +// C++ headers #include +// 3rd party headers +/// \endcond + +// qtrocket headers +#include "Logger.h" + namespace utils { Logger* Logger::instance = nullptr; diff --git a/utils/Logger.h b/utils/Logger.h index c151c4e..dede4e2 100644 --- a/utils/Logger.h +++ b/utils/Logger.h @@ -1,16 +1,22 @@ #ifndef UTILS_LOGGER_H #define UTILS_LOGGER_H +/// \cond +// C headers +// C++ headers #include #include #include -/** - * @todo write docs - */ +// 3rd party headers +/// \endcond + namespace utils { +/** + * @todo write docs + */ class Logger { public: diff --git a/utils/RSEDatabaseLoader.cpp b/utils/RSEDatabaseLoader.cpp index 133151c..09ea04c 100644 --- a/utils/RSEDatabaseLoader.cpp +++ b/utils/RSEDatabaseLoader.cpp @@ -1,10 +1,16 @@ -#include "RSEDatabaseLoader.h" - -#include +/// \cond +// C headers +// C++ headers #include #include +// 3rd party headers +#include +/// \endcond + +// qtrocket headers +#include "utils/RSEDatabaseLoader.h" #include "QtRocket.h" namespace utils { diff --git a/utils/RSEDatabaseLoader.h b/utils/RSEDatabaseLoader.h index 257db33..c9de1c6 100644 --- a/utils/RSEDatabaseLoader.h +++ b/utils/RSEDatabaseLoader.h @@ -1,12 +1,19 @@ #ifndef UTILS_RSEDATABASELOADER_H #define UTILS_RSEDATABASELOADER_H -#include "model/MotorModel.h" -#include +/// \cond +// C headers +// C++ headers #include +#include +// 3rd party headers #include +/// \endcond + +// qtrocket headers +#include "model/MotorModel.h" namespace utils { diff --git a/utils/TSQueue.h b/utils/TSQueue.h index 7862c4a..3352b3f 100644 --- a/utils/TSQueue.h +++ b/utils/TSQueue.h @@ -1,10 +1,16 @@ #ifndef TSQUEUE_H #define TSQUEUE_H -#include -#include -#include +/// \cond +// C headers +// C++ headers #include +#include +#include +#include + +// 3rd party headers +/// \endcond /** * @brief The TSQueue class is a very basic thread-safe queue diff --git a/utils/ThreadPool.cpp b/utils/ThreadPool.cpp index d3e16d7..00c2633 100644 --- a/utils/ThreadPool.cpp +++ b/utils/ThreadPool.cpp @@ -1,6 +1,15 @@ + +/// \cond +// C headers +// C++ headers +#include + +// 3rd party headers +/// \endcond + +// qtrocket headers #include "ThreadPool.h" -#include ThreadPool::ThreadPool() : done(false), diff --git a/utils/ThreadPool.h b/utils/ThreadPool.h index 459a560..476f1d0 100644 --- a/utils/ThreadPool.h +++ b/utils/ThreadPool.h @@ -1,12 +1,19 @@ #ifndef THREADPOOL_H #define THREADPOOL_H +/// \cond +// C headers +// C++ headers #include #include -#include #include +#include -#include "TSQueue.h" +// 3rd party headers +/// \endcond + +// qtrocket headers +#include "utils/TSQueue.h" /** diff --git a/utils/ThrustCurveAPI.cpp b/utils/ThrustCurveAPI.cpp index f40d762..8153085 100644 --- a/utils/ThrustCurveAPI.cpp +++ b/utils/ThrustCurveAPI.cpp @@ -1,6 +1,13 @@ -#include "ThrustCurveAPI.h" +/// \cond +// C headers +// C++ headers +// 3rd party headers #include +/// \endcond + +// qtrocket headers +#include "utils/ThrustCurveAPI.h" #include "utils/Logger.h" namespace utils diff --git a/utils/ThrustCurveAPI.h b/utils/ThrustCurveAPI.h index ba25148..96cfe89 100644 --- a/utils/ThrustCurveAPI.h +++ b/utils/ThrustCurveAPI.h @@ -2,10 +2,17 @@ #define UTILS_THRUSTCURVEAPI_H -#include +/// \cond +// C headers +// C++ headers #include +#include -#include "CurlConnection.h" +// 3rd party headers +/// \endcond + +// qtrocket headers +#include "utils/CurlConnection.h" #include "model/MotorModel.h" namespace utils diff --git a/utils/math/Quaternion.cpp b/utils/math/Quaternion.cpp index ad5dbb2..c575d0f 100644 --- a/utils/math/Quaternion.cpp +++ b/utils/math/Quaternion.cpp @@ -1,4 +1,6 @@ -#include "Quaternion.h" + +// qtrocket headers +#include "utils/math/Quaternion.h" namespace math { diff --git a/utils/math/Quaternion.h b/utils/math/Quaternion.h index 656a57b..2d8a848 100644 --- a/utils/math/Quaternion.h +++ b/utils/math/Quaternion.h @@ -1,9 +1,17 @@ #ifndef MATH_QUATERNION_H #define MATH_QUATERNION_H +/// \cond +// C headers +// C++ headers +#include + +// 3rd party headers +/// \endcond + +// qtrocket headers #include "Vector3.h" -#include namespace math { diff --git a/utils/math/Vector3.cpp b/utils/math/Vector3.cpp index 05282ad..90c7f1b 100644 --- a/utils/math/Vector3.cpp +++ b/utils/math/Vector3.cpp @@ -1,4 +1,6 @@ -#include "Vector3.h" + +// qtrocket headers +#include "utils/math/Vector3.h" namespace math {