diff --git a/interface/src/avatar/MyAvatar.h b/interface/src/avatar/MyAvatar.h
index cc12e4fcee..d8353796b6 100644
--- a/interface/src/avatar/MyAvatar.h
+++ b/interface/src/avatar/MyAvatar.h
@@ -436,38 +436,72 @@ class MyAvatar : public Avatar {
const bool DEFAULT_STRAFE_ENABLED = true;
public:
+ /**jsdoc
+ * The DriveKeys
API provides constant numeric values that represent different logical keys that drive your
+ * avatar and camera.
+ *
+ * @namespace DriveKeys
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-avatar
+ *
+ * @property {number} TRANSLATE_X - Move the user's avatar in the direction of its x-axis, if the camera isn't in
+ * independent or mirror modes.
+ * @property {number} TRANSLATE_Y - Move the user's avatar in the direction of its y-axis, if the camera isn't in
+ * independent or mirror modes.
+ * @property {number} TRANSLATE_Z - Move the user's avatar in the direction of its z-axis, if the camera isn't in
+ * independent or mirror modes.
+ * @property {number} YAW - Rotate the user's avatar about its y-axis at a rate proportional to the control value, if the
+ * camera isn't in independent or mirror modes.
+ * @property {number} STEP_TRANSLATE_X - No action.
+ * @property {number} STEP_TRANSLATE_Y - No action.
+ * @property {number} STEP_TRANSLATE_Z - No action.
+ * @property {number} STEP_YAW - Rotate the user's avatar about its y-axis in a step increment, if the camera isn't in
+ * independent or mirror modes.
+ * @property {number} PITCH - Rotate the user's avatar head and attached camera about its negative x-axis (i.e., positive
+ * values pitch down) at a rate proportional to the control value, if the camera isn't in HMD, independent, or mirror
+ * modes.
+ * @property {number} ZOOM - Zoom the camera in or out.
+ * @property {number} DELTA_YAW - Rotate the user's avatar about its y-axis by an amount proportional to the control value,
+ * if the camera isn't in independent or mirror modes.
+ * @property {number} DELTA_PITCH - Rotate the user's avatar head and attached camera about its negative x-axis (i.e.,
+ * positive values pitch down) by an amount proportional to the control value, if the camera isn't in HMD, independent,
+ * or mirror modes.
+ */
+
/**jsdoc
*
Logical keys that drive your avatar and camera.
*Value | Name | Description |
---|---|---|
Value | Description | |
0 | TRANSLATE_X | Move the user's avatar in the direction of its x-axis, if the - * camera isn't in independent or mirror modes. |
1 | TRANSLATE_Y | Move the user's avatar in the direction of its y-axis, if the - * camera isn't in independent or mirror modes. |
2 | TRANSLATE_Z | Move the user's avatar in the direction of its z-axis, if the - * camera isn't in independent or mirror modes |
3 | YAW | Rotate the user's avatar about its y-axis at a rate proportional to the - * control value, if the camera isn't in independent or mirror modes. |
4 | STEP_TRANSLATE_X | No action. |
5 | STEP_TRANSLATE_Y | No action. |
6 | STEP_TRANSLATE_Z | No action. |
7 | STEP_YAW | Rotate the user's avatar about its y-axis in a step increment, if - * the camera isn't in independent or mirror modes. |
8 | PITCH | Rotate the user's avatar head and attached camera about its negative - * x-axis (i.e., positive values pitch down) at a rate proportional to the control value, if the camera isn't in HMD, - * independent, or mirror modes. |
9 | ZOOM | Zoom the camera in or out. |
10 | DELTA_YAW | Rotate the user's avatar about its y-axis by an amount proportional - * to the control value, if the camera isn't in independent or mirror modes. |
11 | DELTA_PITCH | Rotate the user's avatar head and attached camera about its - * negative x-axis (i.e., positive values pitch down) by an amount proportional to the control value, if the camera - * isn't in HMD, independent, or mirror modes. |
{@link DriveKeys|DriveKeys.TRANSLATE_X} | Move the user's avatar in the direction of its + * x-axis, if the camera isn't in independent or mirror modes. | |
{@link DriveKeys|DriveKeys.TRANSLATE_Y} | Move the user's avatar in the direction of its + * -axis, if the camera isn't in independent or mirror modes. | |
{@link DriveKeys|DriveKeys.TRANSLATE_Z} | Move the user's avatar in the direction of its + * z-axis, if the camera isn't in independent or mirror modes. | |
{@link DriveKeys|DriveKeys.YAW} | Rotate the user's avatar about its y-axis at a rate + * proportional to the control value, if the camera isn't in independent or mirror modes. | |
{@link DriveKeys|DriveKeys.STEP_TRANSLATE_X} | No action. | |
{@link DriveKeys|DriveKeys.STEP_TRANSLATE_Y} | No action. | |
{@link DriveKeys|DriveKeys.STEP_TRANSLATE_Z} | No action. | |
{@link DriveKeys|DriveKeys.STEP_YAW} | Rotate the user's avatar about its y-axis in a + * step increment, if the camera isn't in independent or mirror modes. | |
{@link DriveKeys|DriveKeys.PITCH} | Rotate the user's avatar head and attached camera + * about its negative x-axis (i.e., positive values pitch down) at a rate proportional to the control value, if the + * camera isn't in HMD, independent, or mirror modes. | |
{@link DriveKeys|DriveKeys.ZOOM} | Zoom the camera in or out. | |
{@link DriveKeys|DriveKeys.DELTA_YAW} | Rotate the user's avatar about its y-axis by an + * amount proportional to the control value, if the camera isn't in independent or mirror modes. | |
{@link DriveKeys|DriveKeys.DELTA_PITCH} | Rotate the user's avatar head and attached + * camera about its negative x-axis (i.e., positive values pitch down) by an amount proportional to the control + * value, if the camera isn't in HMD, independent, or mirror modes. |
true
if the drive key is disabled, false
if it isn't.
*/
Q_INVOKABLE bool isDriveKeyDisabled(DriveKeys key) const;
diff --git a/libraries/pointers/src/Pick.h b/libraries/pointers/src/Pick.h
index e4257140fd..9e6c5f9898 100644
--- a/libraries/pointers/src/Pick.h
+++ b/libraries/pointers/src/Pick.h
@@ -93,7 +93,7 @@ public:
* collisions.
*/
- /**jsdoc
+ /**jsdoc
* A type of pick.
*