From 9ed80948f8b4802c55195ba7b9e0dd7c50161047 Mon Sep 17 00:00:00 2001 From: Mat Sutcliffe Date: Sun, 3 Dec 2023 18:34:43 +0000 Subject: [PATCH] Fix doxygen warnings --- docs/Doxyfile | 7 ------- src/blackmisc/aviation/comnavequipment.h | 4 ++-- src/blackmisc/aviation/ssrequipment.h | 4 ++-- src/blackmisc/aviation/waketurbulencecategory.h | 11 ++++++----- src/blackmisc/pq/measurementunit.h | 10 ++++++++-- src/blackmisc/pq/physicalquantity.h | 2 +- 6 files changed, 19 insertions(+), 19 deletions(-) diff --git a/docs/Doxyfile b/docs/Doxyfile index d185ba9c0..f2d1a1b5a 100644 --- a/docs/Doxyfile +++ b/docs/Doxyfile @@ -1112,13 +1112,6 @@ CLANG_DATABASE_PATH = ALPHABETICAL_INDEX = YES -# The COLS_IN_ALPHA_INDEX tag can be used to specify the number of columns in -# which the alphabetical index list will be split. -# Minimum value: 1, maximum value: 20, default value: 5. -# This tag requires that the tag ALPHABETICAL_INDEX is set to YES. - -COLS_IN_ALPHA_INDEX = 5 - # In case all classes in a project start with a common prefix, all classes will # be put under the same header in the alphabetical index. The IGNORE_PREFIX tag # can be used to specify a prefix (or a list of prefixes) that should be ignored diff --git a/src/blackmisc/aviation/comnavequipment.h b/src/blackmisc/aviation/comnavequipment.h index a1b3924b6..6659fd9de 100644 --- a/src/blackmisc/aviation/comnavequipment.h +++ b/src/blackmisc/aviation/comnavequipment.h @@ -66,8 +66,8 @@ namespace BlackMisc::Aviation Other = (1 << 23) }; - Q_DECLARE_FLAGS(ComNavEquipment, ComNavEquipmentOption); - Q_DECLARE_FLAGS(CpdlcSatcomEquipment, CpdlcSatcomEquipmentOption); + Q_DECLARE_FLAGS(ComNavEquipment, ComNavEquipmentOption) + Q_DECLARE_FLAGS(CpdlcSatcomEquipment, CpdlcSatcomEquipmentOption) //! Create default equipment with Standard COM/NAV CComNavEquipment() = default; diff --git a/src/blackmisc/aviation/ssrequipment.h b/src/blackmisc/aviation/ssrequipment.h index 608aac12c..32f6779fc 100644 --- a/src/blackmisc/aviation/ssrequipment.h +++ b/src/blackmisc/aviation/ssrequipment.h @@ -15,6 +15,7 @@ namespace BlackMisc::Aviation class BLACKMISC_EXPORT CSsrEquipment : public BlackMisc::CValueObject { public: + //! Surveillance equipment options enum SsrEquipmentOption : int { None = (1 << 0), @@ -36,8 +37,7 @@ namespace BlackMisc::Aviation AdsCD1 = (1 << 16), AdsCG1 = (1 << 17) }; - - Q_DECLARE_FLAGS(SSrEquipment, SsrEquipmentOption); + Q_DECLARE_FLAGS(SSrEquipment, SsrEquipmentOption) //! Create default SSR equipment with "None" equipment enabled CSsrEquipment() = default; diff --git a/src/blackmisc/aviation/waketurbulencecategory.h b/src/blackmisc/aviation/waketurbulencecategory.h index 0535995e0..bec49bdeb 100644 --- a/src/blackmisc/aviation/waketurbulencecategory.h +++ b/src/blackmisc/aviation/waketurbulencecategory.h @@ -14,17 +14,18 @@ BLACK_DECLARE_VALUEOBJECT_MIXINS(BlackMisc::Aviation, CWakeTurbulenceCategory) namespace BlackMisc::Aviation { + //! ICAO wake turbulence category class BLACKMISC_EXPORT CWakeTurbulenceCategory : public CValueObject { public: //! ICAO wake turbulence categories enum WakeTurbulenceCategory { - UNKNOWN, // required when converting from FAA equipment codes and for some database entries where the correct WTC is not available - LIGHT, - MEDIUM, - HEAVY, - SUPER + UNKNOWN, //!< required when converting from FAA equipment codes and for some database entries where the correct WTC is not available + LIGHT, //!< light + MEDIUM, //!< medium + HEAVY, //!< heavy + SUPER //!< super heavy }; //! Create default object with unknown wake turbulence category diff --git a/src/blackmisc/pq/measurementunit.h b/src/blackmisc/pq/measurementunit.h index af6f53780..6cb441d60 100644 --- a/src/blackmisc/pq/measurementunit.h +++ b/src/blackmisc/pq/measurementunit.h @@ -139,54 +139,60 @@ namespace BlackMisc::PhysicalQuantities } }; - //! @{ //! Metapolicy that can be used to modify template parameters of converters struct One { static double factor() { return 1; } //!< factor }; + //! \copydoc BlackMisc::PhysicalQuantities::CMeasurementUnit::One template struct Two { static double factor() { return Policy::factor() * 2.0; } //!< factor }; + //! \copydoc BlackMisc::PhysicalQuantities::CMeasurementUnit::One template struct Milli { static double factor() { return Policy::factor() / 1000.0; } //!< factor }; + //! \copydoc BlackMisc::PhysicalQuantities::CMeasurementUnit::One template struct Centi { static double factor() { return Policy::factor() / 100.0; } //!< factor }; + //! \copydoc BlackMisc::PhysicalQuantities::CMeasurementUnit::One template struct Hecto { static double factor() { return Policy::factor() * 100.0; } //!< factor }; + //! \copydoc BlackMisc::PhysicalQuantities::CMeasurementUnit::One template struct Kilo { static double factor() { return Policy::factor() * 1000.0; } //!< factor }; + //! \copydoc BlackMisc::PhysicalQuantities::CMeasurementUnit::One template struct Mega { static double factor() { return Policy::factor() * 1e+6; } //!< factor }; + //! \copydoc BlackMisc::PhysicalQuantities::CMeasurementUnit::One template struct Giga { static double factor() { return Policy::factor() * 1e+9; } //!< factor }; + //! \copydoc BlackMisc::PhysicalQuantities::CMeasurementUnit::One template struct InEachHundred { static double fraction() { return 100.0; } //!< fraction static double subfactor() { return float(Subfactor); } //!< subfactor }; - //! @} protected: //! Pimpl class diff --git a/src/blackmisc/pq/physicalquantity.h b/src/blackmisc/pq/physicalquantity.h index 8f548b85d..a784565e5 100644 --- a/src/blackmisc/pq/physicalquantity.h +++ b/src/blackmisc/pq/physicalquantity.h @@ -108,7 +108,7 @@ namespace BlackMisc::PhysicalQuantities public Mixin::String, public Mixin::Icon> { - //! \copydoc CValueObject::compare + //! \copydoc BlackMisc::CValueObject::compare friend int compare(const PQ &a, const PQ &b) { return compareImpl(a, b); } public: