Merge pull request #13147 from ctrlaltdavid/21872-a

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

View file

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

View file

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