Add "Avatar Script" JSDoc API classification

This commit is contained in:
David Rowe 2019-02-12 11:49:49 +13:00
parent 54e36f0825
commit 5428bb19dc
77 changed files with 96 additions and 2 deletions

View file

@ -20,7 +20,8 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* * @hifi-avatar
*
* @property {string} buildDate * @property {string} buildDate
* @property {string} buildVersion * @property {string} buildVersion
* @property {string} qtVersion * @property {string} qtVersion

View file

@ -21,6 +21,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
*/ */

View file

@ -36,6 +36,7 @@ class AABox;
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {number} presentTime <em>Read-only.</em> * @property {number} presentTime <em>Read-only.</em>
* @property {number} engineRunTime <em>Read-only.</em> * @property {number} engineRunTime <em>Read-only.</em>

View file

@ -21,6 +21,7 @@
* *
* @hifi-client-entity * @hifi-client-entity
* @hifi-interface * @hifi-interface
* @hifi-avatar
*/ */
class LocationBookmarks : public Bookmarks, public Dependency { class LocationBookmarks : public Bookmarks, public Dependency {

View file

@ -27,6 +27,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
*/ */
class SpeechRecognizer : public QObject, public Dependency { class SpeechRecognizer : public QObject, public Dependency {
Q_OBJECT Q_OBJECT

View file

@ -31,6 +31,7 @@ class AudioScope : public QObject, public Dependency {
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {number} scopeInput <em>Read-only.</em> * @property {number} scopeInput <em>Read-only.</em>
* @property {number} scopeOutputLeft <em>Read-only.</em> * @property {number} scopeOutputLeft <em>Read-only.</em>

View file

@ -46,6 +46,7 @@ using SortedAvatar = std::pair<float, std::shared_ptr<Avatar>>;
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @borrows AvatarList.getAvatarIdentifiers as getAvatarIdentifiers * @borrows AvatarList.getAvatarIdentifiers as getAvatarIdentifiers
* @borrows AvatarList.getAvatarsInRange as getAvatarsInRange * @borrows AvatarList.getAvatarsInRange as getAvatarsInRange

View file

@ -66,6 +66,7 @@ class MyAvatar : public Avatar {
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {Vec3} qmlPosition - A synonym for <code>position</code> for use by QML. * @property {Vec3} qmlPosition - A synonym for <code>position</code> for use by QML.
* @property {boolean} shouldRenderLocally=true - If <code>true</code> then your avatar is rendered for you in Interface, * @property {boolean} shouldRenderLocally=true - If <code>true</code> then your avatar is rendered for you in Interface,

View file

@ -32,6 +32,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
*/ */
class DdeFaceTracker : public FaceTracker, public Dependency { class DdeFaceTracker : public FaceTracker, public Dependency {

View file

@ -27,6 +27,7 @@ class LaserPointerScriptingInterface : public QObject, public Dependency {
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
*/ */
public: public:

View file

@ -23,6 +23,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {number} PICK_ENTITIES A filter flag. Include domain and avatar entities when intersecting. <em>Read-only.</em>. Deprecated. * @property {number} PICK_ENTITIES A filter flag. Include domain and avatar entities when intersecting. <em>Read-only.</em>. Deprecated.
* @property {number} PICK_OVERLAYS A filter flag. Include local entities when intersecting. <em>Read-only.</em>. Deprecated. * @property {number} PICK_OVERLAYS A filter flag. Include local entities when intersecting. <em>Read-only.</em>. Deprecated.

View file

@ -22,6 +22,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
*/ */
class PointerScriptingInterface : public QObject, public Dependency { class PointerScriptingInterface : public QObject, public Dependency {

View file

@ -25,6 +25,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {number} PICK_ENTITIES <em>Read-only.</em> * @property {number} PICK_ENTITIES <em>Read-only.</em>
* @property {number} PICK_OVERLAYS <em>Read-only.</em> * @property {number} PICK_OVERLAYS <em>Read-only.</em>

View file

@ -42,6 +42,7 @@ class AccountServicesScriptingInterface : public QObject {
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @namespace AccountServices * @namespace AccountServices
* @property {string} username <em>Read-only.</em> * @property {string} username <em>Read-only.</em>

View file

@ -32,6 +32,7 @@ class Audio : public AudioScriptingInterface, protected ReadWriteLockable {
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
* *

View file

@ -24,6 +24,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
*/ */
class ClipboardScriptingInterface : public QObject { class ClipboardScriptingInterface : public QObject {
Q_OBJECT Q_OBJECT

View file

@ -199,6 +199,7 @@ class ScriptEngine;
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {Controller.Actions} Actions - Predefined actions on Interface and the user's avatar. These can be used as end * @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>. * points in a {@link RouteObject} mapping. A synonym for <code>Controller.Hardware.Actions</code>.

View file

@ -24,7 +24,8 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* * @hifi-avatar
*
* @property {number} width * @property {number} width
* @property {number} height * @property {number} height
* @property {number} ALWAYS_ON_TOP - InteractiveWindow flag for always showing a window on top * @property {number} ALWAYS_ON_TOP - InteractiveWindow flag for always showing a window on top

View file

@ -21,6 +21,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
*/ */
class GooglePolyScriptingInterface : public QObject, public Dependency { class GooglePolyScriptingInterface : public QObject, public Dependency {

View file

@ -31,6 +31,7 @@ class QScriptEngine;
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {Vec3} position - The position of the HMD if currently in VR display mode, otherwise * @property {Vec3} position - The position of the HMD if currently in VR display mode, otherwise
* {@link Vec3(0)|Vec3.ZERO}. <em>Read-only.</em> * {@link Vec3(0)|Vec3.ZERO}. <em>Read-only.</em>

View file

@ -24,6 +24,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {bool} raised - <code>true</code> If the keyboard is visible <code>false</code> otherwise * @property {bool} raised - <code>true</code> If the keyboard is visible <code>false</code> otherwise
* @property {bool} password - <code>true</code> Will show * instead of characters in the text display <code>false</code> otherwise * @property {bool} password - <code>true</code> Will show * instead of characters in the text display <code>false</code> otherwise

View file

@ -35,6 +35,7 @@ class MenuItemProperties;
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
*/ */
/** /**

View file

@ -88,6 +88,7 @@ protected:
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @example <caption>Outline an entity when it is grabbed by a controller.</caption> * @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. * // Create a box and copy the following text into the entity's "Script URL" field.

View file

@ -21,6 +21,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
*/ */
class SettingsScriptingInterface : public QObject { class SettingsScriptingInterface : public QObject {

View file

@ -34,6 +34,7 @@ public:
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {number} walletStatus * @property {number} walletStatus
* @property {bool} limitedCommerce * @property {bool} limitedCommerce

View file

@ -31,6 +31,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {number} innerWidth - The width of the drawable area of the Interface window (i.e., without borders or other * @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> * chrome), in pixels. <em>Read-only.</em>

View file

@ -29,6 +29,7 @@ class AvatarInputs : public QObject {
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {boolean} cameraEnabled <em>Read-only.</em> * @property {boolean} cameraEnabled <em>Read-only.</em>
* @property {boolean} cameraMuted <em>Read-only.</em> * @property {boolean} cameraMuted <em>Read-only.</em>

View file

@ -42,6 +42,7 @@ private:
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
*/ */
class Snapshot : public QObject, public Dependency { class Snapshot : public QObject, public Dependency {

View file

@ -27,6 +27,7 @@ private: \
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
* *

View file

@ -87,6 +87,7 @@ public:
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {Uuid} keyboardFocusOverlay - Get or set the {@link Overlays.OverlayType|web3d} overlay that has keyboard focus. * @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 * If no overlay has keyboard focus, get returns <code>null</code>; set to <code>null</code> or {@link Uuid|Uuid.NULL} to

View file

@ -50,6 +50,7 @@ Q_DECLARE_METATYPE(AnimationPointer)
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
* *

View file

@ -30,6 +30,7 @@ class AnimationCacheScriptingInterface : public ScriptableResourceCache, public
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-assignment-client * @hifi-assignment-client
* *
* @property {number} numTotal - Total number of total resources. <em>Read-only.</em> * @property {number} numTotal - Total number of total resources. <em>Read-only.</em>

View file

@ -44,6 +44,7 @@ class AudioStreamStatsInterface : public QObject {
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {number} lossRate <em>Read-only.</em> * @property {number} lossRate <em>Read-only.</em>
* @property {number} lossCount <em>Read-only.</em> * @property {number} lossCount <em>Read-only.</em>
@ -192,6 +193,7 @@ class AudioStatsInterface : public QObject {
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {number} pingMs <em>Read-only.</em> * @property {number} pingMs <em>Read-only.</em>
* @property {number} inputReadMsMax <em>Read-only.</em> * @property {number} inputReadMsMax <em>Read-only.</em>

View file

@ -25,6 +25,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
* *

View file

@ -132,6 +132,7 @@ typedef QSharedPointer<Sound> SharedSoundPointer;
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
* *

View file

@ -30,6 +30,7 @@ class SoundCacheScriptingInterface : public ScriptableResourceCache, public Depe
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
* *

View file

@ -57,6 +57,7 @@ class UserInputMapper;
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
*/ */
/**jsdoc /**jsdoc

View file

@ -39,6 +39,7 @@ class ScriptingInterface;
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
*/ */
// TODO migrate functionality to a RouteBuilder class and make the proxy defer to that // TODO migrate functionality to a RouteBuilder class and make the proxy defer to that

View file

@ -178,6 +178,7 @@ private:
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {boolean} allowMouseCapture * @property {boolean} allowMouseCapture
* @property {number} depth * @property {number} depth

View file

@ -109,6 +109,7 @@ public:
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
* *

View file

@ -27,6 +27,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
*/ */
class GraphicsScriptingInterface : public QObject, public QScriptable, public Dependency { class GraphicsScriptingInterface : public QObject, public QScriptable, public Dependency {

View file

@ -25,6 +25,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
*/ */
class Midi : public QObject, public Dependency { class Midi : public QObject, public Dependency {

View file

@ -30,6 +30,7 @@ class ModelCacheScriptingInterface : public ScriptableResourceCache, public Depe
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {number} numTotal - Total number of total resources. <em>Read-only.</em> * @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} numCached - Total number of cached resource. <em>Read-only.</em>

View file

@ -30,6 +30,7 @@ class TextureCacheScriptingInterface : public ScriptableResourceCache, public De
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {number} numTotal - Total number of total resources. <em>Read-only.</em> * @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} numCached - Total number of cached resource. <em>Read-only.</em>

View file

@ -43,6 +43,7 @@ const QString GET_PLACE = "/api/v1/places/%1";
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-assignment-client * @hifi-assignment-client
* *
* @property {Uuid} domainID - A UUID uniquely identifying the domain you're visiting. Is {@link Uuid|Uuid.NULL} if you're not * @property {Uuid} domainID - A UUID uniquely identifying the domain you're visiting. Is {@link Uuid|Uuid.NULL} if you're not

View file

@ -40,6 +40,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
*/ */

View file

@ -95,6 +95,7 @@ class ScriptableResource : public QObject {
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
* *

View file

@ -22,6 +22,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
*/ */

View file

@ -45,6 +45,7 @@ public:
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {boolean} running - <em>Read-only.</em> * @property {boolean} running - <em>Read-only.</em>
*/ */

View file

@ -68,6 +68,7 @@ public:
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {number} Ray Ray picks intersect a ray with the nearest object in front of them, along a given direction. * @property {number} Ray Ray picks intersect a ray with the nearest object in front of them, along a given direction.
* @property {number} Stylus Stylus picks provide "tapping" functionality on/into flat surfaces. * @property {number} Stylus Stylus picks provide "tapping" functionality on/into flat surfaces.

View file

@ -30,6 +30,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
*/ */

View file

@ -21,6 +21,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
*/ */

View file

@ -26,6 +26,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
*/ */

View file

@ -40,6 +40,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
* *

View file

@ -28,6 +28,7 @@ class QScriptValue;
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-assignment-client * @hifi-assignment-client
*/ */
class RecordingScriptingInterface : public QObject, public Dependency { class RecordingScriptingInterface : public QObject, public Dependency {

View file

@ -115,6 +115,7 @@ namespace SceneScripting {
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {string} backgroundMode * @property {string} backgroundMode
* @property {Scene.Stage.KeyLight} keyLight * @property {Scene.Stage.KeyLight} keyLight
@ -178,6 +179,7 @@ namespace SceneScripting {
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {boolean} shouldRenderAvatars * @property {boolean} shouldRenderAvatars
* @property {boolean} shouldRenderEntities * @property {boolean} shouldRenderEntities

View file

@ -23,6 +23,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
* *

View file

@ -588,6 +588,7 @@ static void scriptableResourceFromScriptValue(const QScriptValue& value, Scripta
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
* *

View file

@ -104,6 +104,7 @@ public:
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
* *

View file

@ -32,6 +32,7 @@ class ScriptEngine;
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {string} debugScriptUrl * @property {string} debugScriptUrl
* @property {string} defaultScriptsPath * @property {string} defaultScriptsPath

View file

@ -27,6 +27,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
* *

View file

@ -71,6 +71,7 @@ public:
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
*/ */
class ScriptsModel : public QAbstractItemModel { class ScriptsModel : public QAbstractItemModel {
Q_OBJECT Q_OBJECT

View file

@ -23,6 +23,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
*/ */
class ScriptsModelFilter : public QSortFilterProxyModel { class ScriptsModelFilter : public QSortFilterProxyModel {
Q_OBJECT Q_OBJECT

View file

@ -21,6 +21,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-assignment-client * @hifi-assignment-client
* *
* @property {boolean} canKick - <code>true</code> if the domain server allows the node or avatar to kick (ban) avatars, * @property {boolean} canKick - <code>true</code> if the domain server allows the node or avatar to kick (ban) avatars,

View file

@ -31,6 +31,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
* *

View file

@ -28,6 +28,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
*/ */

View file

@ -25,6 +25,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @deprecated The Paths API is deprecated. Use {@link Script.resolvePath} and {@link Script.resourcesPath} instead. * @deprecated The Paths API is deprecated. Use {@link Script.resolvePath} and {@link Script.resourcesPath} instead.
* @readonly * @readonly

View file

@ -645,6 +645,7 @@ using MeshPointer = std::shared_ptr<graphics::Mesh>;
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @hifi-server-entity * @hifi-server-entity
* @hifi-assignment-client * @hifi-assignment-client
* *

View file

@ -43,6 +43,7 @@ class Camera : public QObject {
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {Vec3} position - The position of the camera. You can set this value only when the camera is in independent * @property {Vec3} position - The position of the camera. You can set this value only when the camera is in independent
* mode. * mode.

View file

@ -196,6 +196,7 @@ public:
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {number} cpuRunTime - <em>Read-only.</em> * @property {number} cpuRunTime - <em>Read-only.</em>
* @property {boolean} enabled * @property {boolean} enabled

View file

@ -45,6 +45,7 @@ using namespace InteractiveWindowEnums;
* *
* @hifi-interface * @hifi-interface
* @hifi-client-en * @hifi-client-en
* @hifi-avatar
* *
* @property {string} title * @property {string} title
* @property {Vec2} position * @property {Vec2} position

View file

@ -36,6 +36,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* @property {boolean} navigationFocused * @property {boolean} navigationFocused
* @property {boolean} navigationFocusDisabled * @property {boolean} navigationFocusDisabled
*/ */

View file

@ -17,6 +17,7 @@
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {string} url - <em>Read-only.</em> * @property {string} url - <em>Read-only.</em>
* @property {Vec2} position * @property {Vec2} position

View file

@ -25,6 +25,7 @@ class QScriptContext;
* *
* @hifi-interface * @hifi-interface
* @hifi-client-en * @hifi-client-en
* @hifi-avatar
* *
* @property {Vec2} position * @property {Vec2} position
* @property {Vec2} size * @property {Vec2} size

View file

@ -43,12 +43,14 @@ class OffscreenQmlSurface;
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
*/ */
/**jsdoc /**jsdoc
* @namespace tabletInterface * @namespace tabletInterface
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @deprecated This API is deprecated and will be removed. Use {@link Tablet} instead. * @deprecated This API is deprecated and will be removed. Use {@link Tablet} instead.
*/ */
@ -208,6 +210,7 @@ Q_DECLARE_METATYPE(TabletButtonsProxyModel*);
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {string} name - Name of this tablet. <em>Read-only.</em> * @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. * @property {boolean} toolbarMode - Used to transition this tablet into and out of toolbar mode.
@ -456,6 +459,7 @@ Q_DECLARE_METATYPE(TabletProxy*);
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
* *
* @property {Uuid} uuid - Uniquely identifies this button. <em>Read-only.</em> * @property {Uuid} uuid - Uniquely identifies this button. <em>Read-only.</em>
* @property {TabletButtonProxy.ButtonProperties} properties * @property {TabletButtonProxy.ButtonProperties} properties

View file

@ -24,6 +24,7 @@ class QQuickItem;
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
*/ */
class ToolbarButtonProxy : public QmlWrapper { class ToolbarButtonProxy : public QmlWrapper {
Q_OBJECT Q_OBJECT
@ -83,6 +84,7 @@ Q_DECLARE_METATYPE(ToolbarButtonProxy*);
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
*/ */
class ToolbarProxy : public QmlWrapper { class ToolbarProxy : public QmlWrapper {
Q_OBJECT Q_OBJECT
@ -136,6 +138,7 @@ Q_DECLARE_METATYPE(ToolbarProxy*);
* *
* @hifi-interface * @hifi-interface
* @hifi-client-entity * @hifi-client-entity
* @hifi-avatar
*/ */
class ToolbarScriptingInterface : public QObject, public Dependency { class ToolbarScriptingInterface : public QObject, public Dependency {
Q_OBJECT Q_OBJECT

View file

@ -107,6 +107,9 @@ exports.handlers = {
if (e.doclet.hifiClientEntity) { if (e.doclet.hifiClientEntity) {
rows.push("Client Entity Scripts"); rows.push("Client Entity Scripts");
} }
if (e.doclet.hifiAvatar) {
rows.push("Avatar Scripts");
}
if (e.doclet.hifiServerEntity) { if (e.doclet.hifiServerEntity) {
rows.push("Server Entity Scripts"); rows.push("Server Entity Scripts");
} }
@ -140,6 +143,14 @@ exports.defineTags = function (dictionary) {
} }
}); });
// @hifi-avatar-script
dictionary.defineTag("hifi-avatar", {
onTagged: function (doclet, tag) {
doclet.hifiAvatar = true;
}
});
// @hifi-client-entity // @hifi-client-entity
dictionary.defineTag("hifi-client-entity", { dictionary.defineTag("hifi-client-entity", {
onTagged: function (doclet, tag) { onTagged: function (doclet, tag) {