@ui5/builder/tasks/jsdoc/generateJsdoc

Methods

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

Description: Task to execute a JSDoc build for UI5 projects

A factory returning the task descriptor. The factory assembles the glob patterns from options.jsdocExcludes and captures options.namespace and options.version, which the project definition supplies in place of the project-derived values that used to be wrapped around this task. The task body then uses these closure values; the per-run options.projectName is read from the task-run options.

The factory stays pure and cheap: the heavy jsdocGenerator processor is only reached inside the task body, so calling the factory for the build signature loads no processor.

Source: builder/lib/tasks/jsdoc/generateJsdoc.js, line 27

Parameters:

Name	Type	Description
options	object	Options Properties: Name Type Attributes Default Description namespace string Namespace to build (e.g. some/project/name) version string Project version jsdocExcludes Array<string> optional [] List of exclude patterns, relative to /resources/

Returns:

The task descriptor

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

Type Definitions

GenerateJsdocOptions

Source: builder/lib/tasks/jsdoc/generateJsdoc.js, line 17

Properties:

Name	Type	Description
pattern	string \| Array<string>	Pattern to locate the files to be processed
projectName	string	Project name
namespace	string	Namespace to build (e.g. some/project/name)
version	string	Project version

Type:

• object