@hrefcl/apidoc - v4.0.5
    Preparing search index...

    Function preProcess

    Exports

    • Api Define

      PreProcess API Use tags to collect defined blocks

      First phase of

      Parameters

      • parsedFiles: any[]

        Array of parsed file objects containing API documentation blocks

      • filenames: string[]

        Array of filenames corresponding to the parsed files

      • packageInfos: any

        Package information including default version for versioning

      • Optionaltarget: string

        Target key in result object where collected definitions are stored

      Returns any

      Object containing all defined blocks organized by name and version

      processing that scans all parsed files to collect

      blocks and organize them by name and version. These blocks will later be referenced by

      tags during postprocessing.

      // Input: Parsed files with @apiDefine blocks
      const result = preProcess(parsedFiles, filenames, packageInfos, 'define');
      // Output: { define: { "UserObject": { "1.0.0": { ... block data ... } } } }

      4.0.0

    Settings

    Member Visibility