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

Create a documentation generator for definition files #9

Open
wilzbach opened this issue Jul 8, 2015 · 1 comment
Open

Create a documentation generator for definition files #9

wilzbach opened this issue Jul 8, 2015 · 1 comment

Comments

@wilzbach
Copy link
Member

wilzbach commented Jul 8, 2015

We want decouple to the annotations from the code and developers can use whatever flavour they like. #8

@herkulano

A good example of this is Definition Files for TypeScript. They are completely separate from the code and you can even have other people documenting older code.

The community of TypeScript has been building definition files on their own in DefinitelyTyped

Here is the JQuery .d.ts file as an example:
https://github.com/borisyankov/DefinitelyTyped/blob/master/jquery/jquery.d.ts

The only thing is that we have to write our own documentation generator or pick one that suits our needs, here's a few from a quick google search:

@wilzbach
Copy link
Member Author

wilzbach commented Jul 8, 2015

Probably we also want to add a "Hydrolysis" (a generator for the definition files based on the source code) for one or two favorite flavors like Polymer + ES5 or Polymer and ES6 ;-)

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