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

Better Quality Documentation #42

Merged
merged 15 commits into from
Dec 6, 2017

Commits on Nov 24, 2017

  1. Spacing

    Remove excess spacing from the end of lines etc.
    robertmain committed Nov 24, 2017
    Configuration menu
    Copy the full SHA
    b5c4fab View commit details
    Browse the repository at this point in the history
  2. Class Properties

    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
    robertmain committed Nov 24, 2017
    Configuration menu
    Copy the full SHA
    816f9fb View commit details
    Browse the repository at this point in the history
  3. Tidy Up Dependencies

    - 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
    robertmain committed Nov 24, 2017
    Configuration menu
    Copy the full SHA
    763d1ec View commit details
    Browse the repository at this point in the history
  4. Ignore Unimplemented Methods

    Add `@ignore` to unimplemented methods to hide them from the documentation
    
    Ref joshmarinacci#32
    robertmain committed Nov 24, 2017
    Configuration menu
    Copy the full SHA
    192caa1 View commit details
    Browse the repository at this point in the history
  5. ESDoc Configuration

    - Hide private methods and properties
    - Add `esdoc-member-plugin` to document ES6 class getters and setters
    
    Ref joshmarinacci#32
    robertmain committed Nov 24, 2017
    Configuration menu
    Copy the full SHA
    4cab992 View commit details
    Browse the repository at this point in the history
  6. Line Functions

    - 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
    robertmain committed Nov 24, 2017
    Configuration menu
    Copy the full SHA
    bb4fce3 View commit details
    Browse the repository at this point in the history
  7. MDN Documentation

    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
    robertmain committed Nov 24, 2017
    Configuration menu
    Copy the full SHA
    5312b09 View commit details
    Browse the repository at this point in the history
  8. Document Additional Methods

    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
    robertmain committed Nov 24, 2017
    Configuration menu
    Copy the full SHA
    8e6ece1 View commit details
    Browse the repository at this point in the history
  9. Configuration menu
    Copy the full SHA
    7b517ce View commit details
    Browse the repository at this point in the history
  10. Code Tidy-Up

    - 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
    robertmain committed Nov 24, 2017
    Configuration menu
    Copy the full SHA
    06042ab View commit details
    Browse the repository at this point in the history
  11. Documentation Bugs

    Fix small documentation bugs(missing asterisks etc.) causing impoper formatting of documentation
    
    Ref joshmarinacci#32
    robertmain committed Nov 24, 2017
    Configuration menu
    Copy the full SHA
    7247aab View commit details
    Browse the repository at this point in the history
  12. Missing Docblock

    Add missing docblocks for `start` and `end` attribues of `Line`
    
    Ref joshmarinacci#32
    robertmain committed Nov 24, 2017
    Configuration menu
    Copy the full SHA
    fcc550d View commit details
    Browse the repository at this point in the history
  13. Bitmap Class

    Provide more detailed documentation on the Bitmap class
    
    Ref joshmarinacci#32
    robertmain committed Nov 24, 2017
    Configuration menu
    Copy the full SHA
    e4ad9d5 View commit details
    Browse the repository at this point in the history
  14. Ignore Non-Canvas API Methods

    Add `@ignore` tag to methods that are not part of the canvas API spec
    
    Ref joshmarinacci#32
    robertmain committed Nov 24, 2017
    Configuration menu
    Copy the full SHA
    42c9452 View commit details
    Browse the repository at this point in the history

Commits on Nov 25, 2017

  1. Promise Documentation

    Update function docblocks to correctly reflect the fact that resolved
    promises resolve to `void`
    
    Ref joshmarinacci#32
    robertmain committed Nov 25, 2017
    Configuration menu
    Copy the full SHA
    d93c902 View commit details
    Browse the repository at this point in the history