Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-08-09 02:16:51 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 2

Miscellaneous JSDoc tidying

Browse source
This commit is contained in:
David Rowe 2018-05-02 16:15:35 +12:00
parent 48632be3c2
commit 3febdcb141
2 changed files with 5 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
interface/src/scripting/SelectionScriptingInterface.h
View file

@ -131,7 +131,7 @@ public:
/**jsdoc /**jsdoc
* Get the names of all the selection lists. * Get the names of all the selection lists.
* @function Selection.getListNames * @function Selection.getListNames
* @return {list[]} An array of names of all the selection lists. * @returns {list[]} An array of names of all the selection lists.
*/ */
Q_INVOKABLE QStringList getListNames() const; Q_INVOKABLE QStringList getListNames() const;
@ -181,7 +181,7 @@ public:
* Get the list of avatars, entities, and overlays stored in a selection list. * Get the list of avatars, entities, and overlays stored in a selection list.
* @function Selection.getList * @function Selection.getList
* @param {string} listName - The name of the selection list. * @param {string} listName - The name of the selection list.
* @return {Selection.SelectedItemsList} The content of a selection list. If the list name doesn't exist, the function * @returns {Selection.SelectedItemsList} The content of a selection list. If the list name doesn't exist, the function
* returns an empty object with no properties. * returns an empty object with no properties.
*/ */
Q_INVOKABLE QVariantMap getSelectedItemsList(const QString& listName) const; Q_INVOKABLE QVariantMap getSelectedItemsList(const QString& listName) const;
@ -189,7 +189,7 @@ public:
/**jsdoc /**jsdoc
* Get the names of the highlighted selection lists. * Get the names of the highlighted selection lists.
* @function Selection.getHighlightedListNames * @function Selection.getHighlightedListNames
* @return {string[]} An array of names of the selection list currently highlight enabled. * @returns {string[]} An array of names of the selection list currently highlight enabled.
*/ */
Q_INVOKABLE QStringList getHighlightedListNames() const; Q_INVOKABLE QStringList getHighlightedListNames() const;

4
libraries/graphics-scripting/src/graphics-scripting/GraphicsScriptingInterface.h
View file

@ -39,7 +39,7 @@ public slots:
* *
* @function Graphics.getModel * @function Graphics.getModel
* @param {UUID} entityID - The objectID of the model whose meshes are to be retrieved. * @param {UUID} entityID - The objectID of the model whose meshes are to be retrieved.
* @return {Graphics.Model} the resulting Model object * @returns {Graphics.Model} the resulting Model object
*/ */
scriptable::ScriptableModelPointer getModel(QUuid uuid); scriptable::ScriptableModelPointer getModel(QUuid uuid);
@ -54,7 +54,7 @@ public slots:
* *
* @function Graphics.newMesh * @function Graphics.newMesh
* @param {Graphics.IFSData} ifsMeshData Index-Faced Set (IFS) arrays used to create the new mesh. * @param {Graphics.IFSData} ifsMeshData Index-Faced Set (IFS) arrays used to create the new mesh.
* @return {Graphics.Mesh} the resulting Mesh / Mesh Part object * @returns {Graphics.Mesh} the resulting Mesh / Mesh Part object
*/ */
/**jsdoc /**jsdoc
* @typedef {object} Graphics.IFSData * @typedef {object} Graphics.IFSData