Merge pull request #13076 from ctrlaltdavid/21856-g

JSDoc fixes

interface/src/scripting/SelectionScriptingInterface.h

@@ -134,7 +134,7 @@ public:
     /**jsdoc
     * Get the names of all the selection lists.
     * @function Selection.getListNames
-    * @return {list[]} An array of names of all the selection lists.
+    * @returns {list[]} An array of names of all the selection lists.
     */
     Q_INVOKABLE QStringList getListNames() const;
 
@@ -184,7 +184,7 @@ public:
     * Get the list of avatars, entities, and overlays stored in a selection list.
     * @function Selection.getList
     * @param {string} listName - The name of the selection list.
-    * @return {Selection.SelectedItemsList} The content of a selection list. If the list name doesn't exist, the function 
+    * @returns {Selection.SelectedItemsList} The content of a selection list. If the list name doesn't exist, the function 
     *     returns an empty object with no properties.
     */
     Q_INVOKABLE QVariantMap getSelectedItemsList(const QString& listName) const;
@@ -192,7 +192,7 @@ public:
     /**jsdoc
     * Get the names of the highlighted selection lists.
     * @function Selection.getHighlightedListNames
-    * @return {string[]} An array of names of the selection list currently highlight enabled.
+    * @returns {string[]} An array of names of the selection list currently highlight enabled.
     */
     Q_INVOKABLE QStringList getHighlightedListNames() const;
 

libraries/animation/src/AnimationCache.h

@@ -47,45 +47,39 @@ public:
      * @property {number} sizeCached - Size in bytes of all cached resources. <em>Read-only.</em>
      */
 
-     // Functions are copied over from ResourceCache (see ResourceCache.h for reason).
+    // Functions are copied over from ResourceCache (see ResourceCache.h for reason).
 
-     /**jsdoc
+    /**jsdoc
      * Get the list of all resource URLs.
      * @function AnimationCache.getResourceList
-     * @return {string[]}
+     * @returns {string[]}
      */
 
-     /**jsdoc
+    /**jsdoc
      * @function AnimationCache.dirty
      * @returns {Signal}
      */
 
-     /**jsdoc
+    /**jsdoc
      * @function AnimationCache.updateTotalSize
      * @param {number} deltaSize
      */
 
-     /**jsdoc
+    /**jsdoc
+     * Prefetches a resource.
      * @function AnimationCache.prefetch
-     * @param {string} url
+     * @param {string} url - URL of the resource to prefetch.
-     * @param {object} extra
+     * @param {object} [extra=null]
-     * @returns {object}
+     * @returns {Resource}
      */
 
-     /**jsdoc
+    /**jsdoc
      * Asynchronously loads a resource from the specified URL and returns it.
      * @function AnimationCache.getResource
      * @param {string} url - URL of the resource to load.
      * @param {string} [fallback=""] - Fallback URL if load of the desired URL fails.
      * @param {} [extra=null]
-     * @return {Resource}
+     * @returns {Resource}
-     */
-
-     /**jsdoc
-     * Prefetches a resource.
-     * @function AnimationCache.prefetch
-     * @param {string} url - URL of the resource to prefetch.
-     * @return {Resource}
      */
 
 

libraries/audio/src/SoundCache.h

@@ -41,12 +41,12 @@ public:
      */
 
 
-     // Functions are copied over from ResourceCache (see ResourceCache.h for reason).
+    // Functions are copied over from ResourceCache (see ResourceCache.h for reason).
 
     /**jsdoc
      * Get the list of all resource URLs.
      * @function SoundCache.getResourceList
-     * @return {string[]}
+     * @returns {string[]}
      */
 
     /**jsdoc
@@ -60,10 +60,11 @@ public:
      */
 
     /**jsdoc
+     * Prefetches a resource.
      * @function SoundCache.prefetch
-     * @param {string} url
+     * @param {string} url - URL of the resource to prefetch.
-     * @param {object} extra
+     * @param {object} [extra=null]
-     * @returns {object}
+     * @returns {Resource}
      */
 
     /**jsdoc
@@ -72,14 +73,7 @@ public:
      * @param {string} url - URL of the resource to load.
      * @param {string} [fallback=""] - Fallback URL if load of the desired URL fails.
      * @param {} [extra=null]
-     * @return {Resource}
+     * @returns {Resource}
-     */
-
-    /**jsdoc
-     * Prefetches a resource.
-     * @function SoundCache.prefetch
-     * @param {string} url - URL of the resource to prefetch.
-     * @return {Resource}
      */
 
 

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

@@ -42,7 +42,7 @@ public slots:
      *
      * @function Graphics.getModel
      * @param {UUID} entityID - The objectID of the model whose meshes are to be retrieved.
-     * @return {Graphics.Model} the resulting Model object
+     * @returns {Graphics.Model} the resulting Model object
      */
     scriptable::ScriptableModelPointer getModel(QUuid uuid);
 
@@ -57,7 +57,7 @@ public slots:
      *
      * @function Graphics.newMesh
      * @param {Graphics.IFSData} ifsMeshData Index-Faced Set (IFS) arrays used to create the new mesh.
