Showing the changes to libraries/script-engine/src/AssetScriptingInterface.cpp (1 of 220 files). Show all
Unified · Split
| @@ -102,7 +102,7 @@ void AssetScriptingInterface::setMapping(QString path, QString hash, QScriptValu · 101 unmodified lines | ||
| 102 | 102 | setMappingRequest->start(); |
| 103 | 103 | } |
| 104 | 104 | |
| 105 | −/**jsdoc | |
| 105 | +/*@jsdoc | |
| 106 | 106 | * The success or failure of an {@link Assets.downloadData} call. |
| 107 | 107 | * @typedef {object} Assets.DownloadDataError |
| 108 | 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 | 244 | jsVerify(false, "TODO: deleteAsset API"); |
| 245 | 245 | } |
| 246 | 246 | |
| 247 | −/**jsdoc | |
| 247 | +/*@jsdoc | |
| 248 | 248 | * Source and download options for {@link Assets.getAsset}. |
| 249 | 249 | * @typedef {object} Assets.GetOptions |
| 250 | 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 | 252 | * @property {Assets.ResponseType} [responseType="text"] - The desired result type. |
| 253 | 253 | * @property {string} url - The mapped path or hash to download. May have a leading <code>"atp:"</code>. |
| 254 | 254 | */ |
| 255 | −/**jsdoc | |
| 255 | +/*@jsdoc | |
| 256 | 256 | * Result value returned by {@link Assets.getAsset}. |
| 257 | 257 | * @typedef {object} Assets.GetResult |
| 258 | 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 | −/**jsdoc | |
| 323 | +/*@jsdoc | |
| 324 | 324 | * Source options for {@link Assets.resolveAsset}. |
| 325 | 325 | * @typedef {object} Assets.ResolveOptions |
| 326 | 326 | * @property {string} url - The hash or path to resolve. May have a leading <code>"atp:"</code>. |
| 327 | 327 | */ |
| 328 | −/**jsdoc | |
| 328 | +/*@jsdoc | |
| 329 | 329 | * Result value returned by {@link Assets.resolveAsset}. |
| 330 | 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 | 331 | * @typedef {object} Assets.ResolveResult |
| @@ -348,13 +348,13 @@ void AssetScriptingInterface::resolveAsset(QScriptValue options, QScriptValue sc · 16 unmodified lines | ||
| 348 | 348 | jsPromiseReady(getAssetInfo(asset), scope, callback); |
| 349 | 349 | } |
| 350 | 350 | |
| 351 | −/**jsdoc | |
| 351 | +/*@jsdoc | |
| 352 | 352 | * Content and decompression options for {@link Assets.decompressData}. |
| 353 | 353 | * @typedef {object} Assets.DecompressOptions |
| 354 | 354 | * @property {ArrayBuffer} data - The data to decompress. |
| 355 | 355 | * @property {Assets.ResponseType} [responseType=text] - The type of decompressed data to return. |
| 356 | 356 | */ |
| 357 | −/**jsdoc | |
| 357 | +/*@jsdoc | |
| 358 | 358 | * Result value returned by {@link Assets.decompressData}. |
| 359 | 359 | * @typedef {object} Assets.DecompressResult |
| 360 | 360 | * @property {number} [byteLength] - The number of bytes in the decompressed data. |
| @@ -388,7 +388,7 @@ namespace { · 27 unmodified lines | ||
| 388 | 388 | const int32_t MAX_GZIP_COMPRESSION_LEVEL = 9; |
| 389 | 389 | } |
| 390 | 390 | |
| 391 | −/**jsdoc | |
| 391 | +/*@jsdoc | |
| 392 | 392 | * Content and compression options for {@link Assets.compressData}. |
| 393 | 393 | * @typedef {object} Assets.CompressOptions |
| 394 | 394 | * @property {string|ArrayBuffer} data - The data to compress. |
| @@ -396,7 +396,7 @@ namespace { · 1 unmodified line | ||
| 396 | 396 | * use the default gzip compression level, <code>0</code> means no compression, and <code>9</code> means maximum |
| 397 | 397 | * compression. |
| 398 | 398 | */ |
| 399 | −/**jsdoc | |
| 399 | +/*@jsdoc | |
| 400 | 400 | * Result value returned by {@link Assets.compressData}. |
| 401 | 401 | * @typedef {object} Assets.CompressResult |
| 402 | 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 | 412 | jsPromiseReady(compressBytes(dataByteArray, level), scope, callback); |
| 413 | 413 | } |
| 414 | 414 | |
| 415 | −/**jsdoc | |
| 415 | +/*@jsdoc | |
| 416 | 416 | * Content and upload options for {@link Assets.putAsset}. |
| 417 | 417 | * @typedef {object} Assets.PutOptions |
| 418 | 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 | 423 | * <p>Note: The asset server destroys any unmapped SHA256-named file at server restart. Either set the mapping path |
| 424 | 424 | * with this property or use {@link Assets.setMapping} to set a path-to-hash mapping for the uploaded file.</p> |
| 425 | 425 | */ |
| 426 | −/**jsdoc | |
| 426 | +/*@jsdoc | |
| 427 | 427 | * Result value returned by {@link Assets.putAsset}. |
| 428 | 428 | * @typedef {object} Assets.PutResult |
| 429 | 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 | −/**jsdoc | |
| 486 | +/*@jsdoc | |
| 487 | 487 | * Source for {@link Assets.queryCacheMeta}. |
| 488 | 488 | * @typedef {object} Assets.QueryCacheMetaOptions |
| 489 | 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 | 495 | jsPromiseReady(Parent::queryCacheMeta(url), scope, callback); |
| 496 | 496 | } |
| 497 | 497 | |
| 498 | −/**jsdoc | |
| 498 | +/*@jsdoc | |
| 499 | 499 | * Source and retrieval options for {@link Assets.loadFromCache}. |
| 500 | 500 | * @typedef {object} Assets.LoadFromCacheOptions |
| 501 | 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 | 538 | return true; |
| 539 | 539 | } |
| 540 | 540 | |
| 541 | −/**jsdoc | |
| 541 | +/*@jsdoc | |
| 542 | 542 | * The data to save to the cache and cache options for {@link Assets.saveToCache}. |
| 543 | 543 | * @typedef {object} Assets.SaveToCacheOptions |
| 544 | 544 | * @property {string|ArrayBuffer} data - The data to save to the cache. |