feat: Support for reference tag [#153]

[rash805115]

This PR adds support to show @reference tag, which is a custom tag, as discussed in #153

You can use this tag as @reference <Name> {@link <Exported class>}

E.g.

/**
This is class A and does blah.

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

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 new tsdoc.json in the root of your 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
        }
    ]
}

[rash805115]

Hi @milesj Can you take a look when you have a chance?

[rash805115]

Hello @milesj Can you please review this when you get a chance?

[milesj]

Can you post a screenshot of what this looks like in practice?

[rash805115]

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

[rash805115]

@milesj One last question, how can we release the changes? Is it automatically triggered?

[milesj]

I have to manually do it. I'll get around to it later today.