Skip to content

@ui5/builder/tasks/jsdoc/generateApiIndex ​

Methods ​

(static) default(options) → {module:@ui5/builder/tasks/runTask~TaskDescriptor}
​

Description: Compiles an api-index.json resource from all available api.json resources as created by the executeJsdocSdkTransformation task. The resulting api-index.json resource is mainly to be used in the SDK.

Source: builder/lib/tasks/jsdoc/generateApiIndex.js, line 10

Parameters: ​
NameTypeDescription
optionsobjectOptions
Properties:
NameTypeDescription
projectNamestringProject name
Returns: ​

The task descriptor

Type: module:@ui5/builder/tasks/runTask~TaskDescriptor