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

missing overview documentation in .js files #27

Open
pixelzoom opened this issue Feb 10, 2020 · 2 comments
Open

missing overview documentation in .js files #27

pixelzoom opened this issue Feb 10, 2020 · 2 comments

Comments

@pixelzoom
Copy link
Contributor

Related to #2 (code review):

  • Documentation at the top of .js files should provide an overview of purpose, responsibilies, and (where useful) examples of API use. If the file contains a subclass definition, it should indicate what functionality it adds to the superclass.

Most of the .js files have no overview description. Their overview documentation looks like this:

/**
 * @author Thiago de Mendonça Mildemberger (UTFPR)
 */
@pixelzoom
Copy link
Contributor Author

@ariel-phet asked me to mark this one as high priority, since it's important for on-going maintenance.

@tmildemberger
Copy link
Contributor

Now all .js files have an overview documentation.

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

2 participants