ModulesTypesShortName

This class monkey-patches the function JSDoc uses to register links in order to create "aliases" for external types and modules' types so they can be used without the external: and module:[name]. prefixes. For example: module:shared/apiClient.APIClient would also register APIClient; and external:Express would also register Express.

Constructor

new ModulesTypesShortName(events, jsdocTemplateHelper, EVENT_NAMES)

Source:

features/modulesTypesShortName.js, line 9

Parameters:

Name	Type	Description
`events`	EventEmitter	To hook to the event triggered when parsing begins.
`jsdocTemplateHelper`	JSDocTemplateHelper	To monkey-patch the `registerLink` function.
`EVENT_NAMES`	EventNames	To get the name of the event the class needs to listen for.