Merge pull request #113 from hamishwillee/fix_notes

Fix up apiref to use gitbook notes and warnings

en/api_reference/classdronecore_1_1_action.md

@@ -118,7 +118,7 @@ ActionResult dronecore::Action::arm() const
 
 Send command to *arm* the drone (synchronous).
 
-**Note** Arming a drone normally causes motors to spin at idle. Before arming take all safety precautions and stand clear of the drone!
+> **Note** Arming a drone normally causes motors to spin at idle. Before arming take all safety precautions and stand clear of the drone!
 
 **Returns**
 

en/api_reference/classdronecore_1_1_drone_core.md

@@ -112,16 +112,19 @@ Adds Connection via URL.
 
 Supports connection: Serial, TCP or UDP. Connection URL format should be:
 <ul>
-
 <li><p>UDP - udp://[Bind_host][:Bind_port]</p></li>
 <li><p>TCP - tcp://[Server_host][:Server_port]</p></li>
-<li><p>Serial - serial://[Dev_Node][:Baudrate]</p></li></ul>
+<li><p>Serial - serial://[Dev_Node][:Baudrate]</p></li>
+</ul>
 
 
 Default URL : udp://:14540.
 <ul>
+<li><p>Default Bind host IP is localhost(127.0.0.1)</p></li>
+</ul>
+
 
-<li><p>Default Bind host IP is localhost(127.0.0.1)</p></li></ul>
+> **Warning** Serial connections are not supported on Windows (they are supported on Linux and macOS).
 
 **Parameters**
 
@@ -174,6 +177,7 @@ ConnectionResult dronecore::DroneCore::add_serial_connection(const std::string &
 
 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).
 
 **Parameters**
 
@@ -279,7 +283,7 @@ This sets a callback that will be notified if a new system is discovered.
 If systems have been discovered before this callback is registered, they will be notified at the time this callback is registered.
 
 
-**Note** Only one callback can be registered at a time. If this function is called several times, previous callbacks will be overwritten.
+> **Note** Only one callback can be registered at a time. If this function is called several times, previous callbacks will be overwritten.
 
 **Parameters**
 
@@ -296,7 +300,7 @@ Register callback for system timeout.
 This sets a callback that will be notified if no heartbeat of the system has been received in 3 seconds.
 
 
-**Note** Only one callback can be registered at a time. If this function is called several times, previous callbacks will be overwritten.
+> **Note** Only one callback can be registered at a time. If this function is called several times, previous callbacks will be overwritten.
 
 **Parameters**
 

en/api_reference/classdronecore_1_1_follow_me.md

@@ -186,15 +186,12 @@ Sets location of the moving target.
 An app can obtain the location of the moving target from Location framework of the underlying platform.
 
 
-**Notes:**
-
-
-The following links provide information about location services on different platforms:
+> **Note** The following links provide information about location services on different platforms:
 <ul>
-
 <li><p>Android - <a href="https://developer.android.com/reference/android/location/Location.html">https://developer.android.com/reference/android/location/Location.html</a></p></li>
 <li><p>Apple - <a href="https://developer.apple.com/documentation/corelocation">https://developer.apple.com/documentation/corelocation</a></p></li>
-<li><p>Windows - <a href="https://docs.microsoft.com/en-us/uwp/api/Windows.Devices.Geolocation">https://docs.microsoft.com/en-us/uwp/api/Windows.Devices.Geolocation</a></p></li></ul>
+<li><p>Windows - <a href="https://docs.microsoft.com/en-us/uwp/api/Windows.Devices.Geolocation">https://docs.microsoft.com/en-us/uwp/api/Windows.Devices.Geolocation</a></p></li>
+</ul>
 
 **Parameters**
 

en/api_reference/namespacedronecore.md

