plugins: fix result_str comments

mavlink · Nov 20, 2017 · 21654a4 · 21654a4
1 parent 3816812
commit 21654a4
Show file tree

Hide file tree

Showing 5 changed files with 8 additions and 4 deletions.
diff --git a/plugins/action/action.h b/plugins/action/action.h
@@ -53,10 +53,10 @@ class Action
     /**
      * @brief Returns a human-readable English string for an Action::Result.
      *
-     * @param Result The enum value for which a human readable string is required.
+     * @param result The enum value for which a human readable string is required.
      * @return Human readable string for the Action::Result.
      */
-    static const char *result_str(Result);
+    static const char *result_str(Result result);
 
     /**
      * @brief Send command to *arm* the drone (synchronous).

diff --git a/plugins/gimbal/gimbal.h b/plugins/gimbal/gimbal.h
@@ -39,7 +39,7 @@ class Gimbal
     /**
      * @brief Returns a human-readable English string for Gimbal::Result.
      *
-     * @param Result The enum value for which a human readable string is required.
+     * @param result The enum value for which a human readable string is required.
      * @return Human readable string for the Gimbal::Result.
      */
     static const char *result_str(Result result);

diff --git a/plugins/logging/logging.h b/plugins/logging/logging.h
@@ -41,7 +41,7 @@ class Logging
      * @brief Returns human-readable English string for Logging::Result.
      *
      * @param result Enum for which string is required.
-     * @return result Human-readable string.
+     * @return result Human-readable string for Logging::Result.
      */
     static const char *result_str(Result result);
 

diff --git a/plugins/mission/mission.h b/plugins/mission/mission.h
@@ -42,6 +42,9 @@ class Mission
 
     /**
      * @brief Gets a human-readable English string for an Mission::Result.
+     *
+     * @param result Enum for which string is required.
+     * @return Human readable string for the Mission::Result.
      */
     static const char *result_str(Result result);
 

diff --git a/plugins/telemetry/telemetry.h b/plugins/telemetry/telemetry.h
@@ -155,6 +155,7 @@ class Telemetry
      * @brief Get human-readable English string for Telemetry::Result.
      *
      * @param result The enum value for which string is needed.
+     * @return Human readable string for the Telemetry::Result.
      */
     static const char *result_str(Result result);