chichenkov/initi.doc
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

add new format for jsdoc

Browse source
This commit is contained in:
Aleksey Chichenkov 2020-03-31 14:06:26 +03:00
parent eeb2b01574
commit 7c96a53766
19 changed files with 2575 additions and 24 deletions
Download patch file Download diff file Expand all files Collapse all files

142
docfiles/custom/context.js Normal file
View file

@ -0,0 +1,142 @@
/**
* ### Документация по работе с GUI версии 2.9.1
*
* @name 01
* @context
* @memberof context
*/
/**
* ### Контекстное меню
*
* <br>
*
* #### Протокол
| type | command | data |
|------------- |------------------------------ |----------------------------------------------------------------------------- |
| GUI => CORE | requestContext | |
| CORE => GUI | responseContext | result: List(VariableContainer)<br>proxyData: VariableContainer |
| GUI => CORE | executeContextAction | action: String,<br>data: VariableContainer,<br>proxyData: VariableContainer |
| CORE => GUI | executeContextActionResponse | wizard: Boolean,<br>result: Map(Integer, Integer) |
<br>
#### Описание содержимого responseContext.result
| name | type | description |
|---------- |------------------- |-------------------------------------------------------------------- |
| id | String | Идентификатор, пункта меню |
| type | Integer | Тип пункта меню |
| parentId | String | Родительский ПМ, если его нет, то "" |
| name | String | Локализация названия |
| options | VariableContainer | Данные, которые сопутствую ПМ, в зависимости от контекста действия |
<br>
#### Описание типов, пунктов контекстного меню
| id | name | descriptions | options |
|---- |----------- |--------------------------------------------------------------------------------------------------- |------------------------------------------------------------------------------ |
| 0 | group | пункт меню (ПМ), который содержит в себе подпункты | VariableContainer[] |
| 1 | simple | ПМ, который исполняет запрос к ядру (executeAction) | VariableContainer[] |
| 2 | guiAction | действие которое исполняется со стороны GUI. | Опции, специфичные для id |
| 3 | dialog | ПМ, который откроет диалог, который необходимо заполнить и исполнит запрос к ядру (executeAction) | VariableContainer [<br> type: String,<br> data: VariableContainer<br>] |
| 4 | widget | ПМ, который любой виджет | VariableContainer [<br> type: String,<br> data: VariableContainer<br>] |
* #### Пример ответа
*
* ```
VariableContainer [
errCode : 0,
proxyData : VariableContainer [
nodeIds : Set(Integer) [
0
]
],
result : List(VariableContainer) [
VariableContainer [
options : VariableContainer [
],
id : "model",
parentId : "",
type : 2,
name : "Модель"
],
VariableContainer [
options : VariableContainer [
data : VariableContainer [
label : "Введите название для нового контейнера",
formVC : VariableContainer [
data : VariableContainer [
rules : List(VariableContainer) [
VariableContainer [
id : "name",
message : "Имя не может быть пустым",
validator : "input.size() > 0"
]
],
data : List(VariableContainer) [
VariableContainer [
value : "",
id : "name",
title : "Название",
viewer : VariableContainer [
data : VariableContainer [
vc : true
],
type : "LabelString"
],
editor : "Textbox"
]
]
],
type : "Form"
],
windowOptions : VariableContainer [
width : VariableContainer [
type : 0,
data : 300
],
height : VariableContainer [
type : 0,
data : 160
]
]
],
type : "VariablesForm"
],
id : "addContainer",
parentId : "",
type : 3,
name : "Добавить контейнер"
],
VariableContainer [
options : VariableContainer [
],
id : "shortcutTopology",
parentId : "",
type : 1,
name : "Создать ярлык на рабочем столе"
],
VariableContainer [
options : VariableContainer [
],
id : "inventory",
parentId : "",
type : 1,
name : "Синхронизация инвентаря"
]
],
command : "responseContext"
]
* ```
*
* @name 02
* @context
* @memberof context
*/

1593
docfiles/custom/editors.js Normal file
View file

File diff suppressed because it is too large Load diff

18
docfiles/custom/protocol.js Normal file
View file

@ -0,0 +1,18 @@
/**
* Created by Aleksey Chichenkov <a.chichenkov@initi.ru> on 3/4/20.
*/
/**
* ### Документация по работе с GUI версии 2.9.1
*
* asdf
* as
* dfa
* sdf
* asdf
*
* @name 01
* @protocol
* @memberof protocol
*/

6
docfiles/mainpage/main.js
View file

@ -50,7 +50,11 @@
* - - #### {@link std} - реализация сишной библиотеки на js.
* - - #### {@link v2} - сериализуемые типы, которыми можно обмениваться с ядром.
* - - #### {@link tools} - разного рода хелперы и инструменты.
*
* - #### Дополнительные материалы
* - - #### [Эдиторы](./editors.html)
* - - #### Протоколы
* - - - #### [Контекстное меню](./context.html)
* @name 02
* @mainpage
* @memberof mainpage

4
docfiles/providers/managers/entities/manager.js Normal file
View file

@ -0,0 +1,4 @@
/**
* Created by Aleksey Chichenkov <a.chichenkov@initi.ru> on 12/16/19.
*/

46
docfiles/providers/managers/trees/manager.js
View file

@ -31,24 +31,34 @@
*
*
* <br>
* Список доступных тегов деревьев:
* - "cmp" - Компоненты
* - "cst" - Вложенность компонентов
* - "dsk" - Рабочий стол
* - "ect" - Дерево событий
* - "flt" - Фильтры
* - "edg" - Линки
* - "cedg" - Вложенность линков
* - "prf" - Профили
* - "rmt" - Сборщики данных
* - "st" - Схема объектов
* - "uat" - Пользовательские данные
* - "dptt" - ???
* - "ecst" - ???
* - "gat" - Глобальное дерево с атрибутами
* - "gt" - Глобальное дерево
* - "rlt" - ???
* - "role" - ???
* Список доступных тегов деревьев:
*
* att - Массовые операций
* cedg - Вложенность линков
* chp - Провайдеры клик-хауса
* cmp - Компоненты
* cst - Вложенность компонентов
* dsk - Рабочий стол
* dst - Датасорсы
* ecst - Вложенность линков
* ect - Дерево событий
* edg - Дерево эджей (линков)
* gat - Глобальное дерево с атрибутами (Прототип)
* gt - Глобальное дерево (Прототип)
* flt - Фильтры
* fmt - Файловый менеджер
* ppt - Профили опроса
* prf - Профили авторизации
* rlt - Правила
* rmt - Сборщики данных
* rtt - Отчеты
* smptt - Мастер провайдеры
* ssptt - Слейв провайдеры
* st - Схема объектов
* uat - Пользовательские данные
* wmptt - WMI Master
* wsptt - WMI Slave
*
*
* <br>
* Связанные объекты:

25
docfiles/providers/managers/trees/schemeTree/node.js
View file

@ -5,4 +5,29 @@
*/
function Node() {
/**
* Возвращает адрес модели связанный с этой нодой.
*
* @public
* @function model_addr
* @memberof Trees.SchemeTree.Node
* @returns {v2.address}
*/
this.model_addr = function() {
};
/**
* Указывает, является ли данная нода контейнером.
*
* @public
* @function is_container
* @memberof Trees.SchemeTree.Node
* @returns {v2.boolean}
*/
this.is_container = function() {
};
}