diff --git a/packages/builder/lib/lbt/resources/ModuleInfo.js b/packages/builder/lib/lbt/resources/ModuleInfo.js
index aadd1e5b1fa..d94c7c74e2c 100644
--- a/packages/builder/lib/lbt/resources/ModuleInfo.js
+++ b/packages/builder/lib/lbt/resources/ModuleInfo.js
@@ -84,9 +84,10 @@ class ModuleInfo {
* global scope. If a module declares global variables, all of them will be exported
* with additional code of the form:
*
- *
- * this["name"] = name;
- *
+ * ```
+ * this["name"] = name;
+ * ```
+ *
*
* To avoid this, developers can either add "name" to the ignoreGlobals
* attribute of a raw-module or they can completely suppress embedding of the module
diff --git a/packages/builder/lib/lbt/resources/ResourceFilterList.js b/packages/builder/lib/lbt/resources/ResourceFilterList.js
index bb110b1ff0c..d45fc4ad649 100644
--- a/packages/builder/lib/lbt/resources/ResourceFilterList.js
+++ b/packages/builder/lib/lbt/resources/ResourceFilterList.js
@@ -141,10 +141,11 @@ export default class ResourceFilterList {
* and vice versa.
*
* Example:
- *
+ * ```
* !sap/ui/core/
* +sap/ui/core/utils/
- *
+ * ```
+ *
* excludes everything from sap/ui/core, but includes everything from the subpackage sap/ui/core/utils/.
*
* Note that the filter operates on the full name of each resource. If a resource name
diff --git a/packages/builder/lib/processors/bundlers/moduleBundler.js b/packages/builder/lib/processors/bundlers/moduleBundler.js
index 4ce22607ed6..002f5768f35 100644
--- a/packages/builder/lib/processors/bundlers/moduleBundler.js
+++ b/packages/builder/lib/processors/bundlers/moduleBundler.js
@@ -57,7 +57,8 @@ const log = getLogger("builder:processors:bundlers:moduleBundler");
* denote an arbitrary number of characters or folder names.
* Excludes should be marked with a leading exclamation mark '!'. The order of filters is relevant; a later
* exclusion overrides an earlier inclusion, and vice versa.
- * @example List of modules as glob patterns that should be in- or excluded
+ * List of modules as glob patterns that should be in- or excluded
+ * ```
* // Includes everything from "some/path/to/module/",
* // but excludes the subfolder "some/path/to/module/to/be/excluded/"
* const section = {
@@ -66,6 +67,7 @@ const log = getLogger("builder:processors:bundlers:moduleBundler");
* "!some/path/to/module/to/be/excluded/"
* ]
* };
+ * ```
*
* @property {boolean} [resolve=false] Whether (transitive) dependencies of modules that match the given filters
* should be resolved and added to the module set
diff --git a/packages/builder/lib/processors/versionInfoGenerator.js b/packages/builder/lib/processors/versionInfoGenerator.js
index a846177cf61..7917e68479f 100644
--- a/packages/builder/lib/processors/versionInfoGenerator.js
+++ b/packages/builder/lib/processors/versionInfoGenerator.js
@@ -28,14 +28,13 @@ function getTimestamp() {
* @typedef {Object} ManifestLibraries
*
* sample:
- *
+ * @example
* {
* "sap.chart": {
* "lazy": true
* },
* "sap.f": { }
* }
- *
*/
/**
@@ -366,14 +365,16 @@ const processLibraryInfo = async (libraryInfo) => {
* @param {string} parameters.options.rootProjectVersion Version of the root project
* @param {module:@ui5/builder/processors/versionInfoGenerator~LibraryInfo[]} parameters.options.libraryInfos Array of
* objects representing libraries,
- * e.g.
+ * e.g.
+ * ```
* {
* name: "lib.x",
* version: "1.0.0",
* libraryManifest: @ui5/fs/Resource,
* embeddedManifests: @ui5/fs/Resource[]
* }
- *
+ * ```
+ *
* @returns {Promise<@ui5/fs/Resource[]>} Promise resolving with an array containing the versionInfo resource
*/
diff --git a/packages/builder/lib/tasks/generateResourcesJson.js b/packages/builder/lib/tasks/generateResourcesJson.js
index fae7b2c88c4..1157e1c6ec0 100644
--- a/packages/builder/lib/tasks/generateResourcesJson.js
+++ b/packages/builder/lib/tasks/generateResourcesJson.js
@@ -55,7 +55,8 @@ function getCreatorOptions(projectName) {
* Therefore it is also not supported in combination with self-contained build.
*
*
- * @example sample resources.json
+ * sample resources.json
+ * ```
* const resourcesJson = {
* "_version": "1.1.0",
* "resources": [
@@ -95,6 +96,7 @@ function getCreatorOptions(projectName) {
* }
* ]
* };
+ * ```
*
* @public
* @function default
diff --git a/packages/fs/lib/resourceFactory.js b/packages/fs/lib/resourceFactory.js
index ba48d76de1d..da1b4063a2e 100644
--- a/packages/fs/lib/resourceFactory.js
+++ b/packages/fs/lib/resourceFactory.js
@@ -235,7 +235,7 @@ export function createLinkReader(parameters) {
/**
* Create a [Link-Reader]{@link @ui5/fs/readers/Link} where all requests are prefixed with
- * /resources/.
+ * /resources/<namespace>.
*
* This simulates "flat" resource access, which is for example common for projects of type
* "application".
diff --git a/packages/project/lib/build/helpers/TaskUtil.js b/packages/project/lib/build/helpers/TaskUtil.js
index 661dc04ae07..b3a4fb97437 100644
--- a/packages/project/lib/build/helpers/TaskUtil.js
+++ b/packages/project/lib/build/helpers/TaskUtil.js
@@ -275,7 +275,7 @@ class TaskUtil {
* @property {Function} createLinkReader
* Create a [Link-Reader]{@link @ui5/fs/readers/Filter} with the given reader.
* @property {Function} createFlatReader Create a [Link-Reader]{@link @ui5/fs/readers/Link}
- * where all requests are prefixed with /resources/.
+ * where all requests are prefixed with /resources/<namespace>.
*/
/**
diff --git a/packages/project/lib/specifications/ComponentProject.js b/packages/project/lib/specifications/ComponentProject.js
index 5c42ba2c4dc..337b3652e29 100644
--- a/packages/project/lib/specifications/ComponentProject.js
+++ b/packages/project/lib/specifications/ComponentProject.js
@@ -106,7 +106,7 @@ class ComponentProject extends Project {
* runtime: Resource paths always match with what the UI5 runtime expects.
* This means that paths generally depend on the project type. Applications for example use a "flat"-like
* structure, while libraries use a "buildtime"-like structure.
- * This style is typically used for serving resources directly. Therefore, build-excludes are not applied
+ * This style is typically used for serving resources directly. Therefore, build-excludes are not applied
* flat: Resource paths are never prefixed and namespaces are omitted if possible. Note that
* project types like "theme-library", which can have multiple namespaces, can't omit them.
* Any configured build-excludes are applied
diff --git a/packages/project/lib/specifications/Project.js b/packages/project/lib/specifications/Project.js
index 17177b08536..98cbf29da1d 100644
--- a/packages/project/lib/specifications/Project.js
+++ b/packages/project/lib/specifications/Project.js
@@ -235,7 +235,7 @@ class Project extends Specification {
* runtime: Resource paths always match with what the UI5 runtime expects.
* This means that paths generally depend on the project type. Applications for example use a "flat"-like
* structure, while libraries use a "buildtime"-like structure.
- * This style is typically used for serving resources directly. Therefore, build-excludes are not applied
+ * This style is typically used for serving resources directly. Therefore, build-excludes are not applied
* flat: Resource paths are never prefixed and namespaces are omitted if possible. Note that
* project types like "theme-library", which can have multiple namespaces, can't omit them.
* Any configured build-excludes are applied
diff --git a/packages/project/lib/specifications/types/Module.js b/packages/project/lib/specifications/types/Module.js
index 14e6a116442..69c5987c9d8 100644
--- a/packages/project/lib/specifications/types/Module.js
+++ b/packages/project/lib/specifications/types/Module.js
@@ -48,7 +48,7 @@ class Module extends Project {
* runtime: Resource paths always match with what the UI5 runtime expects.
* This means that paths generally depend on the project type. Applications for example use a "flat"-like
* structure, while libraries use a "buildtime"-like structure.
- * This style is typically used for serving resources directly. Therefore, build-excludes are not applied
+ * This style is typically used for serving resources directly. Therefore, build-excludes are not applied
* flat: Resource paths are never prefixed and namespaces are omitted if possible. Note that
* project types like "theme-library", which can have multiple namespaces, can't omit them.
* Any configured build-excludes are applied
diff --git a/packages/project/lib/specifications/types/ThemeLibrary.js b/packages/project/lib/specifications/types/ThemeLibrary.js
index e0bcd90785d..398e570cdfb 100644
--- a/packages/project/lib/specifications/types/ThemeLibrary.js
+++ b/packages/project/lib/specifications/types/ThemeLibrary.js
@@ -55,7 +55,7 @@ class ThemeLibrary extends Project {
* runtime: Resource paths always match with what the UI5 runtime expects.
* This means that paths generally depend on the project type. Applications for example use a "flat"-like
* structure, while libraries use a "buildtime"-like structure.
- * This style is typically used for serving resources directly. Therefore, build-excludes are not applied
+ * This style is typically used for serving resources directly. Therefore, build-excludes are not applied
* flat: Resource paths are never prefixed and namespaces are omitted if possible. Note that
* project types like "theme-library", which can have multiple namespaces, can't omit them.
* Any configured build-excludes are applied
diff --git a/packages/server/lib/middleware/MiddlewareUtil.js b/packages/server/lib/middleware/MiddlewareUtil.js
index 8b977c6a520..d8fbb72de87 100644
--- a/packages/server/lib/middleware/MiddlewareUtil.js
+++ b/packages/server/lib/middleware/MiddlewareUtil.js
@@ -182,7 +182,7 @@ class MiddlewareUtil {
* @property {Function} createLinkReader
* Create a [Link-Reader]{@link @ui5/fs/readers/Filter} with the given reader.
* @property {Function} createFlatReader Create a [Link-Reader]{@link @ui5/fs/readers/Link}
- * where all requests are prefixed with /resources/.
+ * where all requests are prefixed with /resources/<namespace>.
*/
/**