Variable parseConst

Type Declaration

• • (content: string): { name: string }

  • Parse

    Parameters

    • content: string

      Raw content from the

    Returns { name: string }

    Object containing the referenced block name, or null if content is empty

    Api Use

    tag to extract reference to predefined block

    Processes

    Api Use

    tags by extracting the name of a predefined documentation block that should be included in the current API endpoint documentation. This enables DRY (Don't Repeat Yourself) principles in API documentation.

    Api Use

    tag containing the block name

    Example: Reference to predefined block

    // Input: "UserObject"
    // Output: { name: "UserObject" }
    Copy

    Example: Reference to error responses

    // Input: "CommonErrors"
    // Output: { name: "CommonErrors" }
    Copy

    Example: Empty content

    // Input: "   "
    // Output: null
    Copy

    Since

    4.0.0

    Public