@ui5/builder/processors/jsdoc/jsdocGenerator

Methods

(static) default(parameters) → {Promise<Array<@ui5/fs/Resource>>}

Description: JSDoc generator

Source: builder/lib/processors/jsdoc/jsdocGenerator.js, line 14

Parameters:

Name	Type	Description
parameters	object	Parameters Properties: Name Type Description sourcePath string Path of the source files to be processed targetPath string Path to write any output files tmpPath string Path to write temporary and debug files options object Options Properties Name Type Attributes Default Description projectName string Project name namespace string Namespace to build (e.g. some/project/name) version string Project version variants Array optional ["apijson"] JSDoc variants to be built

Returns:

Promise resolving with newly created resources

Type: Promise<Array<@ui5/fs/Resource>>