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

    Exports

    • Parse

      Parameters

      • content: any

        Raw content from the

      • source: any

        Source file path (unused but required for interface compatibility)

      Returns {
          group: string;
          type: string;
          size: string;
          allowedValues: string;
          optional: boolean;
          parentNode: any;
          field: string;
          isArray: boolean;
          defaultValue: string;
          description: any;
      }

      Parsed success response field information or null if parsing fails

      tag to extract success response field information

      Processes

      tags using the same syntax as

      but specifically for success response fields. Automatically assigns the "Success 200" group unless a different group is specified in the tag.

      tag

      // Input: "{String} name User's full name"
      // Output: { type: "String", field: "name", description: "User's full name", group: "Success 200" }
      // Input: "(Success 201) {String} id Created resource ID"
      // Output: { type: "String", field: "id", description: "Created resource ID", group: "Success 201" }
      // Input: "{Object} user User data object"
      // Output: { type: "Object", field: "user", description: "User data object", group: "Success 200" }

      4.0.0