biojs / biojs3

Draft of BioJS 3: Web components
BSD 3-Clause "New" or "Revised" License
18 stars 2 forks source link

Create a documentation generator for definition files #9

Open wilzbach opened 9 years ago

wilzbach commented 9 years ago

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 commented 9 years ago

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 ;-)