Skip to content

Create a documentation generator for definition files #9

@wilzbach

Description

@wilzbach

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:

Metadata

Metadata

Assignees

No one assigned

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions