Update classes' JSDoc per @hideconstructor

This commit is contained in:
David Rowe 2019-12-23 14:13:48 +13:00
parent f7336d9141
commit 2dd981493e
16 changed files with 24 additions and 5 deletions

View file

@ -110,6 +110,7 @@ using namespace InteractiveWindowEnums;
* <p>Create using {@link Desktop.createWindow}.</p>
*
* @class InteractiveWindow
* @hideconstructor
*
* @hifi-interface
* @hifi-client-entity

View file

@ -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

View file

@ -42,9 +42,10 @@ class AudioStreamStatsInterface : public QObject {
/**jsdoc
* Statistics for an audio stream.
*
* <p>Provided in the {@link AudioStats} API.</p>
* <p>Provided in properties of the {@link AudioStats} API.</p>
*
* @class AudioStats.AudioStreamStats
* @hideconstructor
*
* @hifi-interface
* @hifi-client-entity

View file

@ -18,7 +18,7 @@
/**jsdoc
* Audio effect options used by the {@link Audio} API.
*
* <p>Create using <code>new AudioEffectOptions(reverbOptions)</code>.</p>
* <p>Create using <code>new AudioEffectOptions(...)</code>.</p>
*
* @class AudioEffectOptions
* @param {AudioEffectOptions.ReverbOptions} [reverbOptions=null] - Reverberation options.

View file

@ -130,6 +130,7 @@ typedef QSharedPointer<Sound> SharedSoundPointer;
* </ul>
*
* @class SoundObject
* @hideconstructor
*
* @hifi-interface
* @hifi-client-entity

View file

@ -54,6 +54,7 @@ class UserInputMapper;
* </ul>
*
* @class MappingObject
* @hideconstructor
*
* @hifi-interface
* @hifi-client-entity

View file

@ -36,6 +36,7 @@ class ScriptingInterface;
* types.<p>
*
* @class RouteObject
* @hideconstructor
*
* @hifi-interface
* @hifi-client-entity

View file

@ -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

View file

@ -87,7 +87,6 @@ public:
* </ul>
*
* @class ScriptsModel
* @hideconstructor
*
* @hifi-interface

View file

@ -21,7 +21,7 @@
* near-complete implementation of the WebSocket API described in the Mozilla docs:
* <a href="https://developer.mozilla.org/en-US/docs/Web/API/WebSocket">https://developer.mozilla.org/en-US/docs/Web/API/WebSocket</a>.
*
* <p>Constructed by <code>new WebSocket(...)</code> in Interface, client entity, avatar, and server entity scripts, or the
* <p>Create using <code>new WebSocket(...)</code> in Interface, client entity, avatar, and server entity scripts, or the
* {@link WebSocketServer} class in server entity and assignment client scripts.
*
* <p><strong>Note:</strong> Does not support secure, <code>wss:</code> protocol.</p>

View file

@ -20,6 +20,8 @@
/**jsdoc
* Manages {@link WebSocket}s in server entity and assignment client scripts.
*
* <p>Create using <code>new WebSocketServer(...)</code>.</p>
*
* @class WebSocketServer
*
* @hifi-server-entity

View file

@ -61,6 +61,8 @@ XMlHttpRequest.getResponseHeader(QString) function
* the Mozilla docs:
* <a href="https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest">https://developer.mozilla.org/en-US/docs/Web/API/XMLHttpRequest</a>.
*
* <p>Create using <code>new XMLHttpRequest(...)</code>.</p>
*
* @class XMLHttpRequest
*
* @hifi-interface

View file

@ -688,7 +688,9 @@ using MeshPointer = std::shared_ptr<graphics::Mesh>;
/**jsdoc
* A handle for a mesh in an entity, such as returned by {@link Entities.getMeshes}.
*
* @class MeshProxy
* @hideconstructor
*
* @hifi-interface
* @hifi-client-entity

View file

@ -14,6 +14,8 @@
/**jsdoc
* A <code>OverlayWebWindow</code> displays an HTML window inside Interface.
*
* <p>Create using <code>new OverlayWebWindow(...)</code>.</p>
*
* @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

View file

@ -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.</p>
*
* <p>Create using <code>new OverlayWindow(...)</code>.</p>
*
* @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.

View file

@ -217,6 +217,7 @@ Q_DECLARE_METATYPE(TabletButtonsProxyModel*);
* <p>Retrieve an existing tablet or create a new tablet using {@link Tablet.getTablet}.</p>
*
* @class TabletProxy
* @hideconstructor
*
* @hifi-interface
* @hifi-client-entity
@ -586,6 +587,7 @@ Q_DECLARE_METATYPE(TabletProxy*);
* <p>Create a new button using {@link TabletProxy#addButton}.</p>
*
* @class TabletButtonProxy
* @hideconstructor
*
* @hifi-interface
* @hifi-client-entity