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

    Function parse

    • Parse

      Parameters

      • content: string

        Raw content from the

      • source: string

        Source file path (unused but required for interface compatibility)

      Returns any

      Parsed header information or null if parsing fails

      tag to extract HTTP header information

      Processes

      tags using the same syntax as

      but specifically for HTTP headers. Automatically assigns the "Header" group unless a different group is specified in the tag.

      tag

      // Input: "{String} Authorization Bearer token for authentication"
      // Output: { type: "String", field: "Authorization", description: "Bearer token for authentication", group: "Header" }

      Example: Content-Type header

      // Input: "{String} Content-Type=application/json Request content type"
      // Output: { type: "String", field: "Content-Type", defaultValue: "application/json", description: "Request content type" }

      4.0.0

    Settings

    Member Visibility