Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CommentPlugin

A handler that parses javadoc comments and attaches [[Models.Comment]] instances to the generated reflections.

Hierarchy

Implements

Index

Constructors

constructor

Properties

Private comments

comments: object

List of discovered module comments.

Type declaration

componentName

componentName: string

The name of this component as set by the @Component decorator.

Private hidden

hidden: Reflection[]

List of hidden reflections.

Accessors

application

owner

Methods

Private applyModifiers

  • Apply all comment tag modifiers to the given reflection.

    Parameters

    • reflection: Reflection

      The reflection the modifiers should be applied to.

    • comment: Comment

      The comment that should be searched for modifiers.

    Returns void

Protected bubble

getOptionDeclarations

initialize

  • initialize(): void

listenTo

listenToOnce

off

  • off(): any
  • off(eventMap: EventMap, context?: any): any
  • off(name: string, callback?: EventCallback, context?: any): any

on

  • on(eventMap: EventMap, context?: any): any
  • on(eventMap: EventMap, callback?: EventCallback, context?: any, priority?: number): any
  • on(name: string, callback: EventCallback, context?: any, priority?: number): any

Private onBegin

Private onBeginResolve

  • onBeginResolve(context: Context): void

Private onCreateTypeParameter

  • Triggered when the converter has created a type parameter reflection.

    Parameters

    • context: Context

      The context object describing the current state the converter is in.

    • reflection: TypeParameterReflection

      The reflection that is currently processed.

    • Optional node: Node

      The node that is currently processed if available.

    Returns void

Private onDeclaration

  • Triggered when the converter has created a declaration or signature reflection.

    Invokes the comment parser.

    Parameters

    • context: Context

      The context object describing the current state the converter is in.

    • reflection: Reflection

      The reflection that is currently processed.

    • Optional node: Node

      The node that is currently processed if available.

    Returns void

Private onFunctionImplementation

  • onFunctionImplementation(context: Context, reflection: Reflection, node?: Node): void
  • Triggered when the converter has found a function implementation.

    Parameters

    • context: Context

      The context object describing the current state the converter is in.

    • reflection: Reflection

      The reflection that is currently processed.

    • Optional node: Node

      The node that is currently processed if available.

    Returns void

Private onResolve

  • Triggered when the converter resolves a reflection.

    Cleans up comment tags related to signatures like @param or @return and moves their data to the corresponding parameter reflections.

    This hook also copies over the comment of function implementations to their signatures.

    Parameters

    • context: Context

      The context object describing the current state the converter is in.

    • reflection: DeclarationReflection

      The reflection that is currently resolved.

    Returns void

once

  • once(eventMap: EventMap, context?: any): any
  • once(name: string, callback: EventCallback, context?: any, priority?: any): any
  • 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.

    Parameters

    • eventMap: EventMap
    • Optional context: any

    Returns any

  • Parameters

    • name: string
    • callback: EventCallback
    • Optional context: any
    • Optional priority: any

    Returns any

stopListening

Private storeModuleComment

  • storeModuleComment(comment: string, reflection: Reflection): void

trigger

  • 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).

    Parameters

    Returns this

Static removeReflection

Static removeTags

  • removeTags(comment: Comment, tagName: string): void
  • Remove all tags with the given name from the given comment instance.

    Parameters

    • comment: Comment

      The comment that should be modified.

    • tagName: string

      The name of the that that should be removed.

    Returns void

Generated using TypeDoc