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

    Exports

    • Api Define

      PostProcess API Use tags to include defined blocks

      Second phase of

      Parameters

      • parsedFiles: any[]

        Array of parsed file objects to process for

      • filenames: string[]

        Array of filenames for error reporting

      • preProcess: any

        Previously collected defined blocks from preprocessing phase

      • packageInfos: any

        Package information for version handling

      • Optionalsource: string

        Key in preProcess object containing the defined blocks

      • Optionaltarget: string

        Key in block.local containing

      • Optionalmessages: any

        Error message templates for consistent error reporting

      Returns void

      processing that finds

      references in API blocks and replaces them with the corresponding block content. Handles version matching, recursive inclusion, and error reporting for missing references.

      tags

      references to process

      When referenced definition doesn't exist

      When recursion depth exceeds limit (10 levels)

      When no matching version is found

      Processing
      

      references

      // Before: block.local.use = [{ name: "UserObject" }]
      postProcess(parsedFiles, filenames, preProcess, packageInfos);
      // After: UserObject definition content is merged into the block

      4.0.0