From 93d42917b00e71e1dc21510b3b9c5a8891d5694f Mon Sep 17 00:00:00 2001
From: David Rowe <david@ctrlaltstudio.com>
Date: Wed, 12 Jun 2019 19:15:14 +1200
Subject: [PATCH] Revise JSDoc for new MyAvatar signals

---
 interface/src/avatar/MyAvatar.h | 18 ++++++++++--------
 1 file changed, 10 insertions(+), 8 deletions(-)

diff --git a/interface/src/avatar/MyAvatar.h b/interface/src/avatar/MyAvatar.h
index d60c023caa..14fa0c57e4 100644
--- a/interface/src/avatar/MyAvatar.h
+++ b/interface/src/avatar/MyAvatar.h
@@ -2190,33 +2190,35 @@ signals:
     void audioListenerModeChanged();
 
     /**jsdoc
-     * Notifies when the analogPlusWalkSpeed value is changed.
+     * Triggered when the walk speed set for the "AnalogPlus" control scheme changes.
      * @function MyAvatar.analogPlusWalkSpeedChanged
-     * @param {float} value - the new avatar walk speed
+     * @param {number} speed - The new walk speed set for the "AnalogPlus" control scheme.
      * @returns {Signal} 
      */
     void analogPlusWalkSpeedChanged(float value);
 
     /**jsdoc
-     * Notifies when the analogPlusSprintSpeed value is changed.
+     * Triggered when the sprint (run) speed set for the "AnalogPlus" control scheme changes.
      * @function MyAvatar.analogPlusSprintSpeedChanged
-     * @param {float} value - the new avatar sprint speed
+     * @param {number} speed - The new sprint speed set for the "AnalogPlus" control scheme.
      * @returns {Signal} 
      */
     void analogPlusSprintSpeedChanged(float value);
 
     /**jsdoc
-     * Notifies when the sprintSpeed value is changed.
+     * Triggered when the sprint (run) speed set for the current control scheme (see 
+     * {@link MyAvatar.getControlScheme|getControlScheme}) changes.
      * @function MyAvatar.sprintSpeedChanged
-     * @param {float} value - the new avatar sprint speed
+     * @param {number} speed -The new sprint speed set for the current control scheme.
      * @returns {Signal} 
      */
     void sprintSpeedChanged(float value);
 
     /**jsdoc
-     * Notifies when the walkBackwardSpeed value is changed.
+     * Triggered when the walk backward speed set for the current control scheme (see 
+     * {@link MyAvatar.getControlScheme|getControlScheme}) changes.
      * @function MyAvatar.walkBackwardSpeedChanged
-     * @param {float} value - the new avatar walk backward speed
+     * @param {number} speed - The new walk backward speed set for the current control scheme.
      * @returns {Signal} 
      */
     void walkBackwardSpeedChanged(float value);