History

Convert all "/**jsdoc" occurrences to "/*@jsdoc"

David Rowe committed 5 years ago

Commit 4d11d1d1 parent 2130dea220 files · +2319 −2319Browse files

Showing the changes to libraries/script-engine/src/AssetScriptingInterface.cpp (1 of 220 files). Show all

Unified · Split

libraries/script-engine/src/AssetScriptingInterface.cpp+14−14
@@ -102,7 +102,7 @@ void AssetScriptingInterface::setMapping(QString path, QString hash, QScriptValu · 101 unmodified lines
102 setMappingRequest->start();102 setMappingRequest->start();
103}103}
104 104
105/**jsdoc105/*@jsdoc
106 * The success or failure of an {@link Assets.downloadData} call.106 * The success or failure of an {@link Assets.downloadData} call.
107 * @typedef {object} Assets.DownloadDataError107 * @typedef {object} Assets.DownloadDataError
108 * @property {string} errorMessage - <code>""</code> if the download was successful, otherwise a description of the error.108 * @property {string} errorMessage - <code>""</code> if the download was successful, otherwise a description of the error.
@@ -244,7 +244,7 @@ void AssetScriptingInterface::deleteAsset(QScriptValue options, QScriptValue sco · 135 unmodified lines
244 jsVerify(false, "TODO: deleteAsset API");244 jsVerify(false, "TODO: deleteAsset API");
245}245}
246 246
247/**jsdoc247/*@jsdoc
248 * Source and download options for {@link Assets.getAsset}.248 * Source and download options for {@link Assets.getAsset}.
249 * @typedef {object} Assets.GetOptions249 * @typedef {object} Assets.GetOptions
250 * @property {boolean} [decompress=false] - <code>true</code> to gunzip decompress the downloaded data. Synonym:250 * @property {boolean} [decompress=false] - <code>true</code> to gunzip decompress the downloaded data. Synonym:
@@ -252,7 +252,7 @@ void AssetScriptingInterface::deleteAsset(QScriptValue options, QScriptValue sco · 1 unmodified line
252 * @property {Assets.ResponseType} [responseType="text"] - The desired result type.252 * @property {Assets.ResponseType} [responseType="text"] - The desired result type.
253 * @property {string} url - The mapped path or hash to download. May have a leading <code>"atp:"</code>.253 * @property {string} url - The mapped path or hash to download. May have a leading <code>"atp:"</code>.
254 */254 */
255/**jsdoc255/*@jsdoc
256 * Result value returned by {@link Assets.getAsset}. 256 * Result value returned by {@link Assets.getAsset}.
257 * @typedef {object} Assets.GetResult257 * @typedef {object} Assets.GetResult
258 * @property {number} [byteLength] - The number of bytes in the downloaded content in <code>response</code>.258 * @property {number} [byteLength] - The number of bytes in the downloaded content in <code>response</code>.
@@ -320,12 +320,12 @@ void AssetScriptingInterface::getAsset(QScriptValue options, QScriptValue scope, · 61 unmodified lines
320 }320 }
321}321}
322 322
323/**jsdoc323/*@jsdoc
324 * Source options for {@link Assets.resolveAsset}.324 * Source options for {@link Assets.resolveAsset}.
325 * @typedef {object} Assets.ResolveOptions325 * @typedef {object} Assets.ResolveOptions
326 * @property {string} url - The hash or path to resolve. May have a leading <code>"atp:"</code>.326 * @property {string} url - The hash or path to resolve. May have a leading <code>"atp:"</code>.
327 */327 */
328/**jsdoc328/*@jsdoc
329 * Result value returned by {@link Assets.resolveAsset}.329 * Result value returned by {@link Assets.resolveAsset}.
330 * <p>Note: If resolving a hash, a file of that hash need not be present on the asset server for the hash to resolve.</p>330 * <p>Note: If resolving a hash, a file of that hash need not be present on the asset server for the hash to resolve.</p>
331 * @typedef {object} Assets.ResolveResult331 * @typedef {object} Assets.ResolveResult
@@ -348,13 +348,13 @@ void AssetScriptingInterface::resolveAsset(QScriptValue options, QScriptValue sc · 16 unmodified lines
348 jsPromiseReady(getAssetInfo(asset), scope, callback);348 jsPromiseReady(getAssetInfo(asset), scope, callback);
349}349}
350 350
351/**jsdoc351/*@jsdoc
352 * Content and decompression options for {@link Assets.decompressData}.352 * Content and decompression options for {@link Assets.decompressData}.
353 * @typedef {object} Assets.DecompressOptions353 * @typedef {object} Assets.DecompressOptions
354 * @property {ArrayBuffer} data - The data to decompress.354 * @property {ArrayBuffer} data - The data to decompress.
355 * @property {Assets.ResponseType} [responseType=text] - The type of decompressed data to return.355 * @property {Assets.ResponseType} [responseType=text] - The type of decompressed data to return.
356 */356 */
357/**jsdoc357/*@jsdoc
358 * Result value returned by {@link Assets.decompressData}.358 * Result value returned by {@link Assets.decompressData}.
359 * @typedef {object} Assets.DecompressResult359 * @typedef {object} Assets.DecompressResult
360 * @property {number} [byteLength] - The number of bytes in the decompressed data.360 * @property {number} [byteLength] - The number of bytes in the decompressed data.
@@ -388,7 +388,7 @@ namespace { · 27 unmodified lines
388 const int32_t MAX_GZIP_COMPRESSION_LEVEL = 9;388 const int32_t MAX_GZIP_COMPRESSION_LEVEL = 9;
389}389}
390 390
391/**jsdoc391/*@jsdoc
392 * Content and compression options for {@link Assets.compressData}.392 * Content and compression options for {@link Assets.compressData}.
393 * @typedef {object} Assets.CompressOptions393 * @typedef {object} Assets.CompressOptions
394 * @property {string|ArrayBuffer} data - The data to compress.394 * @property {string|ArrayBuffer} data - The data to compress.
@@ -396,7 +396,7 @@ namespace { · 1 unmodified line
396 * use the default gzip compression level, <code>0</code> means no compression, and <code>9</code> means maximum 396 * use the default gzip compression level, <code>0</code> means no compression, and <code>9</code> means maximum
397 * compression.397 * compression.
398 */398 */
399/**jsdoc399/*@jsdoc
400 * Result value returned by {@link Assets.compressData}.400 * Result value returned by {@link Assets.compressData}.
401 * @typedef {object} Assets.CompressResult401 * @typedef {object} Assets.CompressResult
402 * @property {number} [byteLength] - The number of bytes in the compressed data.402 * @property {number} [byteLength] - The number of bytes in the compressed data.
@@ -412,7 +412,7 @@ void AssetScriptingInterface::compressData(QScriptValue options, QScriptValue sc · 9 unmodified lines
412 jsPromiseReady(compressBytes(dataByteArray, level), scope, callback);412 jsPromiseReady(compressBytes(dataByteArray, level), scope, callback);
413}413}
414 414
415/**jsdoc415/*@jsdoc
416 * Content and upload options for {@link Assets.putAsset}.416 * Content and upload options for {@link Assets.putAsset}.
417 * @typedef {object} Assets.PutOptions417 * @typedef {object} Assets.PutOptions
418 * @property {boolean} [compress=false] - <code>true</code> to gzip compress the content for upload and storage,418 * @property {boolean} [compress=false] - <code>true</code> to gzip compress the content for upload and storage,
@@ -423,7 +423,7 @@ void AssetScriptingInterface::compressData(QScriptValue options, QScriptValue sc · 4 unmodified lines
423 * <p>Note: The asset server destroys any unmapped SHA256-named file at server restart. Either set the mapping path 423 * <p>Note: The asset server destroys any unmapped SHA256-named file at server restart. Either set the mapping path
424 * with this property or use {@link Assets.setMapping} to set a path-to-hash mapping for the uploaded file.</p>424 * with this property or use {@link Assets.setMapping} to set a path-to-hash mapping for the uploaded file.</p>
425 */425 */
426/**jsdoc426/*@jsdoc
427 * Result value returned by {@link Assets.putAsset}.427 * Result value returned by {@link Assets.putAsset}.
428 * @typedef {object} Assets.PutResult428 * @typedef {object} Assets.PutResult
429 * @property {number} [byteLength] - The number of bytes in the hash file stored on the asset server.429 * @property {number} [byteLength] - The number of bytes in the hash file stored on the asset server.
@@ -483,7 +483,7 @@ void AssetScriptingInterface::putAsset(QScriptValue options, QScriptValue scope, · 53 unmodified lines
483 }483 }
484}484}
485 485
486/**jsdoc486/*@jsdoc
487 * Source for {@link Assets.queryCacheMeta}.487 * Source for {@link Assets.queryCacheMeta}.
488 * @typedef {object} Assets.QueryCacheMetaOptions488 * @typedef {object} Assets.QueryCacheMetaOptions
489 * @property {string} url - The URL of the cached asset to get information on. Must start with <code>"atp:"</code> or 489 * @property {string} url - The URL of the cached asset to get information on. Must start with <code>"atp:"</code> or
@@ -495,7 +495,7 @@ void AssetScriptingInterface::queryCacheMeta(QScriptValue options, QScriptValue · 5 unmodified lines
495 jsPromiseReady(Parent::queryCacheMeta(url), scope, callback);495 jsPromiseReady(Parent::queryCacheMeta(url), scope, callback);
496}496}
497 497
498/**jsdoc498/*@jsdoc
499 * Source and retrieval options for {@link Assets.loadFromCache}.499 * Source and retrieval options for {@link Assets.loadFromCache}.
500 * @typedef {object} Assets.LoadFromCacheOptions500 * @typedef {object} Assets.LoadFromCacheOptions
501 * @property {boolean} [decompress=false] - <code>true</code> to gunzip decompress the cached data. Synonym:501 * @property {boolean} [decompress=false] - <code>true</code> to gunzip decompress the cached data. Synonym:
@@ -538,7 +538,7 @@ bool AssetScriptingInterface::canWriteCacheValue(const QUrl& url) { · 36 unmodified lines
538 return true;538 return true;
539}539}
540 540
541/**jsdoc541/*@jsdoc
542 * The data to save to the cache and cache options for {@link Assets.saveToCache}.542 * The data to save to the cache and cache options for {@link Assets.saveToCache}.
543 * @typedef {object} Assets.SaveToCacheOptions543 * @typedef {object} Assets.SaveToCacheOptions
544 * @property {string|ArrayBuffer} data - The data to save to the cache.544 * @property {string|ArrayBuffer} data - The data to save to the cache.