@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 body parameter information with type, validation, and metadata

      tag to extract request body parameter information

      Processes

      tags using the same syntax as

      but specifically for request body parameters. Adds special handling for boolean fields by setting a 'checked' property for HTML form rendering.

      tag

      // Input: "{String} name User's full name"
      // Output: { type: "String", field: "name", description: "User's full name", group: "Body" }
      // Input: "{Boolean} [active=true] User is active"
      // Output: { type: "Boolean", field: "active", defaultValue: "true", checked: true, optional: true }
      // Input: "{Object} user User object"
      // Output: { type: "Object", field: "user", description: "User object", parentNode: null }

      4.0.0