Fix a few Doxygen warnings

doc/Doxyfile

@@ -362,7 +362,7 @@ DIAFILE_DIRS           =
 PLANTUML_JAR_PATH      =
 PLANTUML_CFG_FILE      =
 PLANTUML_INCLUDE_PATH  =
-DOT_GRAPH_MAX_NODES    = 100
+DOT_GRAPH_MAX_NODES    = 200
 MAX_DOT_GRAPH_DEPTH    = 0
 DOT_TRANSPARENT        = YES
 DOT_MULTI_TARGETS      = YES

src/FactSystem/Fact.h

@@ -78,8 +78,9 @@ public:
     Q_PROPERTY(bool         writeOnly               READ writeOnly                                          CONSTANT)
     Q_PROPERTY(bool         volatileValue           READ volatileValue                                      CONSTANT)
 
-    /// Convert and validate value
-    ///     @param convertOnly true: validate type conversion only, false: validate against meta data as well
+    /// @brief Convert and validate value
+    /// @param cookedValue: Value to convert and validate
+    /// @param convertOnly true: validate type conversion only, false: validate against meta data as well
     Q_INVOKABLE QString validate(const QString& cookedValue, bool convertOnly);
     /// Convert and clamp value
     Q_INVOKABLE QVariant clamp(const QString& cookedValue);

src/FactSystem/FactMetaData.h

@@ -150,10 +150,10 @@ public:
     void setBuiltInTranslator(void);
 
     /// Converts the specified raw value, validating against meta data
-    ///     @param rawValue Value to convert, can be string
-    ///     @param convertOnly true: convert to correct type only, do not validate against meta data
-    ///     @param typeValue Converted value, correctly typed
-    ///     @param errorString Error string if convert fails, values are cooked values since user visible
+    ///     @param rawValue: Value to convert, can be string
+    ///     @param convertOnly: true: convert to correct type only, do not validate against meta data
+    ///     @param typeValue: Converted value, correctly typed
+    ///     @param errorString: Error string if convert fails, values are cooked values since user visible
     /// @returns false: Convert failed, errorString set
     bool convertAndValidateRaw(const QVariant& rawValue, bool convertOnly, QVariant& typedValue, QString& errorString);
 
@@ -161,8 +161,8 @@ public:
     bool convertAndValidateCooked(const QVariant& cookedValue, bool convertOnly, QVariant& typedValue, QString& errorString);
 
     /// Converts the specified cooked value and clamps it (max/min)
-    ///     @param cookedValue Value to convert, can be string
-    ///     @param typeValue Converted value, correctly typed and clamped
+    ///     @param cookedValue: Value to convert, can be string
+    ///     @param typeValue: Converted value, correctly typed and clamped
     /// @returns false: Convertion failed
     bool clampValue(const QVariant& cookedValue, QVariant& typedValue);
 

src/FactSystem/ParameterManager.h

@@ -66,8 +66,8 @@ public:
     void resetAllToVehicleConfiguration();
 
     /// Returns true if the specifed parameter exists
-    ///     @param componentId Component id or FactSystem::defaultComponentId
-    ///     @param name Parameter name
+    ///     @param componentId: Component id or FactSystem::defaultComponentId
+    ///     @param name: Parameter name
     bool parameterExists(int componentId, const QString& paramName);
 
     /// Returns all parameter names
@@ -75,8 +75,8 @@ public:
 
     /// Returns the specified Parameter. Returns a default empty fact is parameter does not exists. Also will pop
     /// a missing parameter error to user if parameter does not exist.
-    ///     @param componentId Component id or FactSystem::defaultComponentId
-    ///     @param name Parameter name
+    ///     @param componentId: Component id or FactSystem::defaultComponentId
+    ///     @param name: Parameter name
     Fact* getParameter(int componentId, const QString& paramName);
 
     int  getComponentId(const QString& category);

src/Geo/TransverseMercator.cpp

@@ -31,7 +31,7 @@
  * If the preprocessor variable GEOGRAPHICLIB_TRANSVERSEMERCATOR_ORDER is set
  * to an integer between 4 and 8, then this specifies the order of the series
  * used for the forward and reverse transformations.  The default value is 6.
- * (The series accurate to 12th order is given in \ref tmseries.)
+ * (The series accurate to 12th order is given in tmseries.)
  **********************************************************************/
 
 #include <iostream>

src/Joystick/Joystick.h

@@ -189,11 +189,12 @@ signals:
     void circleCorrectionChanged    (bool circleCorrection);
 
     /// Signal containing new joystick information
