Merge branch 'DOC-68' into api-docs

# Conflicts: # libraries/shared/src/RegisteredMetaTypes.h
hifi-archive · Jan 14, 2020 · b9a1b78 · b9a1b78
2 parents 3e1c76e + 2dd9814
commit b9a1b78
Show file tree

Hide file tree

Showing 18 changed files with 25 additions and 7 deletions.
diff --git a/interface/src/ui/InteractiveWindow.h b/interface/src/ui/InteractiveWindow.h
@@ -110,6 +110,7 @@ using namespace InteractiveWindowEnums;
  * <p>Create using {@link Desktop.createWindow}.</p>
  *
  * @class InteractiveWindow
+ * @hideconstructor
  *
  * @hifi-interface
  * @hifi-client-entity

diff --git 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 @@ class AnimationObject : public QObject, protected QScriptable {
 };
 
 /**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
@@ -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

diff --git 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.
  *
- * <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.

diff --git a/libraries/audio/src/Sound.h b/libraries/audio/src/Sound.h
@@ -130,6 +130,7 @@ typedef QSharedPointer<Sound> SharedSoundPointer;
  * </ul>
  *
  * @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
@@ -54,6 +54,7 @@ class UserInputMapper;
  * </ul>
  *
  * @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
@@ -36,6 +36,7 @@ class ScriptingInterface;
  * types.<p>
  *
  * @class RouteObject
+ * @hideconstructor
  *
  * @hifi-interface
  * @hifi-client-entity

diff --git 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
@@ -87,7 +87,6 @@ class TreeNodeFolder : public TreeNodeBase {
  * </ul>
  *
  * @class ScriptsModel
-
  * @hideconstructor
  *
  * @hifi-interface

diff --git 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: 
  * <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>

diff --git 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.
  *
+ * <p>Create using <code>new WebSocketServer(...)</code>.</p>
+ *
  * @class WebSocketServer
  *
  * @hifi-server-entity

diff --git 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:
  * <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

diff --git a/libraries/shared/src/RegisteredMetaTypes.h b/libraries/shared/src/RegisteredMetaTypes.h
@@ -690,6 +690,7 @@ using MeshPointer = std::shared_ptr<graphics::Mesh>;
  * A mesh, such as returned by {@link Entities.getMeshes} or {@link Model} API functions.
  *
  * @class MeshProxy
+ * @hideconstructor
  *
  * @hifi-interface
  * @hifi-client-entity

diff --git a/libraries/ui/src/QmlWebWindowClass.h b/libraries/ui/src/QmlWebWindowClass.h
@@ -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 

diff --git 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.</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.

diff --git a/libraries/ui/src/ui/TabletScriptingInterface.h b/libraries/ui/src/ui/TabletScriptingInterface.h
@@ -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

diff --git a/tools/jsdoc/hifi-jsdoc-template/tmpl/container.tmpl b/tools/jsdoc/hifi-jsdoc-template/tmpl/container.tmpl
@@ -75,7 +75,7 @@
                 <?js doc.modules.forEach(function(module) { ?>
                     <?js= self.partial('methodList.tmpl', module) ?>
                 <?js }) ?>
-            <?js } else if (doc.kind === 'class' || (doc.kind === 'namespace' && doc.signature)) { ?>
+            <?js } else if ((doc.kind === 'class' && !doc.hideconstructor) || (doc.kind === 'namespace' && doc.signature)) { ?>
                 <h3>Description</h3>
                 <div><?js= doc.description ?></div>
                 <?js= self.partial('details.tmpl', doc) ?>

diff --git a/tools/jsdoc/hifi-jsdoc-template/tmpl/details.tmpl b/tools/jsdoc/hifi-jsdoc-template/tmpl/details.tmpl
@@ -19,7 +19,7 @@ if (data.defaultvalue && (data.defaultvaluetype === 'object' || data.defaultvalu
 
 <?js
     var properties = data.properties;
-    if (properties && properties.length && properties.forEach && !data.hideconstructor) {
+    if (properties && properties.length && properties.forEach) {
 ?>
 
     <h3 class="propsHeading" id="props">Properties</h3>