From 06ebba554e0e6fee5f6ba84be6756c36f42116e1 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Thu, 5 Sep 2019 12:23:12 +1200 Subject: [PATCH] Doc review --- libraries/script-engine/src/AssetScriptingInterface.h | 9 ++++----- 1 file changed, 4 insertions(+), 5 deletions(-) diff --git a/libraries/script-engine/src/AssetScriptingInterface.h b/libraries/script-engine/src/AssetScriptingInterface.h index c4c7940a80..325e177964 100644 --- a/libraries/script-engine/src/AssetScriptingInterface.h +++ b/libraries/script-engine/src/AssetScriptingInterface.h @@ -26,12 +26,11 @@ /**jsdoc * The Assets API provides facilities for interacting with the domain's asset server and the client cache. - * cache. *

Assets are stored in the asset server in files with SHA256 names. These files are mapped to user-friendly URLs of the * format: atp:/path/filename. The assets may optionally be baked, in which case a request for the original * unbaked version of the asset is automatically redirected to the baked version. The asset data may optionally be stored as * compressed.

- *

The client cache can be access directly, using "atp:" "cache:" URLs. Interface, avatar, and + *

The client cache can be access directly, using "atp:" or "cache:" URLs. Interface, avatar, and * assignment client scripts can write to the cache. All script types can read from the cache.

* * @namespace Assets @@ -82,7 +81,7 @@ public: * @param {Assets.DownloadDataError} error - The success or failure of the download. */ /**jsdoc - * Downloads content from the asset server, form a SHA256-named file. + * Downloads content from the asset server, from a SHA256-named file. * @function Assets.downloadData * @param {string} url - The raw URL of asset to download: atp: followed by the assets's SHA256 hash. * @param {Assets~downloadDataCallback} callback - The function to call upon completion. @@ -93,7 +92,7 @@ public: * Assets.uploadData("Hello world!", function (url, hash) { * assetURL = url; * print("url: " + assetURL); // atp:a0g89... - * Assets.setMapping("/assetsExamples/hellowWorld.txt", hash, function (error) { + * Assets.setMapping("/assetsExamples/helloWorld.txt", hash, function (error) { * if (error) { * print("ERROR: Could not set mapping!"); * return; @@ -229,7 +228,7 @@ public: * @param {Assets.PutResult} result - Information on the content uploaded. */ /**jsdoc - * Uploads content to the assert server and sets a path-to-hash mapping. + * Uploads content to the asset server and sets a path-to-hash mapping. * @function Assets.putAsset * @param {string|Assets.PutOptions} options - The content to upload and upload options. If a string, the value of the * string is uploaded but a path-to-hash mapping is not set.