From 2dd981493efe541445f5dbaa17ec8538e1c81554 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Mon, 23 Dec 2019 14:13:48 +1300 Subject: [PATCH] Update classes' JSDoc per @hideconstructor --- interface/src/ui/InteractiveWindow.h | 1 + libraries/animation/src/AnimationObject.h | 4 +++- libraries/audio-client/src/AudioIOStats.h | 3 ++- libraries/audio/src/AudioEffectOptions.h | 2 +- libraries/audio/src/Sound.h | 1 + .../controllers/src/controllers/impl/MappingBuilderProxy.h | 1 + .../controllers/src/controllers/impl/RouteBuilderProxy.h | 1 + libraries/networking/src/ResourceCache.h | 1 + libraries/script-engine/src/ScriptsModel.h | 1 - libraries/script-engine/src/WebSocketClass.h | 2 +- libraries/script-engine/src/WebSocketServerClass.h | 2 ++ libraries/script-engine/src/XMLHttpRequestClass.h | 2 ++ libraries/shared/src/RegisteredMetaTypes.h | 2 ++ libraries/ui/src/QmlWebWindowClass.h | 2 ++ libraries/ui/src/QmlWindowClass.h | 2 ++ libraries/ui/src/ui/TabletScriptingInterface.h | 2 ++ 16 files changed, 24 insertions(+), 5 deletions(-) diff --git a/interface/src/ui/InteractiveWindow.h b/interface/src/ui/InteractiveWindow.h index 56060f5c27..1198ce8ee9 100644 --- a/interface/src/ui/InteractiveWindow.h +++ b/interface/src/ui/InteractiveWindow.h @@ -110,6 +110,7 @@ using namespace InteractiveWindowEnums; *

Create using {@link Desktop.createWindow}.

