typedoc-ngx-theme v0.0.3

typedoc-ngx-theme

Deprecated

This library has been deprecated, due to a misnomer. Now that the functionality has become more clear, it's apparent this is not a TypeDoc theme, but rather a TypeDoc plugin.

See typedoc-ngx-plugin for a maintained version of this package.

About

A small TypeDoc plugin that is intended to create more useful documentation for Angular Libraries. Using this plugin will detect the Angular @Output decorator in your TypeDoc reflections, and change the reflection kind from a Class property to an Event. This eliminates the need to use the JSDoc @event notation in your comments, and will correctly classify undocumented Angular events.

TODO

This plugin is very much a work in progress. The intention is to also use the Angular @Input decorator in TypeDoc's reflections. The Inputs will be categorized similar to Events, such that they will present as a separate category on your Component or Directive class's TypeDoc output.