search

SAP / ui5-tooling

An open and modular toolchain to develop state of the art applications based on the UI5 framework
https://sap.github.io/ui5-tooling
Apache License 2.0
466 stars 71 forks source link

JsDoc build incompatible with older versions of the demokit #356

Open sebbi08 opened 5 years ago

sebbi08 commented 5 years ago

Expected Behavior

When running ui5 build jsdoc --all in an project the version schould be considert when formatting the JsDoc output.

Current Behavior

when running ui5 build jsdoc --all on 1.60.14 the output of is different to the one that is deployed on https://openui5.hana.ondemand.com/1.60.14

Steps to reproduce the issue

  1. add the following dependencies to the sample app "dependencies": { "@openui5/sap.f": "1.60.14", "@openui5/sap.m": "1.60.14", "@openui5/sap.tnt": "1.60.14", "@openui5/sap.ui.codeeditor": "1.60.14", "@openui5/sap.ui.core": "1.60.14", "@openui5/sap.ui.documentation": "1.60.14", "@openui5/sap.ui.fl": "1.60.14", "@openui5/sap.ui.dt": "1.60.14", "@openui5/sap.ui.layout": "1.60.14", "@openui5/sap.ui.rta": "1.60.14", "@openui5/sap.uxap": "1.60.14", "@openui5/themelib_sap_belize": "1.60.14" },
  2. run ui5 build jsdoc --all
  3. open the file dist/docs/api/api-index.json and compare it to the file here

Context

Affected components (if known)

matz3 commented 4 years ago

Currently the UI5 Tooling only supports building the JSDoc / SDK for the Demokit at that point in time, which corresponds to a specific UI5 version. Therefore it's right now not easy to build older versions, as this also requires an older UI5 Tooling version (or maybe doesn't even work if it is too old).

Marking this as enhancement as this is status quo and we need to figure out how to make the relevant JSDoc parts independent of the UI5 Tooling, but rather versioned with the UI5 framework to be in sync with the client-side demokit code).

arunkrishnamoorthy commented 1 year ago

Question to everyone here, if someone can help. When i ran the command ui5 build jsdoc --all. In the distribution folder i get a docs folder generated with an extension .json. Form this .json file how do we generate the html documentation. In case of the ui5 demokit, are they reading the json file information and build the layout with tabs to display the information from the api.json or is there any other additional tools/packages that is available to generate the same.