diff --git a/docfiles/providers/managers/core_config/manager.js b/docfiles/providers/managers/core_config/manager.js index ddcff44..ee8bc46 100644 --- a/docfiles/providers/managers/core_config/manager.js +++ b/docfiles/providers/managers/core_config/manager.js @@ -1,4 +1,6 @@ /** + * ### Конфиг платформы + * * Интерфейс предоставляющий доступ к конфигурационным данным платформы, у которой был произведен запрос. * * ```bash diff --git a/docfiles/providers/managers/datasource/manager.js b/docfiles/providers/managers/datasource/manager.js index ca712a2..ee944f1 100644 --- a/docfiles/providers/managers/datasource/manager.js +++ b/docfiles/providers/managers/datasource/manager.js @@ -1,4 +1,6 @@ /** + * ### Каталог источников данных + * * Менеджер предназначеный для работы с датасорсами. * * ```bash diff --git a/docfiles/providers/managers/groupTypes/groupType.js b/docfiles/providers/managers/groupTypes/groupType.js index dd22474..fb5c4c5 100644 --- a/docfiles/providers/managers/groupTypes/groupType.js +++ b/docfiles/providers/managers/groupTypes/groupType.js @@ -1,6 +1,11 @@ /** * Описание типа компонента * + *
+ * Связанные объекты: + * + * - {@link GroupTypes GroupTypes} - менеджер типов групп + * * @class GroupType * @memberof GroupTypes */ diff --git a/docfiles/providers/managers/groupTypes/manager.js b/docfiles/providers/managers/groupTypes/manager.js index ddc483f..81b6541 100644 --- a/docfiles/providers/managers/groupTypes/manager.js +++ b/docfiles/providers/managers/groupTypes/manager.js @@ -1,5 +1,5 @@ /** - * #### Менеджер типов групп. + * ### Группы (Компоненты). * * Этот менеджер позволяет запросить данные по типу компонента. * @@ -7,6 +7,12 @@ * // доступ * ps.pl.gtm * ``` + * + *
+ * Связанные объекты: + * + * - {@link GroupTypes.GroupType GroupType} - Тип группы + * * @group manager * @namespace GroupTypes */ diff --git a/docfiles/providers/managers/models/alarmType.js b/docfiles/providers/managers/models/alarmType.js new file mode 100644 index 0000000..b658cec --- /dev/null +++ b/docfiles/providers/managers/models/alarmType.js @@ -0,0 +1,47 @@ +/** + * Описание типа компонента + * + * @class AlarmType + * @memberof Models + */ +function AlarmType() { + + /** + * Позволяет получить все атрибуты типа аларма. + * + * @public + * @function attributes + * @memberof Models.AlarmType + * @returns {v2.map(v2.string, v2.vc)} + */ + this.attributes = function () { + + }; + + /** + * Описание типа аларма (уже в нужной локали) + * + * @public + * @function description + * @memberof Models.AlarmType + * @returns {v2.string} + */ + this.description = function () { + + }; + + /** + * Тип паблишера, который будет создаваться для данного компонента. + * + * Этот метод предназначен для гридов в поисках по компонентам. + * + * @public + * @function publisher_type + * @memberof Models.AlarmType + * @returns {v2.model_type} + */ + this.publisher_type = function () { + + }; + +} \ No newline at end of file diff --git a/docfiles/providers/managers/models/groups/manager.js b/docfiles/providers/managers/models/groups/manager.js index 9c0b3a3..30fbe0a 100644 --- a/docfiles/providers/managers/models/groups/manager.js +++ b/docfiles/providers/managers/models/groups/manager.js @@ -1,4 +1,13 @@ /** + * ### Группы моделей (Компоненты) + * + *
+ * Связанные объекты: + * + * - {@link Models.Model.Groups.Group Group} - Группа модели (тип компонента) + * - {@link Models.Model.Groups.BaseGroup BaseGroup} - Базовая группа (есть у любого девайса - **baseComponent**) + * - {@link Models.Model Model} - Модель (устройство, девайс). Доступ к данным модели + * - {@link Models Models} - Менеджер моделей. * * @group manager * @class Groups diff --git a/docfiles/providers/managers/models/manager.js b/docfiles/providers/managers/models/manager.js index a803933..b6e8079 100644 --- a/docfiles/providers/managers/models/manager.js +++ b/docfiles/providers/managers/models/manager.js @@ -1,5 +1,5 @@ /** - * Менеджер моделей. + * ### Менеджер моделей. * * Представляет собой интерфейс для доступа ко всем моделям * @@ -9,6 +9,14 @@ * // доступ * ps.pl.mm * ``` + * + * + *
+ * Связанные объекты: + * + * - {@link Models.Model Model} - Модель (устройство, девайс). Доступ к данным модели + * - {@link Models.AlarmType AlarmType} - Тип аварии(аларма). Предоставляет доступ к данным типа аварии. + * * @group manager * @namespace Models * @extends manager @@ -55,4 +63,17 @@ function Models() { }; + /** + * #### Загрузит все объекты, которые попадают в указанную область. + * + * @public + * @function get_alarm_type + * @returns {tools.promise(Models.AlarmType)} + * @memberof Models + */ + this.get_alarm_type = function () { + + }; + + } \ No newline at end of file diff --git a/docfiles/providers/managers/models/model.js b/docfiles/providers/managers/models/model.js index b7ac373..b1c566f 100644 --- a/docfiles/providers/managers/models/model.js +++ b/docfiles/providers/managers/models/model.js @@ -1,10 +1,16 @@ /** - * ### Нода дерева. + * ### Модель (устройство, девайс). * * Представляет интефрейс для доступа к данным устройства. * * Позволяет получить список компонентов модели * + *
+ * Связанные объекты: + * + * - {@link Models Models} - Менеджер моделей. + * - {@link Models.Model.Groups Groups} - Группы моделей (список компонентов, которые есть у модели). + * - {@link Models.Model.static static} - Статические данные модели * * @class Model * @memberof Models diff --git a/docfiles/providers/managers/modelsTypes/manager.js b/docfiles/providers/managers/modelsTypes/manager.js index eeac5f6..4f26c1e 100644 --- a/docfiles/providers/managers/modelsTypes/manager.js +++ b/docfiles/providers/managers/modelsTypes/manager.js @@ -1,5 +1,7 @@ /** - * Менеджер для доступа к типам моделей + * ### Типам моделей + * + * Менеджер для доступа. * * Это системный менеджер, и нужен для работы {@link Models.Model.Groups.Group ModelGroup} * ```bash diff --git a/docfiles/providers/managers/publishers/manager.js b/docfiles/providers/managers/publishers/manager.js index e240b90..4ab3f2d 100644 --- a/docfiles/providers/managers/publishers/manager.js +++ b/docfiles/providers/managers/publishers/manager.js @@ -1,5 +1,5 @@ /** - * Менеджер паблишеров. + * ### Менеджер паблишеров. *
*
* **Доступ:** diff --git a/docfiles/providers/managers/translations/manager.js b/docfiles/providers/managers/translations/manager.js index 3775255..3b36eeb 100644 --- a/docfiles/providers/managers/translations/manager.js +++ b/docfiles/providers/managers/translations/manager.js @@ -1,4 +1,6 @@ /** + * ### Серверные переводы + * * Менеджер доступа до переводов, которые предоставляет сервер. * * ```bash diff --git a/docfiles/providers/managers/trees/manager.js b/docfiles/providers/managers/trees/manager.js index af95a63..b4368b2 100644 --- a/docfiles/providers/managers/trees/manager.js +++ b/docfiles/providers/managers/trees/manager.js @@ -7,6 +7,11 @@ * * Деревья представляют собой следующую иерархию наследования * + * ```bash + * // доступ + * ps.pl.tm + * ``` + * *
* * {@link Trees.GlobalTree GlobalTree} - любое дерево (обладает возможностью открывать свою иерархию) diff --git a/docfiles/providers/managers/user/manager.js b/docfiles/providers/managers/user/manager.js index d202665..77b9ae5 100644 --- a/docfiles/providers/managers/user/manager.js +++ b/docfiles/providers/managers/user/manager.js @@ -1,5 +1,5 @@ /** - * Интерфейс, который предоставляет доступ к данным групп, ваыф + * ### Интерфейс, который предоставляет доступ к данным групп, ваыф * * ```bash * // доступ