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

Generated legend is missing items #1270

Closed
Gerrit0 opened this issue Apr 16, 2020 · 7 comments
Closed

Generated legend is missing items #1270

Gerrit0 opened this issue Apr 16, 2020 · 7 comments
Milestone

Comments

@Gerrit0
Copy link
Collaborator

Gerrit0 commented Apr 16, 2020

I have the same problem. Enum and other types are missing. I am using mode "file".
@johansten : have you found a solution to the problem?

Originally posted by @mcmartincerny in #1136 (comment)


Pulling into a new issue to track.

@Gerrit0 Gerrit0 added the bug Functionality does not match expectation label Apr 16, 2020
@kaiyoma
Copy link

kaiyoma commented Nov 18, 2020

I'm seeing this issue regardless of mode. The legend is always empty.

@Gerrit0 Gerrit0 added needs reproduction Needs a minimal reproducible case - https://gist.github.com/Rich-Harris/88c5fc2ac6dc941b22e7996af05d reproduced and removed needs reproduction Needs a minimal reproducible case - https://gist.github.com/Rich-Harris/88c5fc2ac6dc941b22e7996af05d labels Nov 28, 2020
@Gerrit0
Copy link
Collaborator Author

Gerrit0 commented Nov 28, 2020

This can be reproduced still in 0.20 with a single exported function

export function foo(){}

The legend should have a function item, but is instead rendered empty.

@Gerrit0 Gerrit0 changed the title Generated legend is missing items in file mode Generated legend is missing items Nov 28, 2020
@mnn
Copy link

mnn commented Feb 3, 2021

I have updated from 0.17.7 to 0.20.20 and now I am missing half of classes. 😞 Not just in legend, links are broken and html files are gone.

before vs after (notice missing Some and None classes; not to be confused with some and none function/constant)

Edit: I am not using --excludeNotDocumented.

@Gerrit0
Copy link
Collaborator Author

Gerrit0 commented Feb 4, 2021

That looks like expected behavior to me. TypeDoc 0.20 only documents your exports, and neither Some nor None are exported. If you really want to include those - take a look at #1484.

@mnn
Copy link

mnn commented Feb 4, 2021

Regarding #1484, I don't use --excludeExternals nor have "Externals" unchecked. I have no intention of exporting those classes (it is supposed to be that way - a user should not be creating them directly). Those classes are in a same project, even same file, not a different package (library). I don't understand how that linked issue helps me.

I hope I don't have to downgrade (and possibly fork to fix TS version dependency) to continue using typedoc?

@Gerrit0
Copy link
Collaborator Author

Gerrit0 commented Feb 4, 2021

Sorry about that! I typoed the issue number. I meant to link to #1474

@mnn
Copy link

mnn commented Feb 8, 2021

@Gerrit0 Thank you, that plugin fixed the issue 🙂.

@Gerrit0 Gerrit0 added this to the v0.23 milestone Apr 17, 2022
@Gerrit0 Gerrit0 closed this as completed Jun 26, 2022
@Gerrit0 Gerrit0 removed the bug Functionality does not match expectation label Feb 2, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants