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

Fix doxygen copydoc documentation

Browse Source 
The following issues were fixed
* Fixed wrong/missing namespaces
* Fixed obvious typos in documentation
* Documentation not in sync with source code

refs #544
This commit is contained in:
Roland Winklmeier
2016-02-07 18:40:11 +01:00
parent dfb6798d31
commit 794bf0cd74
154 changed files with 399 additions and 399 deletions
Download Patch File Download Diff File Expand all files Collapse all files

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

@@ -42,7 +42,7 @@ namespace BlackMisc
//! Set to on/off
void setOn(bool on) { m_on = on; }
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
private:

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

@@ -46,10 +46,10 @@ namespace BlackMisc
//! Engine number 1..x on?
bool isEngineOn(int engineNumber) const;
//! \copydoc CValueObject::toJson
//! \copydoc BlackMisc::Mixin::JsonByTuple::toJson
QJsonObject toJson() const;
//! \copydoc CValueObject::convertFromJson
//! \copydoc BlackMisc::Mixin::JsonByTuple::convertFromJson
void convertFromJson(const QJsonObject &json);
};

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

@@ -216,16 +216,16 @@ namespace BlackMisc
//! Matches ICAO, IATA, family?
bool matchesDesignatorIataOrFamily(const QString &icaoIataOrFamily) const;
//! \copydoc CValueObject::propertyByIndex
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
CVariant propertyByIndex(const BlackMisc::CPropertyIndex &index) const;
//! \copydoc CValueObject::setPropertyByIndex
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
void setPropertyByIndex(const CVariant &variant, const BlackMisc::CPropertyIndex &index);
//! Compare for index
int comparePropertyByIndex(const CAircraftIcaoCode &compareValue, const CPropertyIndex &index) const;
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
//! Update missing parts

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

@@ -42,10 +42,10 @@ namespace BlackMisc
//! Constructor
CAircraftLights(bool strobeOn, bool landingOn, bool taxiOn, bool beaconOn, bool navOn, bool logoOn);
//! \copydoc CValueObject::propertyByIndex
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
CVariant propertyByIndex(const BlackMisc::CPropertyIndex &index) const;
//! \copydoc CValueObject::setPropertyByIndex
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
void setPropertyByIndex(const CVariant &variant, const BlackMisc::CPropertyIndex &index);
//! Strobes lights on?
@@ -96,7 +96,7 @@ namespace BlackMisc
//! Returns object with all lights switched off
static CAircraftLights allLightsOff();
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
private:

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

@@ -50,10 +50,10 @@ namespace BlackMisc
m_spoilersOut(spoilersOut), m_isOnGround(onGround)
{}
//! \copydoc CValueObject::propertyByIndex
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
CVariant propertyByIndex(const BlackMisc::CPropertyIndex &index) const;
//! \copydoc CValueObject::setPropertyByIndex
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
void setPropertyByIndex(const CVariant &variant, const BlackMisc::CPropertyIndex &index);
//! Compare for index
@@ -110,7 +110,7 @@ namespace BlackMisc
//! Set aircraft on ground
void setOnGround(bool onGround) { m_isOnGround = onGround; }
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
private:

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

