Compiles source files using TypeScript and converts compiler symbols to reflections.
The name of this component as set by the
The human readable name of the project. Used within the templates to set the title of the document.
Triggered when the converter begins converting a project. The listener will be given a Context object.
Triggered when the converter has finished converting a project. The listener will be given a Context object.
Triggered when the converter begins resolving a project. The listener will be given Context.
Triggered when the converter has finished resolving a project. The listener will be given Context.
Return the owner of this component.
Retrieve a plugin instance.
The instance of the plugin or undefined if no plugin with the given class is attached.
Initialize this component.
Remove one or many callbacks. If
context is null, removes all
callbacks with that function. If
callback is null, removes all
callbacks for the event. If
name is null, removes all bound
callbacks for all events.
Bind an event to a
callback function. Passing
"all" will bind
the callback to all events fired.
Bind an event to only be triggered a single time. After the first time the callback is invoked, its listener will be removed. If multiple events are passed in using the space-separated syntax, the handler will fire once for each event, not once for a combination of all events.
Used to determine if we should immediately bail when creating a reflection. Note: This should not be used for excludeNotDocumented because we don't have enough information at this point since comment discovery hasn't happened.
Trigger one or many events, firing all bound callbacks. Callbacks are
passed the same arguments as
trigger is, apart from the event name
(unless you're listening on
"all", which will cause your callback to
receive the true name of the event as the first argument).
Generated using TypeDoc