Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Add documentation to a typescript module? #20

Closed
gashcrumb opened this issue Jul 3, 2014 · 1 comment
Closed

Add documentation to a typescript module? #20

gashcrumb opened this issue Jul 3, 2014 · 1 comment
Labels
enhancement Improved functionality

Comments

@gashcrumb
Copy link

Is there a way to add some jsdoc to a typescript module declaration and have it show up in the generated docs? Our project code is broken up into a bunch of modules and it'd be nice if it was possible to have a description of what the module is for in the generated API docs.

Nice work though!
@sebastian-lenz
Copy link
Member

Thanks! Module comments are on my todo-list. I'll keep you up to date.

lddubeau pushed a commit to lddubeau/typedoc that referenced this issue Apr 5, 2018
@greenkeeperio-bot @blakeembrey
chore: drop support for Node.js 0.10 (TypeStrong#20)
9dda103 
BREAKING CHANGE: This module no longer supports Node.js 0.10
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
enhancement Improved functionality
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
2 participants
@gashcrumb @sebastian-lenz