-    ///     @param roll         Range is -1:1, negative meaning roll left, positive meaning roll right
-    ///     @param pitch        Range i -1:1, negative meaning pitch down, positive meaning pitch up
-    ///     @param yaw          Range is -1:1, negative meaning yaw left, positive meaning yaw right
-    ///     @param throttle     Range is 0:1, 0 meaning no throttle, 1 meaning full throttle
-    ///     @param mode     See Vehicle::JoystickMode_t enum
+    ///     @param roll:            Range is -1:1, negative meaning roll left, positive meaning roll right
+    ///     @param pitch:           Range i -1:1, negative meaning pitch down, positive meaning pitch up
+    ///     @param yaw:             Range is -1:1, negative meaning yaw left, positive meaning yaw right
+    ///     @param throttle:        Range is 0:1, 0 meaning no throttle, 1 meaning full throttle
+    ///     @param buttons:         Button bitmap
+    ///     @param joystickMmode:   Current joystick mode
     void manualControl              (float roll, float pitch, float yaw, float throttle, quint16 buttons, int joystickMmode);
     void manualControlGimbal        (float gimbalPitch, float gimbalYaw);
 

src/MissionManager/GeoFenceController.h

@@ -39,21 +39,21 @@ public:
     Q_PROPERTY(double               paramCircularFence  READ paramCircularFence                             NOTIFY paramCircularFenceChanged)
 
     /// Add a new inclusion polygon to the fence
-    ///     @param topLeft - Top left coordinate or map viewport
-    ///     @param topLeft - Bottom right left coordinate or map viewport
+    ///     @param topLeft: Top left coordinate or map viewport
+    ///     @param bottomRight: Bottom right left coordinate or map viewport
     Q_INVOKABLE void addInclusionPolygon(QGeoCoordinate topLeft, QGeoCoordinate bottomRight);
 
     /// Add a new inclusion circle to the fence
-    ///     @param topLeft - Top left coordinate or map viewport
-    ///     @param topLeft - Bottom right left coordinate or map viewport
+    ///     @param topLeft: Top left coordinate or map viewport
+    ///     @param bottomRight: Bottom right left coordinate or map viewport
     Q_INVOKABLE void addInclusionCircle(QGeoCoordinate topLeft, QGeoCoordinate bottomRight);
 
     /// Deletes the specified polygon from the polygon list
-    ///     @param index Index of poygon to delete
+    ///     @param index: Index of poygon to delete
     Q_INVOKABLE void deletePolygon(int index);
 
     /// Deletes the specified circle from the circle list
-    ///     @param index Index of circle to delete
+    ///     @param index: Index of circle to delete
     Q_INVOKABLE void deleteCircle(int index);
 
     /// Clears the interactive bit from all fence items

src/comm/LinkInterface.h

@@ -86,7 +86,7 @@ public:
     virtual bool isLogReplay(void) { return false; }
 
     /**
-     * @Enable/Disable data rate collection
+     * @Brief Enable/Disable data rate collection
      **/
     void enableDataRate(bool enable)
     {
@@ -146,8 +146,8 @@ public slots:
      * communication arbitrary byte lengths can be written. The method ensures
      * thread safety regardless of the underlying LinkInterface implementation.
      *
-     * @param bytes The pointer to the byte array containing the data
-     * @param length The length of the data array
+     * @param bytes:  The pointer to the byte array containing the data
+     * @param length: The length of the data array
      **/
     void writeBytesSafe(const char *bytes, int length)
     {
@@ -176,7 +176,8 @@ signals:
      * affect performance, for control links it is however desirable to directly
      * forward the link data.
      *
-     * @param data the new bytes
+     * @param link: Link where the data is coming from
+     * @param data: The data received
      */
     void bytesReceived(LinkInterface* link, QByteArray data);
 
@@ -186,7 +187,8 @@ signals:
      * The new data is contained in the QByteArray data.
      * The data is logged into telemetry logging system
      *
-     * @param data the new bytes
+     * @param link: Link used
+     * @param data: The data sent
      */
     void bytesSent(LinkInterface* link, QByteArray data);
 

src/comm/MAVLinkProtocol.h

@@ -34,8 +34,7 @@ Q_DECLARE_LOGGING_CATEGORY(MAVLinkProtocolLog)
  * @brief MAVLink micro air vehicle protocol reference implementation.
  *
  * MAVLink is a generic communication protocol for micro air vehicles.
- * for more information, please see the official website.
- * @ref https://mavlink.io
+ * for more information, please see the official website: https://mavlink.io
  **/
 class MAVLinkProtocol : public QGCTool
 {