List which contexts each namespace and object is available in

interface/src/AvatarBookmarks.h

@@ -18,6 +18,10 @@
 /**jsdoc 
  * This API helps manage adding and deleting avatar bookmarks.
  * @namespace AvatarBookmarks
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ *
  */
 
 class AvatarBookmarks: public Bookmarks, public  Dependency {

interface/src/LODManager.h

@@ -10,8 +10,11 @@
 //
 
 /**jsdoc
- * The LOD class manages your Level of Detail functions within interface
+ * The LODManager API manages your Level of Detail functions within interface.
  * @namespace LODManager 
+ *
+ * @hifi-interface
+ * @hifi-client-entity
  */
 
 #ifndef hifi_LODManager_h

interface/src/SpeechRecognizer.h

@@ -24,6 +24,9 @@
 
 /**jsdoc
  * @namespace SpeechRecognizer
+ *
+ * @hifi-interface
+ * @hifi-client-entity
  */
 class SpeechRecognizer : public QObject, public Dependency {
     Q_OBJECT

interface/src/audio/AudioScope.h

@@ -28,6 +28,10 @@ class AudioScope : public QObject, public Dependency {
     /**jsdoc
      * The AudioScope API helps control the Audio Scope features in Interface
      * @namespace AudioScope
+     *
+     * @hifi-interface
+     * @hifi-client-entity
+     *
      * @property {number} scopeInput <em>Read-only.</em>
      * @property {number} scopeOutputLeft <em>Read-only.</em>
      * @property {number} scopeOutputRight <em>Read-only.</em>

interface/src/avatar/AvatarManager.h

@@ -30,6 +30,9 @@
 /**jsdoc 
  * The AvatarManager API has properties and methods which manage Avatars within the same domain.
  * @namespace AvatarManager
+ *
+ * @hifi-interface
+ * @hifi-client-entity
  */
 
 class AvatarManager : public AvatarHashMap {

interface/src/devices/DdeFaceTracker.h

@@ -29,6 +29,9 @@
 /**jsdoc 
  * The FaceTracker API helps manage facial tracking hardware. 
  * @namespace FaceTracker
+ *
+ * @hifi-interface
+ * @hifi-client-entity
  */
 
 class DdeFaceTracker : public FaceTracker, public Dependency {

interface/src/raypick/PickScriptingInterface.h

@@ -18,6 +18,10 @@
  * The Picks API lets you create and manage objects for repeatedly calculating intersections in different ways.
  *
  * @namespace Picks
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ *
  * @property PICK_NOTHING {number} A filter flag.  Don't intersect with anything.
  * @property PICK_ENTITIES {number} A filter flag.  Include entities when intersecting.
  * @property PICK_OVERLAYS {number} A filter flag.  Include overlays when intersecting.

interface/src/raypick/PointerScriptingInterface.h

@@ -19,6 +19,9 @@
  *  Pointers can also be configured to automatically generate PointerEvents.
  *
  * @namespace Pointers
+ *
+ * @hifi-interface
+ * @hifi-client-entity
  */
 
 class PointerScriptingInterface : public QObject, public Dependency {

interface/src/scripting/AccountServicesScriptingInterface.h

@@ -38,6 +38,9 @@ class AccountServicesScriptingInterface : public QObject {
     /**jsdoc
      * The AccountServices API contains helper functions related to user connectivity
      * 
+     * @hifi-interface
+     * @hifi-client-entity
+     *
      * @namespace AccountServices
      * @property {string} username <em>Read-only.</em>
      * @property {boolean} loggedIn <em>Read-only.</em>

interface/src/scripting/Audio.h

@@ -29,6 +29,12 @@ class Audio : public AudioScriptingInterface, protected ReadWriteLockable {
      * The Audio API features tools to help control audio contexts and settings.
      *
      * @namespace Audio
+     *
+     * @hifi-interface
+     * @hifi-client-entity
+     * @hifi-server-entity
+     * @hifi-assignment-client
+     *
      * @property {boolean} muted
      * @property {boolean} noiseReduction
      * @property {number} inputVolume

interface/src/scripting/ClipboardScriptingInterface.h

@@ -21,6 +21,9 @@
  * The Clipboard API enables you to export and import entities to and from JSON files.
  *
  * @namespace Clipboard
+ *
+ * @hifi-interface
+ * @hifi-client-entity
  */
 class ClipboardScriptingInterface : public QObject {
     Q_OBJECT

interface/src/scripting/ControllerScriptingInterface.h

@@ -145,6 +145,9 @@ class ScriptEngine;
  *
  * @namespace Controller
  *
+ * @hifi-interface
+ * @hifi-client-entity
+ *
  * @property {Controller.Actions} Actions - Predefined actions on Interface and the user's avatar. These can be used as end
  *     points in a {@link RouteObject} mapping. A synonym for <code>Controller.Hardware.Actions</code>.
  *     <em>Read-only.</em><br />

interface/src/scripting/GooglePolyScriptingInterface.h

@@ -18,6 +18,9 @@
 /**jsdoc 
  * The GooglePoly API allows you to interact with Google Poly models direct from inside High Fidelity.
  * @namespace GooglePoly
+ *
+ * @hifi-interface
+ * @hifi-client-entity
  */
 
 class GooglePolyScriptingInterface : public QObject, public Dependency {

interface/src/scripting/HMDScriptingInterface.h

@@ -28,6 +28,10 @@ class QScriptEngine;
  * The HMD API provides access to the HMD used in VR display mode.
  *
  * @namespace HMD
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ *
  * @property {Vec3} position - The position of the HMD if currently in VR display mode, otherwise
  *     {@link Vec3(0)|Vec3.ZERO}. <em>Read-only.</em>
  * @property {Quat} orientation - The orientation of the HMD if currently in VR display mode, otherwise 

interface/src/scripting/MenuScriptingInterface.h

@@ -32,6 +32,9 @@ class MenuItemProperties;
  * If a menu item doesn't belong to a group it is always displayed.
  *
  * @namespace Menu
+ *
+ * @hifi-interface
+ * @hifi-client-entity
  */
 
 /**

interface/src/scripting/SelectionScriptingInterface.h

@@ -86,6 +86,9 @@ protected:
  * The <code>Selection</code> API provides a means of grouping together avatars, entities, and overlays in named lists.
  * @namespace Selection
  *
+ * @hifi-interface
+ * @hifi-client-entity
+ *
  * @example <caption>Outline an entity when it is grabbed by a controller.</caption>
  * // Create a box and copy the following text into the entity's "Script URL" field.
  * (function () {

interface/src/scripting/SettingsScriptingInterface.h

@@ -18,6 +18,9 @@
 /**jsdoc
  * The Settings API provides a facility to store and retrieve values that persist between Interface runs.
  * @namespace Settings
+ *
+ * @hifi-interface
+ * @hifi-client-entity
  */
 
 class SettingsScriptingInterface : public QObject {

interface/src/scripting/WindowScriptingInterface.h

@@ -28,6 +28,10 @@
  * physics.
  *
  * @namespace Window
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ *
  * @property {number} innerWidth - The width of the drawable area of the Interface window (i.e., without borders or other
  *     chrome), in pixels. <em>Read-only.</em>
  * @property {number} innerHeight - The height of the drawable area of the Interface window (i.e., without borders or other

interface/src/ui/AvatarInputs.h

@@ -26,6 +26,10 @@ class AvatarInputs : public QObject {
     /**jsdoc 
      * API to help manage your Avatar's input
      * @namespace AvatarInputs
+     *
+     * @hifi-interface
+     * @hifi-client-entity
+     *
      * @property {boolean} cameraEnabled <em>Read-only.</em>
      * @property {boolean} cameraMuted <em>Read-only.</em>
      * @property {boolean} isHMD <em>Read-only.</em>

interface/src/ui/overlays/ContextOverlayInterface.h

@@ -31,9 +31,6 @@
 #include "EntityTree.h"
 #include "ContextOverlayLogging.h"
 
-/**jsdoc
-* @namespace ContextOverlay
-*/
 class ContextOverlayInterface : public QObject, public Dependency {
     Q_OBJECT
 

interface/src/ui/overlays/Overlays.h

@@ -76,6 +76,10 @@ void RayToOverlayIntersectionResultFromScriptValue(const QScriptValue& object, R
  * The Overlays API provides facilities to create and interact with overlays. Overlays are 2D and 3D objects visible only to
  * yourself and that aren't persisted to the domain. They are used for UI.
  * @namespace Overlays
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ *
  * @property {Uuid} keyboardFocusOverlay - Get or set the {@link Overlays.OverlayType|web3d} overlay that has keyboard focus.
  *     If no overlay has keyboard focus, get returns <code>null</code>; set to <code>null</code> or {@link Uuid|Uuid.NULL} to 
  *     clear keyboard focus.

libraries/animation/src/AnimationCache.h

@@ -37,6 +37,10 @@ public:
      * API to manage animation cache resources.
      * @namespace AnimationCache
      *
+     * @hifi-interface
+     * @hifi-client-entity
+     * @hifi-assignment-client
+     *
      * @property {number} numTotal - Total number of total resources. <em>Read-only.</em>
      * @property {number} numCached - Total number of cached resource. <em>Read-only.</em>
      * @property {number} sizeTotal - Size in bytes of all resources. <em>Read-only.</em>

libraries/audio-client/src/AudioIOStats.h

@@ -41,6 +41,10 @@ class AudioStreamStatsInterface : public QObject {
 
     /**jsdoc
      * @class AudioStats.AudioStreamStats
+     *
+     * @hifi-interface
+     * @hifi-client-entity
+     *
      * @property {number} lossRate <em>Read-only.</em>
      * @property {number} lossCount <em>Read-only.</em>
      * @property {number} lossRateWindow <em>Read-only.</em>
@@ -185,6 +189,10 @@ class AudioStatsInterface : public QObject {
     /**jsdoc
      * Audio stats from the client.
      * @namespace AudioStats
+     *
+     * @hifi-interface
+     * @hifi-client-entity
+     *
      * @property {number} pingMs <em>Read-only.</em>
      * @property {number} inputReadMsMax <em>Read-only.</em>
      * @property {number} inputUnplayedMsMax <em>Read-only.</em>

libraries/audio/src/SoundCache.h

@@ -29,6 +29,11 @@ public:
      * API to manage sound cache resources.
      * @namespace SoundCache
      *
+     * @hifi-interface
+     * @hifi-client-entity
+     * @hifi-server-entity
+     * @hifi-assignment-client
+     *
      * @property {number} numTotal - Total number of total resources. <em>Read-only.</em>
      * @property {number} numCached - Total number of cached resource. <em>Read-only.</em>
      * @property {number} sizeTotal - Size in bytes of all resources. <em>Read-only.</em>

libraries/controllers/src/controllers/impl/MappingBuilderProxy.h

@@ -49,9 +49,12 @@ class UserInputMapper;
  *     output that already has a route the new route is ignored.</li>
  *     <li>New mappings override previous mappings: each output is processed using the route in the most recently enabled 
  *     mapping that contains that output.</li>
- * </p>
+ * </ul>
  *
  * @class MappingObject
+ *
+ * @hifi-interface
+ * @hifi-client-entity
  */
 
 /**jsdoc

libraries/controllers/src/controllers/impl/RouteBuilderProxy.h

@@ -35,6 +35,9 @@ class ScriptingInterface;
  * types.<p>
  *
  * @class RouteObject
+ *
+ * @hifi-interface
+ * @hifi-client-entity
  */
 
 // TODO migrate functionality to a RouteBuilder class and make the proxy defer to that 

libraries/display-plugins/src/display-plugins/CompositorHelper.h

@@ -174,6 +174,10 @@ private:
 
 /**jsdoc
  * @namespace Reticle
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ *
  * @property {boolean} allowMouseCapture
  * @property {number} depth
  * @property {Vec2} maximumPosition

libraries/entities/src/EntityScriptingInterface.h

@@ -94,6 +94,12 @@ void RayToEntityIntersectionResultFromScriptValue(const QScriptValue& object, Ra
  * Interface has displayed and so knows about.
  *
  * @namespace Entities
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-server-entity
+ * @hifi-assignment-client
+ *
  * @property {Uuid} keyboardFocusEntity - Get or set the {@link Entities.EntityType|Web} entity that has keyboard focus.
  *     If no entity has keyboard focus, get returns <code>null</code>; set to <code>null</code> or {@link Uuid|Uuid.NULL} to 
  *     clear keyboard focus.

libraries/graphics-scripting/src/graphics-scripting/GraphicsScriptingInterface.h

@@ -24,6 +24,9 @@
 /**jsdoc
  * The experimental Graphics API <em>(experimental)</em> lets you query and manage certain graphics-related structures (like underlying meshes and textures) from scripting.
  * @namespace Graphics
+ *
+ * @hifi-interface
+ * @hifi-client-entity
  */
 
 class GraphicsScriptingInterface : public QObject, public QScriptable, public Dependency {

libraries/model-networking/src/model-networking/ModelCache.h

@@ -144,6 +144,9 @@ public:
      * API to manage model cache resources.
      * @namespace ModelCache
      *
+     * @hifi-interface
+     * @hifi-client-entity
+     *
      * @property {number} numTotal - Total number of total resources. <em>Read-only.</em>
      * @property {number} numCached - Total number of cached resource. <em>Read-only.</em>
      * @property {number} sizeTotal - Size in bytes of all resources. <em>Read-only.</em>

libraries/model-networking/src/model-networking/TextureCache.h

@@ -151,6 +151,9 @@ public:
     * API to manage texture cache resources.
     * @namespace TextureCache
     *
+    * @hifi-interface
+    * @hifi-client-entity
+    *
     * @property {number} numTotal - Total number of total resources. <em>Read-only.</em>
     * @property {number} numCached - Total number of cached resource. <em>Read-only.</em>
     * @property {number} sizeTotal - Size in bytes of all resources. <em>Read-only.</em>

libraries/networking/src/AddressManager.h

@@ -33,6 +33,11 @@ const QString GET_PLACE = "/api/v1/places/%1";
  * The location API provides facilities related to your current location in the metaverse.
  *
  * @namespace location
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-assignment-client
+ *
  * @property {Uuid} domainID - A UUID uniquely identifying the domain you're visiting. Is {@link Uuid|Uuid.NULL} if you're not
  *     connected to the domain or are in a serverless domain.
  *     <em>Read-only.</em>

libraries/networking/src/MessagesClient.h

@@ -37,6 +37,11 @@
  * </ul>
  *
  * @namespace Messages
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-server-entity
+ * @hifi-assignment-client
  */
 class MessagesClient : public QObject, public Dependency {
     Q_OBJECT

libraries/networking/src/ResourceCache.h

@@ -89,6 +89,12 @@ class ScriptableResource : public QObject {
 
     /**jsdoc
      * @constructor Resource
+     *
+     * @hifi-interface
+     * @hifi-client-entity
+     * @hifi-server-entity
+     * @hifi-assignment-client
+     *
      * @property {string} url - URL of this resource.
      * @property {Resource.State} state - Current loading state.
      */

libraries/script-engine/src/AssetScriptingInterface.h

@@ -27,6 +27,11 @@
 /**jsdoc
  * The Assets API allows you to communicate with the Asset Browser.
  * @namespace Assets
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-server-entity
+ * @hifi-assignment-client
  */
 class AssetScriptingInterface : public BaseAssetScriptingInterface, QScriptable {
     Q_OBJECT

libraries/script-engine/src/Quat.h

@@ -35,6 +35,12 @@
  * of gimbal lock.
  * @namespace Quat
  * @variation 0
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-server-entity
+ * @hifi-assignment-client
+ *
  * @property IDENTITY {Quat} <code>{ x: 0, y: 0, z: 0, w: 1 }</code> : The identity rotation, i.e., no rotation.
  *     <em>Read-only.</em>
  * @example <caption>Print the <code>IDENTITY</code> value.</caption>

libraries/script-engine/src/RecordingScriptingInterface.h

@@ -25,6 +25,10 @@ class QScriptValue;
 
 /**jsdoc
  * @namespace Recording
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-assignment-client
  */
 class RecordingScriptingInterface : public QObject, public Dependency {
     Q_OBJECT

libraries/script-engine/src/SceneScriptingInterface.h

@@ -112,6 +112,10 @@ namespace SceneScripting {
     
     /**jsdoc
      * @class Scene.Stage
+     *
+     * @hifi-interface
+     * @hifi-client-entity
+     *
      * @property {string} backgroundMode
      * @property {Scene.Stage.KeyLight} keyLight
      * @property {Scene.Stage.Location} location
@@ -171,6 +175,10 @@ namespace SceneScripting {
 
 /**jsdoc
  * @namespace Scene
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ *
  * @property {boolean} shouldRenderAvatars
  * @property {boolean} shouldRenderEntities
  * @property {Scene.Stage} stage

libraries/script-engine/src/ScriptEngine.h

@@ -89,6 +89,12 @@ public:
 
 /**jsdoc
  * @namespace Script
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-server-entity
+ * @hifi-assignment-client
+ *
  * @property {string} context
  */
 class ScriptEngine : public BaseScriptEngine, public EntitiesScriptEngineProvider {

libraries/script-engine/src/ScriptEngines.h

@@ -29,6 +29,10 @@ class ScriptEngine;
 
 /**jsdoc
  * @namespace ScriptDiscoveryService
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ *
  * @property {string} debugScriptUrl
  * @property {string} defaultScriptsPath
  * @property {ScriptsModel} scriptsModel

libraries/script-engine/src/ScriptUUID.h

@@ -23,6 +23,12 @@
  * hexadecimal digits.
  *
  * @namespace Uuid
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-server-entity
+ * @hifi-assignment-client
+ *
  * @property NULL {Uuid} The null UUID, <code>{00000000-0000-0000-0000-000000000000}</code>.
  */
 

libraries/script-engine/src/ScriptsModel.h

@@ -68,6 +68,9 @@ public:
  * <p>Has properties and functions below in addition to those of <a href="http://doc.qt.io/qt-5/qabstractitemmodel.html">
  * http://doc.qt.io/qt-5/qabstractitemmodel.html</a>.</p>
  * @class ScriptsModel
+ *
+ * @hifi-interface
+ * @hifi-client-entity
  */
 class ScriptsModel : public QAbstractItemModel {
     Q_OBJECT

libraries/script-engine/src/ScriptsModelFilter.h

@@ -20,6 +20,9 @@
  * <p>Has properties and functions per <a href="http://doc.qt.io/qt-5/qsortfilterproxymodel.html">
  * http://doc.qt.io/qt-5/qsortfilterproxymodel.html</a>.</p>
  * @class ScriptsModelFilter
+ *
+ * @hifi-interface
+ * @hifi-client-entity
  */
 class ScriptsModelFilter : public QSortFilterProxyModel {
     Q_OBJECT

libraries/script-engine/src/UsersScriptingInterface.h

@@ -18,6 +18,11 @@
 
 /**jsdoc
  * @namespace Users
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-assignment-client
+ *
  * @property {boolean} canKick - <code>true</code> if the domain server allows the node or avatar to kick (ban) avatars,
  *     otherwise <code>false</code>. <em>Read-only.</em>
  * @property {boolean} requestsDomainListData - <code>true</code> if the avatar requests extra data from the mixers (such as 

libraries/script-engine/src/Vec3.h

@@ -47,6 +47,12 @@
  *
  * @namespace Vec3
  * @variation 0
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-server-entity
+ * @hifi-assignment-client
+ *
  * @property {Vec3} UNIT_X - <code>{ x: 1, y: 0, z: 0 }</code> : Unit vector in the x-axis direction. <em>Read-only.</em>
  * @property {Vec3} UNIT_Y - <code>{ x: 0, y: 1, z: 0 }</code> : Unit vector in the y-axis direction. <em>Read-only.</em>
  * @property {Vec3} UNIT_Z - <code>{ x: 0, y: 0, z: 1 }</code> : Unit vector in the z-axis direction. <em>Read-only.</em>

libraries/shared/src/DebugDraw.h

@@ -25,6 +25,11 @@
  * Helper functions to render ephemeral debug markers and lines.
  * DebugDraw markers and lines are only visible locally, they are not visible by other users.
  * @namespace DebugDraw
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-server-entity
+ * @hifi-assignment-client
  */
 class DebugDraw : public QObject {
     Q_OBJECT

libraries/shared/src/PathUtils.h

@@ -22,6 +22,10 @@
  * The Paths API provides absolute paths to the scripts and resources directories.
  *
  * @namespace Paths
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ *
  * @deprecated The Paths API is deprecated. Use {@link Script.resolvePath} and {@link Script.resourcesPath} instead.
  * @readonly
  * @property {string} defaultScripts - The path to the scripts directory. <em>Read-only.</em>

libraries/shared/src/RegisteredMetaTypes.h

@@ -361,6 +361,12 @@ 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
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ * @hifi-server-entity
+ * @hifi-assignment-client
+ *
  * @deprecated Use the {@link Graphics} API instead.
  */
 class MeshProxy : public QObject {

libraries/shared/src/shared/Camera.h

@@ -40,6 +40,10 @@ class Camera : public QObject {
      * The Camera API provides access to the "camera" that defines your view in desktop and HMD display modes.
      *
      * @namespace Camera
+     *
+     * @hifi-interface
+     * @hifi-client-entity
+     *
      * @property position {Vec3} The position of the camera. You can set this value only when the camera is in independent mode.
      * @property orientation {Quat} The orientation of the camera. You can set this value only when the camera is in independent
      *     mode.

libraries/ui/src/ui/TabletScriptingInterface.h

@@ -40,6 +40,9 @@ class OffscreenQmlSurface;
 
 /**jsdoc
  * @namespace Tablet
+ *
+ * @hifi-interface
+ * @hifi-client-entity
  */
 class TabletScriptingInterface : public QObject, public Dependency {
     Q_OBJECT
@@ -176,6 +179,10 @@ Q_DECLARE_METATYPE(TabletButtonsProxyModel*);
 
 /**jsdoc
  * @class TabletProxy
+  *
+ * @hifi-interface
+ * @hifi-client-entity
+ *
  * @property {string} name - Name of this tablet. <em>Read-only.</em>
  * @property {boolean} toolbarMode - Used to transition this tablet into and out of toolbar mode.
  *     When tablet is in toolbar mode, all its buttons will appear in a floating toolbar.
@@ -410,6 +417,10 @@ Q_DECLARE_METATYPE(TabletProxy*);
 
 /**jsdoc
  * @class TabletButtonProxy
+ *
+ * @hifi-interface
+ * @hifi-client-entity
+ *
  * @property {Uuid} uuid - Uniquely identifies this button. <em>Read-only.</em>
  * @property {TabletButtonProxy.ButtonProperties} properties
  */