How do I generate documentation which displays files inline documentation in 1 column and code in another?

Question

I've seen it before, but I can't remember which project or which documentor they used (if any). I'm pretty sure it was a JS project, probably a Node.JS module.

Anyhow, the documentation was listed by file, and each page displayed as 2 columns, one with the inline documentation, and the other with the code.

Does anyone know which tools allow for this?

score 0 · Accepted Answer · answered Jul 02 '12 at 05:14

0

"Annotated Documentation" is what I was trying to think of!

The tool was docco.

The above link is docco's documentation as documented using docco.

answered Jul 02 '12 at 05:14

Dean Rather

31,756
15
66
72

How do I generate documentation which displays files inline documentation in 1 column and code in another?

1 Answers1