set public and private annotations before parameters and return state…

…ment in jsDoc (#129)
phetsims · Jul 29, 2021 · 0f9ba7d · 0f9ba7d
1 parent c3ae621
commit 0f9ba7d
Show file tree

Hide file tree

Showing 9 changed files with 11 additions and 16 deletions.
diff --git a/js/common/model/LightRay.js b/js/common/model/LightRay.js
@@ -414,7 +414,6 @@ class LightRay {
    * Processes all the rays (virtual and real) into shape lines.
    * @private
    * @param {number} distanceTraveled
-   *
    */
   raysToShape( distanceTraveled ) {
 

diff --git a/js/common/model/Optic.js b/js/common/model/Optic.js
@@ -110,7 +110,7 @@ class Optic {
    * The returned object contains an outline shape, representing the reflecting coating,
    * and a fill shape representing the base backing of the mirror.
    * The shapes are drawn using quadratic Bezier curves.
-   *
+   * @public
    * @param {number} radius - radius of curvature at the center of the mirror
    * @param {number} diameter - vertical height of the mirror
    * @param {Optic.Curve} curve
@@ -122,7 +122,6 @@ class Optic {
       backShape: null,
       middleShape: null
     }
-   * @public
    */
   static getMirrorShapes( radius, diameter, curve, options ) {
 
@@ -444,8 +443,8 @@ class Optic {
 
   /**
    * Returns a normalized value (with a max of 1) for the diameter
-   * @param {number} diameter - diameter
    * @public
+   * @param {number} diameter
    * @returns {number}
    */
   getNormalizedDiameter( diameter ) {
@@ -476,8 +475,8 @@ class Optic {
 
   /**
    * Returns a normalized value (between 0 and 1) for the index of refraction
-   * @param {number} index - index of refraction
    * @public
+   * @param {number} index - index of refraction
    * @returns {number}
    */
   getNormalizedIndex( index ) {
@@ -585,7 +584,7 @@ class Optic {
    * The front shape is the left facing contour of the optic. This can be used for ray hit testing
    * The back shape is the right facing contour of the optic. back shape is null for mirror
    * The middle shape is the imaginary vertical line that splits a lens into two halves. Null for mirror.
-   *
+   * @public
    * @param {number} radius - radius of curvature at the center of the mirror
    * @param {number} diameter - vertical height of the mirror
    * @param {Optic.Curve} curve
@@ -597,7 +596,6 @@ class Optic {
       backShape: Shape|null,
       middleShape: Shape|null
     }
-   * @public
    */
   getShapes( radius, diameter, curve, options ) {
     if ( this.isLens() ) {

diff --git a/js/common/model/Ray.js b/js/common/model/Ray.js
@@ -64,7 +64,6 @@ class Ray extends Ray2 {
 
   /**
    * Determines if the point is along the ray direction
-   *
    * @public
    * @param {Vector2} point
    * @param {number} epsilon - tolerance value

diff --git a/js/common/model/SourceObject.js b/js/common/model/SourceObject.js
@@ -105,18 +105,18 @@ class SourceObject {
 
   /**
    * Returns the position of the source
-   * @returns {Vector2}
    * @public
+   * @returns {Vector2}
    */
   getPosition() {
     return this.firstPositionProperty.value;
   }
 
   /**
    * Sets the second source point
+   * @public
    * @param {Property.<Representation>} representationProperty
    * @param {Vector2} position
-   * @public
    */
   setSecondPoint( representationProperty, position ) {
     if ( representationProperty.value.isObject ) {

diff --git a/js/common/model/Target.js b/js/common/model/Target.js
@@ -264,11 +264,11 @@ class Target {
 
   /**
    * Returns the position of the target point
+   * @public
    * @param {Vector2} objectPosition
    * @param {Vector2} opticPosition
    * @param {number} focalLength
    * @returns {Vector2}
-   * @public
    */
   getPosition( objectPosition, opticPosition, focalLength ) {
 

diff --git a/js/common/view/CurveControl.js b/js/common/view/CurveControl.js
@@ -67,13 +67,12 @@ class CurveControl extends RectangularRadioButtonGroup {
   }
 
   /**
-   * Creates centered icon representation of convex/concave, lens/mirror.
-   *
+   * Creates a centered icon representation of convex/concave, lens/mirror.
+   * @public
    * @param {Optic.Curve} curve - the curve can be convex or concave
    * @param {Optic.Type} type - the type can be lens or mirror
    * @param {Object} [options] - see options below
    * @returns {Node}
-   * @public
    */
   static createIconNode( curve, type, options ) {
 

diff --git a/js/common/view/FocalPointNode.js b/js/common/view/FocalPointNode.js
@@ -55,6 +55,7 @@ class FocalPointNode extends PlusNode {
   }
 
   /**
+   * Returns an icon for the focal point
    * @public
    * @param {Object} [options]
    * @returns {PlusNode}

diff --git a/js/common/view/GeometricOpticsRulerNode.js b/js/common/view/GeometricOpticsRulerNode.js
@@ -207,8 +207,8 @@ class GeometricOpticsRulerNode extends RulerNode {
 
   /**
    * Forward an event from the toolbox to start dragging this node
-   * @param {SceneryEvent} event
    * @public
+   * @param {SceneryEvent} event
    */
   startDrag( event ) {
 

diff --git a/js/common/view/ToolboxPanel.js b/js/common/view/ToolboxPanel.js
@@ -103,7 +103,6 @@ class ToolboxPanel extends Panel {
 
   /**
    * Returns a small ruler icon
-   *
    * @private
    * @param {boolean} isVertical - is the ruler icon along the vertical axis
    * @returns {RulerNode} rulerIconNode