cancel
Showing results for 
Search instead for 
Did you mean: 
Subscribe

Hi SAP Community,

As of writing this question, new projects created on SAP Web IDE on the Cloud Platform now use the ui5-tooling modules: ui5-cli, and what looks like a Web IDE-specific version of the ui5-builder module.

Our old projects still use Grunt, where we added an additional task for generating JSDoc documentation.

Is there an immediate need to switch from Grunt to the new ui5-builder? Or will both be supported in the long run?

Also, it doesn't seem like there's an easy option to enable jsdoc, I added the relevant property to my ui5.yaml file (https://github.com/SAP/ui5-project/blob/master/docs/Configuration.md) but nothing was generated. Do I need to create a custom task for this?

Best Regards,
Andre

View Entire Topic
beanonradar
Explorer

Jsdoc generation is a seperate build process and can be called via ui5 cli with "ui5 build jsdoc" see also "ui5 build --help". In Web IDE (package.json)

    "build": "ui5 build --include-task=generateManifestBundle generateCachebusterInfo generateJsdoc"

unfortunately does not work. The following works but I don't know if it should be used that way:

    "build": "ui5 build --include-task=generateManifestBundle generateCachebusterInfo && ui5 build jsdoc"

Then you can find you doc folder inside the dist folder.

janmrs
Explorer
0 Likes

I see. This is my first time trying out the new ui5 builder tool, I didn't realize there was a separate build command for jsdoc. I tried the two commands on both Web IDE and my local machine, the first one really doesn't work like you said, the second one worked but all I got was .json files (which looks empty, by the way):

{"$schema-ref":"http://schemas.sap.com/sapui5/designtime/api-index.json/1.0","version":"0.0.1","library":"*","symbols":[]}

Unfortunately I'm not sure how to generate jsdoc files in HTML format with this new tool.

beanonradar
Explorer
0 Likes

You are right. The files are empty. The only usage examples I found here:

https://github.com/SAP/openui5/blob/master/docs/developing.md

Maybe the jsodoc build mode is meant for openui5 core development and not for ui5 apps. I'm a bit lost now and hope someone else can help out.