Convert all "/**jsdoc" occurrences to "/*@jsdoc"

MarkZuckherberg · May 11, 2021 · 4d11d1d · 4d11d1d
1 parent 2130dea
commit 4d11d1d
Show file tree

Hide file tree

Showing 220 changed files with 2,319 additions and 2,319 deletions.
diff --git a/assignment-client/src/AgentScriptingInterface.h b/assignment-client/src/AgentScriptingInterface.h
@@ -17,7 +17,7 @@
 
 #include "Agent.h"
 
-/**jsdoc
+/*@jsdoc
  * The <code>Agent</code> API enables an assignment client to emulate an avatar. Setting <code>isAvatar = true</code> connects 
  * the assignment client to the avatar and audio mixers, and enables the {@link Avatar} API to be used.
  *
@@ -62,7 +62,7 @@ class AgentScriptingInterface : public QObject {
     QUuid getSessionUUID() const { return _agent->getSessionUUID(); }
 
 public slots:
-    /**jsdoc
+    /*@jsdoc
      * Sets whether the script should emulate an avatar.
      * @function Agent.setIsAvatar
      * @param {boolean} isAvatar - <code>true</code> if the script emulates an avatar, otherwise <code>false</code>.
@@ -75,7 +75,7 @@ public slots:
      */
     void setIsAvatar(bool isAvatar) const { _agent->setIsAvatar(isAvatar); }
 
-    /**jsdoc
+    /*@jsdoc
      * Checks whether the script is emulating an avatar.
      * @function Agent.isAvatar
      * @returns {boolean} <code>true</code> if the script is emulating an avatar, otherwise <code>false</code>.
@@ -87,7 +87,7 @@ public slots:
      */
     bool isAvatar() const { return _agent->isAvatar(); }
 
-    /**jsdoc
+    /*@jsdoc
      * Plays a sound from the position and with the orientation of the emulated avatar's head. No sound is played unless 
      * <code>isAvatar == true</code>.
      * @function Agent.playAvatarSound

diff --git a/assignment-client/src/avatars/ScriptableAvatar.h b/assignment-client/src/avatars/ScriptableAvatar.h
@@ -18,7 +18,7 @@
 #include <ScriptEngine.h>
 #include <EntityItem.h>
 
-/**jsdoc
+/*@jsdoc
  * The <code>Avatar</code> API is used to manipulate scriptable avatars on the domain. This API is a subset of the 
  * {@link MyAvatar} API. To enable this API, set {@link Agent|Agent.isAvatar} to <code>true</code>.
  *
@@ -110,7 +110,7 @@ class ScriptableAvatar : public AvatarData, public Dependency {
 
     ScriptableAvatar();
 
-    /**jsdoc
+    /*@jsdoc
      * Starts playing an animation on the avatar.
      * @function Avatar.startAnimation
      * @param {string} url - The animation file's URL. Animation files need to be in glTF or FBX format but only need to 
@@ -130,13 +130,13 @@ class ScriptableAvatar : public AvatarData, public Dependency {
                                     bool hold = false, float firstFrame = 0.0f, float lastFrame = FLT_MAX, 
                                     const QStringList& maskedJoints = QStringList());
 
-    /**jsdoc
+    /*@jsdoc
      * Stops playing the current animation.
      * @function Avatar.stopAnimation
      */
     Q_INVOKABLE void stopAnimation();
 
-    /**jsdoc
+    /*@jsdoc
      * Gets the details of the current avatar animation that is being or was recently played.
      * @function Avatar.getAnimationDetails
      * @returns {Avatar.AnimationDetails} The current or recent avatar animation.
@@ -146,30 +146,30 @@ class ScriptableAvatar : public AvatarData, public Dependency {
      */
     Q_INVOKABLE AnimationDetails getAnimationDetails();
 
-    /**jsdoc
+    /*@jsdoc
      * @comment Uses the base class's JSDoc.
      */
     Q_INVOKABLE virtual QStringList getJointNames() const override;
 
-    /**jsdoc
+    /*@jsdoc
      * @comment Uses the base class's JSDoc.
      */
     /// Returns the index of the joint with the specified name, or -1 if not found/unknown.
     Q_INVOKABLE virtual int getJointIndex(const QString& name) const override;
 
-    /**jsdoc
+    /*@jsdoc
      * @comment Uses the base class's JSDoc.
      */
     Q_INVOKABLE virtual void setSkeletonModelURL(const QUrl& skeletonModelURL) override;
 
