@playform/document - v0.1.7
    Preparing search index...

    Interface Interface

    • Represents a function that processes file patterns and generates documentation.

      Parameters

      • File: string[]

        An array of file patterns to be processed. Each pattern can include wildcards to match multiple files.

      • OptionalOption: { Folder?: string }

        Optional configuration object for document generation

        • OptionalFolder?: string

          A string representing the output folder path for generated documentation

      Returns Promise<void>

      Promise - Resolves when documentation generation is complete

      If file processing or documentation generation fails

      // Generate documentation for TypeScript files
      await document(['src/\u002A\u002A/\u002A.ts'], { Folder: 'docs' });

      // Generate documentation with default folder
      await document(['src/\u002A\u002A/\u002A.js']);