core: comment about serial connection support

mavlink · Apr 26, 2018 · 84e91ab · 84e91ab
1 parent ce84880
commit 84e91ab
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/core/dronecore.h b/core/dronecore.h
@@ -54,6 +54,8 @@ class DroneCore
      * Default URL : udp://:14540.
      * - Default Bind host IP is localhost(127.0.0.1)
      *
+     * @warning Serial connections are not supported on Windows (they are supported on Linux and macOS).
+     *
      * @param connection_url connection URL string.
      * @return The result of adding the connection.
      */
@@ -80,6 +82,9 @@ class DroneCore
     /**
      * @brief Adds a serial connection with a specific port (COM or UART dev node) and baudrate as specified.
      *
+     *
+     * @warning This method is not supported on Windows (it is supported on Linux and macOS).
+     *
      * @param dev_path COM or UART dev node name/path (defaults to "/dev/ttyS0").
      * @param baudrate Baudrate of the serial port (defaults to 57600).
      * @return The result of adding the connection.