docusaurus-plugin-typedoc-api icon indicating copy to clipboard operation
docusaurus-plugin-typedoc-api copied to clipboard

External symbols, `@inheritDoc` and class extension

Open B4nan opened this issue 2 years ago • 2 comments

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 avatar Jan 04 '23 13:01 B4nan

I'd appreciate some response on this.

B4nan avatar Apr 27 '23 08:04 B4nan

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".

milesj avatar Apr 27 '23 16:04 milesj