Fix jsdoc for getPointerScriptParameters

This commit is contained in:
sabrina-shanman 2019-08-07 10:04:44 -07:00
parent 8cde93973d
commit 4cb925e973

View file

@ -161,13 +161,13 @@ public:
Q_INVOKABLE void removePointer(unsigned int uid) const { DependencyManager::get<PointerManager>()->removePointer(uid); } Q_INVOKABLE void removePointer(unsigned int uid) const { DependencyManager::get<PointerManager>()->removePointer(uid); }
/**jsdoc /**jsdoc
* Gets the parameters that were passed in to {@link Picks.createPick} to create the pick, * Gets the parameters that were passed in to {@link Pointers.createPointer} to create the pointer,
* if the pick was created through a script. * if the pointer was created through a script.
* Note that these properties do not reflect the current state of the pick. * Note that these properties do not reflect the current state of the pointer.
* See {@link Picks.getPickProperties}. * See {@link Pointers.getPointerProperties}.
* @function Picks.getPickScriptParameters * @function Pointers.getPointerScriptParameters
* @param {number} id - The ID of the pick. * @param {number} id - The ID of the pointer.
* @returns {Picks.RayPickProperties|Picks.ParabolaPickProperties|Picks.StylusPickProperties|Picks.CollisionPickProperties} User-provided properties, per the pick <code>type</code>. * @returns {Pointers.RayPointerProperties|Picks.ParabolaPointerProperties|Picks.StylusPointerProperties} User-provided properties, per the pointer <code>type</code>.
*/ */
Q_INVOKABLE QVariantMap getPointerScriptParameters(unsigned int uid) const; Q_INVOKABLE QVariantMap getPointerScriptParameters(unsigned int uid) const;