-    /**jsdoc
+    /*@jsdoc
      * @comment Uses the base class's JSDoc.
      */
     int sendAvatarDataPacket(bool sendAll = false) override;
 
     virtual QByteArray toByteArrayStateful(AvatarDataDetail dataDetail, bool dropFaceTracking = false) override;
 
-    /**jsdoc
+    /*@jsdoc
      * Gets details of all avatar entities.
      * <p><strong>Warning:</strong> Potentially an expensive call. Do not use if possible.</p>
      * @function Avatar.getAvatarEntityData
@@ -184,28 +184,28 @@ class ScriptableAvatar : public AvatarData, public Dependency {
 
     AvatarEntityMap getAvatarEntityDataInternal(bool allProperties) const;
 
-    /**jsdoc
+    /*@jsdoc
      * Sets all avatar entities from an object.
      * <p><strong>Warning:</strong> Potentially an expensive call. Do not use if possible.</p>
      * @function Avatar.setAvatarEntityData
      * @param {AvatarEntityMap} avatarEntityData - Details of the avatar entities.
      */
     Q_INVOKABLE void setAvatarEntityData(const AvatarEntityMap& avatarEntityData) override;
 
-    /**jsdoc
+    /*@jsdoc
      * @comment Uses the base class's JSDoc.
      */
     Q_INVOKABLE void updateAvatarEntity(const QUuid& entityID, const QByteArray& entityData) override;
 
 public slots:
-    /**jsdoc
+    /*@jsdoc
      * @function Avatar.update
      * @param {number} deltaTime - Delta time.
      * @deprecated This function is deprecated and will be removed.
      */
     void update(float deltatime);
 
-    /**jsdoc
+    /*@jsdoc
      * @function Avatar.setJointMappingsFromNetworkReply
      * @deprecated This function is deprecated and will be removed.
      */

diff --git a/assignment-client/src/entities/EntityTreeHeadlessViewer.h b/assignment-client/src/entities/EntityTreeHeadlessViewer.h
@@ -23,7 +23,7 @@
 
 class EntitySimulation;
 
-/**jsdoc
+/*@jsdoc
  * The <code>EntityViewer</code> API provides a headless viewer for assignment client scripts, so that they can "see" entities 
  * in order for them to be available in the {@link Entities} API.
  *

diff --git a/assignment-client/src/octree/OctreeHeadlessViewer.h b/assignment-client/src/octree/OctreeHeadlessViewer.h
@@ -27,7 +27,7 @@ class OctreeHeadlessViewer : public OctreeProcessor {
 
 public slots:
 
-    /**jsdoc
+    /*@jsdoc
      * Updates the entities currently in view.
      * @function EntityViewer.queryOctree
      */
@@ -36,28 +36,28 @@ public slots:
 
     // setters for camera attributes
 
-    /**jsdoc
+    /*@jsdoc
      * Sets the position of the view frustum.
      * @function EntityViewer.setPosition
      * @param {Vec3} position - The position of the view frustum.
      */
     void setPosition(const glm::vec3& position) { _hasViewFrustum = true; _viewFrustum.setPosition(position); }
 
-    /**jsdoc
+    /*@jsdoc
      * Sets the orientation of the view frustum.
      * @function EntityViewer.setOrientation
      * @param {Quat} orientation - The orientation of the view frustum.
      */
     void setOrientation(const glm::quat& orientation) { _hasViewFrustum = true; _viewFrustum.setOrientation(orientation); }
 
-    /**jsdoc
+    /*@jsdoc
      * Sets the radius of the center "keyhole" in the view frustum.
      * @function EntityViewer.setCenterRadius
      * @param {number} radius - The radius of the center "keyhole" in the view frustum.
      */
     void setCenterRadius(float radius) { _hasViewFrustum = true; _viewFrustum.setCenterRadius(radius); }
 
-    /**jsdoc
+    /*@jsdoc
      * Sets the radius of the center "keyhole" in the view frustum.
      * @function EntityViewer.setKeyholeRadius
      * @param {number} radius - The radius of the center "keyhole" in the view frustum.
@@ -69,21 +69,21 @@ public slots:
 
     // setters for LOD and PPS
 
-    /**jsdoc
+    /*@jsdoc
      * @function EntityViewer.setVoxelSizeScale
      * @param {number} sizeScale - The voxel size scale.
      * @deprecated This function is deprecated and will be removed.
      */
     void setVoxelSizeScale(float sizeScale) { _octreeQuery.setOctreeSizeScale(sizeScale) ; }
 
