add guide for providers

This commit is contained in:
Aleksey Chichenkov 2019-03-18 17:03:37 +03:00
parent 89ce45f653
commit 6b4b6ac92b
2 changed files with 91 additions and 0 deletions

View file

@ -1,4 +1,21 @@
/**
* ### Платформа
* Основная точка доступа к данным.
*
* ```bash
* // доступ
* ps.pl
* ```
*
* Доступные менеджеры у платформы:
* - {@link GroupTypes} - Менеджер, который позволяет получить данные по типу компонента, определен как **gtm**
* - {@link ModelTypes} - Менеджер, который позволяет узнать о содержимом модели **mtm**
* - {@link Models} - Менеджер, для доступа к устройствам, определен как **mm**
* - {@link Trees} - Менеджер, для доступа к деревьям, определен как **tm**
* - {@link CoreConfig} - Менеджер, для доступа к конфигу платформы, определен как **core_config**
* - {@link CoreTranslations} - Менеджер, для доступа к переводам, определен как **core_translations**
* - {@link Datasource} - Менеджер, для к каталогу датасорсов, определен как **datasource_manager**
* - {@link UserManager} - Менеджер, для доступа к данным пользоваталей, определен как **user_manager**
*
* @group providers_interface
* @namespace Platform
@ -21,10 +38,29 @@ function Platform() {
*/
this.mm = new Models();
/**
*
* @public
* @name mtm
* @type {ModelTypes}
* @memberof Platform
*/
this.mtm = new ModelTypes();
/**
*
* @public
* @name gtm
* @type {GroupTypes}
* @memberof Platform
*/
this.gtm = new GroupTypes();
/**
*
* @public
* @name core_translations
* @type {CoreTranslations}
* @memberof Platform
*/
this.core_translations = new CoreTranslations();
@ -33,6 +69,7 @@ function Platform() {
*
* @public
* @name core_config
* @type {CoreConfig}
* @memberof Platform
*/
this.core_config = new CoreConfig();
@ -41,6 +78,7 @@ function Platform() {
*
* @public
* @name datasource_manager
* @type {Datasource}
* @memberof Platform
*/
this.datasource_manager = new Datasource();
@ -49,6 +87,7 @@ function Platform() {
*
* @public
* @name user_manager
* @type {UserManager}
* @memberof Platform
*/
this.user_manager = new UserManager();