Update api ref with regenerated text from tool

mavlink · Feb 8, 2018 · 50e8569 · 50e8569
1 parent 42cd96a
commit 50e8569
Show file tree

Hide file tree

Showing 8 changed files with 17 additions and 15 deletions.
diff --git a/en/api_reference/classdronecore_1_1_action.md b/en/api_reference/classdronecore_1_1_action.md
@@ -26,7 +26,7 @@ std::function< void([Result](classdronecore_1_1_action.md#classdronecore_1_1_act
 
 Type | Name | Description
 ---: | --- | ---
-| [Action](#classdronecore_1_1_action_1a9fd3af84d59048b3c787ed0c5644ed07) (Device *device) | Constructor. Creates the plugin and associates it with a specified [Device](classdronecore_1_1_device.md).
+| [Action](#classdronecore_1_1_action_1a9fd3af84d59048b3c787ed0c5644ed07) (Device *device) | Constructor. Creates the plugin for a specific [Device](classdronecore_1_1_device.md).
 | [~Action](#classdronecore_1_1_action_1a6bb0301fecf66d75ca3b27bda25af7f2) () | Destructor (internal use only).
 | [Action](#classdronecore_1_1_action_1ae48b0e06ca2b4b7544a10c7734a03f63) (const Action &)=delete | Copy constructor (object is not copyable).
 [Result](classdronecore_1_1_action.md#classdronecore_1_1_action_1ad92c9d2e08f60f54b17ea0d861339011) | [arm](#classdronecore_1_1_action_1a8b8631ea15655f0c922a9ba7d2e1c72c) () const | Send command to *arm* the drone (synchronous).
@@ -67,6 +67,7 @@ const char * | [result_str](#classdronecore_1_1_action_1a1fefb474ee36cb15fe31b42
 dronecore::Action::Action(Device *device)
 ```
 
+
 Constructor. Creates the plugin for a specific [Device](classdronecore_1_1_device.md).
 
 The plugin is typically created as shown below: 
@@ -75,7 +76,6 @@ The plugin is typically created as shown below:
 auto action = std::make_shared<Action>(&device);
 ```
 
-
 **Parameters**
 
 * [Device](classdronecore_1_1_device.md) * **device** - The specific device associated with this plugin.

diff --git a/en/api_reference/classdronecore_1_1_follow_me.md b/en/api_reference/classdronecore_1_1_follow_me.md
@@ -33,7 +33,7 @@ enum [Result](#classdronecore_1_1_follow_me_1aee7e30070ac95bc63b68c10bd7253b02)
 
 Type | Name | Description
 ---: | --- | ---
-| [FollowMe](#classdronecore_1_1_follow_me_1a2d3cbcee491efa09392e6333ae77926c) (Device *device) | Constructor. Creates the plugin and associates it with a specified [Device](classdronecore_1_1_device.md).
+| [FollowMe](#classdronecore_1_1_follow_me_1a2d3cbcee491efa09392e6333ae77926c) (Device *device) | Constructor. Creates the plugin for a specific [Device](classdronecore_1_1_device.md).
 | [~FollowMe](#classdronecore_1_1_follow_me_1a66ffe3c9652bc08a2766f211592316ac) () | Destructor (internal use only).
 | [FollowMe](#classdronecore_1_1_follow_me_1a54589c314eeba131aca1c4c56d4b15e3) (const FollowMe &)=delete | Copy constructor (object is not copyable).
 const [Config](structdronecore_1_1_follow_me_1_1_config.md) & | [get_config](#classdronecore_1_1_follow_me_1a054aebafe0839a1028f277285b769fe5) () const | Gets current [FollowMe](classdronecore_1_1_follow_me.md) configuration.
@@ -61,6 +61,7 @@ std::string | [result_str](#classdronecore_1_1_follow_me_1a50d848b1c7b00e40343b8
 dronecore::FollowMe::FollowMe(Device *device)
 ```
 
+
 Constructor. Creates the plugin for a specific [Device](classdronecore_1_1_device.md).
 
 The plugin is typically created as shown below: 
@@ -69,7 +70,6 @@ The plugin is typically created as shown below:
 auto follow_me = std::make_shared<FollowMe>(&device);
 ```
 
-
 **Parameters**
 
 * [Device](classdronecore_1_1_device.md) * **device** - The specific device associated with this plugin.

diff --git a/en/api_reference/classdronecore_1_1_gimbal.md b/en/api_reference/classdronecore_1_1_gimbal.md
@@ -23,7 +23,7 @@ std::function< void([Result](classdronecore_1_1_gimbal.md#classdronecore_1_1_gim
 
 Type | Name | Description
 ---: | --- | ---
-| [Gimbal](#classdronecore_1_1_gimbal_1a2a5ad56ba40eaacc0261f82ed49407e6) (Device *device) | Constructor. Creates the plugin and associates it with a specified [Device](classdronecore_1_1_device.md).
+| [Gimbal](#classdronecore_1_1_gimbal_1a2a5ad56ba40eaacc0261f82ed49407e6) (Device *device) | Constructor. Creates the plugin for a specific [Device](classdronecore_1_1_device.md).
 | [~Gimbal](#classdronecore_1_1_gimbal_1a4f8b2a6cf5a7347a474f8e47618ad838) () | Destructor (internal use only).
 | [Gimbal](#classdronecore_1_1_gimbal_1a82637c62da14ae39db96724d4273cad4) (const Gimbal &)=delete | Copy constructor (object is not copyable).
 [Result](classdronecore_1_1_gimbal.md#classdronecore_1_1_gimbal_1a2404686489b502fbc58e940701ba1e6f) | [set_pitch_and_yaw](#classdronecore_1_1_gimbal_1ac8ac49d29f11b2107da6b043bb57b54e) (float pitch_deg, float yaw_deg) | Set gimbal pitch and yaw angles (synchronous).
@@ -46,6 +46,7 @@ const char * | [result_str](#classdronecore_1_1_gimbal_1ad60c5378cc7d160be67432f
 dronecore::Gimbal::Gimbal(Device *device)
 ```
 
+
 Constructor. Creates the plugin for a specific [Device](classdronecore_1_1_device.md).
 
 The plugin is typically created as shown below: 
@@ -54,7 +55,6 @@ The plugin is typically created as shown below:
 auto gimbal = std::make_shared<Gimbal>(&device);
 ```
 
-
 **Parameters**
 
 * [Device](classdronecore_1_1_device.md) * **device** - The specific device associated with this plugin.

diff --git a/en/api_reference/classdronecore_1_1_info.md b/en/api_reference/classdronecore_1_1_info.md
@@ -19,7 +19,7 @@ struct [Version](structdronecore_1_1_info_1_1_version.md)
 
 Type | Name | Description
 ---: | --- | ---
-| [Info](#classdronecore_1_1_info_1a10ea70679e1b2d7e43bc9944fbe18aaf) (Device *device) | Constructor. Creates the plugin and associates it with a specified [Device](classdronecore_1_1_device.md).
+| [Info](#classdronecore_1_1_info_1a10ea70679e1b2d7e43bc9944fbe18aaf) (Device *device) | Constructor. Creates the plugin for a specific [Device](classdronecore_1_1_device.md).
 | [~Info](#classdronecore_1_1_info_1a39e608070500b5fca0b4415cdb13f75f) () | Destructor (internal use only).
 | [Info](#classdronecore_1_1_info_1af0902805d75577d1195363eda21d7bb1) (const Info &)=delete | Copy Constructor (object is not copyable).
 uint64_t | [uuid](#classdronecore_1_1_info_1a49c7dd5f1a369c8296f0c3a2443bc031) () const | Gets the UUID of the device.
@@ -42,6 +42,7 @@ static const unsigned [GIT_HASH_STR_LEN](#classdronecore_1_1_info_1aae671143f80e
 dronecore::Info::Info(Device *device)
 ```
 
+
 Constructor. Creates the plugin for a specific [Device](classdronecore_1_1_device.md).
 
 The plugin is typically created as shown below: 
@@ -50,7 +51,6 @@ The plugin is typically created as shown below:
 auto info = std::make_shared<Info>(&device);
 ```
 
-
 **Parameters**
 
 * [Device](classdronecore_1_1_device.md) * **device** - The specific device associated with this plugin.

diff --git a/en/api_reference/classdronecore_1_1_logging.md b/en/api_reference/classdronecore_1_1_logging.md
@@ -23,7 +23,7 @@ std::function< void([Result](classdronecore_1_1_logging.md#classdronecore_1_1_lo
 
 Type | Name | Description
 ---: | --- | ---
-| [Logging](#classdronecore_1_1_logging_1a191a5eaa0d4c23b634585a276a20ba97) (Device *device) | Constructor. Creates the plugin and associates it with a specified [Device](classdronecore_1_1_device.md).
+| [Logging](#classdronecore_1_1_logging_1a191a5eaa0d4c23b634585a276a20ba97) (Device *device) | Constructor. Creates the plugin for a specific [Device](classdronecore_1_1_device.md).
 | [~Logging](#classdronecore_1_1_logging_1a49e75d77f900ba5ef59a960ae9b8dc55) () | Destructor (internal use only).
 | [Logging](#classdronecore_1_1_logging_1a62a17eb90e3ec9253f1b40e94d3c1fd7) (const Logging &)=delete | Copy constructor (object is not copyable).
 [Result](classdronecore_1_1_logging.md#classdronecore_1_1_logging_1ab11e242369717d9510de1ab93bfad086) | [start_logging](#classdronecore_1_1_logging_1a4684d8226742b575fce423c9ce758fc0) () const | Start logging (synchronous).
@@ -48,15 +48,15 @@ const char * | [result_str](#classdronecore_1_1_logging_1adc5a7560f1a27996fc05f2
 dronecore::Logging::Logging(Device *device)
 ```
 
+
 Constructor. Creates the plugin for a specific [Device](classdronecore_1_1_device.md).
 
 The plugin is typically created as shown below: 
 
 ```cpp
-auto logger = std::make_shared<Logging>(&device);
+auto logging = std::make_shared<Logging>(&device);
 ```
 
-
 **Parameters**
 
 * [Device](classdronecore_1_1_device.md) * **device** - The specific device associated with this plugin.

diff --git a/en/api_reference/classdronecore_1_1_mission.md b/en/api_reference/classdronecore_1_1_mission.md
@@ -22,7 +22,7 @@ std::function< void(int current, int total)> [progress_callback_t](#classdroneco
 
 Type | Name | Description
 ---: | --- | ---
-| [Mission](#classdronecore_1_1_mission_1a3835376b0fbf186ad572dbfad3bcc4e9) (Device *device) | Constructor. Creates the plugin and associates it with a specified [Device](classdronecore_1_1_device.md).
+| [Mission](#classdronecore_1_1_mission_1a3835376b0fbf186ad572dbfad3bcc4e9) (Device *device) | Constructor. Creates the plugin for a specific [Device](classdronecore_1_1_device.md).
 | [~Mission](#classdronecore_1_1_mission_1a395b8c121630aa8a5dd3d48f95290659) () | Destructor (internal use only).
 | [Mission](#classdronecore_1_1_mission_1a4947f79b7dd71e66bca64e5bbb0b3377) (const Mission &)=delete | Copy constructor (object is not copyable).
 void | [upload_mission_async](#classdronecore_1_1_mission_1a414b5b6d0c66af695a725e92003872b5) (const std::vector< std::shared_ptr< MissionItem >> &mission_items, result_callback_t callback) | Uploads a vector of mission items to the device (asynchronous).
@@ -52,6 +52,7 @@ const char * | [result_str](#classdronecore_1_1_mission_1a0eabb2fe4db664c552d281
 dronecore::Mission::Mission(Device *device)
 ```
 
+
 Constructor. Creates the plugin for a specific [Device](classdronecore_1_1_device.md).
 
 The plugin is typically created as shown below: 
@@ -60,7 +61,6 @@ The plugin is typically created as shown below:
 auto mission = std::make_shared<Mission>(&device);
 ```
 
-
 **Parameters**
 
 * [Device](classdronecore_1_1_device.md) * **device** - The specific device associated with this plugin.

diff --git a/en/api_reference/classdronecore_1_1_offboard.md b/en/api_reference/classdronecore_1_1_offboard.md
@@ -36,7 +36,7 @@ std::function< void([Result](classdronecore_1_1_offboard.md#classdronecore_1_1_o
 
 Type | Name | Description
 ---: | --- | ---
-| [Offboard](#classdronecore_1_1_offboard_1a333ac94793dc29ed95158fb2af286fa1) (Device *device) | Constructor. Creates the plugin and associates it with a specified [Device](classdronecore_1_1_device.md).
+| [Offboard](#classdronecore_1_1_offboard_1a333ac94793dc29ed95158fb2af286fa1) (Device *device) | Constructor. Creates the plugin for a specific [Device](classdronecore_1_1_device.md).
 | [~Offboard](#classdronecore_1_1_offboard_1a7cb4eff36c37fed1c6d973aa41b059b8) () | Destructor (internal use only).
 | [Offboard](#classdronecore_1_1_offboard_1ac586be55cb24aa0ccd29c97352dd2ee5) (const Offboard &)=delete | Copy constructor (object is not copyable).
 [Offboard::Result](classdronecore_1_1_offboard.md#classdronecore_1_1_offboard_1a0f6e5e9f73289f27dc99abbb3ab572ed) | [start](#classdronecore_1_1_offboard_1a658454f130f7b19d56f23347a448f1b9) () | Start offboard control (synchronous).
@@ -64,6 +64,7 @@ const char * | [result_str](#classdronecore_1_1_offboard_1a8eb7467e48fe354d34bc4
 dronecore::Offboard::Offboard(Device *device)
 ```
 
+
 Constructor. Creates the plugin for a specific [Device](classdronecore_1_1_device.md).
 
 The plugin is typically created as shown below: 

diff --git a/en/api_reference/classdronecore_1_1_telemetry.md b/en/api_reference/classdronecore_1_1_telemetry.md
@@ -52,7 +52,7 @@ std::function< void([RCStatus](structdronecore_1_1_telemetry_1_1_r_c_status.md)
 
 Type | Name | Description
 ---: | --- | ---
-| [Telemetry](#classdronecore_1_1_telemetry_1ad0cb6dd62c12af390870f8b5cb5bde55) (Device *device) | Constructor. Creates the plugin and associates it with a specified [Device](classdronecore_1_1_device.md).
+| [Telemetry](#classdronecore_1_1_telemetry_1ad0cb6dd62c12af390870f8b5cb5bde55) (Device *device) | Constructor. Creates the plugin for a specific [Device](classdronecore_1_1_device.md).
 | [~Telemetry](#classdronecore_1_1_telemetry_1ade5f44873d1fd5a5ec63037307920095) () | Destructor (internal use only).
 | [Telemetry](#classdronecore_1_1_telemetry_1a91a3319d9040bd89d241be3d8b2e9a5e) (const Telemetry &)=delete | Copy constructor (object is not copyable).
 [Result](classdronecore_1_1_telemetry.md#classdronecore_1_1_telemetry_1a5bfab85edb7c160e156133a9643964bc) | [set_rate_position](#classdronecore_1_1_telemetry_1ae7a6e1313b1508fef7163287aa77a6da) (double rate_hz) | Set rate of position updates (synchronous).
@@ -122,6 +122,7 @@ const char * | [result_str](#classdronecore_1_1_telemetry_1a05c6355b7f8743250b2a
 dronecore::Telemetry::Telemetry(Device *device)
 ```
 
+
 Constructor. Creates the plugin for a specific [Device](classdronecore_1_1_device.md).
 
 The plugin is typically created as shown below: