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

    Function parse

    • Parse options to process and generate API documentation.

      Handles parsing of source directories/files, processing of parsing results, and generating output data (e.g., API data and project metadata).

      Parameters

      • options: any

        Configuration options. Overwrite default options.

      Returns boolean | { data: string; project: string }

      If successful, an object containing API data (data) and project information (project) is returned, otherwise returns true if no data is parsed, or false if an error occurs.