Skip to content

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

@samreid

Description

@samreid

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.

Metadata

Metadata

Assignees

No one assigned

    Type

    No type
    No fields configured for issues without a type.

    Projects

    Status
    No status

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions