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

Clipboard JSDoc improvements

Browse source
This commit is contained in:
David Rowe 2017-11-11 16:16:24 +13:00
parent c77a12f5fa
commit a576cc04e1
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
interface/src/scripting/ClipboardScriptingInterface.h
View file

@ -47,28 +47,28 @@ public:
* You can generate a JSON file using {@link Clipboard.exportEntities}.
* @function Clipboard.importEntities
* @param {String} filename Path and name of file to import.
* @returns {Boolean} `true` if the import was successful, otherwise `false`.
* @returns {Boolean} <code>true</code> if the import was successful, otherwise <code>false</code>.
*/
Q_INVOKABLE bool importEntities(const QString& filename);
/**jsdoc
* Export the entities specified to a JSON file.
* @function Clipboard.exportEntities
* @param {String} filename Path and name of the file to export entities to. Should have the extension `.json`.
* @param {EntityID[]} entityIDs IDs of entities to export.
* @returns {Boolean} `true` if the export was successful, otherwise `false`.
* @param {String} filename Path and name of the file to export the entities to. Should have the extension ".json".
* @param {EntityID[]} entityIDs Array of IDs of the entities to export.
* @returns {Boolean} <code>true</code> if the export was successful, otherwise <code>false</code>.
*/
Q_INVOKABLE bool exportEntities(const QString& filename, const QVector<EntityItemID>& entityIDs);
/**jsdoc
* Export the entities with centers within a cube to a JSON file.
* @function Clipboard.exportEntities
* @param {String} filename Path and name of the file to export entities to. Should have the extension `.json`.
* @param {String} filename Path and name of the file to export the entities to. Should have the extension ".json".
* @param {Number} x X-coordinate of the cube center.
* @param {Number} y Y-coordinate of the cube center.
* @param {Number} z Z-coordinate of the cube center.
* @param {Number} scale Half dimension of the cube.
* @returns {Boolean} `true` if the export was successful, otherwise `false`.
* @returns {Boolean} <code>true</code> if the export was successful, otherwise <code>false</code>.
*/
Q_INVOKABLE bool exportEntities(const QString& filename, float x, float y, float z, float scale);