@ui5/builder/tasks/jsdoc/executeJsdocSdkTransformation

Methods

(static) default(parameters) → {Promise<undefined>}

Description: Task to transform the api.json file as created by the generateJsdoc task into a pre-processed api.json file suitable for the SDK.

Source: builder/lib/tasks/jsdoc/executeJsdocSdkTransformation.js, line 12

Parameters:

Name	Type	Description
parameters	object	Parameters Properties: Name Type Description workspace @ui5/fs/DuplexCollection DuplexCollection to read and write files dependencies @ui5/fs/AbstractReader Reader or Collection to read dependency files options object Options Properties Name Type Description dotLibraryPattern string | Array Pattern to locate the .library resource to be processed projectName string Project name

Returns:

Promise resolving with undefined once data has been written

Type: Promise<undefined>