From 113e848c973f2e278eac06c1e32f86fbf28128a4 Mon Sep 17 00:00:00 2001 From: Artur Arseniev Date: Wed, 11 May 2022 17:11:04 +0200 Subject: [PATCH] Update jsdocs --- src/asset_manager/index.js | 2 -- src/canvas/model/Frame.ts | 3 +++ src/dom_components/index.js | 2 -- src/editor/index.ts | 5 ++++- src/pages/index.ts | 10 ++++++++++ src/selector_manager/model/Selector.ts | 5 ++++- 6 files changed, 21 insertions(+), 6 deletions(-) diff --git a/src/asset_manager/index.js b/src/asset_manager/index.js index be8c8b737..e2c20053b 100644 --- a/src/asset_manager/index.js +++ b/src/asset_manager/index.js @@ -36,8 +36,6 @@ * * [getAll](#getall) * * [getAllVisible](#getallvisible) * * [remove](#remove) - * * [store](#store) - * * [load](#load) * * [getContainer](#getcontainer) * * [Asset]: asset.html diff --git a/src/canvas/model/Frame.ts b/src/canvas/model/Frame.ts index b3e9824f5..82ea2dfc6 100644 --- a/src/canvas/model/Frame.ts +++ b/src/canvas/model/Frame.ts @@ -36,6 +36,9 @@ export default class Frame extends Model { em: EditorModel; view?: FrameView; + /** + * @hideconstructor + */ constructor(props: any, opts: any) { super(props); const { em } = opts; diff --git a/src/dom_components/index.js b/src/dom_components/index.js index 6b007e431..048448638 100644 --- a/src/dom_components/index.js +++ b/src/dom_components/index.js @@ -44,8 +44,6 @@ * * [getComponents](#getcomponents) * * [addComponent](#addcomponent) * * [clear](#clear) - * * [load](#load) - * * [store](#store) * * [addType](#addtype) * * [getType](#gettype) * * [getTypes](#gettypes) diff --git a/src/editor/index.ts b/src/editor/index.ts index 42dfd7627..c7c7edb49 100644 --- a/src/editor/index.ts +++ b/src/editor/index.ts @@ -217,7 +217,10 @@ export default class EditorModule implements IBaseModule { return this.em.get('DeviceManager'); } - //@deprecated + /** + * Returns configuration object + * @returns {any} Returns the configuration object or the value of the specified property + */ getConfig(prop?: string) { const config = this.config; //@ts-ignore diff --git a/src/pages/index.ts b/src/pages/index.ts index ab0d72ddf..a6ccb4bc4 100644 --- a/src/pages/index.ts +++ b/src/pages/index.ts @@ -85,6 +85,16 @@ export default class PageManager extends ItemManagerModule { } model: Model; + + /** + * Get all pages + * @name getAll + * @function + * @returns {Array<[Page]>} + * @example + * const arrayOfPages = pageManager.getAll(); + */ + /** * Initialize module * @param {Object} config Configurations diff --git a/src/selector_manager/model/Selector.ts b/src/selector_manager/model/Selector.ts index 3abb8da8b..2bb937c48 100644 --- a/src/selector_manager/model/Selector.ts +++ b/src/selector_manager/model/Selector.ts @@ -33,6 +33,9 @@ export default class Selector extends Model { em: EditorModel; + /** + * @hideconstructor + */ constructor(props: any, opts: any = {}) { super(props, opts); const { config = {} } = opts; @@ -166,7 +169,7 @@ export default class Selector extends Model { * Escape string * @param {string} name * @return {string} - * @public + * @private */ static escapeName(name: string) { return `${name}`.trim().replace(/([^a-z0-9\w-\:]+)/gi, '-');