diff --git a/packages/builder/lib/lbt/resources/ModuleInfo.js b/packages/builder/lib/lbt/resources/ModuleInfo.js index d94c7c74e2c..08f7fe9e041 100644 --- a/packages/builder/lib/lbt/resources/ModuleInfo.js +++ b/packages/builder/lib/lbt/resources/ModuleInfo.js @@ -84,7 +84,7 @@ class ModuleInfo { * global scope. If a module declares global variables, all of them will be exported * with additional code of the form: * - * ``` + * ```js * this["name"] = name; * ``` * diff --git a/packages/builder/lib/lbt/utils/JSTokenizer.js b/packages/builder/lib/lbt/utils/JSTokenizer.js index 7e173fcbc86..1d741db482a 100644 --- a/packages/builder/lib/lbt/utils/JSTokenizer.js +++ b/packages/builder/lib/lbt/utils/JSTokenizer.js @@ -29,10 +29,11 @@ * * Contains functions to consume tokens on an input string. * - * @example + * ```js * sap.ui.require(["sap/base/util/JSTokenizer"], function(JSTokenizer){ * JSTokenizer().parseJS("{test:'123'}"); // {test:'123'} * }); + * ``` * * @class sap/base/util/JSTokenizer * @since 1.58 diff --git a/packages/builder/lib/processors/bundlers/moduleBundler.js b/packages/builder/lib/processors/bundlers/moduleBundler.js index 002f5768f35..7da415c519d 100644 --- a/packages/builder/lib/processors/bundlers/moduleBundler.js +++ b/packages/builder/lib/processors/bundlers/moduleBundler.js @@ -58,7 +58,7 @@ const log = getLogger("builder:processors:bundlers:moduleBundler"); * 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. * List of modules as glob patterns that should be in- or excluded - * ``` + * ```js * // Includes everything from "some/path/to/module/", * // but excludes the subfolder "some/path/to/module/to/be/excluded/" * const section = { diff --git a/packages/builder/lib/processors/nonAsciiEscaper.js b/packages/builder/lib/processors/nonAsciiEscaper.js index 4548967db5d..ff9d58e97d6 100644 --- a/packages/builder/lib/processors/nonAsciiEscaper.js +++ b/packages/builder/lib/processors/nonAsciiEscaper.js @@ -57,10 +57,10 @@ const escapeNonAscii = function(string) { /** * Escapes non ASCII characters with unicode escape sequences. * - * @example + * ```js * const encoding = nonAsciiEscaper.getEncodingFromAlias("ISO-8859-1"); * nonAsciiEscaper({resources, options: {encoding}}); - * + * ``` * * @public * @function default diff --git a/packages/builder/lib/processors/versionInfoGenerator.js b/packages/builder/lib/processors/versionInfoGenerator.js index 7917e68479f..f7161ec399e 100644 --- a/packages/builder/lib/processors/versionInfoGenerator.js +++ b/packages/builder/lib/processors/versionInfoGenerator.js @@ -28,13 +28,14 @@ function getTimestamp() { * @typedef {Object} ManifestLibraries * * sample: - * @example + * ```json * { * "sap.chart": { * "lazy": true * }, * "sap.f": { } * } + * ``` */ /** @@ -366,7 +367,7 @@ const processLibraryInfo = async (libraryInfo) => { * @param {module:@ui5/builder/processors/versionInfoGenerator~LibraryInfo[]} parameters.options.libraryInfos Array of * objects representing libraries, * e.g. - * ``` + * ```json * { * name: "lib.x", * version: "1.0.0", diff --git a/packages/builder/lib/tasks/generateResourcesJson.js b/packages/builder/lib/tasks/generateResourcesJson.js index 1157e1c6ec0..9f0a4ba46e5 100644 --- a/packages/builder/lib/tasks/generateResourcesJson.js +++ b/packages/builder/lib/tasks/generateResourcesJson.js @@ -56,7 +56,7 @@ function getCreatorOptions(projectName) { *

* * sample resources.json - * ``` + * ```js * const resourcesJson = { * "_version": "1.1.0", * "resources": [ diff --git a/packages/fs/lib/AbstractReader.js b/packages/fs/lib/AbstractReader.js index 8f5c3632f83..a557bc5e63b 100644 --- a/packages/fs/lib/AbstractReader.js +++ b/packages/fs/lib/AbstractReader.js @@ -35,10 +35,11 @@ class AbstractReader { /** * Locates resources by matching glob patterns. * - * @example + * ```js * byGlob("**‏/*.{html,htm}"); * byGlob("**‏/.library"); * byGlob("/pony/*"); + * ``` * * @public * @param {string|string[]} virPattern glob pattern as string or array of glob patterns for diff --git a/packages/fs/lib/WriterCollection.js b/packages/fs/lib/WriterCollection.js index 7c01f783f14..f601867632e 100644 --- a/packages/fs/lib/WriterCollection.js +++ b/packages/fs/lib/WriterCollection.js @@ -19,7 +19,7 @@ class WriterCollection extends AbstractReaderWriter { * @param {object.} parameters.writerMapping * Mapping of virtual base paths to writers. Path are matched greedy * - * @example + * ```js * new WriterCollection({ * name: "Writer Collection", * writerMapping: { @@ -27,6 +27,7 @@ class WriterCollection extends AbstractReaderWriter { * "/my/path/": writerB, * } * }); + * ``` */ constructor({name, writerMapping}) { super(name); diff --git a/packages/fs/lib/readers/Link.js b/packages/fs/lib/readers/Link.js index dd2d40b3ce3..726a22b763b 100644 --- a/packages/fs/lib/readers/Link.js +++ b/packages/fs/lib/readers/Link.js @@ -7,7 +7,7 @@ const log = getLogger("resources:readers:Link"); /** * A reader that allows for rewriting paths segments of all resources passed through it. * - * @example + * ```js * import Link from "@ui5/fs/readers/Link"; * const linkedReader = new Link({ * reader: sourceReader, @@ -20,6 +20,7 @@ const log = getLogger("resources:readers:Link"); * // The following resolves with a @ui5/fs/ResourceFacade of the resource * // located at "/resources/my-app-name/Component.js" in the sourceReader * const resource = await linkedReader.byPath("/app/Component.js"); + * ``` * * @public * @class diff --git a/packages/fs/lib/resourceFactory.js b/packages/fs/lib/resourceFactory.js index da1b4063a2e..6a98c9a7961 100644 --- a/packages/fs/lib/resourceFactory.js +++ b/packages/fs/lib/resourceFactory.js @@ -209,7 +209,7 @@ export function createFilterReader(parameters) { * Create a [Link-Reader]{@link @ui5/fs/readers/Filter} with the given reader. * The provided path mapping allows for rewriting paths segments of all resources passed through it. * - * @example + * ```js * import {createLinkReader} from "@ui5/fs/resourceFactory"; * const linkedReader = createLinkReader({ * reader: sourceReader, @@ -218,6 +218,7 @@ export function createFilterReader(parameters) { * targetPath: `/resources/my-app-name/` * } * }); + * ``` * * // The following resolves with a @ui5/fs/ResourceFacade of the resource * // located at "/resources/my-app-name/Component.js" in the sourceReader diff --git a/packages/project/lib/ui5Framework/AbstractResolver.js b/packages/project/lib/ui5Framework/AbstractResolver.js index 6cb532d98a6..266d4bcd1a6 100644 --- a/packages/project/lib/ui5Framework/AbstractResolver.js +++ b/packages/project/lib/ui5Framework/AbstractResolver.js @@ -129,7 +129,7 @@ class AbstractResolver { /** * Library metadata entry * - * @example + * ```js * const libraryMetadataEntry = { * "id": "@openui5/sap.ui.core", * "version": "1.75.0", @@ -137,6 +137,7 @@ class AbstractResolver { * "dependencies": [], * "optionalDependencies": [] * }; + * ``` * * @public * @typedef {object} @ui5/project/ui5Framework/AbstractResolver~LibraryMetadataEntry @@ -150,7 +151,7 @@ class AbstractResolver { /** * Install result * - * @example + * ```js * const resolverInstallResult = { * "libraryMetadata": { * "sap.ui.core": { @@ -161,6 +162,7 @@ class AbstractResolver { * } * } * }; + * ``` * * @public * @typedef {object} @ui5/project/ui5Framework/AbstractResolver~ResolverInstallResult @@ -171,7 +173,7 @@ class AbstractResolver { /** * Installs the provided libraries and their dependencies * - * @example + * ```js * const resolver = new Sapui5Resolver({version: "1.76.0"}); * // Or for OpenUI5: * // const resolver = new Openui5Resolver({version: "1.76.0"}); @@ -181,6 +183,7 @@ class AbstractResolver { * }).catch((err) => { * // Handle installation errors * }); + * ``` * * @public * @param {string[]} libraryNames List of library names to be installed diff --git a/packages/server/lib/middleware/MiddlewareUtil.js b/packages/server/lib/middleware/MiddlewareUtil.js index d8fbb72de87..eea1f003a42 100644 --- a/packages/server/lib/middleware/MiddlewareUtil.js +++ b/packages/server/lib/middleware/MiddlewareUtil.js @@ -63,12 +63,13 @@ class MiddlewareUtil { /** * MIME Info * - * @example + * ```js * const mimeInfo = { * "type": "text/html", * "charset": "utf-8", * "contentType": "text/html; charset=utf-8" * }; + * ``` * * @public * @typedef {object} MimeInfo