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

Standardize API documentation style #17

Closed
mikeybanez opened this issue Oct 13, 2015 · 0 comments
Closed

Standardize API documentation style #17

mikeybanez opened this issue Oct 13, 2015 · 0 comments

Comments

@mikeybanez
Copy link
Collaborator

(mostly copy pasted from internal issue tracking: PLG-175, some parts might already be accomplished or might be outdated)

Here's the list of classes that we should tidy up:

Core/Scene Class

  • setName did not specify the parameter datatype (but has example)
  • isEmpty did not specify the return datatype (but has example)
  • searchAllForItemId does not have the standard parameter and return information
  • searchSceneWithItemId did not specify parameter datatype (but has example)
  • searchAllForItemName did not specify parameter datatype (but has example)

Core/Transition Class

  • toString did not specify the return datatype
  • toTransitionKey did not specify the return datatype

Core/AudioItem Class

  • Missing parameter/return datatype and description on most methods
  • No sample usage unlike other Item subclasses

Core/HTMLItem Class

  • No sample usage unlike other Item subclasses

System/CameraDevice Class

  • addToScene has no return datatype

System/Game Class

  • addToScene has no return datatype
  • getFpsRender, getFpsCapture, getImageName, and getReplace do not have any return datatype

System/MicrophoneDevice class

  • addToScene has no return datatype

Util Module

  • Color class and rectangle class do not have any documentation comments
@mikeybanez mikeybanez added this to the 0.11.0 milestone Nov 12, 2015
@mikeybanez mikeybanez self-assigned this Jan 14, 2016
@mikeybanez mikeybanez assigned ghost and unassigned mikeybanez Jan 19, 2016
@ghost ghost assigned miyb, mikeybanez and ghost and unassigned ghost , miyb and mikeybanez Jan 20, 2016
@ghost ghost assigned SML-MeSo and unassigned ghost Jan 22, 2016
@xjsframework xjsframework assigned ghost and unassigned SML-MeSo Jan 22, 2016
@ghost ghost assigned mikeybanez and ghost and unassigned ghost and mikeybanez Jan 22, 2016
@ghost ghost added the ready-for-release label Jan 25, 2016
@ghost ghost removed the review label Jan 25, 2016
@ghost ghost closed this as completed in 8f2cf64 Jan 25, 2016
This issue was closed.
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

3 participants