-    /**jsdoc
+    /*@jsdoc
      * @function EntityViewer.setBoundaryLevelAdjust
      * @param {number} boundaryLevelAdjust - The boundary level adjust factor.
      * @deprecated This function is deprecated and will be removed.
      */
     void setBoundaryLevelAdjust(int boundaryLevelAdjust) { _octreeQuery.setBoundaryLevelAdjust(boundaryLevelAdjust); }
 
-    /**jsdoc
+    /*@jsdoc
      * Sets the maximum number of entity packets to receive from the domain server per second.
      * @function EntityViewer.setMaxPacketsPerSecond
      * @param {number} maxPacketsPerSecond - The maximum number of entity packets to receive per second.
@@ -92,14 +92,14 @@ public slots:
 
     // getters for camera attributes
 
-    /**jsdoc
+    /*@jsdoc
      * Gets the position of the view frustum.
      * @function EntityViewer.getPosition
      * @returns {Vec3} The position of the view frustum.
      */
     const glm::vec3& getPosition() const { return _viewFrustum.getPosition(); }
 
-    /**jsdoc
+    /*@jsdoc
      * Gets the orientation of the view frustum.
      * @function EntityViewer.getOrientation
      * @returns {Quat} The orientation of the view frustum.
@@ -109,29 +109,29 @@ public slots:
 
     // getters for LOD and PPS
 
-    /**jsdoc
+    /*@jsdoc
      * @function EntityViewer.getVoxelSizeScale
      * @returns {number} The voxel size scale.
      * @deprecated This function is deprecated and will be removed.
      */
     float getVoxelSizeScale() const { return _octreeQuery.getOctreeSizeScale(); }
 
-    /**jsdoc
+    /*@jsdoc
      * @function EntityViewer.getBoundaryLevelAdjust
      * @returns {number} The boundary level adjust factor.
      * @deprecated This function is deprecated and will be removed.
      */
     int getBoundaryLevelAdjust() const { return _octreeQuery.getBoundaryLevelAdjust(); }
 
-    /**jsdoc
+    /*@jsdoc
      * Gets the maximum number of entity packets to receive from the domain server per second.
      * @function EntityViewer.getMaxPacketsPerSecond
      * @returns {number} The maximum number of entity packets to receive per second.
      */
     int getMaxPacketsPerSecond() const { return _octreeQuery.getMaxQueryPacketsPerSecond(); }
 
 
-    /**jsdoc
+    /*@jsdoc
      * Gets the number of nodes in the octree.
      * @function EntityViewer.getOctreeElementsCount
      * @returns {number} The number of nodes in the octree.

diff --git a/interface/src/AboutUtil.h b/interface/src/AboutUtil.h
@@ -16,7 +16,7 @@
 
 #include <QObject>
 
-/**jsdoc
+/*@jsdoc
  * The <code>About</code> API provides information about the version of Interface that is currently running. It also has the
  * functionality to open a web page in an Interface browser window.
  *
@@ -41,7 +41,7 @@
  * print("Qt version: " + About.qtVersion);
  */
 
- /**jsdoc
+ /*@jsdoc
  * The <code>HifiAbout</code> API provides information about the version of Interface that is currently running. It also
  * has the functionality to open a web page in an Interface browser window.
  *
@@ -82,7 +82,7 @@ class AboutUtil : public QObject {
 
 public slots:
 
-    /**jsdoc
+    /*@jsdoc
      * Display a web page in an Interface browser window or the tablet.
      * @function About.openUrl
      * @param {string} url - The URL of the web page you want to view in Interface.

diff --git a/interface/src/Application.cpp b/interface/src/Application.cpp
@@ -657,7 +657,7 @@ class ApplicationMeshProvider : public scriptable::ModelProviderFactory  {
     }
 };
 
-/**jsdoc
+/*@jsdoc
  * <p>The <code>Controller.Hardware.Application</code> object has properties representing Interface's state. The property
  * values are integer IDs, uniquely identifying each output. <em>Read-only.</em></p>
  * <p>These states can be mapped to actions or functions or <code>Controller.Standard</code> items in a {@link RouteObject}

diff --git a/interface/src/AvatarBookmarks.cpp b/interface/src/AvatarBookmarks.cpp
@@ -180,7 +180,7 @@ void AvatarBookmarks::updateAvatarEntities(const QVariantList &avatarEntities) {
     }
 }
 
-/**jsdoc
+/*@jsdoc
  * Details of an avatar bookmark.
  * @typedef {object} AvatarBookmarks.BookmarkData
  * @property {number} version - The version of the bookmark data format.