-
Notifications
You must be signed in to change notification settings - Fork 6
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
Labels
Comments
List of files to review.
|
veillette
changed the title
Add JSDoc for all methods
Add JSDoc for all methods and bring documentation up to PhET standards
Jun 22, 2016
veillette
referenced
this issue
Jun 22, 2016
Seems like this represents an extension of the work for #38, should that be closed? |
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 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
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
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:to detect where methods are called from.
The text was updated successfully, but these errors were encountered: