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.

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

Generate documentation for external modules #43

Closed
smoli opened this issue Nov 15, 2014 · 2 comments
Closed

Generate documentation for external modules #43

smoli opened this issue Nov 15, 2014 · 2 comments
Labels
bug Functionality does not match expectation

Comments

@smoli
Copy link

smoli commented Nov 15, 2014

I love typedoc, atm it's missing one thing (I guess). My project is completely based on external modules (amd in my case). I keep a comment at the top of every module file to document what the purpose of the module is. These comments don't show up in the generated documentation.

Do I understand the documentation correctly that these comments only work for internal modules? Do you consider adding support for external modules?

@sebastian-lenz
Copy link
Member

Hi smoli, nice to hear from you and sorry for the long delay. The support of module level comments is not limited to internal modules, they should also show up for external modules.

We are currently in the process of moving to TypeScript 1.3 and the process of resolving module comments already has been completely rewritten. It would be great if you could wait for the release of TypeDoc v0.2 and test it against your files again.

@sebastian-lenz sebastian-lenz added the bug Functionality does not match expectation label Jan 14, 2015
@smoli
Copy link
Author

smoli commented Jan 17, 2015

Hi Sebastian, thanks for the reply. I switched to internal modules in the meantime. That works perfectly. Thanks.

lddubeau pushed a commit to lddubeau/typedoc that referenced this issue Apr 5, 2018
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Functionality does not match expectation
Projects
None yet
Development

No branches or pull requests

2 participants