@@ -64,10 +64,10 @@ namespace BlackMisc
const BlackMisc::PhysicalQuantities::CAngle &bank = {},
const BlackMisc::PhysicalQuantities::CSpeed &gs = {});
//! \copydoc CValueObject::propertyByIndex
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
CVariant propertyByIndex(const BlackMisc::CPropertyIndex &index) const;
//! \copydoc CValueObject::setPropertyByIndex
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
void setPropertyByIndex(const CVariant &variant, const BlackMisc::CPropertyIndex &index);
//! Get position
@@ -76,23 +76,23 @@ namespace BlackMisc
//! Set position
void setPosition(const BlackMisc::Geo::CCoordinateGeodetic &position) { this->m_position = position; }
//! \copydoc ICoordinateGeodetic::latitude()
//! \copydoc Geo::ICoordinateGeodetic::latitude()
virtual BlackMisc::Geo::CLatitude latitude() const override { return this->m_position.latitude(); }
//! \copydoc ICoordinateGeodetic::longitude()
//! \copydoc Geo::ICoordinateGeodetic::longitude()
virtual BlackMisc::Geo::CLongitude longitude() const override { return this->m_position.longitude(); }
//! Guess if aircraft is "on ground"
virtual bool isOnGroundGuessed() const;
//! \copydoc ICoordinateGeodetic::geodeticHeight
//! \copydoc Geo::ICoordinateGeodetic::geodeticHeight
//! \remarks this should be used for elevation as depicted here: http://en.wikipedia.org/wiki/Altitude#mediaviewer/File:Vertical_distances.svg
const BlackMisc::PhysicalQuantities::CLength &geodeticHeight() const override { return this->m_position.geodeticHeight(); }
//! \copydoc ICoordinateGeodetic::normalVector
//! \copydoc Geo::ICoordinateGeodetic::normalVector
virtual QVector3D normalVector() const override { return this->m_position.normalVector(); }
//! \copydoc ICoordinateGeodetic::normalVectorDouble
//! \copydoc Geo::ICoordinateGeodetic::normalVectorDouble
virtual std::array<double, 3> normalVectorDouble() const override { return this->m_position.normalVectorDouble(); }
//! Elevation
@@ -143,7 +143,7 @@ namespace BlackMisc
//! Corresponding callsign
void setCallsign(const BlackMisc::Aviation::CCallsign &callsign);
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
private:

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

@@ -150,16 +150,16 @@ namespace BlackMisc
//! Comined string with key
QString getCombinedStringWithKey() const;
//! \copydoc CValueObject::toIcon
//! \copydoc BlackMisc::Mixin::Icon::toIcon
CIcon toIcon() const;
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
//! \copydoc CValueObject::propertyByIndex
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
CVariant propertyByIndex(const BlackMisc::CPropertyIndex &index) const;
//! \copydoc CValueObject::setPropertyByIndex
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
void setPropertyByIndex(const CVariant &variant, const BlackMisc::CPropertyIndex &index);
//! Compare for index

16
src/blackmisc/aviation/airport.h
View File

@@ -77,41 +77,41 @@ namespace BlackMisc
//! \sa setGeodeticHeight
void setElevation(const BlackMisc::PhysicalQuantities::CLength &elevation) { return this->m_position.setGeodeticHeight(elevation); }
//! \copydoc ICoordinateGeodetic::geodeticHeight
//! \copydoc Geo::ICoordinateGeodetic::geodeticHeight
//! \remarks this should be used for elevation as depicted here: http://en.wikipedia.org/wiki/Altitude#mediaviewer/File:Vertical_distances.svg
const BlackMisc::PhysicalQuantities::CLength &geodeticHeight() const override { return this->m_position.geodeticHeight(); }
//! Valid ICAO code
bool hasValidIcaoCode() const { return !this->getIcao().isEmpty(); }
//! \copydoc ICoordinateGeodetic::latitude
//! \copydoc Geo::ICoordinateGeodetic::latitude
virtual BlackMisc::Geo::CLatitude latitude() const override
{
return this->getPosition().latitude();
}
//! \copydoc ICoordinateGeodetic::longitude
//! \copydoc Geo::ICoordinateGeodetic::longitude
virtual BlackMisc::Geo::CLongitude longitude() const override
{
return this->getPosition().longitude();
}
//! \copydoc ICoordinateGeodetic::normalVector
//! \copydoc Geo::ICoordinateGeodetic::normalVector
virtual QVector3D normalVector() const override { return this->getPosition().normalVector(); }
//! \copydoc ICoordinateGeodetic::normalVectorDouble
//! \copydoc Geo::ICoordinateGeodetic::normalVectorDouble
virtual std::array<double, 3> normalVectorDouble() const override { return this->getPosition().normalVectorDouble(); }
//! \copydoc CValueObject::propertyByIndex
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
CVariant propertyByIndex(const BlackMisc::CPropertyIndex &index) const;
//! \copydoc CValueObject::setPropertyByIndex
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
void setPropertyByIndex(const CVariant &variant, const BlackMisc::CPropertyIndex &index);
//! Compare for index
int comparePropertyByIndex(const CAirport &compareValue, const CPropertyIndex &index) const;
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
private:

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