* * @class InteractiveWindow + * @hideconstructor * * @hifi-interface * @hifi-client-entity diff --git a/libraries/animation/src/AnimationObject.h b/libraries/animation/src/AnimationObject.h index 303d0e0d9e..40fd534a71 100644 --- a/libraries/animation/src/AnimationObject.h +++ b/libraries/animation/src/AnimationObject.h @@ -23,6 +23,7 @@ class QScriptEngine; * Information about an animation resource, created by {@link AnimationCache.getAnimation}. * * @class AnimationObject + * @hideconstructor * * @hifi-interface * @hifi-client-entity @@ -57,9 +58,10 @@ public: }; /**jsdoc - * Joint rotations in one frame of an animation. + * Joint rotations in one frame of an {@link AnimationObject}. * * @class AnimationFrameObject + * @hideconstructor * * @hifi-interface * @hifi-client-entity diff --git a/libraries/audio-client/src/AudioIOStats.h b/libraries/audio-client/src/AudioIOStats.h index 26ea301eaa..9265ae3062 100644 --- a/libraries/audio-client/src/AudioIOStats.h +++ b/libraries/audio-client/src/AudioIOStats.h @@ -42,9 +42,10 @@ class AudioStreamStatsInterface : public QObject { /**jsdoc * Statistics for an audio stream. * - *

Provided in the {@link AudioStats} API.

+ *

Provided in properties of the {@link AudioStats} API.

* * @class AudioStats.AudioStreamStats + * @hideconstructor * * @hifi-interface * @hifi-client-entity diff --git a/libraries/audio/src/AudioEffectOptions.h b/libraries/audio/src/AudioEffectOptions.h index e090832510..48fe44feb5 100644 --- a/libraries/audio/src/AudioEffectOptions.h +++ b/libraries/audio/src/AudioEffectOptions.h @@ -18,7 +18,7 @@ /**jsdoc * Audio effect options used by the {@link Audio} API. * - *

Create using new AudioEffectOptions(reverbOptions).

+ *

Create using new AudioEffectOptions(...).

* * @class AudioEffectOptions * @param {AudioEffectOptions.ReverbOptions} [reverbOptions=null] - Reverberation options. diff --git a/libraries/audio/src/Sound.h b/libraries/audio/src/Sound.h index 62fdb9dcdc..205e1cba33 100644 --- a/libraries/audio/src/Sound.h +++ b/libraries/audio/src/Sound.h @@ -130,6 +130,7 @@ typedef QSharedPointer SharedSoundPointer; * * * @class SoundObject + * @hideconstructor * * @hifi-interface * @hifi-client-entity diff --git a/libraries/controllers/src/controllers/impl/MappingBuilderProxy.h b/libraries/controllers/src/controllers/impl/MappingBuilderProxy.h index 5a8fd3083d..9dafc03f1f 100644 --- a/libraries/controllers/src/controllers/impl/MappingBuilderProxy.h +++ b/libraries/controllers/src/controllers/impl/MappingBuilderProxy.h @@ -54,6 +54,7 @@ class UserInputMapper; * * * @class MappingObject + * @hideconstructor * * @hifi-interface * @hifi-client-entity diff --git a/libraries/controllers/src/controllers/impl/RouteBuilderProxy.h b/libraries/controllers/src/controllers/impl/RouteBuilderProxy.h index f1b36cfec5..38b18346a8 100644 --- a/libraries/controllers/src/controllers/impl/RouteBuilderProxy.h +++ b/libraries/controllers/src/controllers/impl/RouteBuilderProxy.h @@ -36,6 +36,7 @@ class ScriptingInterface; * types.

* * @class RouteObject + * @hideconstructor * * @hifi-interface * @hifi-client-entity diff --git a/libraries/networking/src/ResourceCache.h b/libraries/networking/src/ResourceCache.h index ddc750664f..35261298b9 100644 --- a/libraries/networking/src/ResourceCache.h +++ b/libraries/networking/src/ResourceCache.h @@ -95,6 +95,7 @@ class ScriptableResource : public QObject { * {@link ModelCache.prefetch}, {@link SoundCache.prefetch}, or {@link TextureCache.prefetch}. * * @class ResourceObject + * @hideconstructor * * @hifi-interface * @hifi-client-entity diff --git a/libraries/script-engine/src/ScriptsModel.h b/libraries/script-engine/src/ScriptsModel.h index bd6c9687c1..0412bbf0fe 100644 --- a/libraries/script-engine/src/ScriptsModel.h +++ b/libraries/script-engine/src/ScriptsModel.h @@ -87,7 +87,6 @@ public: * * * @class ScriptsModel - * @hideconstructor * * @hifi-interface diff --git a/libraries/script-engine/src/WebSocketClass.h b/libraries/script-engine/src/WebSocketClass.h index c181965bf7..543f6146a6 100644 --- a/libraries/script-engine/src/WebSocketClass.h +++ b/libraries/script-engine/src/WebSocketClass.h @@ -21,7 +21,7 @@ * near-complete implementation of the WebSocket API described in the Mozilla docs: * https://developer.mozilla.org/en-US/docs/Web/API/WebSocket. * - *

Constructed by new WebSocket(...) in Interface, client entity, avatar, and server entity scripts, or the + *

Create using new WebSocket(...) in Interface, client entity, avatar, and server entity scripts, or the * {@link WebSocketServer} class in server entity and assignment client scripts. * *

Note: Does not support secure, wss: protocol.

diff --git a/libraries/script-engine/src/WebSocketServerClass.h b/libraries/script-engine/src/WebSocketServerClass.h index dfd277fec1..fff33d5bfb 100644 --- a/libraries/script-engine/src/WebSocketServerClass.h +++ b/libraries/script-engine/src/WebSocketServerClass.h @@ -20,6 +20,8 @@ /**jsdoc * Manages {@link WebSocket}s in server entity and assignment client scripts. * + *

Create using new WebSocketServer(...).

+ * * @class WebSocketServer * * @hifi-server-entity diff --git a/libraries/script-engine/src/XMLHttpRequestClass.h b/libraries/script-engine/src/XMLHttpRequestClass.h index cb86cafb67..3ab7d38dda 100644 --- a/libraries/script-engine/src/XMLHttpRequestClass.h +++ b/libraries/script-engine/src/XMLHttpRequestClass.h @@ -61,6 +61,8 @@ XMlHttpRequest.getResponseHeader(QString) function * the Mozilla docs: * https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest. * + *

Create using new XMLHttpRequest(...).

+ * * @class XMLHttpRequest * * @hifi-interface diff --git a/libraries/shared/src/RegisteredMetaTypes.h b/libraries/shared/src/RegisteredMetaTypes.h index 3b47bb70c6..c4a724c13a 100644 --- a/libraries/shared/src/RegisteredMetaTypes.h +++ b/libraries/shared/src/RegisteredMetaTypes.h @@ -688,7 +688,9 @@ using MeshPointer = std::shared_ptr; /**jsdoc * A handle for a mesh in an entity, such as returned by {@link Entities.getMeshes}. + * * @class MeshProxy + * @hideconstructor * * @hifi-interface * @hifi-client-entity diff --git a/libraries/ui/src/QmlWebWindowClass.h b/libraries/ui/src/QmlWebWindowClass.h index 3ca6418195..2c1a5eabbb 100644 --- a/libraries/ui/src/QmlWebWindowClass.h +++ b/libraries/ui/src/QmlWebWindowClass.h @@ -14,6 +14,8 @@ /**jsdoc * A OverlayWebWindow displays an HTML window inside Interface. * + *

Create using new OverlayWebWindow(...).

+ * * @class OverlayWebWindow * @param {string|OverlayWindow.Properties} [titleOrProperties="WebWindow"] - The window's title or initial property values. * @param {string} [source="about:blank"] - The URL of the HTML to display. Not used unless the first parameter is the window diff --git a/libraries/ui/src/QmlWindowClass.h b/libraries/ui/src/QmlWindowClass.h index ef9d1a8771..3a2f202bd3 100644 --- a/libraries/ui/src/QmlWindowClass.h +++ b/libraries/ui/src/QmlWindowClass.h @@ -26,6 +26,8 @@ class QScriptContext; * control is defined by a "WebView.qml" file included in the Interface install.) Alternatively, an {@link OverlayWebWindow} * can be used for HTML-based windows.

* + *

Create using new OverlayWindow(...).

+ * * @class OverlayWindow * @param {string|OverlayWindow.Properties} [titleOrProperties="WebWindow"] - The window's title or initial property values. * @param {string} [source] - The source of the QML to display. Not used unless the first parameter is the window title. diff --git a/libraries/ui/src/ui/TabletScriptingInterface.h b/libraries/ui/src/ui/TabletScriptingInterface.h index 04222b3ea1..c063307597 100644 --- a/libraries/ui/src/ui/TabletScriptingInterface.h +++ b/libraries/ui/src/ui/TabletScriptingInterface.h @@ -217,6 +217,7 @@ Q_DECLARE_METATYPE(TabletButtonsProxyModel*); *

Retrieve an existing tablet or create a new tablet using {@link Tablet.getTablet}.

* * @class TabletProxy + * @hideconstructor * * @hifi-interface * @hifi-client-entity @@ -586,6 +587,7 @@ Q_DECLARE_METATYPE(TabletProxy*); *

Create a new button using {@link TabletProxy#addButton}.

* * @class TabletButtonProxy + * @hideconstructor * * @hifi-interface * @hifi-client-entity