Browse Source

Update jsdocs

pull/4329/head
Artur Arseniev 4 years ago
parent
commit
113e848c97
  1. 2
      src/asset_manager/index.js
  2. 3
      src/canvas/model/Frame.ts
  3. 2
      src/dom_components/index.js
  4. 5
      src/editor/index.ts
  5. 10
      src/pages/index.ts
  6. 5
      src/selector_manager/model/Selector.ts

2
src/asset_manager/index.js

@ -36,8 +36,6 @@
* * [getAll](#getall) * * [getAll](#getall)
* * [getAllVisible](#getallvisible) * * [getAllVisible](#getallvisible)
* * [remove](#remove) * * [remove](#remove)
* * [store](#store)
* * [load](#load)
* * [getContainer](#getcontainer) * * [getContainer](#getcontainer)
* *
* [Asset]: asset.html * [Asset]: asset.html

3
src/canvas/model/Frame.ts

@ -36,6 +36,9 @@ export default class Frame extends Model {
em: EditorModel; em: EditorModel;
view?: FrameView; view?: FrameView;
/**
* @hideconstructor
*/
constructor(props: any, opts: any) { constructor(props: any, opts: any) {
super(props); super(props);
const { em } = opts; const { em } = opts;

2
src/dom_components/index.js

@ -44,8 +44,6 @@
* * [getComponents](#getcomponents) * * [getComponents](#getcomponents)
* * [addComponent](#addcomponent) * * [addComponent](#addcomponent)
* * [clear](#clear) * * [clear](#clear)
* * [load](#load)
* * [store](#store)
* * [addType](#addtype) * * [addType](#addtype)
* * [getType](#gettype) * * [getType](#gettype)
* * [getTypes](#gettypes) * * [getTypes](#gettypes)

5
src/editor/index.ts

@ -217,7 +217,10 @@ export default class EditorModule implements IBaseModule<typeof defaults> {
return this.em.get('DeviceManager'); 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) { getConfig(prop?: string) {
const config = this.config; const config = this.config;
//@ts-ignore //@ts-ignore

10
src/pages/index.ts

@ -85,6 +85,16 @@ export default class PageManager extends ItemManagerModule<Config, Pages> {
} }
model: Model; model: Model;
/**
* Get all pages
* @name getAll
* @function
* @returns {Array<[Page]>}
* @example
* const arrayOfPages = pageManager.getAll();
*/
/** /**
* Initialize module * Initialize module
* @param {Object} config Configurations * @param {Object} config Configurations

5
src/selector_manager/model/Selector.ts

@ -33,6 +33,9 @@ export default class Selector extends Model {
em: EditorModel; em: EditorModel;
/**
* @hideconstructor
*/
constructor(props: any, opts: any = {}) { constructor(props: any, opts: any = {}) {
super(props, opts); super(props, opts);
const { config = {} } = opts; const { config = {} } = opts;
@ -166,7 +169,7 @@ export default class Selector extends Model {
* Escape string * Escape string
* @param {string} name * @param {string} name
* @return {string} * @return {string}
* @public * @private
*/ */
static escapeName(name: string) { static escapeName(name: string) {
return `${name}`.trim().replace(/([^a-z0-9\w-\:]+)/gi, '-'); return `${name}`.trim().replace(/([^a-z0-9\w-\:]+)/gi, '-');

Loading…
Cancel
Save