@@ -51,7 +51,7 @@ namespace BlackMisc
//! Valid ICAO designator
static bool isValidIcaoDesignator(const QString &icaoCode);
//! \copydoc CValueObject::convertToQString()
//! \copydoc BlackMisc::Mixin::String::toQString()
QString convertToQString(bool i18n = false) const;
//! Compare for index

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

@@ -57,7 +57,7 @@ namespace BlackMisc
FlightLevel //!< Flight level
};
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
//! Default constructor: 0 Altitude true
@@ -90,13 +90,13 @@ namespace BlackMisc
//! Flightlevel to MSL
void toMeanSeaLevel();
//! \copydoc CValueObject::parseFromString(const QString &value)
//! Parse value from string
void parseFromString(const QString &value);
//! \copydoc CValueObject::parseFromString(const QString &value, BlackMisc::PhysicalQuantities::CPqString::SeparatorMode mode)
//! Parse value from string, with specified separator
void parseFromString(const QString &value, BlackMisc::PhysicalQuantities::CPqString::SeparatorMode mode);
//! \copydoc CValueObject::toIcon
//! \copydoc BlackMisc::Mixin::Icon::toIcon
BlackMisc::CIcon toIcon() const;
private:

18
src/blackmisc/aviation/atcstation.h
View File

@@ -67,7 +67,7 @@ namespace BlackMisc
bool isOnline = false, const QDateTime &bookedFromUtc = QDateTime(), const QDateTime &bookedUntilUtc = QDateTime(),
const CInformationMessage &atis = CInformationMessage(CInformationMessage::ATIS), const CInformationMessage &metar = CInformationMessage(CInformationMessage::METAR));
//! \copydoc CValueObject::toIcon()
//! \copydoc BlackMisc::Mixin::Icon::toIcon()
BlackMisc::CIcon toIcon() const { return this->m_callsign.toIcon(); }
//! Has booking times?
@@ -220,29 +220,29 @@ namespace BlackMisc
//! Set booked until
void setBookedUntilUtc(const QDateTime &until) { this->m_bookedUntilUtc = until; }
//! \copydoc ICoordinateGeodetic::latitude
//! \copydoc Geo::ICoordinateGeodetic::latitude
virtual BlackMisc::Geo::CLatitude latitude() const override;
//! \copydoc ICoordinateGeodetic::longitude
//! \copydoc Geo::ICoordinateGeodetic::longitude
virtual BlackMisc::Geo::CLongitude longitude() const override;
//! \copydoc ICoordinateGeodetic::geodeticHeight
//! \copydoc Geo::ICoordinateGeodetic::geodeticHeight
//! \remarks this should be used for elevation as depicted here: http://en.wikipedia.org/wiki/Altitude#mediaviewer/File:Vertical_distances.svg
const BlackMisc::PhysicalQuantities::CLength &geodeticHeight() const override;
//! \copydoc ICoordinateGeodetic::normalVector
//! \copydoc Geo::ICoordinateGeodetic::normalVector
virtual QVector3D normalVector() const override;
//! \copydoc ICoordinateGeodetic::normalVectorDouble
//! \copydoc Geo::ICoordinateGeodetic::normalVectorDouble
virtual std::array<double, 3> normalVectorDouble() const override;
//! \copydoc CValueObject::propertyByIndex
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
CVariant propertyByIndex(const BlackMisc::CPropertyIndex &index) const;
//! \copydoc CValueObject::setPropertyByIndex
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
void setPropertyByIndex(const CVariant &variant, const CPropertyIndex &index);
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
private:

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

