TypeStrong / typedoc

Documentation generator for TypeScript projects.
https://typedoc.org
Apache License 2.0
7.61k stars 689 forks source link

Support for Tags used in documenting custom elements #2637

Closed fireflysemantics closed 3 weeks ago

fireflysemantics commented 1 month ago

Search Terms

It would be nice if Typedoc has support for the tags used to document custom element. JSDoc has these. More here: https://www.npmjs.com/package/web-component-analyzer

Problem

If Typedoc had the corresponding JSDoc features it makes documenting web components more straight forward with Typedoc

Suggested Solution

Implement corresponding JSDoc tags like @element, etc.

Gerrit0 commented 1 month ago

Marking this wontfix.

TypeDoc can be configured with support for custom tags already. If custom parsing/rendering is desired for a tag, this can be done by an external plugin. TypeDoc doesn't need to support it natively, and in the interest of reducing the maintenance burden, I do not plan on supporting additional sets of non-standard tags in the core without a very compelling reason.