documentation, const correctness

Author: kebekus

src/Librarian.cpp

@@ -392,9 +392,9 @@ bool Librarian::contains(const Navigation::Aircraft& acft)
 }
 
 
-bool Librarian::contains(QObject* obj)
+bool Librarian::contains(const QObject* obj)
 {
-    auto* route = qobject_cast<Navigation::FlightRoute*>(obj);
+    auto* route = qobject_cast<const Navigation::FlightRoute*>(obj);
     if (route == nullptr)
     {
         return false;

src/Librarian.h

@@ -80,16 +80,16 @@ class Librarian : public QObject {
      */
     [[nodiscard]] Q_INVOKABLE static bool contains(const Navigation::Aircraft& acft);
 
-    /*! \brief Check if an object exists in the library
+    /*! \brief Check if a flight route exists in the library
      *
      *  At the moment, only flight routes are supported.
      *
-     *  @param object Pointer to an object
+     *  @param route Pointer to the route
      *
      *  @returns True if the object is of type Navigation::FlightRoute and
      *  exists in the library.
      */
-    [[nodiscard]] Q_INVOKABLE static bool contains(QObject* route);
+    [[nodiscard]] Q_INVOKABLE static bool contains(const QObject* route);
 
     /*! \brief Name of the directory containing the given
      *

src/navigation/FlightRoute.h

@@ -390,21 +390,11 @@ namespace Navigation
          */
         [[nodiscard]] Q_INVOKABLE QString toVfrFlightPlan() const;
 
-        /*! \brief Exports to route to VFR Flight Plan Format.
+        /*! \brief Check for equality
          *
-         * This method serialises the current flight route as a simplified VFR flight plan
-         * route string following standard aviation format:
+         * @param other Flight route to compare with
          *
-         * Format: [departure] DCT [waypoint1] DCT [waypoint2] DCT ... DCT [destination]
-         * Example: EDPC DCT EDDM DCT 4620N07805W DCT EDML DCT EDTF
-         *
-         * Waypoint formatting rules:
-         * - Airfields (type "AD"): Use ICAO codes (e.g., EDPC, EDDM, EDTF)
-         * - Navigation Aids (type "NAV"): Use ICAO codes (e.g., VOR, NDB, DME)
-         * - Reporting Points (type "WP"): Use coordinate format "4620N07805W" (degrees and minutes)
-         * - User Waypoints (type "WP"): Use coordinate format "4620N07805W" (degrees and minutes)
-         *
-         * @returns QString containing the VFR flight plan route string
+         * @returns True on equality
          */
         [[nodiscard]] Q_INVOKABLE bool operator==(const Navigation::FlightRoute& other) const
         {

src/platform/FileExchange_Abstract.h

@@ -142,7 +142,7 @@ public slots:
      *
      * @param path File name
      *
-     * @param unmigledFilename Unmingled filename
+     * @param unmingledFilename Unmingled filename
      */
     virtual void processFileOpenRequest(const QString& path, const QString& unmingledFilename);