From d5e08d19e39048988b9fc1ff1ee9db7f603f13e2 Mon Sep 17 00:00:00 2001 From: David Rowe Date: Fri, 20 Sep 2019 08:17:24 +1200 Subject: [PATCH] Fix JSDoc for miscellaneous white space issues --- interface/src/avatar/MyAvatar.cpp | 2 +- interface/src/avatar/MyAvatar.h | 13 ++-- .../src/raypick/PickScriptingInterface.cpp | 22 +++--- .../scripting/ControllerScriptingInterface.h | 18 ++--- .../scripting/DesktopScriptingInterface.cpp | 4 +- .../scripting/SelectionScriptingInterface.cpp | 2 +- .../src/scripting/WalletScriptingInterface.h | 6 +- .../src/scripting/WindowScriptingInterface.h | 24 +++---- interface/src/ui/InteractiveWindow.h | 4 +- interface/src/ui/overlays/Overlays.cpp | 67 +++++++++---------- .../animation/src/AnimInverseKinematics.h | 14 ++-- libraries/animation/src/IKTarget.h | 4 +- .../src/avatars-renderer/Avatar.cpp | 2 +- libraries/avatars/src/AvatarData.cpp | 4 +- libraries/avatars/src/AvatarData.h | 6 +- .../controllers/impl/MappingBuilderProxy.h | 16 ++--- .../src/controllers/impl/RouteBuilderProxy.h | 8 +-- .../entities/src/EntityItemProperties.cpp | 6 +- libraries/entities/src/EntityTypes.h | 12 ++-- .../src/input-plugins/KeyboardMouseDevice.cpp | 14 ++-- libraries/networking/src/MessagesClient.h | 12 ++-- libraries/script-engine/src/ScriptEngine.cpp | 4 +- .../ui/src/ui/TabletScriptingInterface.h | 2 +- 23 files changed, 135 insertions(+), 131 deletions(-) diff --git a/interface/src/avatar/MyAvatar.cpp b/interface/src/avatar/MyAvatar.cpp index 4d1c20010c..af6836a8a3 100644 --- a/interface/src/avatar/MyAvatar.cpp +++ b/interface/src/avatar/MyAvatar.cpp @@ -2479,7 +2479,7 @@ void MyAvatar::clearWornAvatarEntities() { } /**jsdoc - * Information about an avatar entity. + *

Information about an avatar entity.

* * * diff --git a/interface/src/avatar/MyAvatar.h b/interface/src/avatar/MyAvatar.h index a7ddb7a837..6cb9de9e96 100644 --- a/interface/src/avatar/MyAvatar.h +++ b/interface/src/avatar/MyAvatar.h @@ -180,8 +180,8 @@ class MyAvatar : public Avatar { * property value is audioListenerModeCustom. * @property {Quat} customListenOrientation=Quat.IDENTITY - The listening orientation used when the * audioListenerMode property value is audioListenerModeCustom. - * @property {boolean} hasScriptedBlendshapes=false - true to transmit blendshapes over the network.
- * Note: Currently doesn't work. Use {@link MyAvatar.setForceFaceTrackerConnected} instead. + * @property {boolean} hasScriptedBlendshapes=false - true to transmit blendshapes over the network. + *

Note: Currently doesn't work. Use {@link MyAvatar.setForceFaceTrackerConnected} instead.

* @property {boolean} hasProceduralBlinkFaceMovement=true - true if procedural blinking is turned on. * @property {boolean} hasProceduralEyeFaceMovement=true - true if procedural eye movement is turned on. * @property {boolean} hasAudioEnabledFaceMovement=true - true to move the mouth blendshapes with voice audio @@ -239,8 +239,8 @@ class MyAvatar : public Avatar { * @property {boolean} useAdvancedMovementControls - Returns and sets the value of the Interface setting, Settings > * Controls > Walking. Note: Setting the value has no effect unless Interface is restarted. * @property {boolean} showPlayArea - Returns and sets the value of the Interface setting, Settings > Controls > Show room - * boundaries while teleporting.
- * Note: Setting the value has no effect unless Interface is restarted. + * boundaries while teleporting. + *

Note: Setting the value has no effect unless Interface is restarted.

* * @property {number} yawSpeed=75 - The mouse X sensitivity value in Settings > General. Read-only. * @property {number} pitchSpeed=50 - The mouse Y sensitivity value in Settings > General. Read-only. @@ -488,9 +488,10 @@ public: * - * + * the avatar to sit on the floor when the user sits on the floor.

+ *

Note: Experimental.

* *
PropertyTypeDescription
2AutoInterface detects when the user is standing or seated in the real world. * Avatar leaning is disabled when the user is sitting (i.e., avatar always recenters), and avatar leaning is enabled * when the user is standing (i.e., avatar leans, then if leans too far it recenters).
3DisableHMDLeanBoth avatar leaning and recentering are disabled regardless of + *
3DisableHMDLean

Both avatar leaning and recentering are disabled regardless of * what the user is doing in the real world and no matter what their avatar is doing in the virtual world. Enables - * the avatar to sit on the floor when the user sits on the floor.
Note: Experimental.

* @typedef {number} MyAvatar.SitStandModelType diff --git a/interface/src/raypick/PickScriptingInterface.cpp b/interface/src/raypick/PickScriptingInterface.cpp index ddc1fe376c..54c9cbe277 100644 --- a/interface/src/raypick/PickScriptingInterface.cpp +++ b/interface/src/raypick/PickScriptingInterface.cpp @@ -83,12 +83,12 @@ PickFilter getPickFilter(unsigned int filter) { * means no maximum. * @property {Uuid} [parentID] - The ID of the parent: an avatar, an entity, or another pick. * @property {number} [parentJointIndex=0] - The joint of the parent to parent to, for example, an avatar joint. - * A value of 0 means no joint.
- * Used only if parentID is specified. + * A value of 0 means no joint. + *

Used only if parentID is specified.

* @property {string} [joint] - "Mouse" parents the pick to the mouse; "Avatar" parents the pick to * the user's avatar head; a joint name parents to the joint in the user's avatar; otherwise, the pick is "static", not - * parented to anything.
- * Used only if parentID is not specified. + * parented to anything. + *

Used only if parentID is not specified.

* @property {Vec3} [position=Vec3.ZERO] - The offset of the ray origin from its parent if parented, otherwise the ray origin * in world coordinates. * @property {Vec3} [posOffset] - Synonym for position. @@ -217,12 +217,12 @@ std::shared_ptr PickScriptingInterface::buildStylusPick(const QVarian * means no maximum. * @property {Uuid} [parentID] - The ID of the parent: an avatar, an entity, or another pick. * @property {number} [parentJointIndex=0] - The joint of the parent to parent to, for example, an avatar joint. - * A value of 0 means no joint.
- * Used only if parentID is specified. + * A value of 0 means no joint. + *

Used only if parentID is specified.

* @property {string} [joint] - "Mouse" parents the pick to the mouse; "Avatar" parents the pick to * the user's avatar head; a joint name parents to the joint in the user's avatar; otherwise, the pick is "static", not * parented to anything. - * Used only if parentID is not specified. + *

Used only if parentID is not specified.

* @property {Vec3} [position=Vec3.ZERO] - The offset of the parabola origin from its parent if parented, otherwise the * parabola origin in world coordinates. * @property {Vec3} [posOffset] - Synonym for position. @@ -327,12 +327,12 @@ std::shared_ptr PickScriptingInterface::buildParabolaPick(const QVari * means no maximum. * @property {Uuid} [parentID] - The ID of the parent: an avatar, an entity, or another pick. * @property {number} [parentJointIndex=0] - The joint of the parent to parent to, for example, an avatar joint. - * A value of 0 means no joint.
- * Used only if parentID is specified. + * A value of 0 means no joint. + *

Used only if parentID is specified.

* @property {string} [joint] - "Mouse" parents the pick to the mouse; "Avatar" parents the pick to * the user's avatar head; a joint name parents to the joint in the user's avatar; otherwise, the pick is "static", not - * parented to anything.
- * Used only if parentID is not specified. + * parented to anything. + *

Used only if parentID is not specified.

* @property {boolean} [scaleWithParent=true] - true to scale the pick's dimensions and threshold according to the * scale of the parent. * diff --git a/interface/src/scripting/ControllerScriptingInterface.h b/interface/src/scripting/ControllerScriptingInterface.h index dbd172abe7..f65791335d 100644 --- a/interface/src/scripting/ControllerScriptingInterface.h +++ b/interface/src/scripting/ControllerScriptingInterface.h @@ -216,25 +216,25 @@ class ScriptEngine; * * @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 Controller.Hardware.Actions. - * Read-only.

- * Default mappings are provided from the Controller.Hardware.Keyboard and Controller.Standard to - * actions in + * Read-only. + *

Default mappings are provided from the Controller.Hardware.Keyboard and Controller.Standard + * to actions in * * keyboardMouse.json and * - * standard.json, respectively. + * standard.json, respectively.

* * @property {Controller.Hardware} Hardware - Standard and hardware-specific controller and computer outputs, plus predefined * actions on Interface and the user's avatar. The outputs can be mapped to Actions or functions in a - * {@link RouteObject} mapping. Additionally, hardware-specific controller outputs can be mapped to Standard - * controller outputs. Read-only. + * {@link RouteObject} mapping. Additionally, hardware-specific controller outputs can be mapped to + * Controller.Standard controller outputs. Read-only. * * @property {Controller.Standard} Standard - Standard controller outputs that can be mapped to Actions or - * functions in a {@link RouteObject} mapping. Read-only.

- * Each hardware device has a mapping from its outputs to Controller.Standard items, specified in a JSON file. + * functions in a {@link RouteObject} mapping. Read-only. + *

Each hardware device has a mapping from its outputs to Controller.Standard items, specified in a JSON file. * For example, * leapmotion.json and - * vive.json. + * vive.json.

*/ /// handles scripting of input controller commands from JS diff --git a/interface/src/scripting/DesktopScriptingInterface.cpp b/interface/src/scripting/DesktopScriptingInterface.cpp index bb4ab89f2c..95d3bae332 100644 --- a/interface/src/scripting/DesktopScriptingInterface.cpp +++ b/interface/src/scripting/DesktopScriptingInterface.cpp @@ -31,7 +31,7 @@ * @property {InteractiveWindow.DockArea} RIGHT - Dock to the right edge of the Interface window. */ /**jsdoc - * A docking location of an InteractiveWindow. + *

