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 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.
Create using new WebSocketServer(...)
.
Create using new XMLHttpRequest(...)
.
OverlayWebWindow
displays an HTML window inside Interface.
*
+ * Create using new OverlayWebWindow(...)
.
Create using new OverlayWindow(...)
.
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 diff --git a/tools/jsdoc/hifi-jsdoc-template/tmpl/container.tmpl b/tools/jsdoc/hifi-jsdoc-template/tmpl/container.tmpl index fccf5f7d31..9a4695e21c 100644 --- a/tools/jsdoc/hifi-jsdoc-template/tmpl/container.tmpl +++ b/tools/jsdoc/hifi-jsdoc-template/tmpl/container.tmpl @@ -75,7 +75,7 @@ - +