Skip to content

Commit

Permalink
mission: capitalize, add period.
Browse files Browse the repository at this point in the history
  • Loading branch information
julianoes committed Nov 8, 2017
1 parent f4b847d commit af5007d
Showing 1 changed file with 11 additions and 11 deletions.
22 changes: 11 additions & 11 deletions plugins/mission/mission.h
Expand Up @@ -56,8 +56,8 @@ class Mission
* The mission items are uploaded to a drone. Once uploaded the mission can be started and
* executed even if a connection is lost.
*
* @param mission_items reference to vector of mission items.
* @param callback callback to receive result of this request
* @param mission_items Reference to vector of mission items.
* @param callback Callback to receive result of this request.
*/
void upload_mission_async(const std::vector<std::shared_ptr<MissionItem>> &mission_items,
result_callback_t callback);
Expand All @@ -73,8 +73,8 @@ class Mission
*
* The mission items are downloaded from a drone.
*
* @param mission_items reference to vector of mission items.
* @param callback callback to receive result of this request
* @param mission_items Reference to vector of mission items.
* @param callback Callback to receive result of this request.
*/
void download_mission_async(mission_items_and_result_callback_t callback);

Expand All @@ -84,7 +84,7 @@ class Mission
* Note that the mission must be uplaoded to the vehicle using `upload_mission_async()` before
* this method is called.
*
* @param callback callback to receive result of this request
* @param callback callback to receive result of this request.
*/
void start_mission_async(result_callback_t callback);

Expand All @@ -96,7 +96,7 @@ class Mission
* A multicopter should just hover at the spot while a fixedwing vehicle should loiter
* around the location where it paused.
*
* @param callback callback to receive result of this request
* @param callback Callback to receive result of this request.
*/
void pause_mission_async(result_callback_t callback);

Expand All @@ -109,8 +109,8 @@ class Mission
* Note that this is not necessarily true for general missions using mavlink if loop counters
* are used.
*
* @param current index for mission index to go to next (0 based)
* @param callback callback to receive result of this request.
* @param current Index for mission index to go to next (0 based).
* @param callback Callback to receive result of this request.
*/
void set_current_mission_item_async(int current, result_callback_t callback);

Expand Down Expand Up @@ -143,15 +143,15 @@ class Mission
*
* The mission is finished if current == total.
*
* @param current current mission item index (0 based)
* @param total total number of mission items
* @param current Current mission item index (0 based).
* @param total Total number of mission items.
*/
typedef std::function<void(int current, int total)> progress_callback_t;

/**
* @brief Subscribes to mission progress (asynchronous).
*
* @param callback callback to receive mission progress
* @param callback Callback to receive mission progress.
*/
void subscribe_progress(progress_callback_t callback);

Expand Down

0 comments on commit af5007d

Please sign in to comment.