typedoc suddenly stopped documenting namespaces / modules? #2968
Unanswered
petermakeswebsites
asked this question in
Q&A
Replies: 1 comment
-
Module comments must be at the top of the file, before any imports/exports |
Beta Was this translation helpful? Give feedback.
0 replies
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Uh oh!
There was an error while loading. Please reload this page.
-
Hey all. Weird issue. Everything in typedoc works, but now suddenly it stopped adding documentation to the root of my namespaces. Even going back in the git log doesn't work. It's possible I didn't save a commit while I had it working, but I can't think of anything I would have changed that could possibly have affected this. I have a simple setup like this:
In
navigation/index.ts
I import all navigation related stuff and export it, then add module documentation to it.navigation/index.ts:
Then in main.ts I import it
When I run typedoc targeting main.ts, it generates everything fine, with namespaces neatly organised and their appropriate exports, but I can't see the Navigation module comments! The Navigation namespace in the documentation has no comments. It's just a list of all the exports - which do have comments/documentation of course.
It's the most confusing thing because it was working at some point... and then it wasn't!
Can anyone think of any reason why this would not be working?
I use
typedoc --out docs src/main.ts
with{"excludeInternal": true}
in mytypedoc.json
.Thanks!
Beta Was this translation helpful? Give feedback.
All reactions