This project is read-only.

State of code documentation in TypeScript

Topics: General
Nov 29, 2013 at 6:15 PM
Edited Nov 29, 2013 at 6:16 PM
I work on a fairly large TypeScript project that consists of multiple public APIs and I'm curious as to what people are using to generate documentation from code.

The project I work on was ported from JavaScript and we were hoping to use the existing JSDoc statements (with JSDoc 2), but our namespaces seemed to prevent that - JSDoc did not seem to like nested functions past a certain level. Furthermore, our use of the @class tag was causing JSDoc to crash.

I've seen a few "TSDoc" projects out there, but they all seem very incomplete.

I'm very interested in what others are doing to create documentation from their codebases... particularly because I have to ship API docs in the very near future.
Nov 30, 2013 at 3:30 PM
I actually like the idea of a documentation tool for .d.ts files. A (not fully implemented) solution for that is:
I'm currently working on an own tool, but it isn't ready for production yet.