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
Expand union types #2303
Comments
That's a union type.. I have been considering a |
It would be excellent! I often come out to the situation where I want to |
@Gerrit0 You'll have to make sure such a tag can force rendering behavior in both the "expand" and "link" directions - the are situations where you want both, and it depends on code semantics that TypeDoc can't possibly know about. Also note that the present behavior does not necessarily always link or always expand - it differs depending on which part of the generated documentation you're in. Lower bounds on generic type parameters are always expanded in full, for example, while type declarations only expand if the component type is not present in the generated documentation. I also think I'm trying to convince my workplace to give me some time to spend on a plugin that does this, because we desperately need it. |
It would be nice if
->
Looks like related issue |
I'm in favor of the |
Search Terms
expand, imported, types
Problem
Code: https://github.com/deep-foundation/capacitor-device/blob/6d6eae584c3567c5e381fc8a68f733e157d1ab85/src/device-info.ts#L1
I get such documentation:
I would like typedoc to expand those types.
Example:
Suggested Solution
typescript-json-schema
is able to find all the actual properties of DeviceInfo and their descriptionsThe text was updated successfully, but these errors were encountered: