Skip to content

Commit f25bed7

Browse files
committed
[INTERNAL] lib/processors/jsdoc: Add missing references section
Events have references defined in the api.json (via JSDoc @see tags) and now they are displayed via references section for the events in the API Reference. JIRA: BGSOFUIPIRIN-6778 Cherry-picked from UI5/openui5@8bf0847f5b
1 parent 45730bb commit f25bed7

File tree

1 file changed

+16
-0
lines changed

1 file changed

+16
-0
lines changed

lib/processors/jsdoc/lib/transformApiJson.js

Lines changed: 16 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -737,6 +737,14 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
737737
oEvent.description = formatters.formatDescriptionSince(oEvent.description, oEvent.since);
738738
}
739739

740+
if (oEvent.references) {
741+
formatters.formatReferencesInDescription(oEvent);
742+
}
743+
744+
if (oEvent.description) {
745+
oEvent.description = formatters.formatDescription(oEvent.description);
746+
}
747+
740748
// Deprecated
741749
if (oEvent.deprecated) {
742750
oEvent.deprecatedText = formatters.formatEventDeprecated(oEvent.deprecated.since,
@@ -757,6 +765,14 @@ function transformer(sInputFile, sOutputFile, sLibraryFile, vDependencyAPIFiles,
757765
oParameter.description = formatters.formatDescriptionSince(oParameter.description, oParameter.since);
758766
}
759767

768+
if (oParameter.references) {
769+
formatters.formatReferencesInDescription(oParameter);
770+
}
771+
772+
if (oParameter.description) {
773+
oParameter.description = formatters.formatDescription(oParameter.description);
774+
}
775+
760776
// Deprecated
761777
if (oParameter.deprecated) {
762778
oParameter.deprecatedText = formatters.formatDeprecated(oParameter.deprecated.since,

0 commit comments

Comments
 (0)