Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add JSDoc for all methods and bring documentation up to PhET standards #49

Open
samreid opened this issue Jun 16, 2016 · 3 comments
Open

Comments

@samreid
Copy link
Member

samreid commented Jun 16, 2016

At today's developer meeting, we agreed it would be nice to have complete and correct JSDoc for all methods. @phetsims/martin volunteered to help out.

To discover the types for @param you may wish to put debugger statements and examine runtime types.

To discover whether each method is @public or @private you may wish to search for usages, examine context, or use debugger statements or use strategy like phetAllocation.js and:

      var stack;
      try { throw new Error(); }
      catch( e ) { stack = e.stack; }

to detect where methods are called from.

@veillette
Copy link
Contributor

veillette commented Jun 18, 2016

List of files to review.

  • BinPacker.js
  • Bounds2.js
  • Bounds3.js
  • Complex.js
  • config.js
  • ConvexHull2.js
  • Dimension2.js
  • dot.js
  • EigenvalueDecomposition.js
  • LinearFunction.js
  • LUDecomposition.js
  • main.js
  • Matrix.js
  • Matrix3.js
  • Matrix4.js
  • MatrixOps3.js
  • Permutation.js
  • Plane3.js
  • QRDecomposition.js
  • Quaternion.js
  • Random.js
  • Range.js
  • Ray2.js
  • Ray3.js
  • Rectangle.js
  • SingularValueDecomposition.js
  • Sphere3.js
  • Transform3.js
  • Transform4.js
  • Util.js
  • Vector2.js
  • Vector3.js
  • Vector4.js

@veillette veillette changed the title Add JSDoc for all methods Add JSDoc for all methods and bring documentation up to PhET standards Jun 22, 2016
@jonathanolson
Copy link
Contributor

Seems like this represents an extension of the work for #38, should that be closed?

@veillette
Copy link
Contributor

This is an extension of #38. A lot of documentation was added for #38 but there are a few files that need more documentation. I should be able to figure out most of it by reading the code. If i'm unsure about a particular method, I'll create an issue and assign it to @jonathanolson .

veillette added a commit that referenced this issue Jun 27, 2016
veillette added a commit that referenced this issue Jun 27, 2016
veillette added a commit that referenced this issue Jun 27, 2016
veillette added a commit that referenced this issue Jun 27, 2016
veillette added a commit that referenced this issue Jun 27, 2016
veillette added a commit that referenced this issue Jun 28, 2016
veillette added a commit that referenced this issue Jun 28, 2016
veillette added a commit that referenced this issue Jun 28, 2016
veillette added a commit that referenced this issue Jun 28, 2016
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

4 participants