Adding Doxygen generation. Add doxygen \cond logic to exclude 3rd party headers from being indexed and documented

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

QtRocket.cpp

@@ -1,12 +1,18 @@
-#include "QtRocket.h"
-#include "gui/MainWindow.h"
 
+/// \cond
+// C headers
+// C++ headers
+#include <thread>
+
+// 3rd party headers
 #include <QApplication>
 #include <QLocale>
 #include <QTranslator>
+/// \endcond
 
-#include <thread>
-
+// qtrocket headers
+#include "QtRocket.h"
+#include "gui/MainWindow.h"
 #include "sim/ConstantAtmosphere.h"
 #include "sim/ConstantGravityModel.h"
 

QtRocket.h

@@ -1,17 +1,22 @@
 #ifndef QTROCKET_H
 #define QTROCKET_H
 
+/// \cond
+// C headers
+// C++ headers
+#include <atomic>
 #include <memory>
 #include <mutex>
-#include <atomic>
 
-#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.

gui/AboutWindow.cpp

@@ -1,4 +1,5 @@
 #include "AboutWindow.h"
+
 #include "ui_AboutWindow.h"
 
 AboutWindow::AboutWindow(QWidget *parent) :

gui/AboutWindow.h

@@ -1,7 +1,14 @@
 #ifndef ABOUTWINDOW_H
 #define ABOUTWINDOW_H
 
+/// \cond
+// C headers
+// C++ headers
+// 3rd party headers
 #include <QDialog>
