From 049dd1d9939f210b3318755767d33281e0d7bb4b Mon Sep 17 00:00:00 2001 From: Volker Schukai <volker.schukai@schukai.com> Date: Mon, 27 Mar 2023 18:38:14 +0200 Subject: [PATCH] doc: update --- application/source/dom/dimension.mjs | 17 ++++++++++------- application/source/i18n/translations.mjs | 1 + application/source/util/runtime.mjs | 2 ++ 3 files changed, 13 insertions(+), 7 deletions(-) diff --git a/application/source/dom/dimension.mjs b/application/source/dom/dimension.mjs index ce5b850a0..b0de0e8ba 100644 --- a/application/source/dom/dimension.mjs +++ b/application/source/dom/dimension.mjs @@ -9,12 +9,13 @@ import {getWindow} from './util.mjs'; export {convertToPixels, getDeviceDPI} - /** * Stores the DPI of the device. * + * @private * @returns {number} - * @type {number} + * @since 3.34.0 + * @type {number|function} */ let CURRENT_DEVICE_DPI = function () { let i = 0; @@ -29,6 +30,8 @@ let CURRENT_DEVICE_DPI = function () { /** * Returns the DPI of the device. * + * @since 3.34.0 + * @memberOf Monster.DOM * @returns {number} */ function getDeviceDPI() { @@ -59,15 +62,15 @@ function getDeviceDPI() { * - rem * - % * - * @param value - * @param parentElement - * @param fontSizeElement + * @param {string} value + * @param {HTMLElement} [parentElement=document.documentElement] + * @param {HTMLElement} [fontSizeElement=document.documentElement] * @returns {number} * @license AGPLv3 - * @since 1.6.0 + * @since 3.34.0 * @copyright schukai GmbH - * @memberOf Monster.DOM * @throws {Error} Unsupported unit + * @memberOf Monster.DOM */ function convertToPixels(value, parentElement = document.documentElement, fontSizeElement = document.documentElement) { diff --git a/application/source/i18n/translations.mjs b/application/source/i18n/translations.mjs index a575d87da..9f5678e15 100644 --- a/application/source/i18n/translations.mjs +++ b/application/source/i18n/translations.mjs @@ -208,6 +208,7 @@ class Translations extends Base { * @throws {Error} Cannot find element with translations. Add a translations object to the document. * @throws {Error} This element has no translations. * @throws {Error} Missing translations. + * @memberOf Monster.I18n */ function getDocumentTranslations(element) { diff --git a/application/source/util/runtime.mjs b/application/source/util/runtime.mjs index 422e21691..7040fc252 100644 --- a/application/source/util/runtime.mjs +++ b/application/source/util/runtime.mjs @@ -27,6 +27,8 @@ const ENV_UNKNOWN = 'unknown'; * - 'react-native': React Native environment * - 'unknown': Unknown environment * + * @since 3.34.0 + * @memberOf Monster.Util * @returns {string} The detected runtime environment. Possible values are: */ function detectRuntimeEnvironment() { -- GitLab