Skip to content

suggestions for improving API documentation #286

@tygerpatch

Description

@tygerpatch

The API documentations haven't been updated in almost two years. It'd be nice if they were updated automatically. Also, the JsDoc Toolkit is no longer being actively developed. It is now JsDoc 3.

There is a grunt plugin for generating the documentation: https://github.com/krampstudio/grunt-jsdoc

I would also like to see a different template being used, besides Codeview. The jsdoc3Template looks nice. I think it would especially help out when you need to search for a specific method. It also displays the source code inline.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions