docs: Escape HTML tags and replace pre in jsdoc examples

Author: Gianluca Beil

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:
 		 *
-		 * <pre>
-		 *	 this["name"] = name;
-		 * </pre>
+		 * ```
+		 * this["name"] = name;
+		 * ```
+		 *
 		 *
 		 * To avoid this, developers can either add "name" to the <code>ignoreGlobals</code>
 		 * attribute of a raw-module or they can completely suppress embedding of the module

packages/builder/lib/lbt/resources/ResourceFilterList.js

@@ -141,10 +141,11 @@ export default class ResourceFilterList {
 	 * and vice versa.
 	 *
 	 * Example:
-	 * <pre>
+	 * ```
 	 *	 !sap/ui/core/
 	*	 +sap/ui/core/utils/
-	* </pre>
+	 * ```
+	*
 	* 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

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 <caption>List of modules as glob patterns that should be in- or excluded</caption>
+ * <caption>List of modules as glob patterns that should be in- or excluded</caption>
+ * ```
  * // 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

packages/builder/lib/processors/versionInfoGenerator.js

@@ -28,14 +28,13 @@ function getTimestamp() {
  * @typedef {Object<string, {lazy: boolean}>} ManifestLibraries
  *
  * sample:
- * <pre>
+ * @example
  * {
  * 	"sap.chart": {
  * 		"lazy": true
  * 	},
  * 	"sap.f": { }
  * }
- * </pre>
  */
 
 /**
@@ -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. <pre>
+ *  e.g.
+ *  ```
  *   {
  *      name: "lib.x",
  *      version: "1.0.0",
  *      libraryManifest: @ui5/fs/Resource,
  *      embeddedManifests: @ui5/fs/Resource[]
  *   }
- * </pre>
+ *   ```
+ *
  * @returns {Promise<@ui5/fs/Resource[]>} Promise resolving with an array containing the versionInfo resource
  */
 

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.
  * </p>
  *
- * @example <caption>sample resources.json</caption>
+ * <caption>sample resources.json</caption>
+ * ```
  * const resourcesJson = {
  * 	"_version": "1.1.0",
  * 	"resources": [
@@ -95,6 +96,7 @@ function getCreatorOptions(projectName) {
  * 		}
  * 	]
  * };
+ * ```
  *
  * @public
  * @function default

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
- * <code>/resources/<namespace></code>.
+ * <code>/resources/&lt;namespace&gt;</code>.
  *
  * This simulates "flat" resource access, which is for example common for projects of type
  * "application".

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 <code>/resources/<namespace></code>.
+	 * where all requests are prefixed with <code>/resources/&lt;namespace&gt;</code>.
 	 */
 
 	/**

packages/project/lib/specifications/ComponentProject.js

@@ -106,7 +106,7 @@ class ComponentProject extends Project {
 	 * <li><b>runtime:</b> 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</li>
 	 * <li><b>flat:</b> 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</li>

packages/project/lib/specifications/Project.js

@@ -235,7 +235,7 @@ class Project extends Specification {
 	 * <li><b>runtime:</b> 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</li>
 	 * <li><b>flat:</b> 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</li>

packages/project/lib/specifications/types/Module.js

@@ -48,7 +48,7 @@ class Module extends Project {
 	 * <li><b>runtime:</b> 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</li>
 	 * <li><b>flat:</b> 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</li>