From 37854ab05eb061961d83e5d10f5b4d71a2dd5c4a Mon Sep 17 00:00:00 2001 From: Luis Cuenca Date: Thu, 6 Dec 2018 11:58:48 -0800 Subject: [PATCH] Add jsdoc information --- libraries/entities/src/EntityScriptingInterface.h | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/libraries/entities/src/EntityScriptingInterface.h b/libraries/entities/src/EntityScriptingInterface.h index ad1c11ba41..4b06d2d16b 100644 --- a/libraries/entities/src/EntityScriptingInterface.h +++ b/libraries/entities/src/EntityScriptingInterface.h @@ -980,7 +980,16 @@ public slots: */ // FIXME move to a renderable entity interface Q_INVOKABLE glm::vec3 getAbsoluteJointTranslationInObjectFrame(const QUuid& entityID, int jointIndex); + + /**jsdoc + * Get the index of the parent joint. + * @function Entities.getJointParent + * @param {Uuid} entityID - The ID of the entity. + * @param {number} index - The integer index of the joint. + * @returns {number} The index of the parent joint. + */ Q_INVOKABLE int getJointParent(const QUuid& entityID, int index); + /**jsdoc * Get the translation of a joint in a {@link Entities.EntityType|Model} entity relative to the entity's position and * orientation.