Mirrors/overte
3
0
Fork 0
mirror of https://github.com/overte-org/overte.git synced 2025-06-28 08:29:47 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions

Merge pull request #13147 from ctrlaltdavid/21872-a

Browse source 
Fix JSDoc function definitions specifying properties instead of params
This commit is contained in:
MiladNazeri 2018-05-11 16:20:06 -07:00 committed by GitHub
commit ea26512793
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 31 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -481,8 +481,8 @@ public slots:
/**jsdoc /**jsdoc
* Gets the status of server entity script attached to an entity * Gets the status of server entity script attached to an entity
* @function Entities.getServerScriptStatus * @function Entities.getServerScriptStatus
* @property {Uuid} entityID - The ID of the entity to get the server entity script status for. * @param {Uuid} entityID - The ID of the entity to get the server entity script status for.
* @property {Entities~getServerScriptStatusCallback} callback - The function to call upon completion. * @param {Entities~getServerScriptStatusCallback} callback - The function to call upon completion.
* @returns {boolean} <code>true</code> always. * @returns {boolean} <code>true</code> always.
*/ */
/**jsdoc /**jsdoc

58
libraries/script-engine/src/AssetScriptingInterface.h
View file

@ -186,36 +186,36 @@ public:
/**jsdoc /**jsdoc
* @function Assets.deleteAsset * @function Assets.deleteAsset
* @property {} options * @param {} options
* @property {} scope * @param {} scope
* @property {} [callback = ""] * @param {} [callback = ""]
*/ */
Q_INVOKABLE void deleteAsset(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); Q_INVOKABLE void deleteAsset(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
/**jsdoc /**jsdoc
* @function Assets.resolveAsset * @function Assets.resolveAsset
* @property {} options * @param {} options
* @property {} scope * @param {} scope
* @property {} [callback = ""] * @param {} [callback = ""]
*/ */
Q_INVOKABLE void resolveAsset(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); Q_INVOKABLE void resolveAsset(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
/**jsdoc /**jsdoc
* @function Assets.decompressData * @function Assets.decompressData
* @property {} options * @param {} options
* @property {} scope * @param {} scope
* @property {} [callback = ""] * @param {} [callback = ""]
*/ */
Q_INVOKABLE void decompressData(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); Q_INVOKABLE void decompressData(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
/**jsdoc /**jsdoc
* @function Assets.compressData * @function Assets.compressData
* @property {} options * @param {} options
* @property {} scope * @param {} scope
* @property {} [callback = ""] * @param {} [callback = ""]
*/ */
Q_INVOKABLE void compressData(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); Q_INVOKABLE void compressData(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
@ -229,7 +229,7 @@ public:
/**jsdoc /**jsdoc
* @function Assets.canWriteCacheValue * @function Assets.canWriteCacheValue
* @property {string} url * @param {string} url
* @returns {boolean} * @returns {boolean}
*/ */
@ -237,8 +237,8 @@ public:
/**jsdoc /**jsdoc
* @function Assets.getCacheStatus * @function Assets.getCacheStatus
* @property {} scope * @param {} scope
* @property {} [callback=undefined] * @param {} [callback=undefined]
*/ */
Q_INVOKABLE void getCacheStatus(QScriptValue scope, QScriptValue callback = QScriptValue()) { Q_INVOKABLE void getCacheStatus(QScriptValue scope, QScriptValue callback = QScriptValue()) {
@ -247,38 +247,38 @@ public:
/**jsdoc /**jsdoc
* @function Assets.queryCacheMeta * @function Assets.queryCacheMeta
* @property {} options * @param {} options
* @property {} scope * @param {} scope
* @property {} [callback=undefined] * @param {} [callback=undefined]
*/ */
Q_INVOKABLE void queryCacheMeta(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); Q_INVOKABLE void queryCacheMeta(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
/**jsdoc /**jsdoc
* @function Assets.loadFromCache * @function Assets.loadFromCache
* @property {} options * @param {} options
* @property {} scope * @param {} scope
* @property {} [callback=undefined] * @param {} [callback=undefined]
*/ */
Q_INVOKABLE void loadFromCache(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); Q_INVOKABLE void loadFromCache(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
/**jsdoc /**jsdoc
* @function Assets.saveToCache * @function Assets.saveToCache
* @property {} options * @param {} options
* @property {} scope * @param {} scope
* @property {} [callback=undefined] * @param {} [callback=undefined]
*/ */
Q_INVOKABLE void saveToCache(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue()); Q_INVOKABLE void saveToCache(QScriptValue options, QScriptValue scope, QScriptValue callback = QScriptValue());
/**jsdoc /**jsdoc
* @function Assets.saveToCache * @function Assets.saveToCache
* @property {} url * @param {} url
* @property {} data * @param {} data
* @property {} metadata * @param {} metadata
* @property {} scope * @param {} scope
* @property {} [callback=undefined] * @param {} [callback=undefined]
*/ */
Q_INVOKABLE void saveToCache(const QUrl& url, const QByteArray& data, const QVariantMap& metadata, Q_INVOKABLE void saveToCache(const QUrl& url, const QByteArray& data, const QVariantMap& metadata,