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

    Export configuration for the structure worker

    • Api Structure Api Define

      PreProcess API Structure tags to collect structure definitions

      First phase of processing that delegates to the

      Parameters

      • parsedFiles: any

        Array of parsed file objects containing structure definitions

      • filenames: any

        Array of filenames for the parsed files

      • packageInfos: any

        Package information for version handling

      Returns any

      Object containing collected structure definitions organized by name and version

      worker to collect blocks specifically for parameter structures. These structures define reusable parameter patterns that can be included in multiple endpoints.

      // Collects @apiDefine blocks marked for structure use
      const result = preProcess(parsedFiles, filenames, packageInfos);
      // Returns: { defineStructure: { "UserStructure": { "1.0.0": {...} } } }

      4.0.0