-     * @return {Graphics.Mesh} the resulting Mesh / Mesh Part object
+     * @returns {Graphics.Mesh} the resulting Mesh / Mesh Part object
      */
     /**jsdoc
     * @typedef {object} Graphics.IFSData

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

@@ -159,7 +159,7 @@ public:
     /**jsdoc
      * Get the list of all resource URLs.
      * @function ModelCache.getResourceList
-     * @return {string[]}
+     * @returns {string[]}
      */
 
     /**jsdoc
@@ -173,10 +173,11 @@ public:
      */
 
     /**jsdoc
+     * Prefetches a resource.
      * @function ModelCache.prefetch
-     * @param {string} url
+     * @param {string} url - URL of the resource to prefetch.
-     * @param {object} extra
+     * @param {object} [extra=null]
-     * @returns {object}
+     * @returns {Resource}
      */
 
     /**jsdoc
@@ -185,14 +186,7 @@ public:
      * @param {string} url - URL of the resource to load.
      * @param {string} [fallback=""] - Fallback URL if load of the desired URL fails.
      * @param {} [extra=null]
-     * @return {Resource}
+     * @returns {Resource}
-     */
-
-    /**jsdoc
-     * Prefetches a resource.
-     * @function ModelCache.prefetch
-     * @param {string} url - URL of the resource to prefetch.
-     * @return {Resource}
      */
 
 

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

@@ -163,44 +163,38 @@ public:
 
     // Functions are copied over from ResourceCache (see ResourceCache.h for reason).
 
-   /**jsdoc
+    /**jsdoc
-    * Get the list of all resource URLs.
+     * Get the list of all resource URLs.
-    * @function TextureCache.getResourceList
+     * @function TextureCache.getResourceList
-    * @return {string[]}
+     * @returns {string[]}
-    */
+     */
 
-   /**jsdoc
+    /**jsdoc
-    * @function TextureCache.dirty
+     * @function TextureCache.dirty
-    * @returns {Signal}
+     * @returns {Signal}
-    */
+     */
 
-   /**jsdoc
+    /**jsdoc
-    * @function TextureCache.updateTotalSize
+     * @function TextureCache.updateTotalSize
-    * @param {number} deltaSize
+     * @param {number} deltaSize
-    */
+     */
 
-   /**jsdoc
+    /**jsdoc
-    * @function TextureCache.prefetch
+     * Prefetches a resource.
-    * @param {string} url
+     * @function TextureCache.prefetch
-    * @param {object} extra
+     * @param {string} url - URL of the resource to prefetch.
-    * @returns {object}
+     * @param {object} [extra=null]
-    */
+     * @returns {Resource}
+     */
 
-   /**jsdoc
+    /**jsdoc
-    * Asynchronously loads a resource from the specified URL and returns it.
+     * Asynchronously loads a resource from the specified URL and returns it.
-    * @function TextureCache.getResource
+     * @function TextureCache.getResource
-    * @param {string} url - URL of the resource to load.
+     * @param {string} url - URL of the resource to load.
-    * @param {string} [fallback=""] - Fallback URL if load of the desired URL fails.
+     * @param {string} [fallback=""] - Fallback URL if load of the desired URL fails.
-    * @param {} [extra=null]
+     * @param {} [extra=null]
-    * @return {Resource}
+     * @returns {Resource}
-    */
+     */
-
-   /**jsdoc
-    * Prefetches a resource.
-    * @function TextureCache.prefetch
-    * @param {string} url - URL of the resource to prefetch.
-    * @return {Resource}
-    */
 
 
     /// Returns the ID of the permutation/normal texture used for Perlin noise shader programs.  This texture
@@ -249,10 +243,11 @@ signals:
 protected:
     
     /**jsdoc
-     * @function TextureCache.prefect
+     * @function TextureCache.prefetch
      * @param {string} url
      * @param {number} type
      * @param {number} [maxNumPixels=67108864]
+     * @returns {Resource}
      */
     // Overload ResourceCache::prefetch to allow specifying texture type for loads
     Q_INVOKABLE ScriptableResource* prefetch(const QUrl& url, int type, int maxNumPixels = ABSOLUTE_MAX_TEXTURE_NUM_PIXELS);

libraries/networking/src/ResourceCache.h

@@ -215,7 +215,7 @@ public:
     /**jsdoc
      * Get the list of all resource URLs.
      * @function ResourceCache.getResourceList
-     * @return {string[]}
+     * @returns {string[]}
      */
     Q_INVOKABLE QVariantList getResourceList();
 
@@ -257,10 +257,11 @@ protected slots:
     void updateTotalSize(const qint64& deltaSize);
 
     /**jsdoc
+     * Prefetches a resource.
      * @function ResourceCache.prefetch
-     * @param {string} url
+     * @param {string} url - URL of the resource to prefetch.
-     * @param {object} extra
+     * @param {object} [extra=null]
-     * @returns {object}
+     * @returns {Resource}
      */
     // Prefetches a resource to be held by the QScriptEngine.
     // Left as a protected member so subclasses can overload prefetch
@@ -273,7 +274,7 @@ protected slots:
      * @param {string} url - URL of the resource to load.
      * @param {string} [fallback=""] - Fallback URL if load of the desired URL fails.
      * @param {} [extra=null]
-     * @return {Resource}
+     * @returns {Resource}
      */
     /// Loads a resource from the specified URL and returns it.
     /// If the caller is on a different thread than the ResourceCache,
@@ -291,12 +292,7 @@ protected:
     // Pointers created through this method should be owned by the caller,
     // which should be a QScriptEngine with ScriptableResource registered, so that
     // the QScriptEngine will delete the pointer when it is garbage collected.
-    /**jsdoc
+    // JSDoc is provided on more general function signature.
-     * Prefetches a resource.
-     * @function ResourceCache.prefetch
-     * @param {string} url - URL of the resource to prefetch.
-     * @return {Resource}
-     */
     Q_INVOKABLE ScriptableResource* prefetch(const QUrl& url) { return prefetch(url, nullptr); }
 
     /// Creates a new resource.