[Question] Support for a "Reference" section.

In my class doc, I want to show a new section called "References" which should be able to show a list of classes I want to reference.

The UI would look similar to what you see today in the Index section, but with a new heading References.

I feel a functionality like this would come in handy for projects like mine where I want to show "This class A can be called by Class B and Class C". In class B file, you will be able to reference class A as well.

TypeDoc does not support any such tags. So I was thinking of supporting a custom tag in this library, called - @reference. E.g.

/**
This is class A and does blah.

@reference {@link B}
@reference {@link C}
*/
class A {
  ...
}

To make this work, the users would have to create a new tsdoc.json file in the root of their directory.

{
    "$schema": "https://developer.microsoft.com/en-us/json-schemas/tsdoc/v0/tsdoc.schema.json",
    "extends": ["typedoc/tsdoc.json"],
    "noStandardTags": false,
    "tagDefinitions": [
        {
            "tagName": "@reference",
            "syntaxKind": "block",
            "allowMultiple": true
        }
    ]
}

In the code, we should be able to

Just parse the incoming reflections, and collect all @reference tags.
Remove those tags from comment, and add them to categories.

I have a semi-working POC that I can make a PR with. Do you think this would be helpful to support in this library?

milesj / docusaurus-plugin-typedoc-api

[Question] Support for a "Reference" section. #153