A docking location of an InteractiveWindow.

* * * @@ -73,7 +73,7 @@ int DesktopScriptingInterface::getHeight() { * own separate window. */ /**jsdoc - * A display mode for an InteractiveWindow. + *

A display mode for an InteractiveWindow.

*
ValueNameDescription
* * diff --git a/interface/src/scripting/SelectionScriptingInterface.cpp b/interface/src/scripting/SelectionScriptingInterface.cpp index 5856188868..d2147ac5cc 100644 --- a/interface/src/scripting/SelectionScriptingInterface.cpp +++ b/interface/src/scripting/SelectionScriptingInterface.cpp @@ -44,7 +44,7 @@ SelectionScriptingInterface::SelectionScriptingInterface() { } /**jsdoc - * The type of a specific item in a selection list. + *

The type of a specific item in a selection list.

*
ValueNameDescription
* * diff --git a/interface/src/scripting/WalletScriptingInterface.h b/interface/src/scripting/WalletScriptingInterface.h index 3ef9c7953a..0decbbad11 100644 --- a/interface/src/scripting/WalletScriptingInterface.h +++ b/interface/src/scripting/WalletScriptingInterface.h @@ -73,9 +73,9 @@ public: /**jsdoc * Check that a certified avatar entity is owned by the avatar whose entity it is. The result of the check is provided via * the {@link WalletScriptingInterface.ownershipVerificationSuccess|ownershipVerificationSuccess} and - * {@link WalletScriptingInterface.ownershipVerificationFailed|ownershipVerificationFailed} signals.
- * Warning: Neither of these signals are triggered if the entity is not an avatar entity or is not - * certified. + * {@link WalletScriptingInterface.ownershipVerificationFailed|ownershipVerificationFailed} signals. + *

Warning: Neither of these signals are triggered if the entity is not an avatar entity or is not + * certified.

* @function WalletScriptingInterface.proveAvatarEntityOwnershipVerification * @param {Uuid} entityID - The avatar entity's ID. * @example diff --git a/interface/src/scripting/WindowScriptingInterface.h b/interface/src/scripting/WindowScriptingInterface.h index 83d7de56a5..45585e940a 100644 --- a/interface/src/scripting/WindowScriptingInterface.h +++ b/interface/src/scripting/WindowScriptingInterface.h @@ -326,10 +326,10 @@ public slots: * full resolution is used (window dimensions in desktop mode; HMD display dimensions in HMD mode), otherwise one of the * dimensions is adjusted in order to match the aspect ratio. * @param {string} [filename=""] - If a filename is not provided, the image is saved as "hifi-snap-by-<user - * name>-on-YYYY-MM-DD_HH-MM-SS".
- * Still images are saved in JPEG or PNG format according to the extension provided — ".jpg", + * name>-on-YYYY-MM-DD_HH-MM-SS". + *

Still images are saved in JPEG or PNG format according to the extension provided — ".jpg", * ".jpeg", or ".png" — or if not provided then in JPEG format with an extension of - * ".jpg". Animated images are saved in GIF format. + * ".jpg". Animated images are saved in GIF format.

* * @example * function onStillSnapshotTaken(path, notify) { @@ -365,10 +365,10 @@ public slots: * @param {boolean} [notify=true] - This value is passed on through the {@link Window.stillSnapshotTaken|stillSnapshotTaken} * signal. * @param {string} [filename=""] - If a filename is not provided, the image is saved as "hifi-snap-by-<user - * name>-on-YYYY-MM-DD_HH-MM-SS".
- * Images are saved in JPEG or PNG format according to the extension provided — ".jpg", + * name>-on-YYYY-MM-DD_HH-MM-SS". + *

Images are saved in JPEG or PNG format according to the extension provided — ".jpg", * ".jpeg", or ".png" — or if not provided then in JPEG format with an extension of - * ".jpg". + * ".jpg".

*/ void takeSecondaryCameraSnapshot(const bool& notify = true, const QString& filename = QString()); @@ -384,10 +384,10 @@ public slots: * @param {boolean} [notify=true] - This value is passed on through the {@link Window.stillSnapshotTaken|stillSnapshotTaken} * signal. * @param {string} [filename=""] - If a filename is not provided, the image is saved as "hifi-snap-by-<user - * name>-on-YYYY-MM-DD_HH-MM-SS".
- * Images are saved in JPEG or PNG format according to the extension provided — ".jpg", + * name>-on-YYYY-MM-DD_HH-MM-SS". + *

Images are saved in JPEG or PNG format according to the extension provided — ".jpg", * ".jpeg", or ".png" — or if not provided then in JPEG format with an extension of - * ".jpg". + * ".jpg".

*/ void takeSecondaryCamera360Snapshot(const glm::vec3& cameraPosition, const bool& cubemapOutputFormat = false, const bool& notify = true, const QString& filename = QString()); @@ -515,13 +515,13 @@ public slots: /**jsdoc * Opens a URL in the Interface window or other application, depending on the URL's scheme. The following schemes are - * supported:
+ * supported: *
    *
  • hifi: Navigate to the URL in Interface.
    • *
  • hifiapp: Open a system app in Interface.
    • *
- * Other schemes will either be handled by the OS (e.g. http, https, or mailto) or - * will display a dialog asking the user to confirm that they want to try to open the URL. + *

Other schemes will either be handled by the OS (e.g. http, https, or mailto) or + * will display a dialog asking the user to confirm that they want to try to open the URL.

* @function Window.openUrl * @param {string} url - The URL to open. */ diff --git a/interface/src/ui/InteractiveWindow.h b/interface/src/ui/InteractiveWindow.h index 70077a27b0..ba53684173 100644 --- a/interface/src/ui/InteractiveWindow.h +++ b/interface/src/ui/InteractiveWindow.h @@ -56,8 +56,8 @@ namespace InteractiveWindowEnums { Q_NAMESPACE /**jsdoc - * A set of flags controlling InteractiveWindow behavior. The value is constructed by using the - * | (bitwise OR) operator on the individual flag values.
+ *

A set of flags controlling InteractiveWindow behavior. The value is constructed by using the + * | (bitwise OR) operator on the individual flag values.

*
ValueDescription
Check the ownership of all nearby certified avatar entities.Using the snapshot function and signals.
* * diff --git a/interface/src/ui/overlays/Overlays.cpp b/interface/src/ui/overlays/Overlays.cpp index 1f5bba86b2..730554366f 100644 --- a/interface/src/ui/overlays/Overlays.cpp +++ b/interface/src/ui/overlays/Overlays.cpp @@ -1346,49 +1346,48 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * * * - * + * * * - * + * * * - * + * * * - * + * * * - * + * * * - * + * * * - * + * * * - * + * * * - * + * * * - * + * * * - * + * * * *
Flag NameValueDescription
Some text.{@link Overlays.OverlayProperties-Text|OverlayProperties-Text}
"cube"3DA cube. A "shape" overlay can also be used to create a cube.
- * Deprecated. - *

A cube. A "shape" overlay can also be used to create a cube.

+ *

Deprecated.

{@link Overlays.OverlayProperties-Cube|OverlayProperties-Cube}
"sphere"3DA sphere. A "shape" overlay can also be used to create a sphere.
- * Deprecated.

A sphere. A "shape" overlay can also be used to create a sphere.

+ *

Deprecated.

{@link Overlays.OverlayProperties-Sphere|OverlayProperties-Sphere}
"shape"3DA geometric shape, such as a cube, sphere, or cylinder.
- * Deprecated.

A geometric shape, such as a cube, sphere, or cylinder.

+ *

Deprecated.

{@link Overlays.OverlayProperties-Shape|OverlayProperties-Shape}
"model"3DA model.
- * Deprecated.

A model.

+ *

Deprecated.

{@link Overlays.OverlayProperties-Model|OverlayProperties-Model}
"image3d"3DAn image. Synonym: "billboard".
- * Deprecated.

An image. Synonym: "billboard".

+ *

Deprecated.

{@link Overlays.OverlayProperties-Image3D|OverlayProperties-Image3D}
"rectangle3d"3DA rectangle.
- * Deprecated.

A rectangle.

+ *

Deprecated.

{@link Overlays.OverlayProperties-Rectangle3D|OverlayProperties-Rectangle3D}
"text3d"3DSome text.
- * Deprecated.

Some text.

+ *

Deprecated.

{@link Overlays.OverlayProperties-Text3D|OverlayProperties-Text3D}
"web3d"3DWeb content.
- * Deprecated.

Web content.

+ *

Deprecated.

{@link Overlays.OverlayProperties-Web3D|OverlayProperties-Web3D}
"line3d"3DA line.
- * Deprecated.

A line.

+ *

Deprecated.

{@link Overlays.OverlayProperties-Line3D|OverlayProperties-Line3D}
"grid"3DA grid of lines in a plane.
- * Deprecated.

A grid of lines in a plane.

+ *

Deprecated.

{@link Overlays.OverlayProperties-Grid|OverlayProperties-Grid}
"circle3d"3DA circle.
- * Deprecated.

A circle.

+ *

Deprecated.

{@link Overlays.OverlayProperties-Circle3D|OverlayProperties-Circle3D}
@@ -1410,17 +1409,17 @@ QVector Overlays::findOverlays(const glm::vec3& center, float radius) { * @see {@link Overlays.OverlayProperties-Rectangle|OverlayProperties-Rectangle} * @see {@link Overlays.OverlayProperties-Image|OverlayProperties-Image} * @see {@link Overlays.OverlayProperties-Text|OverlayProperties-Text} - * @see {@link Overlays.OverlayProperties-Cube|OverlayProperties-Cube} Deprecated. - * @see {@link Overlays.OverlayProperties-Sphere|OverlayProperties-Sphere} Deprecated. - * @see {@link Overlays.OverlayProperties-Shape|OverlayProperties-Shape} Deprecated. - * @see {@link Overlays.OverlayProperties-Model|OverlayProperties-Model} Deprecated. - * @see {@link Overlays.OverlayProperties-Rectangle3D|OverlayProperties-Rectangle3D} Deprecated. - * @see {@link Overlays.OverlayProperties-Image3D|OverlayProperties-Image3D} Deprecated. - * @see {@link Overlays.OverlayProperties-Text3D|OverlayProperties-Text3D} Deprecated. - * @see {@link Overlays.OverlayProperties-Web3D|OverlayProperties-Web3D} Deprecated. - * @see {@link Overlays.OverlayProperties-Line3D|OverlayProperties-Line3D} Deprecated. - * @see {@link Overlays.OverlayProperties-Grid|OverlayProperties-Grid} Deprecated. - * @see {@link Overlays.OverlayProperties-Circle3D|OverlayProperties-Circle3D} Deprecated. + * @see {@link Overlays.OverlayProperties-Cube|OverlayProperties-Cube} — Deprecated. + * @see {@link Overlays.OverlayProperties-Sphere|OverlayProperties-Sphere} — Deprecated. + * @see {@link Overlays.OverlayProperties-Shape|OverlayProperties-Shape} — Deprecated. + * @see {@link Overlays.OverlayProperties-Model|OverlayProperties-Model} — Deprecated. + * @see {@link Overlays.OverlayProperties-Rectangle3D|OverlayProperties-Rectangle3D} — Deprecated. + * @see {@link Overlays.OverlayProperties-Image3D|OverlayProperties-Image3D} — Deprecated. + * @see {@link Overlays.OverlayProperties-Text3D|OverlayProperties-Text3D} — Deprecated. + * @see {@link Overlays.OverlayProperties-Web3D|OverlayProperties-Web3D} — Deprecated. + * @see {@link Overlays.OverlayProperties-Line3D|OverlayProperties-Line3D} — Deprecated. + * @see {@link Overlays.OverlayProperties-Grid|OverlayProperties-Grid} — Deprecated. + * @see {@link Overlays.OverlayProperties-Circle3D|OverlayProperties-Circle3D} — Deprecated. */ /**jsdoc diff --git a/libraries/animation/src/AnimInverseKinematics.h b/libraries/animation/src/AnimInverseKinematics.h index d184038815..959a504e79 100644 --- a/libraries/animation/src/AnimInverseKinematics.h +++ b/libraries/animation/src/AnimInverseKinematics.h @@ -73,12 +73,14 @@ public: * 1RelaxToLimitCenterPosesThis is a blend: it is 15/16 * PreviousSolution and 1/16 LimitCenterPoses. This should converge quickly because it is * close to the previous solution, but still provides the benefits of avoiding limb locking. - * 2PreviousSolutionThe IK system will begin to solve from the same position and - * orientations for each joint that was the result from the previous frame.
- * Pros: As the end effectors typically do not move much from frame to frame, this is likely to converge quickly - * to a valid solution.
- * Cons: If the previous solution resulted in an awkward or uncomfortable posture, the next frame will also be - * awkward and uncomfortable. It can also result in locked elbows and knees. + * 2PreviousSolution + *

The IK system will begin to solve from the same position and orientations for each joint that was the result + * from the previous frame.

+ *

Pros: As the end effectors typically do not move much from frame to frame, this is likely to converge quickly + * to a valid solution.

+ *

Cons: If the previous solution resulted in an awkward or uncomfortable posture, the next frame will also be + * awkward and uncomfortable. It can also result in locked elbows and knees.

+ * * 3UnderPosesThe IK occurs at one of the top-most layers. It has access to the * full posture that was computed via canned animations and blends. We call this animated set of poses the "under * pose". The under poses are what would be visible if IK was completely disabled. Using the under poses as the diff --git a/libraries/animation/src/IKTarget.h b/libraries/animation/src/IKTarget.h index d0c060e44c..a56f5578b3 100644 --- a/libraries/animation/src/IKTarget.h +++ b/libraries/animation/src/IKTarget.h @@ -26,8 +26,8 @@ public: * 0RotationAndPositionAttempt to reach the rotation and position end * effector. * 1RotationOnlyAttempt to reach the end effector rotation only. - * 2HmdHeadA special mode of IK that would attempt to prevent unnecessary - * bending of the spine.
+ * 2HmdHead + *

A special mode of IK that would attempt to prevent unnecessary bending of the spine.

*

Deprecated: This target type is deprecated and will be removed.

* 3HipsRelativeRotationAndPositionAttempt to reach a rotation and position end * effector that is not in absolute rig coordinates but is offset by the avatar hips translation. diff --git a/libraries/avatars-renderer/src/avatars-renderer/Avatar.cpp b/libraries/avatars-renderer/src/avatars-renderer/Avatar.cpp index 7f363dd36f..dacd479aef 100644 --- a/libraries/avatars-renderer/src/avatars-renderer/Avatar.cpp +++ b/libraries/avatars-renderer/src/avatars-renderer/Avatar.cpp @@ -517,7 +517,7 @@ void Avatar::relayJointDataToChildren() { } /**jsdoc - * An avatar has different types of data simulated at different rates, in Hz. + *

An avatar has different types of data simulated at different rates, in Hz.

* * * diff --git a/libraries/avatars/src/AvatarData.cpp b/libraries/avatars/src/AvatarData.cpp index c03f9430be..0389dc9149 100755 --- a/libraries/avatars/src/AvatarData.cpp +++ b/libraries/avatars/src/AvatarData.cpp @@ -1444,7 +1444,7 @@ int AvatarData::parseDataFromBuffer(const QByteArray& buffer) { } /**jsdoc - * The avatar mixer data comprises different types of data, with the data rates of each being tracked in kbps. + *

The avatar mixer data comprises different types of data, with the data rates of each being tracked in kbps.

* *
* @@ -1549,7 +1549,7 @@ float AvatarData::getDataRate(const QString& rateName) const { } /**jsdoc - * The avatar mixer data comprises different types of data updated at different rates, in Hz. + *

The avatar mixer data comprises different types of data updated at different rates, in Hz.

* *
* diff --git a/libraries/avatars/src/AvatarData.h b/libraries/avatars/src/AvatarData.h index 59a2e2a53e..df0783ef4b 100755 --- a/libraries/avatars/src/AvatarData.h +++ b/libraries/avatars/src/AvatarData.h @@ -1277,9 +1277,9 @@ public: * @param {number} [scale=1.0] - The scale to apply to the model. * @param {boolean} [isSoft=false] - If the model has a skeleton, set this to true so that the bones of the * attached model's skeleton are rotated to fit the avatar's current pose. isSoft is used, for example, - * to have clothing that moves with the avatar.
- * If true, the translation, rotation, and scale parameters are - * ignored. + * to have clothing that moves with the avatar. + *

If true, the translation, rotation, and scale parameters are + * ignored.

* @param {boolean} [allowDuplicates=false] - If true then more than one copy of any particular model may be * attached to the same joint; if false then the same model cannot be attached to the same joint. * @param {boolean} [useSaved=true] - Not used. diff --git a/libraries/controllers/src/controllers/impl/MappingBuilderProxy.h b/libraries/controllers/src/controllers/impl/MappingBuilderProxy.h index 5f3b9dc3fc..5a8fd3083d 100644 --- a/libraries/controllers/src/controllers/impl/MappingBuilderProxy.h +++ b/libraries/controllers/src/controllers/impl/MappingBuilderProxy.h @@ -135,8 +135,8 @@ public: /**jsdoc * Creates a new {@link RouteObject} from a controller output, ready to be mapped to a standard control, action, or - * function.
- * This is a QML-specific version of {@link MappingObject#from|from}: use this version in QML files. + * function. + *

This is a QML-specific version of {@link MappingObject#from|from}: use this version in QML files.

* @function MappingObject#fromQml * @param {Controller.Standard|Controller.Hardware|function} source - The controller output or function that is the source * of the route data. If a function, it must return a number or a {@link Pose} value as the route data. @@ -146,8 +146,8 @@ public: /**jsdoc * Creates a new {@link RouteObject} from two numeric {@link Controller.Hardware} outputs, one applied in the negative - * direction and the other in the positive direction, ready to be mapped to a standard control, action, or function.
- * This is a QML-specific version of {@link MappingObject#makeAxis|makeAxis}: use this version in QML files. + * direction and the other in the positive direction, ready to be mapped to a standard control, action, or function. + *

This is a QML-specific version of {@link MappingObject#makeAxis|makeAxis}: use this version in QML files.

* @function MappingObject#makeAxisQml * @param {Controller.Hardware} source1 - The first, negative-direction controller output. * @param {Controller.Hardware} source2 - The second, positive-direction controller output. @@ -189,8 +189,8 @@ public: Q_INVOKABLE QObject* makeAxis(const QScriptValue& source1, const QScriptValue& source2); /**jsdoc - * Enables or disables the mapping. When enabled, the routes in the mapping take effect.
- * Synonymous with {@link Controller.enableMapping}. + * Enables or disables the mapping. When enabled, the routes in the mapping take effect. + *

Synonymous with {@link Controller.enableMapping}.

* @function MappingObject#enable * @param {boolean} enable=true - If true then the mapping is enabled, otherwise it is disabled. * @returns {MappingObject} The mapping object, so that further routes can be added. @@ -198,8 +198,8 @@ public: Q_INVOKABLE QObject* enable(bool enable = true); /**jsdoc - * Disables the mapping. When disabled, the routes in the mapping have no effect.
- * Synonymous with {@link Controller.disableMapping}. + * Disables the mapping. When disabled, the routes in the mapping have no effect. + *

Synonymous with {@link Controller.disableMapping}.

* @function MappingObject#disable * @returns {MappingObject} The mapping object, so that further routes can be added. */ diff --git a/libraries/controllers/src/controllers/impl/RouteBuilderProxy.h b/libraries/controllers/src/controllers/impl/RouteBuilderProxy.h index e7ff04d72c..f1b36cfec5 100644 --- a/libraries/controllers/src/controllers/impl/RouteBuilderProxy.h +++ b/libraries/controllers/src/controllers/impl/RouteBuilderProxy.h @@ -52,8 +52,8 @@ class RouteBuilderProxy : public QObject { /**jsdoc * Terminates the route with a standard control, an action, or a script function. The output value from the route is - * sent to the specified destination.
- * This is a QML-specific version of {@link MappingObject#to|to}: use this version in QML files. + * sent to the specified destination. + *

This is a QML-specific version of {@link MappingObject#to|to}: use this version in QML files.

* @function RouteObject#toQml * @param {Controller.Standard|Controller.Actions|function} destination - The standard control, action, or JavaScript * function that the route output is mapped to. For a function, the parameter can be either the name of the function or @@ -64,8 +64,8 @@ class RouteBuilderProxy : public QObject { /**jsdoc * Processes the route only if a condition is satisfied. The condition is evaluated before the route input is read, and * the input is read only if the condition is true. Thus, if the condition is not met then subsequent - * routes using the same input are processed.
- * This is a QML-specific version of {@link MappingObject#to|to}: use this version in QML files. + * routes using the same input are processed. + *

This is a QML-specific version of {@link MappingObject#when|when}: use this version in QML files.

* @function RouteObject#whenQml * @param {condition|condition[]} expression -

A condition may be a:

*
    diff --git a/libraries/entities/src/EntityItemProperties.cpp b/libraries/entities/src/EntityItemProperties.cpp index e45d05a1b5..b835cab40b 100644 --- a/libraries/entities/src/EntityItemProperties.cpp +++ b/libraries/entities/src/EntityItemProperties.cpp @@ -1217,10 +1217,10 @@ EntityPropertyFlags EntityItemProperties::getChangedProperties() const { * dimensions / voxelVolumesize. * @property {string} voxelData="ABAAEAAQAAAAHgAAEAB42u3BAQ0AAADCoPdPbQ8HFAAAAPBuEAAAAQ==" - Base-64 encoded compressed dump of * the PolyVox data. This property is typically not used in scripts directly; rather, functions that manipulate a PolyVox - * entity update it.
    - * The size of this property increases with the size and complexity of the PolyVox entity, with the size depending on how + * entity update it. + *

    The size of this property increases with the size and complexity of the PolyVox entity, with the size depending on how * the particular entity's voxels compress. Because this property value has to fit within a High Fidelity datagram packet, - * there is a limit to the size and complexity of a PolyVox entity; edits which would result in an overflow are rejected. + * there is a limit to the size and complexity of a PolyVox entity; edits which would result in an overflow are rejected.

    * @property {Entities.PolyVoxSurfaceStyle} voxelSurfaceStyle=2 - The style of rendering the voxels' surface and how * neighboring PolyVox entities are joined. * @property {string} xTextureURL="" - The URL of the texture to map to surfaces perpendicular to the entity's local x-axis. diff --git a/libraries/entities/src/EntityTypes.h b/libraries/entities/src/EntityTypes.h index 4106eb8054..7f72c3f761 100644 --- a/libraries/entities/src/EntityTypes.h +++ b/libraries/entities/src/EntityTypes.h @@ -46,18 +46,18 @@ public: * See also, the "Box" and "Sphere" entity types. *
* * * * * * diff --git a/libraries/input-plugins/src/input-plugins/KeyboardMouseDevice.cpp b/libraries/input-plugins/src/input-plugins/KeyboardMouseDevice.cpp index ac8e6b8053..b1746951bb 100755 --- a/libraries/input-plugins/src/input-plugins/KeyboardMouseDevice.cpp +++ b/libraries/input-plugins/src/input-plugins/KeyboardMouseDevice.cpp @@ -275,13 +275,15 @@ controller::Input KeyboardMouseDevice::InputDevice::makeInput(KeyboardMouseDevic * * + * is the number of units rotated (typically 1.0). + *

Warning: The mouse wheel in an ordinary mouse generates left/right wheel events instead of + * up/down.

+ * * + * is the number of units rotated (typically 1.0). + *

Warning: The mouse wheel in an ordinary mouse generates left/right wheel events instead of + * up/down.

+ * * * * // Receiving script. * var channelName = "com.highfidelity.example.messages-example"; @@ -105,10 +105,10 @@ public: * @param {object} data - The data to send. The data is handled as a byte stream, for example, as may be provided via a * JavaScript Int8Array object. * @param {boolean} [localOnly=false] - If false then the message is sent to all Interface, client entity, - * server entity, and assignment client scripts in the domain.
- * If true then: if sent from an Interface or client entity script it is received by all Interface and + * server entity, and assignment client scripts in the domain. + *

If true then: if sent from an Interface or client entity script it is received by all Interface and * client entity scripts; if sent from a server entity script it is received by all entity server scripts; and if sent - * from an assignment client script it is received only by that same assignment client script. + * from an assignment client script it is received only by that same assignment client script.

* @example * // Receiving script. * var channelName = "com.highfidelity.example.messages-example"; diff --git a/libraries/script-engine/src/ScriptEngine.cpp b/libraries/script-engine/src/ScriptEngine.cpp index 8337d1911a..4cf4a9fc42 100644 --- a/libraries/script-engine/src/ScriptEngine.cpp +++ b/libraries/script-engine/src/ScriptEngine.cpp @@ -1027,8 +1027,8 @@ void ScriptEngine::addEventHandler(const EntityItemID& entityID, const QString& }; /**jsdoc - * The name of an entity event. When the entity event occurs, any function that has been registered for that event via - * {@link Script.addEventHandler} is called with parameters per the entity event. + *

The name of an entity event. When the entity event occurs, any function that has been registered for that event via + * {@link Script.addEventHandler} is called with parameters per the entity event.

*
{@link Entities.EntityProperties-Shape|EntityProperties-Shape}
"Box"A rectangular prism. This is a synonym of "Shape" for the case - * where the entity's shape property value is "Cube".
- * If an entity is created with its type + * where the entity's shape property value is "Cube". + *

If an entity is created with its type * set to "Box" it will always be created with a shape property value of * "Cube". If an entity of type Shape or Sphere has its shape set - * to "Cube" then its type will be reported as "Box". + * to "Cube" then its type will be reported as "Box".

{@link Entities.EntityProperties-Box|EntityProperties-Box}
"Sphere"A sphere. This is a synonym of "Shape" for the case - * where the entity's shape property value is "Sphere".
- * If an entity is created with its type + * where the entity's shape property value is "Sphere". + *

If an entity is created with its type * set to "Sphere" it will always be created with a shape property value of * "Sphere". If an entity of type Box or Shape has its shape set - * to "Sphere" then its type will be reported as "Sphere". + * to "Sphere" then its type will be reported as "Sphere".

{@link Entities.EntityProperties-Sphere|EntityProperties-Sphere}
"Model"A mesh model from a glTF, FBX, or OBJ file.{@link Entities.EntityProperties-Model|EntityProperties-Model}
MouseWheelLeftnumbernumberThe mouse wheel rotated left. The data value * is the number of units rotated (typically 1.0).
MouseWheelUpnumbernumberThe mouse wheel rotated up. The data value - * is the number of units rotated (typically 1.0).
- * Warning: The mouse wheel in an ordinary mouse generates left/right wheel events instead of - * up/down.
MouseWheelDownnumbernumberThe mouse wheel rotated down. The data value - * is the number of units rotated (typically 1.0).
- * Warning: The mouse wheel in an ordinary mouse generates left/right wheel events instead of - * up/down.
TouchpadRightnumbernumberThe average touch on a touch-enabled device * moved right. The data value is how far the average position of all touch points moved.
TouchpadLeftnumbernumberThe average touch on a touch-enabled device diff --git a/libraries/networking/src/MessagesClient.h b/libraries/networking/src/MessagesClient.h index b97c6d8360..7f2714e5ea 100644 --- a/libraries/networking/src/MessagesClient.h +++ b/libraries/networking/src/MessagesClient.h @@ -57,10 +57,10 @@ public: * @param {string} channel - The channel to send the message on. * @param {string} message - The message to send. * @param {boolean} [localOnly=false] - If false then the message is sent to all Interface, client entity, - * server entity, and assignment client scripts in the domain.
- * If true then: if sent from an Interface or client entity script it is received by all Interface and + * server entity, and assignment client scripts in the domain. + *

If true then: if sent from an Interface or client entity script it is received by all Interface and * client entity scripts; if sent from a server entity script it is received by all entity server scripts; and if sent - * from an assignment client script it is received only by that same assignment client script. + * from an assignment client script it is received only by that same assignment client script.

* @example
Send and receive a message.Send and receive data.
* * diff --git a/libraries/ui/src/ui/TabletScriptingInterface.h b/libraries/ui/src/ui/TabletScriptingInterface.h index ba02ba25b0..8cb28c2f20 100644 --- a/libraries/ui/src/ui/TabletScriptingInterface.h +++ b/libraries/ui/src/ui/TabletScriptingInterface.h @@ -69,7 +69,7 @@ class TabletScriptingInterface : public QObject, public Dependency { public: /**jsdoc - * Standard tablet sounds. + *

Standard tablet sounds.

*
Event NameEntity Event
* *
ValueDescription