Function documentCodeInstruction

  • Generates instruction on to document code for the provided source code.

    Returns

    Instruction to document code for the provided source code.

    Parameters

    • Optional language: string

      The programming language, e.g. TypeScript. If not provided, defaults to TypeScript.

    • Optional framework: string

      The testing framework, e.g. JSDoc. If not provided, defaults to JSDoc.

    Returns string

Settings

Member Visibility

Theme

Generated using TypeDoc