Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MissingCheckPlugin

MissingCheckPlugin checks resolved symbols in the Converter for adequate documentation.

Hierarchy

  • MissingCheckPlugin

Index

Constructors

Properties

Methods

Constructors

constructor

  • Instantiate new MissingCheckPlugin.

    Parameters

    • typedoc: Application

      Core TypeDoc Application processing

    Returns MissingCheckPlugin

Properties

Protected disabledOption

disabledOption: BooleanDeclarationOption = ...

Enable/disable this plugin.

Protected missingCheckLevelOption

missingCheckLevelOption: StringDeclarationOption = ...

Scope level to run check across.

Private typedoc

typedoc: Application

Protected verboseOption

verboseOption: BooleanDeclarationOption = ...

Enable/disable verbose error messages.

Methods

Private addOptionsToApplication

  • addOptionsToApplication(typedoc: Application): void

  • Register command line options this plugin supports for congifuration.

    Parameters

    • typedoc: Application

      The TypeDoc Application

    Returns void

Private checkReflection

  • checkReflection(reflection: Reflection, _context: Context, scopeLevel: string, verbose: boolean): boolean

  • Parameters

    • reflection: Reflection
    • _context: Context
    • scopeLevel: string
    • verbose: boolean

    Returns boolean

Private format

  • format(reflectionObj: Record<string, any>): string

  • Parameters

    • reflectionObj: Record<string, any>

    Returns string

init

  • init(): void

  • Initialise functionality of plugin by registering options and listeners.

    Returns void

Private kindChain

  • kindChain(reflection: Reflection): ReflectionKind[]

  • Parameters

    • reflection: Reflection

    Returns ReflectionKind[]

Private kindChainNames

  • kindChainNames(reflection: Reflection): (undefined | String)[]

  • Parameters

    • reflection: Reflection

    Returns (undefined | String)[]

Private onConverterResolveEnd

  • onConverterResolveEnd(_context: Context): void

  • Triggered when the converter finishes.

    Parameters

    • _context: Context

    Returns void

Private shouldCheck

  • shouldCheck(scopeLevel: string, flags: ReflectionFlags): boolean

  • Parameters

    • scopeLevel: string
    • flags: ReflectionFlags

    Returns boolean

Private subscribeToApplicationEvents

  • subscribeToApplicationEvents(typedoc: Application): void

  • Subscribes to events of the application so the plugin can do its work in the particular doc generation phases.

    Parameters

    • typedoc: Application

      The TypeDoc Application.

    Returns void

Generated using TypeDoc