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

      Parameters

      • content: string

        Raw content from the

      • source: string

        Source file path (unused but required for interface compatibility)

      Returns any

      Parsed error response field information or null if parsing fails

      tag to extract error response field information

      Processes

      tags using the same syntax as

      but specifically for error response fields. Automatically assigns the "Error 4xx" group unless a different group is specified in the tag.

      tag

      // Input: "{String} message Error description"
      // Output: { type: "String", field: "message", description: "Error description", group: "Error 4xx" }
      // Input: "(Error 404) {String} message Resource not found"
      // Output: { type: "String", field: "message", description: "Resource not found", group: "Error 404" }
      // Input: "{Object} error Error details object"
      // Output: { type: "Object", field: "error", description: "Error details object", group: "Error 4xx" }

      4.0.0