From 68f76851fdd356089d57da43aa8e716342948b57 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Fri, 5 Apr 2019 17:10:52 +1300 Subject: [PATCH] Updates per doc review --- libraries/audio/src/Sound.h | 2 +- libraries/image/src/image/Image.h | 12 ++++++------ .../TextureCacheScriptingInterface.h | 1 + libraries/networking/src/ResourceCache.h | 6 +++--- libraries/script-engine/src/ScriptEngine.cpp | 2 +- 5 files changed, 12 insertions(+), 11 deletions(-) diff --git a/libraries/audio/src/Sound.h b/libraries/audio/src/Sound.h index 5f5fd839b4..e5ba322599 100644 --- a/libraries/audio/src/Sound.h +++ b/libraries/audio/src/Sound.h @@ -124,7 +124,7 @@ typedef QSharedPointer SharedSoundPointer; * An audio resource, created by {@link SoundCache.getSound}, to be played back using {@link Audio.playSound}. *

Supported formats:

* diff --git a/libraries/image/src/image/Image.h b/libraries/image/src/image/Image.h index 5a04e4f2a7..a992d80e94 100644 --- a/libraries/image/src/image/Image.h +++ b/libraries/image/src/image/Image.h @@ -26,7 +26,7 @@ namespace image { namespace TextureUsage { /**jsdoc - *

Signifies what type of texture a texture is.

+ *

Describes the type of texture.

*

See also: {@link Material} and * {@link https://docs.highfidelity.com/create/3d-models/pbr-materials-guide.html|PBR Materials Guide}.

* @@ -39,14 +39,14 @@ namespace TextureUsage { * * * - * - * - * + * + * + * * * - * + * * - * + * * *
2AlbedoColor for PBR.
3NormalNormal map.
4BumpBump map.
5Specular / MetallicMetallic or not.
6RoughnessRough / matte.
7GlossGloss / shine.
5Specular or metallicMetallic or not.
6RoughnessRough or matte.
7GlossGloss or shine.
8EmissiveThe amount of light reflected.
9CubeCubic image for sky boxes.
10Occlusion / ScatteringHow objects / human skin interact with light.
10Occlusion or scatteringHow objects or human skin interact with light.
11LightmapLight map.
12UnusedTexture is not used.
12UnusedTexture is not currently used.
* @typedef {number} TextureCache.TextureType diff --git a/libraries/material-networking/src/material-networking/TextureCacheScriptingInterface.h b/libraries/material-networking/src/material-networking/TextureCacheScriptingInterface.h index d74ac97762..58d2784855 100644 --- a/libraries/material-networking/src/material-networking/TextureCacheScriptingInterface.h +++ b/libraries/material-networking/src/material-networking/TextureCacheScriptingInterface.h @@ -50,6 +50,7 @@ public: /**jsdoc * Prefetches a texture resource of specific type. * @function TextureCache.prefetch + * @variation 0 * @param {string} url - The URL of the texture to prefetch. * @param {TextureCache.TextureType} type - The type of the texture. * @param {number} [maxNumPixels=67108864] - The maximum number of pixels to use for the image. If the texture has more diff --git a/libraries/networking/src/ResourceCache.h b/libraries/networking/src/ResourceCache.h index 4e255c14d2..e1f3098658 100644 --- a/libraries/networking/src/ResourceCache.h +++ b/libraries/networking/src/ResourceCache.h @@ -116,9 +116,9 @@ public: * @typedef {object} Resource.State * @property {number} QUEUED - The resource is queued up, waiting to be loaded. * @property {number} LOADING - The resource is downloading. - * @property {number} LOADED - The resource has finished downloaded but is not complete. + * @property {number} LOADED - The resource has finished downloading but is not complete. * @property {number} FINISHED - The resource has completely finished loading and is ready. - * @property {number} FAILED - Downloading the resource has failed. + * @property {number} FAILED - The resource has failed to download. */ enum State { QUEUED, @@ -325,7 +325,7 @@ public: * @function ResourceCache.getResourceList * @returns {string[]} The URLs of all resources in the cache. * @example Report cached resources. - * // Replace AnimationCache with ModelCache, SoundCache, or TextureCache as wanted. + * // Replace AnimationCache with ModelCache, SoundCache, or TextureCache as appropriate. * * var cachedResources = AnimationCache.getResourceList(); * print("Cached resources: " + JSON.stringify(cachedResources)); diff --git a/libraries/script-engine/src/ScriptEngine.cpp b/libraries/script-engine/src/ScriptEngine.cpp index c2798816c9..eba300d662 100644 --- a/libraries/script-engine/src/ScriptEngine.cpp +++ b/libraries/script-engine/src/ScriptEngine.cpp @@ -589,7 +589,7 @@ static void scriptableResourceFromScriptValue(const QScriptValue& value, Scripta * @hifi-server-entity * @hifi-assignment-client * - * @property {Resource.State} State - The possible loading states of a resource. Read-inly. + * @property {Resource.State} State - The possible loading states of a resource. Read-only. */ static QScriptValue createScriptableResourcePrototype(ScriptEnginePointer engine) { auto prototype = engine->newObject();