flightsimulatorplatfrom/pilotclient
1
0
Fork 0
mirror of https://github.com/swift-project/pilotclient.git synced 2026-04-17 10:55:32 +08:00
Code Issues Packages Projects Releases Wiki Activity

Fix doxygen warnings

Browse Source 
Fixes #188
This commit is contained in:
Mat Sutcliffe
2023-02-05 16:32:51 +00:00
committed by Lars Toenning
parent 5e5b3f830d
commit 7691e42a5b
175 changed files with 570 additions and 664 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
src/blackmisc/aviation/aircraftsituation.h
View File

@@ -322,8 +322,8 @@ namespace BlackMisc
//! \sa CAircraftSituation::presetGroundElevation
bool interpolateElevation(const Aviation::CAircraftSituation &oldSituation, const Aviation::CAircraftSituation &newSituation);
//! Is on ground by elevation data, requires elevation and CG
//! @{
//! Is on ground by elevation data, requires elevation and CG
IsOnGround isOnGroundByElevation() const;
IsOnGround isOnGroundByElevation(const PhysicalQuantities::CLength &cg) const;
//! @}
@@ -368,15 +368,15 @@ namespace BlackMisc
//! Get altitude unit
PhysicalQuantities::CLengthUnit getAltitudeOrDefaultUnit() const;
//! @{
//! Get altitude under consideration of ground elevation and ground flag
//! \remark with dragToGround it will also compensate overflows, otherwise only underflow
//! @{
CAltitude getCorrectedAltitude(bool enableDragToGround = true, AltitudeCorrection *correction = nullptr) const;
CAltitude getCorrectedAltitude(const PhysicalQuantities::CLength &centerOfGravity, bool enableDragToGround = true, AltitudeCorrection *correction = nullptr) const;
//! @}
//! Set the corrected altitude from CAircraftSituation::getCorrectedAltitude
//! @{
//! Set the corrected altitude from CAircraftSituation::getCorrectedAltitude
AltitudeCorrection correctAltitude(bool enableDragToGround = true);
AltitudeCorrection correctAltitude(const PhysicalQuantities::CLength &centerOfGravity = PhysicalQuantities::CLength::null(), bool enableDragToGround = true);
//! @}
@@ -521,7 +521,7 @@ namespace BlackMisc
//! A default CG if not other value is available
static const PhysicalQuantities::CLength &defaultCG();
//! Ground flag comparisons
//! \name Ground flag comparisons
//! @{
//! Both on ground

6
src/blackmisc/aviation/aircraftvelocity.h
View File

@@ -45,14 +45,14 @@ namespace BlackMisc::Aviation
CAircraftVelocity(double x, double y, double z, PhysicalQuantities::CSpeedUnit xyzUnit,
double pitch, double roll, double heading, PhysicalQuantities::CAngleUnit pbhAngleUnit, PhysicalQuantities::CTimeUnit pbhTimeUnit);
//! Setter
//! @{
//! Setter
void setLinearVelocity(double x, double y, double z, PhysicalQuantities::CSpeedUnit xyzUnit);
void setAngularVelocity(double pitch, double roll, double heading, PhysicalQuantities::CAngleUnit pbhAngleUnit, PhysicalQuantities::CTimeUnit pbhTimeUnit);
//! @}
//! Getter
//! @{
//! Getter
double getVelocityX(PhysicalQuantities::CSpeedUnit unit) const;
double getVelocityY(PhysicalQuantities::CSpeedUnit unit) const;
double getVelocityZ(PhysicalQuantities::CSpeedUnit unit) const;
@@ -73,8 +73,8 @@ namespace BlackMisc::Aviation
//! \copydoc Mixin::Index::comparePropertyByIndex
int comparePropertyByIndex(CPropertyIndexRef index, const CAircraftVelocity &compareValue) const;
//! Unit constants
//! @{
//! Unit constants
static const PhysicalQuantities::CSpeedUnit c_xyzSpeedUnit;
static const PhysicalQuantities::CLengthUnit c_xyzLengthUnit;
static const PhysicalQuantities::CAngleUnit c_pbhAngleUnit; // TODO Create a dedicated PQ class for angular velocity

2
src/blackmisc/aviation/altitude.h
View File

@@ -206,8 +206,8 @@ namespace BlackMisc::Aviation
//! \remark https://en.wikipedia.org/wiki/Flight_level
CAltitude roundedToNearest100ft(bool roundDown) const;
//! Search the corresponding feet <-> metric / metric <-> feet
//! @{
//! Search the corresponding feet <-> metric / metric <-> feet
static int findMetricAltitude(int feet);
static int findAltitudeForMetricAltitude(int metric);
//! @}

2
src/blackmisc/aviation/callsign.h
View File

@@ -127,8 +127,8 @@ namespace BlackMisc
//! Get the callsign suffix ("TWR", "ATIS" ...) if any ("_" is removed)
QString getSuffix() const;
//! Airline suffix (e.g. DLH1234 -> DLH) if applicable
//! @{
//! Airline suffix (e.g. DLH1234 -> DLH) if applicable
QString getAirlinePrefix() const;
QString getAirlinePrefix(QString &flightNumber) const;
QString getAirlinePrefix(QString &flightNumber, QString &flightIdentification) const;

4
src/blackmisc/aviation/flightplan.h
View File

@@ -414,14 +414,14 @@ namespace BlackMisc::Aviation
//! All rules as string
static const QStringList &flightRules();
//! Is rule a VFR rule?
//! @{
//! Is rule a VFR rule?
static bool isVFRRules(FlightRules rule);
static bool isVFRRules(const QString &rule);
//! @}
//! Is rule a IFR rule?
//! @{
//! Is rule a IFR rule?
static bool isIFRRules(FlightRules rule);
static bool isIFRRules(const QString &rule);
//! @}