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.

Sign up for GitHub

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

Jump to bottom

docs: Add missing and update JSDoc comments (fix #839) #1711

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

docs: Add missing and update JSDoc comments (fix #839) #1711

wants to merge 2 commits into from

Commits on Oct 15, 2019

  1. docs: Add missing and update JSDoc comments 

    Not all JSDoc comments are complete.  I marked incomplete comments with `@todo` or `FIXME`, so a simple `grep` or `ag` search for either string should make it easy to start filling in missing info bit-by-bit.

I don’t know the architecture of this project, so I did my best to use accurate `{type}` annoations in the JSDoc comments. If I wasn’t able to determine a given field’s type, I usually marked it `{object}`.
    @Zearin
    Zearin committed Oct 15, 2019
    Configuration menu
    Copy the full SHA
    2d00075 View commit details
    Browse the repository at this point in the history

  2. docs: Fix wrongly de-dented functions

    @Zearin
    Zearin committed Oct 15, 2019
    Configuration menu
    Copy the full SHA
    fd9f722 View commit details
    Browse the repository at this point in the history