Skip to content

Support JSDoc "synonyms" for tags #203

Open
@rbuckton

Description

@rbuckton

JSDoc supports synonyms for many tags, and it would be worthwhile to support those synonyms for code bases that were previously migrated from JavaScript to TypeScript without requiring an investment in time to rewrite doc comment tags to support TSDoc. For example:

  • @abstract (synonyms: @virtual)
  • @augments (synonyms: @extends)
  • @default (synonyms: @defaultvalue)
  • @description (synonyms: @desc)
  • @fires (synonyms: @emits)
  • @param (synonyms: @arg, @argument)
  • @returns (synonyms: @return)
  • @throws (synonyms: @exception)
  • @yields (synonyms: @yield)
  • {@link} (synonyms: {@linkcode}, {@linkplain})
  • etc.

It would also be valuable for type parameter support (#72), allowing @template as a synonym for @typeParam.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions