Updated api docs

lib/anytone_extension.hh

@@ -119,6 +119,7 @@ public:
   /** Holds the APRS PTT mode. That his, if and when the APRS information is send via the
    * associated APRS system. */
   APRSPTT aprsPTT() const;
+  /** Sets the APRS PTT mode. */
   void setAPRSPTT(APRSPTT mode);
 
 protected:

lib/c7000device.cc

@@ -96,7 +96,7 @@ C7000Device::Packet::payloadSize() const {
 
 QByteArray
 C7000Device::Packet::payload() const {
-  return _encoded.mid(8,payloadSize());
+  return _encoded.mid(8, payloadSize());
 }
 
 const QByteArray &

lib/c7000device.hh

@@ -32,11 +32,17 @@ public:
     /** Returns @c true, if the packet is valid. */
     bool isValid() const;
 
+    /** Returns the flags field. */
     uint8_t flags() const;
+    /** Returns the command field. */
     uint8_t command() const;
+    /** Returns the sub-command field. */
     uint8_t subcommand() const;
+    /** Returns the payload size. */
     uint16_t payloadSize() const;
+    /** Returns the payload field. */
     QByteArray payload() const;
+    /** Returns the encoded packet. */
     const QByteArray &encoded() const;
 
   protected:

lib/configmergevisitor.hh

@@ -44,6 +44,7 @@ public:
   /** Constructor of the merge visitor.
    * @param destination Specifies the destination configuration, the additional configurations are
    *        merged into.
+   * @param translation Specifies the translation table to fill of objects being replaced.
    * @param itemStrategy Specifies the item merge strategy.
    * @param setStrategy Specifies the set merge strategy. */
   ConfigMergeVisitor(Config *destination, QHash<ConfigObject *, ConfigObject *> &translation,

lib/d878uv_codeplug.hh

@@ -1176,8 +1176,7 @@ public:
   };
 
 
-  /** Implements some storage to hold the names for the FM APRS frequencies.
-   * @verbinclude d878uv_fm_aprs_frequency_names.txt */
+  /** Implements some storage to hold the names for the FM APRS frequencies. */
   class FMAPRSFrequencyNamesElement: public Element
   {
   protected:

lib/dmr6x2uv_codeplug.hh

@@ -916,8 +916,9 @@ public:
     bool fromChannelObj(const Channel *c, Context &ctx);
 
 public:
+    /** Some limits of this element. */
     struct Limit {
-      // Maximum number of scan list indices.
+      /// Maximum number of scan list indices.
       static constexpr unsigned int scanListIndices() { return 8; }
     };
 

lib/encryptionextension.hh

@@ -139,6 +139,7 @@ public:
 
   int add(ConfigObject *obj, int row=-1, bool unique=true);
 
+  /** Returns the key the given index. */
   EncryptionKey *key(int index) const;
 
   ConfigItem *allocateChild(const YAML::Node &node, ConfigItem::Context &ctx, const ErrorStack &err=ErrorStack());

lib/gd73_codeplug.hh

@@ -183,9 +183,12 @@ public:
     /** Possible programmable key function. */
     struct KeyFunction {
     public:
+      /** Encodes the given function. */
       static uint8_t encode(RadioddityButtonSettingsExtension::Function func);
+      /** Decodes the given function code. */
       static RadioddityButtonSettingsExtension::Function decode(uint8_t code);
     protected:
+      /** Possible function codes. */
       enum Code {
         None=0, RadioEnable=1, RadioCheck=2, RadioDisable=3, PowerLevel=4,
         Monitor=5, EmergencyOn=6, EmergencyOff=7, ZoneSwitch=8, ToggleScan=9, ToggleVOX=10,
@@ -1275,7 +1278,9 @@ public:
     /** Sets the key size in bits. */
     void setKeySize(unsigned int size);
 
+    /** Decodes the encryption key. */
     BasicEncryptionKey *createEncryptionKey(const ErrorStack &err=ErrorStack()) const;
+    /** Encodes the encryption key. */
     bool encodeEncryptionKey(BasicEncryptionKey *key, const ErrorStack &err=ErrorStack());
 
   protected:

lib/opengd77_callsigndb.hh

@@ -28,14 +28,12 @@ public:
   bool encode(UserDatabase *calldb, const Selection &selection=Selection(),
               const ErrorStack &err=ErrorStack());
 
-public:
-  struct Limit: public OpenGD77BaseCallsignDB::Limit {
-
-  };
-
 protected:
+  /** Some internal offsets within the callsign db. */
   struct Offset {
+    /// @cond DO_NOT_DOCUMENT
     static constexpr unsigned int callsignDB() { return 0x30000; }
+    /// @endcond
   };
 };
 

lib/opengd77_interface.hh

@@ -161,6 +161,7 @@ public:
   /** The Flash memory bank. */
   static const uint32_t FLASH  = 1;
 
+  /** Specifies the detected model variant. */
   enum class Variant {
     GD77, UV380
   };

lib/opengd77base_codeplug.hh

@@ -10,7 +10,8 @@
 
 #include <QGeoCoordinate>
 
-
+/** Base codeplug for all OpenGD77 based firmware variants.
+ * @ingroup ogd77 */
 class OpenGD77BaseCodeplug : public Codeplug
 {
   Q_OBJECT
@@ -31,8 +32,7 @@ public:
   static SelectiveCall decodeSelectiveCall(uint16_t code);
 
 public:
-  /** Implements the base for all OpenGD77 channel encodings.
-   */
+  /** Implements the base for all OpenGD77 channel encodings. */
   class ChannelElement: public Codeplug::Element
   {
   public:
@@ -265,6 +265,7 @@ public:
       static constexpr Bit skipZoneScan() { return {0x0033, 5}; }
       static constexpr Bit vox() { return {0x0033, 6}; }
       static constexpr unsigned int squelch() { return 0x0037; }
+      /// @endcond
     };
   };
 
@@ -459,10 +460,12 @@ public:
   class APRSSettingsElement: public Element
   {
   public:
+    /** Possible APRS baud rates. */
     enum class BaudRate {
       Baud300 = 1, Baud1200 = 0
     };
 
+    /** Possible position precisions. */
     enum class PositionPrecision {
       Max = 0,
       Mask1_8sec = 1,
@@ -563,14 +566,17 @@ public:
   public:
     /** Some limits. */
     struct Limit: public Element::Limit {
+      /** The maximum name length in chars. */
       static constexpr unsigned int nameLength() { return 8; }
+      /** The maximum comment length in chars. */
       static constexpr unsigned int commentLength() { return 23; }
     };
 
   protected:
-    /// @cond DO_NOT_DOCUMENT
+    /** Some internal offsets within the element. */
     struct Offset: public Element::Offset
     {
+      /// @cond DO_NOT_DOCUMENT
       static constexpr unsigned int name() { return 0x0000; }
       static constexpr unsigned int sourceSSID() { return 0x0008; }
       static constexpr unsigned int latitude() { return 0x0009; }
@@ -585,8 +591,8 @@ public:
       static constexpr Bit positionPrecision() { return { 0x003d, 4}; }
       static constexpr Bit useFixedPosition() { return { 0x003d, 1}; }
       static constexpr Bit baudRate() { return { 0x003d, 0}; }
+      /// @endcond
     };
-    /// @endcond
   };
 
 
@@ -908,6 +914,7 @@ public:
   };
 
 
+  /** Encodes an orbital element of OpenGD77 devices. */
   class OrbitalElement: public Element
   {
   protected:
@@ -1067,8 +1074,11 @@ public:
   class ContactElement: public Element
   {
   public:
+    /** Possible modes of time slot override. */
     enum class TimeSlotOverride {
-      None, TS1, TS2
+      None, ///< Do not override time slot.
+      TS1,  ///< Override with time slot 1.
+      TS2   ///< Override with time slot 2.
     };
 
   protected:
@@ -1293,9 +1303,11 @@ public:
   };
 
 
-public:
+protected:
+  /** Default hidden constructor. */
   explicit OpenGD77BaseCodeplug(QObject *parent = nullptr);
 
+public:
   /** Clears and resets the complete codeplug to some default values. */
   virtual void clear();
 

lib/openuv380_callsigndb.hh

@@ -28,14 +28,12 @@ public:
   bool encode(UserDatabase *calldb, const Selection &selection=Selection(),
               const ErrorStack &err=ErrorStack());
 
-public:
-  struct Limit: public OpenGD77BaseCallsignDB::Limit {
-
-  };
-
 protected:
+  /** Some internal offsets within the callsign db. */
   struct Offset {
+    /// @cond DO_NOT_DOCUMENT
     static constexpr unsigned int callsignDB() { return 0x00050000; }
+    /// @endcond
   };
 };
 

lib/orbitalelementsdatabase.hh

@@ -1,20 +1,34 @@
+/** @defgroup sat Satellite tracking settings.
+ * @ingroup conf */
+
 #ifndef ORBITALELEMENTSDATABASE_HH
 #define ORBITALELEMENTSDATABASE_HH
 
 #include <QAbstractTableModel>
 #include <QNetworkAccessManager>
 
 
+/** Defines a single orbital element, enabling the tracking of a single satellite. This dataset
+ * does not contain any transponder information.
+ * @ingroup sat */
 class OrbitalElement
 {
 public:
+  /** Represents a Julien day epoch since a specified year. */
   struct Epoch {
+    /** The year of the epoch. */
     unsigned int year;
+    /** The month. */
     unsigned int month;
+    /** The day. */
     unsigned int day;
+    /** The hour. */
     unsigned int hour;
+    /** The minute. */
     unsigned int minute;
+    /** The second. */
     unsigned int second;
+    /** The microsecond. */
     unsigned int microsecond;
 
     /** Default constructor. */
@@ -27,8 +41,11 @@ public:
     /** Copy assignment. */
     Epoch &operator =(const Epoch &other) = default;
 
+    /** Parses a date-time string into the epoch. */
     static Epoch parse(const QString &datetime);
+    /** Computes the decimal epoch as the day of year a  */
     double toEpoch() const;
+    /** Encodes the Epoch as YYYY-MM-DDThh:mm:ss.uuuuuu. */
     QString toString() const;
   };
 
@@ -69,41 +86,68 @@ public:
   unsigned int revolutionNumber() const;
 
 public:
+  /** Constructs a orbital element from a CelesTrak JSON object. */
   static OrbitalElement fromCelesTrak(const QJsonObject &obj);
 
 protected:
+  /** NORAD id of the satellite. */
   unsigned int _id;
+  /** Desriptive name of the satellite. */
   QString _name;
+  /** The epoch. */
   Epoch _epoch;
+  /** Mean motion. */
   double _meanMotion;
+  /** First derivative of the mean motion. */
   double _meanMotionDerivative;
+  /** Inclination. */
   double _inclination;
+  /** Right ascension of the ascending node. */
   double _ascension;
+  /** Eccentricity. */
   double _eccentricity;
+  /** Argument of perigee. */
   double _perigee;
+  /** Mean anomaly. */
   double _meanAnomaly;
+  /** The revolution number. */
   unsigned int _revolutionNumber;
 };
 
 
 
+/** Downloads and updates a database of orbital elements from CelesTrak.
+ * @ingroup sat */
 class OrbitalElementsDatabase: public QAbstractTableModel
 {
   Q_OBJECT
 
 public:
+  /** Constructs a orbital element database.
+   * @param autoLoad [in] If @c true, the database gets downloaded and loaded automatically.
+   * @param updatePeriodDays [in] Specifies the max age of the local database cache in days.
+   * @param parent [in] Specifies the QObject parent. */
   explicit OrbitalElementsDatabase(bool autoLoad, unsigned int updatePeriodDays=7, QObject *parent=nullptr);
 
+  /** @c returns @c true if the database contains a satellite with the given NORAD id. */
   bool contains(unsigned int id) const;
+  /** Retunrs the orbital elements for the satellite with the given NORAD id. */
   OrbitalElement getById(unsigned int id) const;
+  /** Returns the i-th orbital element. */
   const OrbitalElement &getAt(unsigned int idx) const;
+  /** Returns the i-th orbital element. */
   OrbitalElement &getAt(unsigned int idx);
 
+  /** Returns the current age of the cache. */
   unsigned int dbAge() const;
+  /** If needed, downloads the database and loads all received orbital elements. */
   void load();
 
+  /** Returns the number of elements in the database. */
   int rowCount(const QModelIndex &parent = QModelIndex()) const;
+  /** Returns the number of columns of the database table. */
   int columnCount(const QModelIndex &parent = QModelIndex()) const;
+  /** Returns a single cell of the database table. */
   QVariant data(const QModelIndex &index, int role) const;
 
 signals:
@@ -121,6 +165,7 @@ private slots:
   void downloadFinished(QNetworkReply *reply);
 
 protected:
+  /** Loads a database from the given filename. */
   bool load(const QString &filename);
 
 private:

lib/radioddity_codeplug.hh

@@ -263,6 +263,7 @@ public:
       static constexpr Bit talkaround() { return {0x0033, 3}; }
       static constexpr Bit vox() { return {0x0033, 6}; }
       static constexpr Bit power() { return {0x0033, 7}; }
+      /// @endcond
     };
   };
 

lib/radioddity_extensions.hh

@@ -38,6 +38,7 @@ public:
   Q_ENUM(Function)
 
 public:
+  /** Default constructor. */
   explicit RadioddityButtonSettingsExtension(QObject *parent=nullptr);
 
   ConfigItem *clone() const;

lib/satellitedatabase.cc

@@ -25,7 +25,7 @@ Satellite::Satellite()
 }
 
 Satellite::Satellite(const OrbitalElement &orbit)
-  : OrbitalElement(orbit), _name(orbit.name()),
+  : OrbitalElement(orbit), _name(),
     _fmUplink(), _fmDownlink(), _fmUplinkTone(), _fmDownlinkTone(),
     _aprsUplink(), _aprsDownlink(), _aprsUplinkTone(), _aprsDownlinkTone(), _beacon()
 {
@@ -43,6 +43,7 @@ Satellite::setName(const QString &name) {
   _name = name.simplified();
 }
 
+
 const Frequency &
 Satellite::fmUplink() const {
   return _fmUplink;