`sap.ui.version` missing `@public` in API reference of `sap/ui/Global`
See original GitHub issueURL (minimal example if possible): https://openui5nightly.hana.ondemand.com/api/sap.ui
Currently, the API reference page of the namespace sap.ui
doesn’t mention sap.ui.version
. I believe it’s because the JSDoc tags @public
, @readonly
, and @name sap.ui.version
are missing at: https://github.com/SAP/openui5/blob/8d2e7dc6a1cfad10e972f631fdea38115ab34a05/src/sap.ui.core/src/sap/ui/Global.js#L71-L79
This would result in a new section “Fields” in the sap.ui
API reference page (similar to https://openui5nightly.hana.ondemand.com/api/sap.ui.core.Component.registry#properties) which doesn’t exist there yet.
According to the section “Don’t use references to global names”, sap.ui.version
is one of the exceptions that can be still used via the global name.
OpenUI5 provides a couple of static modules and (factory) functions that can be referred to via their global name:
- …
- …
sap.ui.version
Issue Analytics
- State:
- Created 2 years ago
- Comments:7 (7 by maintainers)
@codeworrior @flovogt Thanks for letting us know.
Somewhat related (please correct me if I’m wrong): the
sap/ui/VersionInfo
currently relies on the generatedsap-ui-version.json
file which in typical cases contains the framework version with the correct patch level (in SAPUI5 cases). Standalone apps, however, report the app version instead. Related enhancement request: https://github.com/SAP/ui5-tooling/issues/353.AFAIK, i.e. there is currently no reliable way for standalone SAPUI5 apps to determine the correct patch version.
I will first check with the team is it feasible.