a fork of tsd-jsdoc to generate the type definitions for the overte scripting api

Original readme starts here

To use this module, simply specify it as the template for your normal JSDoc generation.

For example, from the command-line you can do:

$> jsdoc -t node_modules/tsd-jsdoc/dist -r .

Or add this to your JSON configuration:

{
    "opts": {
        "template": "./node_modules/tsd-jsdoc/dist"
    }
}

If you want to use supported ClosureCompiler features, you also need to specify this module as a pluginin your JSON configuration, like so:

{
    "plugins": [ "./node_modules/tsd-jsdoc/dist/plugin" ],
    "opts": {
        "template": "./node_modules/tsd-jsdoc/dist"
    }
}

This library provides very little validation beyond what JSDoc provides. Meaning if you have invalid JSDoc comments, this will likely output an invalid TypeScript Definition File.

Additionally there are things that JSDoc allows, that TypeScript does not. This library tries to make these differences transparent, and translate from one to the other when necessary. It can't handle anything though, and you can generate invalid Typescript even if your JSDoc is valid.

JSDoc has a bug that prevents it from correctly parsing export default class Name {}. The workaround is to use named exports (export class Name {}) or utilize the jsdoc-export-default-interop plugin.

Tags that describe the code, but support is not implemented are:

• @default - No TS equivalent
• @deprecated - No TS equivalent (issue)
• @event - No TS equivalent
• @exports - Everything is exported
• @external - Not sure what behavior would be expected
• @fires - No TS equivalent
• @listens - No TS equivalent
• @override - No TS equivalent (issue)
• @throws - No TS equivalent

Tags that are just metadata and don't actually describe the code are ignored. These are:

• @author
• @classdesc
• @copyright
• @description
• @example
• @file
• @license
• @requires
• @see
• @since
• @summary
• @todo
• @tutorial
• @version

All other JSDoc tags should work fine.

ClosureCompiler has a couple tags beyond the built-in JSDoc tags that can improve your TypeScript output. Here is a complete list of the features from CC that are supported in this template:

• @template T - For generics
• typeof T - For typeof operator

Vanilla JSDoc doesn't have a way to express all the features of TypeScript so we also support these non-standardized conventions:

• Class<T> - If we encounter a type that is Class<T> we will treat it as typeof T. See jsdoc3/jsdoc#1349