From 8e69e0b0491150a85fc77698ff9bb171436975b4 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Thu, 25 Apr 2019 20:55:30 +1200 Subject: [PATCH] Regularize deprecation notices --- .../src/avatars/ScriptableAvatar.h | 4 +- .../src/octree/OctreeHeadlessViewer.h | 3 +- interface/src/avatar/AvatarManager.cpp | 3 +- interface/src/avatar/MyAvatar.h | 28 +-- .../scripting/ControllerScriptingInterface.h | 4 +- libraries/animation/src/IKTarget.h | 5 +- libraries/avatars/src/AvatarData.h | 18 +- libraries/avatars/src/ScriptAvatarData.h | 7 +- .../controllers/src/controllers/Actions.cpp | 197 ++++++++++-------- .../src/controllers/ScriptingInterface.h | 4 +- .../entities/src/EntityScriptingInterface.h | 4 +- libraries/shared/src/RegisteredMetaTypes.h | 2 - .../ui/src/ui/TabletScriptingInterface.h | 3 - 13 files changed, 154 insertions(+), 128 deletions(-) diff --git a/assignment-client/src/avatars/ScriptableAvatar.h b/assignment-client/src/avatars/ScriptableAvatar.h index e5df411099..54e9fa2fba 100644 --- a/assignment-client/src/avatars/ScriptableAvatar.h +++ b/assignment-client/src/avatars/ScriptableAvatar.h @@ -62,8 +62,8 @@ * @property {boolean} lookAtSnappingEnabled=true - true if the avatar's eyes snap to look at another avatar's * eyes when the other avatar is in the line of sight and also has lookAtSnappingEnabled == true. * @property {string} skeletonModelURL - The avatar's FST file. - * @property {AttachmentData[]} attachmentData - Information on the avatar's attachments.
- * Deprecated: Use avatar entities instead. + * @property {AttachmentData[]} attachmentData - Information on the avatar's attachments. + *

Deprecated: This property is deprecated and will be removed. Use avatar entities instead.

* @property {string[]} jointNames - The list of joints in the current avatar model. Read-only. * @property {Uuid} sessionUUID - Unique ID of the avatar in the domain. Read-only. * @property {Mat4} sensorToWorldMatrix - The scale, rotation, and translation transform from the user's real world to the diff --git a/assignment-client/src/octree/OctreeHeadlessViewer.h b/assignment-client/src/octree/OctreeHeadlessViewer.h index a2a49dceb8..67a81b1d2a 100644 --- a/assignment-client/src/octree/OctreeHeadlessViewer.h +++ b/assignment-client/src/octree/OctreeHeadlessViewer.h @@ -56,7 +56,8 @@ public slots: /**jsdoc * @function EntityViewer.setKeyholeRadius * @param {number} radius - * @deprecated Use {@link EntityViewer.setCenterRadius|setCenterRadius} instead. + * @deprecated This function is deprecated and will be removed. Use {@link EntityViewer.setCenterRadius|setCenterRadius} + * instead. */ void setKeyholeRadius(float radius) { _hasViewFrustum = true; _viewFrustum.setCenterRadius(radius); } // TODO: remove this legacy support diff --git a/interface/src/avatar/AvatarManager.cpp b/interface/src/avatar/AvatarManager.cpp index ba1309d5b8..9246c328e3 100755 --- a/interface/src/avatar/AvatarManager.cpp +++ b/interface/src/avatar/AvatarManager.cpp @@ -942,7 +942,8 @@ void AvatarManager::setAvatarSortCoefficient(const QString& name, const QScriptV * It is unique among all avatars present in the domain at the time. * @property {number} audioLoudness - The instantaneous loudness of the audio input that the avatar is injecting into the * domain. - * @property {boolean} isReplicated - Deprecated. + * @property {boolean} isReplicated - Deprecated: This property is deprecated and will be + * removed. * @property {Vec3} position - The position of the avatar. * @property {number} palOrbOffset - The vertical offset from the avatar's position that an overlay orb should be displayed at. */ diff --git a/interface/src/avatar/MyAvatar.h b/interface/src/avatar/MyAvatar.h index 4cf13e54dc..ef38318b0f 100755 --- a/interface/src/avatar/MyAvatar.h +++ b/interface/src/avatar/MyAvatar.h @@ -116,8 +116,8 @@ class MyAvatar : public Avatar { * @property {boolean} lookAtSnappingEnabled=true - true if the avatar's eyes snap to look at another avatar's * eyes when the other avatar is in the line of sight and also has lookAtSnappingEnabled == true. * @property {string} skeletonModelURL - The avatar's FST file. - * @property {AttachmentData[]} attachmentData - Information on the avatar's attachments.
- * Deprecated: Use avatar entities instead. + * @property {AttachmentData[]} attachmentData - Information on the avatar's attachments. + *

Deprecated: This property is deprecated and will be removed. Use avatar entities instead.

* @property {string[]} jointNames - The list of joints in the current avatar model. Read-only. * @property {Uuid} sessionUUID - Unique ID of the avatar in the domain. Read-only. * @property {Mat4} sensorToWorldMatrix - The scale, rotation, and translation transform from the user's real world to the @@ -198,7 +198,7 @@ class MyAvatar : public Avatar { * @property {Pose} rightHandTipPose - The right hand's pose as determined by the hand controllers, relative to the avatar, * with the position adjusted by 0.3m along the direction of the palm. Read-only. * - * @property {number} energy - Deprecated: This property will be removed from the API. + * @property {number} energy - Deprecated: This property will be removed. * @property {boolean} isAway - true if your avatar is away (i.e., inactive), false if it is * active. * @@ -213,8 +213,9 @@ class MyAvatar : public Avatar { * was set false because the zone may disallow collisionless avatars. * @property {boolean} otherAvatarsCollisionsEnabled - Set to true to enable the avatar to collide with other * avatars, false to disable collisions with other avatars. - * @property {boolean} characterControllerEnabled - Synonym of collisionsEnabled.
- * Deprecated: Use collisionsEnabled instead. + * @property {boolean} characterControllerEnabled - Synonym of collisionsEnabled. + *

Deprecated: This property is deprecated and will be removed. Use collisionsEnabled + * instead.

* @property {boolean} useAdvancedMovementControls - Returns and sets the value of the Interface setting, Settings > * Controls > Walking. Note: Setting the value has no effect unless Interface is restarted. * @property {boolean} showPlayArea - Returns and sets the value of the Interface setting, Settings > Controls > Show room @@ -1557,14 +1558,14 @@ public: * @function MyAvatar.setCharacterControllerEnabled * @param {boolean} enabled - true to enable the avatar to collide with entities, false to * disable. - * @deprecated Use {@link MyAvatar.setCollisionsEnabled} instead. + * @deprecated This function is deprecated and will be removed. Use {@link MyAvatar.setCollisionsEnabled} instead. */ Q_INVOKABLE void setCharacterControllerEnabled(bool enabled); // deprecated /**jsdoc * @function MyAvatar.getCharacterControllerEnabled * @returns {boolean} true if the avatar will currently collide with entities, false if it won't. - * @deprecated Use {@link MyAvatar.getCollisionsEnabled} instead. + * @deprecated This function is deprecated and will be removed. Use {@link MyAvatar.getCollisionsEnabled} instead. */ Q_INVOKABLE bool getCharacterControllerEnabled(); // deprecated @@ -1910,7 +1911,7 @@ public slots: /**jsdoc * @function MyAvatar.clearScaleRestriction - * @deprecated This function is deprecated and will be removed from the API. + * @deprecated This function is deprecated and will be removed. */ void clearScaleRestriction(); @@ -1919,7 +1920,8 @@ public slots: * Adds a thrust to your avatar's current thrust to be applied for a short while. * @function MyAvatar.addThrust * @param {Vec3} thrust - The thrust direction and magnitude. - * @deprecated Use {@link MyAvatar|MyAvatar.motorVelocity} and related properties instead. + * @deprecated This function is deprecated and will be removed. Use {@link MyAvatar|MyAvatar.motorVelocity} and related + * properties instead. */ // Set/Get update the thrust that will move the avatar around void addThrust(glm::vec3 newThrust) { _thrust += newThrust; }; @@ -1928,7 +1930,8 @@ public slots: * Gets the thrust currently being applied to your avatar. * @function MyAvatar.getThrust * @returns {Vec3} The thrust currently being applied to your avatar. - * @deprecated Use {@link MyAvatar|MyAvatar.motorVelocity} and related properties instead. + * @deprecated This function is deprecated and will be removed. Use {@link MyAvatar|MyAvatar.motorVelocity} and related + * properties instead. */ glm::vec3 getThrust() { return _thrust; }; @@ -1936,7 +1939,8 @@ public slots: * Sets the thrust to be applied to your avatar for a short while. * @function MyAvatar.setThrust * @param {Vec3} thrust - The thrust direction and magnitude. - * @deprecated Use {@link MyAvatar|MyAvatar.motorVelocity} and related properties instead. + * @deprecated This function is deprecated and will be removed. Use {@link MyAvatar|MyAvatar.motorVelocity} and related + * properties instead. */ void setThrust(glm::vec3 newThrust) { _thrust = newThrust; } @@ -2281,7 +2285,7 @@ signals: * {@link MyAvatar.setAttachmentData|setAttachmentData}. * @function MyAvatar.attachmentsChanged * @returns {Signal} - * @deprecated Use avatar entities instead. + * @deprecated This signal is deprecated and will be removed. Use avatar entities instead. */ void attachmentsChanged(); diff --git a/interface/src/scripting/ControllerScriptingInterface.h b/interface/src/scripting/ControllerScriptingInterface.h index f8adbd5c12..9701c911b8 100644 --- a/interface/src/scripting/ControllerScriptingInterface.h +++ b/interface/src/scripting/ControllerScriptingInterface.h @@ -284,7 +284,7 @@ public slots: * Disable default Interface actions for a joystick. * @function Controller.captureJoystick * @param {number} joystickID - The integer ID of the joystick. - * @deprecated This function no longer has any effect. + * @deprecated This function is deprecated and will be removed. It no longer has any effect. */ virtual void captureJoystick(int joystickIndex); @@ -293,7 +293,7 @@ public slots: * {@link Controller.captureJoystick|captureJoystick}. * @function Controller.releaseJoystick * @param {number} joystickID - The integer ID of the joystick. - * @deprecated This function no longer has any effect. + * @deprecated This function is deprecated and will be removed. It no longer has any effect. */ virtual void releaseJoystick(int joystickIndex); diff --git a/libraries/animation/src/IKTarget.h b/libraries/animation/src/IKTarget.h index 564dba7f05..331acedd4e 100644 --- a/libraries/animation/src/IKTarget.h +++ b/libraries/animation/src/IKTarget.h @@ -26,8 +26,9 @@ public: * 0RotationAndPositionAttempt to reach the rotation and position end * effector. * 1RotationOnlyAttempt to reach the end effector rotation only. - * 2HmdHeadDeprecated: A special mode of IK that would attempt - * to prevent unnecessary bending of the spine. + * 2HmdHeadA special mode of IK that would attempt to prevent unnecessary + * bending of the spine.
+ *

Deprecated: This target type is deprecated and will be removed.

* 3HipsRelativeRotationAndPositionAttempt to reach a rotation and position end * effector that is not in absolute rig coordinates but is offset by the avatar hips translation. * 4SplineUse a cubic Hermite spline to model the human spine. This prevents diff --git a/libraries/avatars/src/AvatarData.h b/libraries/avatars/src/AvatarData.h index 79c82d4f29..d73573272d 100755 --- a/libraries/avatars/src/AvatarData.h +++ b/libraries/avatars/src/AvatarData.h @@ -467,8 +467,8 @@ class AvatarData : public QObject, public SpatiallyNestable { * @property {boolean} lookAtSnappingEnabled=true - true if the avatar's eyes snap to look at another avatar's * eyes when the other avatar is in the line of sight and also has lookAtSnappingEnabled == true. * @property {string} skeletonModelURL - The avatar's FST file. - * @property {AttachmentData[]} attachmentData - Information on the avatar's attachments.
- * Deprecated: Use avatar entities instead. + * @property {AttachmentData[]} attachmentData - Information on the avatar's attachments. + *

Deprecated: This property is deprecated and will be removed. Use avatar entities instead.

* @property {string[]} jointNames - The list of joints in the current avatar model. Read-only. * @property {Uuid} sessionUUID - Unique ID of the avatar in the domain. Read-only. * @property {Mat4} sensorToWorldMatrix - The scale, rotation, and translation transform from the user's real world to the @@ -1076,7 +1076,7 @@ public: * Gets information about the models currently attached to your avatar. * @function Avatar.getAttachmentsVariant * @returns {AttachmentData[]} Information about all models attached to your avatar. - * @deprecated Use avatar entities instead. + * @deprecated This function is deprecated and will be removed. Use avatar entities instead. */ // FIXME: Can this name be improved? Can it be deprecated? Q_INVOKABLE virtual QVariantList getAttachmentsVariant() const; @@ -1087,7 +1087,7 @@ public: * update your avatar's attachments per the changed data. * @function Avatar.setAttachmentsVariant * @param {AttachmentData[]} variant - The attachment data defining the models to have attached to your avatar. - * @deprecated Use avatar entities instead. + * @deprecated This function is deprecated and will be removed. Use avatar entities instead. */ // FIXME: Can this name be improved? Can it be deprecated? Q_INVOKABLE virtual void setAttachmentsVariant(const QVariantList& variant); @@ -1168,7 +1168,7 @@ public: * Gets information about the models currently attached to your avatar. * @function Avatar.getAttachmentData * @returns {AttachmentData[]} Information about all models attached to your avatar. - * @deprecated Use avatar entities instead. + * @deprecated This function is deprecated and will be removed. Use avatar entities instead. * @example Report the URLs of all current attachments. * var attachments = MyAvatar.getaAttachmentData(); * for (var i = 0; i < attachments.length; i++) { @@ -1186,7 +1186,7 @@ public: * @function Avatar.setAttachmentData * @param {AttachmentData[]} attachmentData - The attachment data defining the models to have attached to your avatar. Use * null to remove all attachments. - * @deprecated Use avatar entities instead. + * @deprecated This function is deprecated and will be removed. Use avatar entities instead. * @example Remove a hat attachment if your avatar is wearing it. * var hatURL = "https://s3.amazonaws.com/hifi-public/tony/cowboy-hat.fbx"; * var attachments = MyAvatar.getAttachmentData(); @@ -1223,7 +1223,7 @@ public: * @param {boolean} [allowDuplicates=false] - If true then more than one copy of any particular model may be * attached to the same joint; if false then the same model cannot be attached to the same joint. * @param {boolean} [useSaved=true] - Not used. - * @deprecated Use avatar entities instead. + * @deprecated This function is deprecated and will be removed. Use avatar entities instead. * @example Attach a cowboy hat to your avatar's head. * var attachment = { * modelURL: "https://s3.amazonaws.com/hifi-public/tony/cowboy-hat.fbx", @@ -1254,7 +1254,7 @@ public: * @param {string} modelURL - The URL of the model to detach. * @param {string} [jointName=""] - The name of the joint to detach the model from. If "", then the most * recently attached model is removed from which ever joint it was attached to. - * @deprecated Use avatar entities instead. + * @deprecated This function is deprecated and will be removed. Use avatar entities instead. */ Q_INVOKABLE virtual void detachOne(const QString& modelURL, const QString& jointName = QString()); @@ -1264,7 +1264,7 @@ public: * @param {string} modelURL - The URL of the model to detach. * @param {string} [jointName=""] - The name of the joint to detach the model from. If "", then the model is * detached from all joints. - * @deprecated Use avatar entities instead. + * @deprecated This function is deprecated and will be removed. Use avatar entities instead. */ Q_INVOKABLE virtual void detachAll(const QString& modelURL, const QString& jointName = QString()); diff --git a/libraries/avatars/src/ScriptAvatarData.h b/libraries/avatars/src/ScriptAvatarData.h index 7e33618ba9..9c5c2c6918 100644 --- a/libraries/avatars/src/ScriptAvatarData.h +++ b/libraries/avatars/src/ScriptAvatarData.h @@ -40,13 +40,14 @@ * @property {string} displayName - The avatar's display name. * @property {string} sessionDisplayName - The avatar's display name, sanitized and versioned, as defined by the avatar mixer. * It is unique among all avatars present in the domain at the time. - * @property {boolean} isReplicated - Deprecated. + * @property {boolean} isReplicated - Deprecated: This property is deprecated and will be + * removed. * @property {boolean} lookAtSnappingEnabled - true if the avatar's eyes snap to look at another avatar's eyes * when the other avatar is in the line of sight and also has lookAtSnappingEnabled == true. * * @property {string} skeletonModelURL - The avatar's FST file. - * @property {AttachmentData[]} attachmentData - Information on the avatar's attachments.
- * Deprecated: Use avatar entities instead. + * @property {AttachmentData[]} attachmentData - Information on the avatar's attachments. + *

Deprecated: This property is deprecated and will be removed. Use avatar entities instead.

* @property {string[]} jointNames - The list of joints in the current avatar model. * * @property {number} audioLoudness - The instantaneous loudness of the audio input that the avatar is injecting into the diff --git a/libraries/controllers/src/controllers/Actions.cpp b/libraries/controllers/src/controllers/Actions.cpp index 57be2f788b..e34ce277e2 100644 --- a/libraries/controllers/src/controllers/Actions.cpp +++ b/libraries/controllers/src/controllers/Actions.cpp @@ -201,15 +201,16 @@ namespace controller { * UiNavSelectnumbernumberGenerate a keyboard Enter key event. * * UiNavBacknumbernumberGenerate a keyboard Esc key event. - * LeftHandClicknumbernumberDeprecated: No action. - * - * RightHandClicknumbernumberDeprecated: No action. - * - * ShiftnumbernumberDeprecated: No action. - * PrimaryActionnumbernumberDeprecated: No action. - * - * SecondaryActionnumbernumberDeprecated: No action. - * + * LeftHandClicknumbernumberDeprecated: This + * action is deprecated and will be removed. It takes no action. + * RightHandClicknumbernumberDeprecated: This + * action is deprecated and will be removed. It takes no action. + * ShiftnumbernumberDeprecated: This + * action is deprecated and will be removed. It takes no action. + * PrimaryActionnumbernumberDeprecated: This + * action is deprecated and will be removed. It takes no action. + * SecondaryActionnumbernumberDeprecated: This + * action is deprecated and will be removed. It takes no action. * * Aliases * BackwardnumbernumberAlias for TranslateZ in the @@ -234,86 +235,108 @@ namespace controller { * direction. * * Deprecated Aliases - * LEFT_HANDnumber{@link Pose}Deprecated: Use - * LeftHand instead. - * RIGHT_HANDnumber{@link Pose}Deprecated: Use - * RightHand instead. - * BOOM_INnumbernumberDeprecated: Use - * BoomIn instead. - * BOOM_OUTnumbernumberDeprecated: Use - * BoomOut instead. - * CONTEXT_MENUnumbernumberDeprecated: Use - * ContextMenu instead. - * TOGGLE_MUTEnumbernumberDeprecated: Use - * ToggleMute instead. - * TOGGLE_PUSHTOTALKnumbernumberDeprecated: Use - * TogglePushToTalk instead. - * SPRINTnumbernumberDeprecated: Use - * Sprint instead. - * LONGITUDINAL_BACKWARDnumbernumberDeprecated: Use - * Backward instead. - * LONGITUDINAL_FORWARDnumbernumberDeprecated: Use - * Forward instead. - * LATERAL_LEFTnumbernumberDeprecated: Use - * StrafeLeft instead. - * LATERAL_RIGHTnumbernumberDeprecated: Use - * StrafeRight instead. - * VERTICAL_UPnumbernumberDeprecated: Use - * Up instead. - * VERTICAL_DOWNnumbernumberDeprecated: Use - * Down instead. - * PITCH_DOWNnumbernumberDeprecated: Use - * PitchDown instead. - * PITCH_UPnumbernumberDeprecated: Use - * PitchUp instead. - * YAW_LEFTnumbernumberDeprecated: Use - * YawLeft instead. - * YAW_RIGHTnumbernumberDeprecated: Use - * YawRight instead. - * LEFT_HAND_CLICKnumbernumberDeprecated: Use - * LeftHandClick instead. - * RIGHT_HAND_CLICKnumbernumberDeprecated: Use - * RightHandClick instead. - * SHIFTnumbernumberDeprecated: Use - * Shift instead. - * ACTION1numbernumberDeprecated: Use - * PrimaryAction instead. - * ACTION2numbernumberDeprecated: Use - * SecondaryAction instead. + * LEFT_HANDnumber{@link Pose}Deprecated: This + * action is deprecated and will be removed. Use LeftHand instead. + * RIGHT_HANDnumber{@link Pose}Deprecated: This + * action is deprecated and will be removed. Use + * RightHand instead. + * BOOM_INnumbernumberDeprecated: This + * action is deprecated and will be removed. Use + * BoomIn instead. + * BOOM_OUTnumbernumberDeprecated: This + * action is deprecated and will be removed. Use + * BoomOut instead. + * CONTEXT_MENUnumbernumberDeprecated: This + * action is deprecated and will be removed. Use + * ContextMenu instead. + * TOGGLE_MUTEnumbernumberDeprecated: This + * action is deprecated and will be removed. Use + * ToggleMute instead. + * TOGGLE_PUSHTOTALKnumbernumberDeprecated: This + * action is deprecated and will be removed. Use + * TogglePushToTalk instead. + * SPRINTnumbernumberDeprecated: This + * action is deprecated and will be removed. Use + * Sprint instead. + * LONGITUDINAL_BACKWARDnumbernumberDeprecated: This + * action is deprecated and will be removed. Use + * Backward instead. + * LONGITUDINAL_FORWARDnumbernumberDeprecated: This + * action is deprecated and will be removed. Use + * Forward instead. + * LATERAL_LEFTnumbernumberDeprecated: This + * action is deprecated and will be removed. Use + * StrafeLeft instead. + * LATERAL_RIGHTnumbernumberDeprecated: This + * action is deprecated and will be removed. Use + * StrafeRight instead. + * VERTICAL_UPnumbernumberDeprecated: This + * action is deprecated and will be removed. Use + * Up instead. + * VERTICAL_DOWNnumbernumberDeprecated: This + * action is deprecated and will be removed. Use + * Down instead. + * PITCH_DOWNnumbernumberDeprecated: This + * action is deprecated and will be removed. Use + * PitchDown instead. + * PITCH_UPnumbernumberDeprecated: This + * action is deprecated and will be removed. Use + * PitchUp instead. + * YAW_LEFTnumbernumberDeprecated: This + * action is deprecated and will be removed. Use + * YawLeft instead. + * YAW_RIGHTnumbernumberDeprecated: This + * action is deprecated and will be removed. Use + * YawRight instead. + * LEFT_HAND_CLICKnumbernumberDeprecated: This + * action is deprecated and will be removed. Use + * LeftHandClick instead. + * RIGHT_HAND_CLICKnumbernumberDeprecated: This + * action is deprecated and will be removed. Use + * RightHandClick instead. + * SHIFTnumbernumberDeprecated: This + * action is deprecated and will be removed. Use + * Shift instead. + * ACTION1numbernumberDeprecated: This + * action is deprecated and will be removed. Use + * PrimaryAction instead. + * ACTION2numbernumberDeprecated: This + * action is deprecated and will be removed. Use + * SecondaryAction instead. * * Deprecated Trackers - * TrackedObject00number{@link Pose}Deprecated: No - * action. - * TrackedObject01number{@link Pose}Deprecated: No - * action. - * TrackedObject02number{@link Pose}Deprecated: No - * action. - * TrackedObject03number{@link Pose}Deprecated: No - * action. - * TrackedObject04number{@link Pose}Deprecated: No - * action. - * TrackedObject05number{@link Pose}Deprecated: No - * action. - * TrackedObject06number{@link Pose}Deprecated: No - * action. - * TrackedObject07number{@link Pose}Deprecated: No - * action. - * TrackedObject08number{@link Pose}Deprecated: No - * action. - * TrackedObject09number{@link Pose}Deprecated: No - * action. - * TrackedObject10number{@link Pose}Deprecated: No - * action. - * TrackedObject11number{@link Pose}Deprecated: No - * action. - * TrackedObject12number{@link Pose}Deprecated: No - * action. - * TrackedObject13number{@link Pose}Deprecated: No - * action. - * TrackedObject14number{@link Pose}Deprecated: No - * action. - * TrackedObject15number{@link Pose}Deprecated: No - * action. + * TrackedObject00number{@link Pose}Deprecated: + * This action is deprecated and will be removed. It takes no action. + * TrackedObject01number{@link Pose}Deprecated: + * This action is deprecated and will be removed. It takes no action. + * TrackedObject02number{@link Pose}Deprecated: + * This action is deprecated and will be removed. It takes no action. + * TrackedObject03number{@link Pose}Deprecated: + * This action is deprecated and will be removed. It takes no action. + * TrackedObject04number{@link Pose}Deprecated: + * This action is deprecated and will be removed. It takes no action. + * TrackedObject05number{@link Pose}Deprecated: + * This action is deprecated and will be removed. It takes no action. + * TrackedObject06number{@link Pose}Deprecated: + * This action is deprecated and will be removed. It takes no action. + * TrackedObject07number{@link Pose}Deprecated: + * This action is deprecated and will be removed. It takes no action. + * TrackedObject08number{@link Pose}Deprecated: + * This action is deprecated and will be removed. It takes no action. + * TrackedObject09number{@link Pose}Deprecated: + * This action is deprecated and will be removed. It takes no action. + * TrackedObject10number{@link Pose}Deprecated: + * This action is deprecated and will be removed. It takes no action. + * TrackedObject11number{@link Pose}Deprecated: + * This action is deprecated and will be removed. It takes no action. + * TrackedObject12number{@link Pose}Deprecated: + * This action is deprecated and will be removed. It takes no action. + * TrackedObject13number{@link Pose}Deprecated: + * This action is deprecated and will be removed. It takes no action. + * TrackedObject14number{@link Pose}Deprecated: + * This action is deprecated and will be removed. It takes no action. + * TrackedObject15number{@link Pose}Deprecated: + * This action is deprecated and will be removed. It takes no action. * * * @typedef {object} Controller.Actions diff --git a/libraries/controllers/src/controllers/ScriptingInterface.h b/libraries/controllers/src/controllers/ScriptingInterface.h index 157730e7c6..156fc1af7c 100644 --- a/libraries/controllers/src/controllers/ScriptingInterface.h +++ b/libraries/controllers/src/controllers/ScriptingInterface.h @@ -76,7 +76,7 @@ namespace controller { * Get a list of all available actions. * @function Controller.getAllActions * @returns {Action[]} All available actions. - * @deprecated This function no longer works. + * @deprecated This function is deprecated and will be removed. It no longer works. */ // FIXME: This function causes a JavaScript crash: https://highfidelity.manuscript.com/f/cases/edit/13921 Q_INVOKABLE QVector getAllActions(); @@ -86,7 +86,7 @@ namespace controller { * @function Controller.getAvailableInputs * @param {number} deviceID - Integer ID of the hardware device. * @returns {NamedPair[]} All available inputs for the device. - * @deprecated This function no longer works. + * @deprecated This function is deprecated and will be removed. It no longer works. */ // FIXME: This function causes a JavaScript crash: https://highfidelity.manuscript.com/f/cases/edit/13922 Q_INVOKABLE QVector getAvailableInputs(unsigned int device); diff --git a/libraries/entities/src/EntityScriptingInterface.h b/libraries/entities/src/EntityScriptingInterface.h index f6aedac3fc..38b73aaf45 100644 --- a/libraries/entities/src/EntityScriptingInterface.h +++ b/libraries/entities/src/EntityScriptingInterface.h @@ -1550,7 +1550,7 @@ public slots: * @function Entities.getMeshes * @param {Uuid} entityID - The ID of the Model or PolyVox entity to get the meshes of. * @param {Entities~getMeshesCallback} callback - The function to call upon completion. - * @deprecated Use the {@link Graphics} API instead. + * @deprecated This function is deprecated and will be removed. Use the {@link Graphics} API instead. */ /**jsdoc * Called when {@link Entities.getMeshes} is complete. @@ -1559,7 +1559,7 @@ public slots: * Model or PolyVox entity; otherwise undefined. * @param {boolean} success - true if the {@link Entities.getMeshes} call was successful, false * otherwise. The call may be unsuccessful if the requested entity could not be found. - * @deprecated Use the {@link Graphics} API instead. + * @deprecated This function is deprecated and will be removed. Use the {@link Graphics} API instead. */ // FIXME move to a renderable entity interface Q_INVOKABLE void getMeshes(const QUuid& entityID, QScriptValue callback); diff --git a/libraries/shared/src/RegisteredMetaTypes.h b/libraries/shared/src/RegisteredMetaTypes.h index d3fb816f3c..99dc896c31 100644 --- a/libraries/shared/src/RegisteredMetaTypes.h +++ b/libraries/shared/src/RegisteredMetaTypes.h @@ -687,7 +687,6 @@ public: * Get the number of vertices in the mesh. * @function MeshProxy#getNumVertices * @returns {number} Integer number of vertices in the mesh. - * @deprecated Use the {@link Graphics} API instead. */ Q_INVOKABLE virtual int getNumVertices() const = 0; @@ -696,7 +695,6 @@ public: * @function MeshProxy#getPos * @param {number} index - Integer index of the mesh vertex. * @returns {Vec3} Local position of the vertex relative to the mesh. - * @deprecated Use the {@link Graphics} API instead. */ Q_INVOKABLE virtual glm::vec3 getPos(int index) const = 0; Q_INVOKABLE virtual glm::vec3 getPos3(int index) const { return getPos(index); } // deprecated diff --git a/libraries/ui/src/ui/TabletScriptingInterface.h b/libraries/ui/src/ui/TabletScriptingInterface.h index 1a6df83d93..0b8dc95fa4 100644 --- a/libraries/ui/src/ui/TabletScriptingInterface.h +++ b/libraries/ui/src/ui/TabletScriptingInterface.h @@ -98,7 +98,6 @@ public: * @function tabletInterface.getTablet * @param {string} name - Tablet name. * @returns {TabletProxy} Tablet instance. - * @deprecated This function is deprecated and will be removed. Use {@link Tablet.getTablet} instead. */ Q_INVOKABLE TabletProxy* getTablet(const QString& tabletId); @@ -111,7 +110,6 @@ public: /**jsdoc * @function tabletInterface.playSound * @param {Tablet.AudioEvents} sound - * @deprecated This function is deprecated and will be removed. Use {@link Tablet.playSound} instead. */ Q_INVOKABLE void playSound(TabletAudioEvents aEvent); @@ -134,7 +132,6 @@ signals: * Triggered when a tablet message or dialog is created. * @function tabletInterface.tabletNotification * @returns {Signal} - * @deprecated This function is deprecated and will be removed. Use {@link Tablet.tabletNotification} instead. */ void tabletNotification();