@@ -108,13 +108,13 @@ namespace BlackMisc
//! Equals callsign string?
bool equalsString(const QString &callsignString) const;
//! \copydoc CValueObject::toIcon()
//! \copydoc BlackMisc::Mixin::Icon::toIcon()
BlackMisc::CIcon toIcon() const { return convertToIcon(*this); }
//! \copydoc CValueObject::propertyByIndex
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
CVariant propertyByIndex(const BlackMisc::CPropertyIndex &index) const;
//! \copydoc CValueObject::setPropertyByIndex
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
void setPropertyByIndex(const CVariant &variant, const BlackMisc::CPropertyIndex &index);
//! Compare for index
@@ -147,7 +147,7 @@ namespace BlackMisc
//! Representing icon
static const CIcon &convertToIcon(const CCallsign &callsign);
//! \copydoc CValueObject::convertToQString()
//! \copydoc BlackMisc::Mixin::String::toQString()
QString convertToQString(bool i18n = false) const;
protected:

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

@@ -179,10 +179,10 @@ namespace BlackMisc
//! Get remarks string
const QString &getRemarks() const { return m_remarks; }
//! \copydoc CValueObject::toIcon
//! \copydoc BlackMisc::Mixin::Icon::toIcon
CIcon toIcon() const;
//! \copydoc CValueObject::convertToQString()
//! \copydoc BlackMisc::Mixin::String::toQString()
QString convertToQString(bool i18n = false) const;
private:

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

@@ -52,7 +52,7 @@ namespace BlackMisc
True = 1 //!< true north
};
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
//! \brief Default constructor: 0 heading true

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

@@ -90,7 +90,7 @@ namespace BlackMisc
//! Is empty?
bool isEmpty() const { return this->m_message.isEmpty(); }
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
private:

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

@@ -109,16 +109,16 @@ namespace BlackMisc
//! Matches combined code
bool matchesCombinedCode(const QString &candidate) const;
//! \copydoc CValueObject::propertyByIndex
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
CVariant propertyByIndex(const BlackMisc::CPropertyIndex &index) const;
//! \copydoc CValueObject::setPropertyByIndex
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
void setPropertyByIndex(const CVariant &variant, const BlackMisc::CPropertyIndex &index);
//! Compare for index
int comparePropertyByIndex(const CLivery &compareValue, const CPropertyIndex &index) const;
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
//! Complete data?

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

@@ -79,13 +79,13 @@ namespace BlackMisc
//! Are set values valid?
virtual bool validValues() const { return true; }
//! \copydoc CValueObject::propertyByIndex
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
CVariant propertyByIndex(const BlackMisc::CPropertyIndex &index) const;
//! \copydoc CValueObject::setPropertyByIndex
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
void setPropertyByIndex(const CVariant &variant, const BlackMisc::CPropertyIndex &index);
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
//! Destructor

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

@@ -70,7 +70,7 @@ namespace BlackMisc
//! All valid code pairs: AB, AC, AD ...
static const QStringList &codePairs();
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
private:

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

@@ -81,7 +81,7 @@ namespace BlackMisc
//! \brief Get reference north (magnetic or true)
ReferenceNorth getReferenceNorth() const { return m_north; }
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
private:

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

@@ -154,10 +154,10 @@ namespace BlackMisc
return CTransponder(transponderCode, mode);
}
//! \copydoc CValueObject::propertyByIndex
//! \copydoc BlackMisc::Mixin::Index::propertyByIndex
CVariant propertyByIndex(const BlackMisc::CPropertyIndex &index) const;
//! \copydoc CValueObject::setPropertyByIndex
//! \copydoc BlackMisc::Mixin::Index::setPropertyByIndex
void setPropertyByIndex(const CVariant &variant, const BlackMisc::CPropertyIndex &index);
//! Is valid transponder code?
@@ -166,7 +166,7 @@ namespace BlackMisc
//! Is valid transponder code?
static bool isValidTransponderCode(qint32 transponderMode);
//! \copydoc CValueObject::convertToQString
//! \copydoc BlackMisc::Mixin::String::toQString
QString convertToQString(bool i18n = false) const;
private: