Mirrors/overte-lubosz
3
0
Fork 0
mirror of https://github.com/lubosz/overte.git synced 2025-08-07 18:41:10 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Miscellaneous JSDoc improvements

Browse source
This commit is contained in:
David Rowe 2018-03-01 09:58:35 +13:00
parent 3275846882
commit d82a300f5f
2 changed files with 19 additions and 17 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
libraries/entities/src/EntityScriptingInterface.h
View file

@ -151,7 +151,7 @@ public slots:
/**jsdoc /**jsdoc
* Check whether or not you can rez (create) new entities in the domain. * Check whether or not you can rez (create) new entities in the domain.
* @function Entities.canRez * @function Entities.canRez
* @returns {boolean} <code>true</code> if the domain server will allow this script to rez (create) new entities, * @returns {boolean} <code>true</code> if the domain server will allow the script to rez (create) new entities,
* otherwise <code>false</code>. * otherwise <code>false</code>.
*/ */
Q_INVOKABLE bool canRez(); Q_INVOKABLE bool canRez();
@ -160,7 +160,7 @@ public slots:
* Check whether or not you can rez (create) new temporary entities in the domain. Temporary entities are entities with a * Check whether or not you can rez (create) new temporary entities in the domain. Temporary entities are entities with a
* finite <code>lifetime</code> property value set. * finite <code>lifetime</code> property value set.
* @function Entities.canRezTmp * @function Entities.canRezTmp
* @returns {boolean} <code>true</code> if the domain server will allow this script to rez (create) new temporary * @returns {boolean} <code>true</code> if the domain server will allow the script to rez (create) new temporary
* entities, otherwise <code>false</code>. * entities, otherwise <code>false</code>.
*/ */
Q_INVOKABLE bool canRezTmp(); Q_INVOKABLE bool canRezTmp();
@ -169,7 +169,7 @@ public slots:
* Check whether or not you can rez (create) new certified entities in the domain. Certified entities are entities that have * Check whether or not you can rez (create) new certified entities in the domain. Certified entities are entities that have
* PoP certificates. * PoP certificates.
* @function Entities.canRezCertified * @function Entities.canRezCertified
* @returns {boolean} <code>true</code> if the domain server will allow this script to rez (create) new certified * @returns {boolean} <code>true</code> if the domain server will allow the script to rez (create) new certified
* entities, otherwise <code>false</code>. * entities, otherwise <code>false</code>.
*/ */
Q_INVOKABLE bool canRezCertified(); Q_INVOKABLE bool canRezCertified();
@ -178,7 +178,7 @@ public slots:
* Check whether or not you can rez (create) new temporary certified entities in the domain. Temporary entities are entities * Check whether or not you can rez (create) new temporary certified entities in the domain. Temporary entities are entities
* with a finite <code>lifetime</code> property value set. Certified entities are entities that have PoP certificates. * with a finite <code>lifetime</code> property value set. Certified entities are entities that have PoP certificates.
* @function Entities.canRezTmpCertified * @function Entities.canRezTmpCertified
* @returns {boolean} <code>true</code> if the domain server will allow this script to rez (create) new temporary * @returns {boolean} <code>true</code> if the domain server will allow the script to rez (create) new temporary
* certified entities, otherwise <code>false</code>. * certified entities, otherwise <code>false</code>.
*/ */
Q_INVOKABLE bool canRezTmpCertified(); Q_INVOKABLE bool canRezTmpCertified();
@ -186,15 +186,17 @@ public slots:
/**jsdoc /**jsdoc
* Check whether or not you can make changes to the asset server's assets. * Check whether or not you can make changes to the asset server's assets.
* @function Entities.canWriteAssets * @function Entities.canWriteAssets
* @returns {boolean} <code>true</code> if the domain server will allow this script to make changes to the to the asset * @returns {boolean} <code>true</code> if the domain server will allow the script to make changes to the to the asset
* server's assets, otherwise <code>false</code>. * server's assets, otherwise <code>false</code>.
*/ */
Q_INVOKABLE bool canWriteAssets(); Q_INVOKABLE bool canWriteAssets();
/**jsdoc /**jsdoc
* @function Entities.canReplaceContent * Check whether or not you can replace the domain's content set.
* @return {bool} `true` if the DomainServer will allow this Node/Avatar to replace the domain's content set * @function Entities.canReplaceContent
*/ * @returns {boolean} <code>true</code> if the domain server will allow the script to replace the domain's content set,
* otherwise <code>false</code>.
*/
Q_INVOKABLE bool canReplaceContent(); Q_INVOKABLE bool canReplaceContent();
/**jsdoc /**jsdoc

18
libraries/script-engine/src/Vec3.h
View file

@ -25,27 +25,27 @@
* A 2-dimensional vector. * A 2-dimensional vector.
* *
* @typedef {object} Vec2 * @typedef {object} Vec2
* @property {float} x X-coordinate of the vector. * @property {number} x - X-coordinate of the vector.
* @property {float} y Y-coordinate of the vector. * @property {number} y - Y-coordinate of the vector.
*/ */
/**jsdoc /**jsdoc
* A 3-dimensional vector. * A 3-dimensional vector.
* *
* @typedef {object} Vec3 * @typedef {object} Vec3
* @property {float} x X-coordinate of the vector. * @property {number} x - X-coordinate of the vector.
* @property {float} y Y-coordinate of the vector. * @property {number} y - Y-coordinate of the vector.
* @property {float} z Z-coordinate of the vector. * @property {number} z - Z-coordinate of the vector.
*/ */
/**jsdoc /**jsdoc
* A 4-dimensional vector. * A 4-dimensional vector.
* *
* @typedef {object} Vec4 * @typedef {object} Vec4
* @property {float} x X-coordinate of the vector. * @property {number} x - X-coordinate of the vector.
* @property {float} y Y-coordinate of the vector. * @property {number} y - Y-coordinate of the vector.
* @property {float} z Z-coordinate of the vector. * @property {number} z - Z-coordinate of the vector.
* @property {float} w W-coordinate of the vector. * @property {number} w - W-coordinate of the vector.
*/ */
/**jsdoc /**jsdoc