+/// \endcond
+
+// qtrocket headers
 
 namespace Ui {
 class AboutWindow;

gui/AnalysisWindow.h

@@ -1,7 +1,15 @@
 #ifndef ANALYSISWINDOW_H
 #define ANALYSISWINDOW_H
 
+/// \cond
+
+// C
+// C++
+// 3rd party
 #include <QDialog>
+/// \endcond
+
+// qtrocket headers
 
 namespace Ui {
 class AnalysisWindow;

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 <cmath>
+#include <iostream>
+#include <memory>
 
+// 3rd party headers
 #include <QFileDialog>
 
-#include <memory>
-#include <iostream>
-#include <cmath>
+/// \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),

gui/MainWindow.h

@@ -1,8 +1,14 @@
 #ifndef MAINWINDOW_H
 #define MAINWINDOW_H
 
+/// \cond
+// C headers
+// C++ headers
+// 3rd Party headers
 #include <QMainWindow>
+/// \endcond
 
+// qtrocket headers
 #include "QtRocket.h"
 
 

gui/RocketTreeView.h

@@ -1,7 +1,14 @@
 #ifndef ROCKETTREEVIEW_H
 #define ROCKETTREEVIEW_H
 
+/// \cond
+// C headers
+// C++ headers
+// 3rd party headers
 #include <QTreeView>
+/// \endcond
+
+// qtrocket headers
 
 /**
  * @brief RocketTreeView basically just renames QTreeView with a specific

gui/ThrustCurveMotorSelector.cpp

@@ -1,3 +1,5 @@
+
+// qtrocket headers
 #include "ThrustCurveMotorSelector.h"
 #include "ui_ThrustCurveMotorSelector.h"
 

gui/ThrustCurveMotorSelector.h

@@ -1,10 +1,16 @@
 #ifndef THRUSTCURVEMOTORSELECTOR_H
 #define THRUSTCURVEMOTORSELECTOR_H
 
-#include <QDialog>
-
+/// \cond
+// C headers
+// C++ headers
 #include <memory>
 
+// 3rd party headers
+#include <QDialog>
+/// \endcond
+
+// qtrocket headers
 #include "utils/ThrustCurveAPI.h"
 
 namespace Ui {

main.cpp

@@ -1,3 +1,11 @@
+
+/// \cond
+// C headers
+// C++ headers
+// 3rd party headers
+/// \endcond
+
+
 #include "QtRocket.h"
 #include "utils/Logger.h"
 

model/MotorModel.h

@@ -1,13 +1,19 @@
 #ifndef MODEL_MOTORMODEL_H
 #define MODEL_MOTORMODEL_H
 
+/// \cond
+// C headers
+// C++ headers
+#include <string>
+
+// 3rd party headers
 // For boost serialization. We're using boost::serialize to save
 // and load Motor data to file
 #include <boost/archive/text_iarchive.hpp>
 #include <boost/archive/text_oarchive.hpp>
+/// \endcond
 
-#include <string>
-
+// qtrocke theaders
 #include "Thrustcurve.h"
 
 class MotorModel

model/Rocket.h

@@ -1,11 +1,18 @@
 #ifndef ROCKET_H
 #define ROCKET_H
 
-#include "sim/Propagator.h"
-#include "model/Thrustcurve.h"
-
-#include <utility> // std::move
+/// \cond
+// C headers
+// C++ headers
 #include <memory>
+#include <utility> // std::move
+
+// 3rd party headers
+/// \endcond
+
+// qtrocket headers
+#include "model/Thrustcurve.h"
+#include "sim/Propagator.h"
 
 class Rocket
 {

model/Thrustcurve.cpp

@@ -1,6 +1,14 @@
+
+/// \cond
+// C headers
+// C++ headers
+#include <algorithm>
+
+// 3rd party headers
+/// \endcond
+
 #include "Thrustcurve.h"
 
-#include <algorithm>
 
 Thrustcurve::Thrustcurve(std::vector<std::pair<double, double>>& tc)
    : thrustCurve(tc),

model/Thrustcurve.h

@@ -1,11 +1,15 @@
 #ifndef MODEL_THRUSTCURVE_H
 #define MODEL_THRUSTCURVE_H
 
+/// \cond
+// C headers
+// C++ headers
 #include <vector>
-#include <tuple>
 
+// 3rd party headers
 #include <boost/archive/text_iarchive.hpp>
 #include <boost/archive/text_oarchive.hpp>
+/// \endcond
 
 class Thrustcurve
 {

sim/ConstantAtmosphere.h

@@ -1,6 +1,7 @@
 #ifndef SIM_CONSTANTATMOSPHERE_H
 #define SIM_CONSTANTATMOSPHERE_H
 
+// qtrocket headers
 #include "AtmosphericModel.h"
 
 namespace sim {

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 {

sim/DESolver.h

@@ -1,8 +1,14 @@
 #ifndef SIM_DESOLVER_H
 #define SIM_DESOLVER_H
 
+/// \cond
+// C headers
+// C++ headers
 #include <vector>
 
+// 3rd party headers
+/// \endcond
+
 namespace sim
 {
 

sim/GravityModel.h

@@ -1,6 +1,7 @@
 #ifndef SIM_GRAVITYMODEL_H
 #define SIM_GRAVITYMODEL_H
 
+// qtrocket headers
 #include "utils/Triplet.h"
 
 namespace sim

sim/Propagator.cpp

@@ -1,14 +1,23 @@
+
+/// \cond
+// C headers
+// C++ headers
+#include <chrono>
 #include <iostream>
+#include <sstream>
+#include <utility>
+
+// 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 <utility>
-#include <chrono>
-#include <sstream>
 
 namespace sim {
 

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 <memory>
 #include <vector>
 
+// 3rd party headers
+/// \endcond
+
+// qtrocket headers
+#include "sim/DESolver.h"
+
+
 // Forward declare
 class Rocket;
 class QtRocket;

sim/RK4Solver.h

@@ -1,13 +1,21 @@
 #ifndef SIM_RK4SOLVER_H
 #define SIM_RK4SOLVER_H
 
-#include <functional>
-#include <vector>
-#include <limits>
+/// \cond
+// C headers
+// C++ headers
 #include <cmath>
+#include <functional>
+#include <limits>
+#include <vector>
 
-#include "utils/Logger.h"
+// 3rd party headers
+
+/// \endcond
+
+// qtrocket headers
 #include "sim/DESolver.h"
+#include "utils/Logger.h"
 
 namespace sim {
 

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
+} // namespace sim

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
+#endif // SIM_SPHERICALGEOIDMODEL_H

sim/SphericalGravityModel.cpp

@@ -1,8 +1,16 @@
-#include "SphericalGravityModel.h"
 
+/// \cond
+// C headers
+// C++ headers
+#include <cmath>
+
+// 3rd party headers
+/// \endcond
+
+// qtrocket headers
+#include "sim/SphericalGravityModel.h"
 #include "utils/math/Constants.h"
 
-#include <cmath>
 
 namespace sim
 {

sim/SphericalGravityModel.h

@@ -1,6 +1,7 @@
 #ifndef SIM_SPHERICALGRAVITYMODEL_H
 #define SIM_SPHERICALGRAVITYMODEL_H
 
+// qtrocket headers
 #include "GravityModel.h"
 
 namespace sim

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"
 

sim/USStandardAtmosphere.cpp

@@ -1,8 +1,16 @@
-#include "USStandardAtmosphere.h"
 
-#include "utils/math/Constants.h"
+/// \cond
+// C headers
+// C++ headers
 #include <cmath>
 
+// 3rd party headers
+/// \endcond
+
+// qtrocket headers
+#include "sim/USStandardAtmosphere.h"
+#include "utils/math/Constants.h"
+
 using namespace utils::math;
 
 namespace sim

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
+#endif // SIM_USSTANDARDATMOSPHERE_H

sim/WindModel.cpp

@@ -1,3 +1,5 @@
+
+// qtrocket headers
 #include "WindModel.h"
 
 namespace sim

sim/WindModel.h

@@ -1,6 +1,7 @@
 #ifndef SIM_WINDMODEL_H
 #define SIM_WINDMODEL_H
 
+// qtrocket headers
 #include "utils/Triplet.h"
 
 namespace sim

utils/BinMap.cpp

@@ -1,11 +1,17 @@
-#include "BinMap.h"
 
+/// \cond
+// C headers
+// C++ headers
 #include <algorithm>
-
-#include <stdexcept>
 #include <sstream>
+#include <stdexcept>
 
+// 3rd party headers
 #include <fmt/core.h>
+/// \endcond
+
+// qtrocket headers
+#include "BinMap.h"
 
 // TODO: Check on the availability of this in Clang.
 // Replace libfmt with format when LLVM libc++ supports it

utils/BinMap.h

@@ -1,8 +1,14 @@
 #ifndef UTILS_BINMAP_H
 #define UTILS_BINMAP_H
 
-#include <vector>
+/// \cond
+// C headers
+// C++ headers
 #include <utility>
+#include <vector>
+
+// 3rd party headers
+/// \endcond
 
 namespace utils {
 

utils/CurlConnection.cpp

@@ -1,7 +1,16 @@
-#include "CurlConnection.h"
 
+/// \cond
+// C headers
+// C++ headers
 #include <iostream>
 
+// 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)

utils/CurlConnection.h

@@ -1,10 +1,17 @@
 #ifndef UTILS_CURLCONNECTION_H
 #define UTILS_CURLCONNECTION_H
 
-#include <vector>
-#include <string>
+/// \cond
+// C headers
 #include <curl/curl.h>
 
+// C++ headers
+#include <string>
+#include <vector>
+
+// 3rd party headers
+/// \endcond
+
 namespace utils {
 
 class CurlConnection

utils/Logger.cpp

@@ -1,7 +1,15 @@
-#include "Logger.h"
 
+/// \cond
+// C headers
+// C++ headers
 #include <iostream>
 
+// 3rd party headers
+/// \endcond
+
+// qtrocket headers
+#include "Logger.h"
+
 namespace utils
 {
 Logger* Logger::instance = nullptr;

utils/Logger.h

@@ -1,16 +1,22 @@
 #ifndef UTILS_LOGGER_H
 #define UTILS_LOGGER_H
 
+/// \cond
+// C headers
+// C++ headers
 #include <fstream>
 #include <mutex>
 #include <string_view>
 
-/**
- * @todo write docs
- */
+// 3rd party headers
+/// \endcond
+
 namespace utils
 {
 
+/**
+ * @todo write docs
+ */
 class Logger
 {
 public:

utils/RSEDatabaseLoader.cpp

@@ -1,10 +1,16 @@
-#include "RSEDatabaseLoader.h"
-
-#include <boost/property_tree/xml_parser.hpp>
 
+/// \cond
+// C headers
+// C++ headers
 #include <iostream>
 #include <cmath>
 
+// 3rd party headers
+#include <boost/property_tree/xml_parser.hpp>
+/// \endcond
+
+// qtrocket headers
+#include "utils/RSEDatabaseLoader.h"
 #include "QtRocket.h"
 
 namespace utils {

utils/RSEDatabaseLoader.h

@@ -1,12 +1,19 @@
 #ifndef UTILS_RSEDATABASELOADER_H
 #define UTILS_RSEDATABASELOADER_H
 
-#include "model/MotorModel.h"
 
-#include <vector>
+/// \cond
+// C headers
+// C++ headers
 #include <string>
+#include <vector>
 
+// 3rd party headers
 #include <boost/property_tree/ptree.hpp>
+/// \endcond
+
+// qtrocket headers
+#include "model/MotorModel.h"
 
 namespace utils {
 

utils/TSQueue.h

@@ -1,10 +1,16 @@
 #ifndef TSQUEUE_H
 #define TSQUEUE_H
 
-#include <mutex>
-#include <memory>
-#include <queue>
+/// \cond
+// C headers
+// C++ headers
 #include <condition_variable>
+#include <memory>
+#include <mutex>
+#include <queue>
+
+// 3rd party headers
+/// \endcond
 
 /**
  * @brief The TSQueue class is a very basic thread-safe queue

utils/ThreadPool.cpp

@@ -1,6 +1,15 @@
+
+/// \cond
+// C headers
+// C++ headers
+#include <cstdint>
+
+// 3rd party headers
+/// \endcond
+
+// qtrocket headers
 #include "ThreadPool.h"
 
-#include <cstdint>
 
 ThreadPool::ThreadPool()
    : done(false),

utils/ThreadPool.h

@@ -1,12 +1,19 @@
 #ifndef THREADPOOL_H
 #define THREADPOOL_H
 
+/// \cond
+// C headers
+// C++ headers
 #include <atomic>
 #include <functional>
-#include <vector>
 #include <thread>
+#include <vector>
 
-#include "TSQueue.h"
+// 3rd party headers
+/// \endcond
+
+// qtrocket headers
+#include "utils/TSQueue.h"
 
 
 /**

utils/ThrustCurveAPI.cpp

@@ -1,6 +1,13 @@
-#include "ThrustCurveAPI.h"
 
+/// \cond
+// C headers
+// C++ headers
+// 3rd party headers
 #include <json/json.h>
+/// \endcond
+
+// qtrocket headers
+#include "utils/ThrustCurveAPI.h"
 #include "utils/Logger.h"
 
 namespace utils

utils/ThrustCurveAPI.h

@@ -2,10 +2,17 @@
 #define UTILS_THRUSTCURVEAPI_H
 
 
-#include <string>
+/// \cond
+// C headers
+// C++ headers
 #include <map>
+#include <string>
 
-#include "CurlConnection.h"
+// 3rd party headers
+/// \endcond
+
+// qtrocket headers
+#include "utils/CurlConnection.h"
 #include "model/MotorModel.h"
 
 namespace utils

utils/math/Quaternion.cpp

@@ -1,4 +1,6 @@
-#include "Quaternion.h"
+
+// qtrocket headers
+#include "utils/math/Quaternion.h"
 
 namespace math
 {

utils/math/Quaternion.h

@@ -1,9 +1,17 @@
 #ifndef MATH_QUATERNION_H
 #define MATH_QUATERNION_H
 
+/// \cond
+// C headers
+// C++ headers
+#include <utility>
+
+// 3rd party headers
+/// \endcond
+
+// qtrocket headers
 #include "Vector3.h"
 
-#include <utility>
 
 namespace math
 {

utils/math/Vector3.cpp

@@ -1,4 +1,6 @@
-#include "Vector3.h"
+
+// qtrocket headers
+#include "utils/math/Vector3.h"
 
 namespace math
 {