CODEWITHSUNDEEP
typescriptdocumentation-generationjsdoc
user1147862
user1147862

Reputation: 4226

Tool to generate documentation from JSDoc on TypeScript interfaces

I have a .d.ts file with the interfaces describing my library. It has JSDoc comments, which will be shown via intellisense in Visual Studio when people refer to the .d.ts in their code:

/** Description of JSNLogAppender */
interface JSNLogAppender {
    /* Description of setOptions */
    setOptions(options: JSNLogAppenderOptions): void;

    /* Description of log */
    log(logItem: JSNLogItem): void;
}

... etc ...

I need to generate documentation based on the JSDoc and TypeScript interfaces. Problem is that the generators I found all work with JavaScript, and interfaces are not compiled to JavaScript. I could put the JSDoc on the actual classes and functions that implement the interfaces, but than I would lose the intellisense when people refer to the .d.ts file.

Is there a tool that generates html documentation from the JSDoc comments and the TypeScript interface definitions in a .d.ts file?

Upvotes: 8

Views: 19959

Answers (4)

balupton
balupton

Reputation: 48709

You can use http://typedoc.org/

It supports jsdoc for things it cannot infer http://typedoc.org/guides/doccomments/

And any jsdoc descriptor it doesn't recognise will still be outputted, which is fortunate.

Upvotes: 4

Phil Freeman
Phil Freeman

Reputation: 4169

I've written this small tool which may be helpful: typescript-docs

You'll need to install the Haskell Platform to build it.

It has basic support for jsdoc-style comments, and will generate HTML with hyperlinks between types, possibly across modules.

Upvotes: 1

JasonS
JasonS

Reputation: 7733

I found a npm module that claims to do this, though I haven't tried it yet: https://www.npmjs.org/package/tsdoc

Upvotes: 1

basarat
basarat

Reputation: 276255

None at the moment. Could not find any related feature request here either: http://typescript.codeplex.com/workitem/list/basic

All that we do have at the moment is TypeScript language service understanding JSDoc: http://typescript.codeplex.com/workitem/178

Upvotes: 1

Related Questions