-
Notifications
You must be signed in to change notification settings - Fork 89
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
Better Quality Documentation #42
Merged
joshmarinacci
merged 15 commits into
joshmarinacci:master
from
robertmain:documentation-tidy-up
Dec 6, 2017
Merged
Better Quality Documentation #42
joshmarinacci
merged 15 commits into
joshmarinacci:master
from
robertmain:documentation-tidy-up
Dec 6, 2017
Commits on Nov 24, 2017
-
Configuration menu - View commit details
-
Copy full SHA for b5c4fab - Browse repository at this point
Copy the full SHA b5c4fabView commit details -
Move class properties out of `Object.defineProperty` calls to class getters and setters. This allows us to target them with esdoc annotations in a way that wasn't possible before with `Object.defineProperty` Ref joshmarinacci#32
Configuration menu - View commit details
-
Copy full SHA for 816f9fb - Browse repository at this point
Copy the full SHA 816f9fbView commit details -
- Remove `/** @ignore*/` before each dependency require - unfortunately this will make the documentation coverage score go down, but it seems better to have easier to read code - Assign dependencies with `const` instead of `var` since it prevents accidental re-assignment - Sort dependencies alphabetically
Configuration menu - View commit details
-
Copy full SHA for 763d1ec - Browse repository at this point
Copy the full SHA 763d1ecView commit details -
Add `@ignore` to unimplemented methods to hide them from the documentation Ref joshmarinacci#32
Configuration menu - View commit details
-
Copy full SHA for 192caa1 - Browse repository at this point
Copy the full SHA 192caa1View commit details -
- Hide private methods and properties - Add `esdoc-member-plugin` to document ES6 class getters and setters Ref joshmarinacci#32
Configuration menu - View commit details
-
Copy full SHA for 4cab992 - Browse repository at this point
Copy the full SHA 4cab992View commit details -
- Update documentation for line related functions to provide examples on how they can be called - Also remove `makeLine()` function since it is now obsolete Ref joshmarinacci#32
Configuration menu - View commit details
-
Copy full SHA for bb4fce3 - Browse repository at this point
Copy the full SHA bb4fce3View commit details -
Update `Context` to more closely match the documentation on MDN, since it is intended to match the API available from the HTML5 `<canvas>` API. In each case - a link has been provided to the appropriate MDN page, both for attribution and for further reference. Ref joshmarinacci#32
Configuration menu - View commit details
-
Copy full SHA for 5312b09 - Browse repository at this point
Copy the full SHA 5312b09View commit details -
Provide documentation for additional methods(in particular those not available on MDN for reference) to better explain their purpose and usage. Whilst some of these methods may be private and/or non-exported - this information may still prove useful for library contributors and maintainers(some IDEs can provide this information in a popup dialog box). Also, make more usage of `{@link }` to link to other classes, functions, variables etc. when talking about them in the docblocks Ref joshmarinacci#32
Configuration menu - View commit details
-
Copy full SHA for 8e6ece1 - Browse repository at this point
Copy the full SHA 8e6ece1View commit details -
Configuration menu - View commit details
-
Copy full SHA for 7b517ce - Browse repository at this point
Copy the full SHA 7b517ceView commit details -
- Align `=` signs to make the assignments easier to read - Replace single-line `if` statements to wrap `return` in braces so it's easier to read at a glance - Remove commented out `console.log` logging/debugging code
Configuration menu - View commit details
-
Copy full SHA for 06042ab - Browse repository at this point
Copy the full SHA 06042abView commit details -
Fix small documentation bugs(missing asterisks etc.) causing impoper formatting of documentation Ref joshmarinacci#32
Configuration menu - View commit details
-
Copy full SHA for 7247aab - Browse repository at this point
Copy the full SHA 7247aabView commit details -
Add missing docblocks for `start` and `end` attribues of `Line` Ref joshmarinacci#32
Configuration menu - View commit details
-
Copy full SHA for fcc550d - Browse repository at this point
Copy the full SHA fcc550dView commit details -
Provide more detailed documentation on the Bitmap class Ref joshmarinacci#32
Configuration menu - View commit details
-
Copy full SHA for e4ad9d5 - Browse repository at this point
Copy the full SHA e4ad9d5View commit details -
Add `@ignore` tag to methods that are not part of the canvas API spec Ref joshmarinacci#32
Configuration menu - View commit details
-
Copy full SHA for 42c9452 - Browse repository at this point
Copy the full SHA 42c9452View commit details
Commits on Nov 25, 2017
-
Update function docblocks to correctly reflect the fact that resolved promises resolve to `void` Ref joshmarinacci#32
Configuration menu - View commit details
-
Copy full SHA for d93c902 - Browse repository at this point
Copy the full SHA d93c902View commit details
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.