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

Generate documentations through param and return #2

Open
mako-taco opened this issue May 30, 2015 · 0 comments
Open

Generate documentations through param and return #2

mako-taco opened this issue May 30, 2015 · 0 comments

Comments

@mako-taco
Copy link
Owner

Ideally, i'd like to have decorators replace JSDocs for documenting code, which means we need a way to generate pretty docs from a decorated class or object. AFAIK, there are no AST-generating libraries which handle decorator syntax, so that will need to be solved first.

Proposed syntax:

let typedef = {name: String, age: Number}

@jsdoc(options)
class T {
  @param(Type, 'Description for arg0')
  @param(typedef, 'Description for arg1')
  method(arg0, arg1) {
  }
}

Requirements:

  • Docs must be stripped out upon minification of code
  • CLI must produce a folder of HTML docs in a configurable location
  • Reasonable support of describing duck-typed / complex types

Any class decorated with @jsdoc will have docs exported by a CLI tool.

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

1 participant