Tool to generate documentation from JSDoc on TypeScript interfaces

Question

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?

balupton · Accepted Answer · 2018-12-07 11:32:20Z

4

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.

answered Dec 7, 2018 at 11:32

balupton

49k32 gold badges136 silver badges185 bronze badges

Sign up to request clarification or add additional context in comments.

Comments

JasonS · Accepted Answer · 2014-07-03 02:03:39Z

1

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

answered Jul 3, 2014 at 2:03

JasonS

7,7736 gold badges43 silver badges63 bronze badges

1 Comment

Adam Harte Over a year ago

I can't see anywhere where tsdoc claims to generate docs from a definition file. It just says it uses the TypeScript compiler to generate docs from the source code.

basarat · Accepted Answer · 2013-05-20 00:13:06Z

1

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

answered May 20, 2013 at 0:13

basarat

278k60 gold badges475 silver badges528 bronze badges

2 Comments

user1147862 Over a year ago

In the absence of any tools to do this, I'm thinking of creating my own. It would parse a .d.ts file (including the JSDoc) and generate HTML using T4 templates. Am wondering if such a tool would be useful to people besides myself, or am I going off track here?

basarat Over a year ago

I would love to have a tool to do this. One recommendation is to use NodeJS instead of C# (I know it can be a pain) but it would be more cross platform and would integrate into the modern web workflows (e.g yeoman.io gruntjs etc)

Phil Freeman · Accepted Answer · 2015-09-07 22:15:33Z

1

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.

edited Sep 7, 2015 at 22:15

answered Sep 26, 2013 at 16:06

Phil Freeman

4,1691 gold badge22 silver badges15 bronze badges

Collectives™ on Stack Overflow

Tool to generate documentation from JSDoc on TypeScript interfaces

4 Answers 4

Comments

1 Comment

2 Comments

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

4 Answers 4

Comments

1 Comment

2 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Related