Closed rash805115 closed 1 week ago
Hi @milesj Can you take a look when you have a chance?
Hello @milesj Can you please review this when you get a chance?
Can you post a screenshot of what this looks like in practice?
@milesj The screenshot in PR description is taken from a real example. The new sections Models
and Resources
are created based on the @reference
tag.
@milesj One last question, how can we release the changes? Is it automatically triggered?
I have to manually do it. I'll get around to it later today.
This PR adds support to show
@reference
tag, which is a custom tag, as discussed in #153You can use this tag as
@reference <Name> {@link <Exported class>}
E.g.
It would look like,
If your IDE complains about using
@reference
tag, which is a custom tag not supported in TypeDoc, then you will need to extend their schema definition by putting a newtsdoc.json
in the root of your directory.