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

External symbols, @inheritDoc and class extension #87

Open
B4nan opened this issue Jan 4, 2023 · 2 comments
Open

External symbols, @inheritDoc and class extension #87

B4nan opened this issue Jan 4, 2023 · 2 comments

Comments

@B4nan
Copy link
Contributor

B4nan commented Jan 4, 2023

We have this apify SDK package which extends some classes from another package (crawlee). One example is the KeyValueStore class, exported from crawlee, which is extended in the SDK - only this extension is being exported from the SDK package. We have it documented with @inheritDoc but it is not being resolved (you can see the hierarchy is also not clickable - but we do set excludeExternals: false in the typedocOptions):

image

https://sdk.apify.com/api/apify/class/KeyValueStore
https://github.com/apify/apify-sdk-js/blob/master/packages/apify/src/key_value_store.ts

Not sure if this is a bug in the docusaurus integration or more of a typedoc thing on its own. If I reexport the class from crawlee inside the SDK package, it starts to work (both the @inheritDoc as well as the hierarchy links), but then I have one more class in the docs I don't want to have documented.

@B4nan
Copy link
Contributor Author

B4nan commented Apr 27, 2023

I'd appreciate some response on this.

@milesj
Copy link
Owner

milesj commented Apr 27, 2023

I'll be honest, I'm really not sure. All of the doc inheritance/linking stuff happens on the TypeDoc side. I'd guess that only things exported are actually considered "documentable".

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

2 participants