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

    Function parse

    Export configuration for the description parser

    • Parse

      Parameters

      • content: string

        Raw description content from the

      Returns { description: string }

      Object containing the processed description, or null if content is empty

      tag to extract endpoint description

      Processes

      tags by trimming whitespace and unindenting multi-line descriptions to create clean, readable documentation text. The description supports markdown formatting and multi-line content.

      tag

      // Input: "Retrieves user information by ID"
      // Output: { description: "Retrieves user information by ID" }

      // Input: "Creates a new user account.\n\n**Requirements:**\n- Valid email\n- Strong password"
      // Output: { description: "Creates a new user account.\n\n**Requirements:**\n- Valid email\n- Strong password" }

      Example: Empty content

      // Input: "   "
      // Output: null

      4.0.0

    Settings

    Member Visibility