@@ -41,6 +41,10 @@ bool | [operator==](#namespacedronecore_1a0363203162fba53fefe7d4d60cd3b1c9) (con
 std::ostream & | [operator<<](#namespacedronecore_1a9bc5f60e2e310023bbd0ed436250b217) (std::ostream & str, [Telemetry::Position](structdronecore_1_1_telemetry_1_1_position.md) const & position) |
 bool | [operator==](#namespacedronecore_1ab044bfb4b8bceac15f4ef1f7959775d8) (const [Telemetry::Health](structdronecore_1_1_telemetry_1_1_health.md) & lhs, const [Telemetry::Health](structdronecore_1_1_telemetry_1_1_health.md) & rhs) |
 std::ostream & | [operator<<](#namespacedronecore_1a33d736c83c404d96c46ff9a7f4750fb1) (std::ostream & str, [Telemetry::Health](structdronecore_1_1_telemetry_1_1_health.md) const & health) |
+bool | [operator==](#namespacedronecore_1a65e8014734a31eaf756b98b672dd6466) (const [Telemetry::GPSInfo](structdronecore_1_1_telemetry_1_1_g_p_s_info.md) & lhs, const [Telemetry::GPSInfo](structdronecore_1_1_telemetry_1_1_g_p_s_info.md) & rhs) |
+std::ostream & | [operator<<](#namespacedronecore_1a80860746c1bda3cc94fb5ab3962cd6f6) (std::ostream & str, [Telemetry::GPSInfo](structdronecore_1_1_telemetry_1_1_g_p_s_info.md) const & gps_info) |
+bool | [operator==](#namespacedronecore_1ae113d4a3da31a7baa40029e3a1833e86) (const [Telemetry::Battery](structdronecore_1_1_telemetry_1_1_battery.md) & lhs, const [Telemetry::Battery](structdronecore_1_1_telemetry_1_1_battery.md) & rhs) |
+std::ostream & | [operator<<](#namespacedronecore_1a5e9f9c205d03cca66694584afb649155) (std::ostream & str, [Telemetry::Battery](structdronecore_1_1_telemetry_1_1_battery.md) const & battery) |
 
 ## Enumeration Type Documentation
 
@@ -54,7 +58,7 @@ std::ostream & | [operator<<](#namespacedronecore_1a33d736c83c404d96c46ff9a7f475
 
 Possible results returned for commanded actions.
 
-**Note**: [DroneCore](classdronecore_1_1_drone_core.md) does not throw exceptions. Instead a result of this type will be returned when you execute actions.
+> **Note** [DroneCore](classdronecore_1_1_drone_core.md) does not throw exceptions. Instead a result of this type will be returned when you execute actions.
 
 Value | Description
 --- | ---
@@ -273,4 +277,80 @@ std::ostream& dronecore::operator<<(std::ostream &str, Telemetry::Health const &
 
 **Returns**
 
+&emsp;std::ostream & - 
+
+### operator==() {#namespacedronecore_1a65e8014734a31eaf756b98b672dd6466}
+
+```
+#include: telemetry.h
+```
+```cpp
+bool dronecore::operator==(const Telemetry::GPSInfo &lhs, const Telemetry::GPSInfo &rhs)
+```
+
+
+**Parameters**
+
+* const [Telemetry::GPSInfo](structdronecore_1_1_telemetry_1_1_g_p_s_info.md)& **lhs** - 
+* const [Telemetry::GPSInfo](structdronecore_1_1_telemetry_1_1_g_p_s_info.md)& **rhs** - 
+
+**Returns**
+
+&emsp;bool - 
+
+### operator<<() {#namespacedronecore_1a80860746c1bda3cc94fb5ab3962cd6f6}
+
+```
+#include: telemetry.h
+```
+```cpp
+std::ostream& dronecore::operator<<(std::ostream &str, Telemetry::GPSInfo const &gps_info)
+```
+
+
+**Parameters**
+
+* std::ostream& **str** - 
+* [Telemetry::GPSInfo](structdronecore_1_1_telemetry_1_1_g_p_s_info.md) const& **gps_info** - 
+
+**Returns**
+
+&emsp;std::ostream & - 
+
+### operator==() {#namespacedronecore_1ae113d4a3da31a7baa40029e3a1833e86}
+
+```
+#include: telemetry.h
+```
+```cpp
+bool dronecore::operator==(const Telemetry::Battery &lhs, const Telemetry::Battery &rhs)
+```
+
+
+**Parameters**
+
+* const [Telemetry::Battery](structdronecore_1_1_telemetry_1_1_battery.md)& **lhs** - 
+* const [Telemetry::Battery](structdronecore_1_1_telemetry_1_1_battery.md)& **rhs** - 
+
+**Returns**
+
+&emsp;bool - 
+
+### operator<<() {#namespacedronecore_1a5e9f9c205d03cca66694584afb649155}
+
+```
+#include: telemetry.h
+```
+```cpp
+std::ostream& dronecore::operator<<(std::ostream &str, Telemetry::Battery const &battery)
+```
+
+
+**Parameters**
+
+* std::ostream& **str** - 
+* [Telemetry::Battery](structdronecore_1_1_telemetry_1_1_battery.md) const& **battery** - 
+
+**Returns**
+
 &emsp;std::ostream & -