@ui5/builder/tasks/jsdoc/generateJsdoc

Methods

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

Description:
  • Task to execute a JSDoc build for UI5 projects
Source:
Parameters:
Name Type Description
parameters object Parameters
Properties
Name Type Attributes Description
workspace @ui5/fs/DuplexCollection DuplexCollection to read and write files
dependencies @ui5/fs/AbstractReader Reader or Collection to read dependency files
options module:@ui5/builder/tasks/jsdoc/generateJsdoc~GenerateJsdocOptions Options
taskUtil @ui5/project/build/helpers/TaskUtil | object <optional>
 TaskUtil
Returns:
Promise resolving with undefined once data has been written
Type
Promise.<undefined>

Type Definitions

GenerateJsdocOptions

Source:
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