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

add show list methods

This commit is contained in:
Aleksey Chichenkov 2018-09-18 17:41:21 +03:00
parent 058104b10f
commit 3478e04a63
7 changed files with 1064 additions and 121 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
docfiles/trees/globalAttributeTree.js
View File

@ -91,6 +91,7 @@ function Attributes() {
*
* @public
* @function get
* @param {v2.string} attributeName
* @returns {tools.promise.native}
* @memberof Trees.GlobalAttributeTree.Node.Attributes
*/
@ -103,7 +104,7 @@ function Attributes() {
*
* @public
* @function is_exist_attribute
* @params {v2.string} attributeName
* @param {v2.string} attributeName
* @returns {boolean}
* @memberof Trees.GlobalAttributeTree.Node.Attributes
*/
@ -116,7 +117,7 @@ function Attributes() {
*
* @public
* @function has_base_attribute
* @params {v2.string} attributeName
* @param {v2.string} attributeName
* @returns {boolean}
* @memberof Trees.GlobalAttributeTree.Node.Attributes
*/
@ -129,8 +130,8 @@ function Attributes() {
*
* @public
* @function add
* @param {v2.vc} attributes список атрибутов
* @returns {v2.model_type}
* @params {v2.vc} attributes список атрибутов
* @memberof Trees.GlobalAttributeTree.Node.Attributes
*/
this.add = function(attributes) {
@ -142,8 +143,8 @@ function Attributes() {
*
* @public
* @function remove
* @param {v2.set(v2.string)} attributes
* @returns {v2.model_type}
* @params {v2.set(v2.string)} attributes
* @memberof Trees.GlobalAttributeTree.Node.Attributes
*/
this.remove = function(attributes) {

951
example.json Normal file
View File

@ -0,0 +1,951 @@
[{
"comment": "/**\n * Вернет ссылку на модель. В качестве идентификатора следует указать адрес дерева.\n *\n * @public\n * @function get\n * @param {v2.address} address Адрес модели\n * @returns {tools.promise.native}\n * @memberof Models\n */",
"meta": {
"filename": "models.js",
"lineno": 10,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles",
"code": {},
"shortpath": "models.js"
},
"description": "Вернет ссылку на модель. В качестве идентификатора следует указать адрес дерева.",
"access": "public",
"kind": "function",
"name": "get",
"params": [
{
"type": {
"names": [
"v2.address"
]
},
"description": "Адрес модели",
"name": "address"
}
],
"returns": [
{
"type": {
"names": [
"tools.promise.native"
]
}
}
],
"memberof": "Models",
"scope": "static",
"longname": "Models.get",
"___id": "T000002R000004",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".get",
"signature": "<span class=\"signature\">(address)</span><span class=\"type-signature\"> &rarr; {tools.promise.native}</span>",
"ancestors": [
"<a href=\"Models.html\">Models</a>."
]
},
{
"comment": "/**\n * Вернет ссылку на дерево. В качестве идентификатора следует указать тег дерева.\n *\n * @public\n * @function get\n * @param {v2.string} treeTag Тег дерева. Например: \"rmt\", \"uat\"\n * @returns {tools.promise.native}\n * @memberof Trees\n */",
"meta": {
"filename": "trees.js",
"lineno": 16,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles",
"code": {},
"shortpath": "trees.js"
},
"description": "Вернет ссылку на дерево. В качестве идентификатора следует указать тег дерева.",
"access": "public",
"kind": "function",
"name": "get",
"params": [
{
"type": {
"names": [
"v2.string"
]
},
"description": "Тег дерева. Например: \"rmt\", \"uat\"",
"name": "treeTag"
}
],
"returns": [
{
"type": {
"names": [
"tools.promise.native"
]
}
}
],
"memberof": "Trees",
"scope": "static",
"longname": "Trees.get",
"___id": "T000002R000076",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".get",
"signature": "<span class=\"signature\">(treeTag)</span><span class=\"type-signature\"> &rarr; {tools.promise.native}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>."
]
},
{
"comment": "/**\n * Возвращает булевое значение о существовании дерева\n *\n * @public\n * @function is_tree_exist\n * @param {v2.string} treeTag Тег дерева. Например: \"rmt\", \"uat\"\n * @returns {boolean}\n * @memberof Trees\n */",
"meta": {
"filename": "trees.js",
"lineno": 28,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles",
"code": {},
"shortpath": "trees.js"
},
"description": "Возвращает булевое значение о существовании дерева",
"access": "public",
"kind": "function",
"name": "is_tree_exist",
"params": [
{
"type": {
"names": [
"v2.string"
]
},
"description": "Тег дерева. Например: \"rmt\", \"uat\"",
"name": "treeTag"
}
],
"returns": [
{
"type": {
"names": [
"boolean"
]
}
}
],
"memberof": "Trees",
"scope": "static",
"longname": "Trees.is_tree_exist",
"___id": "T000002R000078",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".is_tree_exist",
"signature": "<span class=\"signature\">(treeTag)</span><span class=\"type-signature\"> &rarr; {boolean}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>."
]
},
{
"comment": "/**\n * Возвращает менеджер атрибутов ноды.\n *\n * @public\n * @function am\n * @returns {tools.promise.native}\n * @memberof Trees.GlobalAttributeTree.Node\n */",
"meta": {
"filename": "globalAttributeTree.js",
"lineno": 45,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles/trees",
"code": {},
"shortpath": "trees/globalAttributeTree.js"
},
"description": "Возвращает менеджер атрибутов ноды.",
"access": "public",
"kind": "function",
"name": "am",
"returns": [
{
"type": {
"names": [
"tools.promise.native"
]
}
}
],
"memberof": "Trees.GlobalAttributeTree.Node",
"scope": "static",
"longname": "Trees.GlobalAttributeTree.Node.am",
"___id": "T000002R000018",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".am",
"signature": "<span class=\"signature\">()</span><span class=\"type-signature\"> &rarr; {tools.promise.native}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>",
"<a href=\"Trees.GlobalAttributeTree.html\">.GlobalAttributeTree</a>",
"<a href=\"Trees.GlobalAttributeTree.Node.html\">.Node</a>."
]
},
{
"comment": "/**\n * Возвращает список всех атрибутов, включая динамические <br>\n * <br> Работает через промис.\n *\n * @public\n * @function attributes\n * @returns {tools.promise.native}\n * @memberof Trees.GlobalAttributeTree.Node\n */",
"meta": {
"filename": "globalAttributeTree.js",
"lineno": 19,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles/trees",
"code": {},
"shortpath": "trees/globalAttributeTree.js"
},
"description": "Возвращает список всех атрибутов, включая динамические <br>\n<br> Работает через промис.",
"access": "public",
"kind": "function",
"name": "attributes",
"returns": [
{
"type": {
"names": [
"tools.promise.native"
]
}
}
],
"memberof": "Trees.GlobalAttributeTree.Node",
"scope": "static",
"longname": "Trees.GlobalAttributeTree.Node.attributes",
"___id": "T000002R000014",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".attributes",
"signature": "<span class=\"signature\">()</span><span class=\"type-signature\"> &rarr; {tools.promise.native}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>",
"<a href=\"Trees.GlobalAttributeTree.html\">.GlobalAttributeTree</a>",
"<a href=\"Trees.GlobalAttributeTree.Node.html\">.Node</a>."
]
},
{
"comment": "/**\n * Возвращает список базовых атрибутов ноды (их нельзя удалить) <br>\n * <br> Работает через промис.\n *\n * @public\n * @function base_attributes\n * @returns {tools.promise.native}\n * @memberof Trees.GlobalAttributeTree.Node\n */",
"meta": {
"filename": "globalAttributeTree.js",
"lineno": 32,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles/trees",
"code": {},
"shortpath": "trees/globalAttributeTree.js"
},
"description": "Возвращает список базовых атрибутов ноды (их нельзя удалить) <br>\n<br> Работает через промис.",
"access": "public",
"kind": "function",
"name": "base_attributes",
"returns": [
{
"type": {
"names": [
"tools.promise.native"
]
}
}
],
"memberof": "Trees.GlobalAttributeTree.Node",
"scope": "static",
"longname": "Trees.GlobalAttributeTree.Node.base_attributes",
"___id": "T000002R000016",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".base_attributes",
"signature": "<span class=\"signature\">()</span><span class=\"type-signature\"> &rarr; {tools.promise.native}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>",
"<a href=\"Trees.GlobalAttributeTree.html\">.GlobalAttributeTree</a>",
"<a href=\"Trees.GlobalAttributeTree.Node.html\">.Node</a>."
]
},
{
"comment": "/**\n * Добавляет динамические атрибуты в ноду\n *\n * @public\n * @function add\n * @returns {v2.model_type}\n * @params {v2.vc} attributes список атрибутов\n * @memberof Trees.GlobalAttributeTree.Node.Attributes\n */",
"meta": {
"filename": "globalAttributeTree.js",
"lineno": 127,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles/trees",
"code": {},
"shortpath": "trees/globalAttributeTree.js"
},
"description": "Добавляет динамические атрибуты в ноду",
"access": "public",
"kind": "function",
"name": "add",
"returns": [
{
"type": {
"names": [
"v2.model_type"
]
}
}
],
"tags": [
{
"originalTitle": "params",
"title": "params",
"text": "{v2.vc} attributes список атрибутов",
"value": "{v2.vc} attributes список атрибутов"
}
],
"memberof": "Trees.GlobalAttributeTree.Node.Attributes",
"scope": "static",
"longname": "Trees.GlobalAttributeTree.Node.Attributes.add",
"___id": "T000002R000032",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".add",
"signature": "<span class=\"signature\">()</span><span class=\"type-signature\"> &rarr; {v2.model_type}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>",
"<a href=\"Trees.GlobalAttributeTree.html\">.GlobalAttributeTree</a>",
"<a href=\"Trees.GlobalAttributeTree.Node.html\">.Node</a>",
"<a href=\"Trees.GlobalAttributeTree.Node.Attributes.html\">.Attributes</a>."
]
},
{
"comment": "/**\n * Возвращает список атрибутов ноды\n *\n * @public\n * @function attributes\n * @returns {v2.map(v2.string.type, v2.vc.type)}\n * @memberof Trees.GlobalAttributeTree.Node.Attributes\n */",
"meta": {
"filename": "globalAttributeTree.js",
"lineno": 65,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles/trees",
"code": {},
"shortpath": "trees/globalAttributeTree.js"
},
"description": "Возвращает список атрибутов ноды",
"access": "public",
"kind": "function",
"name": "attributes",
"returns": [
{
"type": {
"names": [
"v2.map(v2.string.type, v2.vc.type)"
]
}
}
],
"memberof": "Trees.GlobalAttributeTree.Node.Attributes",
"scope": "static",
"longname": "Trees.GlobalAttributeTree.Node.Attributes.attributes",
"___id": "T000002R000022",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".attributes",
"signature": "<span class=\"signature\">()</span><span class=\"type-signature\"> &rarr; {v2.map(v2.string.type, v2.vc.type)}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>",
"<a href=\"Trees.GlobalAttributeTree.html\">.GlobalAttributeTree</a>",
"<a href=\"Trees.GlobalAttributeTree.Node.html\">.Node</a>",
"<a href=\"Trees.GlobalAttributeTree.Node.Attributes.html\">.Attributes</a>."
]
},
{
"comment": "/**\n * Возвращает список базовых атрибутов ноды\n *\n * @public\n * @function base_attributes\n * @returns {v2.vc}\n * @memberof Trees.GlobalAttributeTree.Node.Attributes\n */",
"meta": {
"filename": "globalAttributeTree.js",
"lineno": 77,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles/trees",
"code": {},
"shortpath": "trees/globalAttributeTree.js"
},
"description": "Возвращает список базовых атрибутов ноды",
"access": "public",
"kind": "function",
"name": "base_attributes",
"returns": [
{
"type": {
"names": [
"v2.vc"
]
}
}
],
"memberof": "Trees.GlobalAttributeTree.Node.Attributes",
"scope": "static",
"longname": "Trees.GlobalAttributeTree.Node.Attributes.base_attributes",
"___id": "T000002R000024",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".base_attributes",
"signature": "<span class=\"signature\">()</span><span class=\"type-signature\"> &rarr; {v2.vc}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>",
"<a href=\"Trees.GlobalAttributeTree.html\">.GlobalAttributeTree</a>",
"<a href=\"Trees.GlobalAttributeTree.Node.html\">.Node</a>",
"<a href=\"Trees.GlobalAttributeTree.Node.Attributes.html\">.Attributes</a>."
]
},
{
"comment": "/**\n * Возвращает ссылку на атрибут ноды\n *\n * @public\n * @function get\n * @returns {tools.promise.native}\n * @memberof Trees.GlobalAttributeTree.Node.Attributes\n */",
"meta": {
"filename": "globalAttributeTree.js",
"lineno": 89,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles/trees",
"code": {},
"shortpath": "trees/globalAttributeTree.js"
},
"description": "Возвращает ссылку на атрибут ноды",
"access": "public",
"kind": "function",
"name": "get",
"returns": [
{
"type": {
"names": [
"tools.promise.native"
]
}
}
],
"memberof": "Trees.GlobalAttributeTree.Node.Attributes",
"scope": "static",
"longname": "Trees.GlobalAttributeTree.Node.Attributes.get",
"___id": "T000002R000026",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".get",
"signature": "<span class=\"signature\">()</span><span class=\"type-signature\"> &rarr; {tools.promise.native}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>",
"<a href=\"Trees.GlobalAttributeTree.html\">.GlobalAttributeTree</a>",
"<a href=\"Trees.GlobalAttributeTree.Node.html\">.Node</a>",
"<a href=\"Trees.GlobalAttributeTree.Node.Attributes.html\">.Attributes</a>."
]
},
{
"comment": "/**\n * Провеляет наличие базового атрибута у ноды\n *\n * @public\n * @function has_base_attribute\n * @params {v2.string} attributeName\n * @returns {boolean}\n * @memberof Trees.GlobalAttributeTree.Node.Attributes\n */",
"meta": {
"filename": "globalAttributeTree.js",
"lineno": 114,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles/trees",
"code": {},
"shortpath": "trees/globalAttributeTree.js"
},
"description": "Провеляет наличие базового атрибута у ноды",
"access": "public",
"kind": "function",
"name": "has_base_attribute",
"tags": [
{
"originalTitle": "params",
"title": "params",
"text": "{v2.string} attributeName",
"value": "{v2.string} attributeName"
}
],
"returns": [
{
"type": {
"names": [
"boolean"
]
}
}
],
"memberof": "Trees.GlobalAttributeTree.Node.Attributes",
"scope": "static",
"longname": "Trees.GlobalAttributeTree.Node.Attributes.has_base_attribute",
"___id": "T000002R000030",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".has_base_attribute",
"signature": "<span class=\"signature\">()</span><span class=\"type-signature\"> &rarr; {boolean}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>",
"<a href=\"Trees.GlobalAttributeTree.html\">.GlobalAttributeTree</a>",
"<a href=\"Trees.GlobalAttributeTree.Node.html\">.Node</a>",
"<a href=\"Trees.GlobalAttributeTree.Node.Attributes.html\">.Attributes</a>."
]
},
{
"comment": "/**\n * Проверяет наличие любого атрибута у ноды\n *\n * @public\n * @function is_exist_attribute\n * @params {v2.string} attributeName\n * @returns {boolean}\n * @memberof Trees.GlobalAttributeTree.Node.Attributes\n */",
"meta": {
"filename": "globalAttributeTree.js",
"lineno": 101,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles/trees",
"code": {},
"shortpath": "trees/globalAttributeTree.js"
},
"description": "Проверяет наличие любого атрибута у ноды",
"access": "public",
"kind": "function",
"name": "is_exist_attribute",
"tags": [
{
"originalTitle": "params",
"title": "params",
"text": "{v2.string} attributeName",
"value": "{v2.string} attributeName"
}
],
"returns": [
{
"type": {
"names": [
"boolean"
]
}
}
],
"memberof": "Trees.GlobalAttributeTree.Node.Attributes",
"scope": "static",
"longname": "Trees.GlobalAttributeTree.Node.Attributes.is_exist_attribute",
"___id": "T000002R000028",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".is_exist_attribute",
"signature": "<span class=\"signature\">()</span><span class=\"type-signature\"> &rarr; {boolean}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>",
"<a href=\"Trees.GlobalAttributeTree.html\">.GlobalAttributeTree</a>",
"<a href=\"Trees.GlobalAttributeTree.Node.html\">.Node</a>",
"<a href=\"Trees.GlobalAttributeTree.Node.Attributes.html\">.Attributes</a>."
]
},
{
"comment": "/**\n * Удаляет динамические атрибуты из ноды\n *\n * @public\n * @function remove\n * @returns {v2.model_type}\n * @params {v2.set(v2.string)} attributes\n * @memberof Trees.GlobalAttributeTree.Node.Attributes\n */",
"meta": {
"filename": "globalAttributeTree.js",
"lineno": 140,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles/trees",
"code": {},
"shortpath": "trees/globalAttributeTree.js"
},
"description": "Удаляет динамические атрибуты из ноды",
"access": "public",
"kind": "function",
"name": "remove",
"returns": [
{
"type": {
"names": [
"v2.model_type"
]
}
}
],
"tags": [
{
"originalTitle": "params",
"title": "params",
"text": "{v2.set(v2.string)} attributes",
"value": "{v2.set(v2.string)} attributes"
}
],
"memberof": "Trees.GlobalAttributeTree.Node.Attributes",
"scope": "static",
"longname": "Trees.GlobalAttributeTree.Node.Attributes.remove",
"___id": "T000002R000034",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".remove",
"signature": "<span class=\"signature\">()</span><span class=\"type-signature\"> &rarr; {v2.model_type}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>",
"<a href=\"Trees.GlobalAttributeTree.html\">.GlobalAttributeTree</a>",
"<a href=\"Trees.GlobalAttributeTree.Node.html\">.Node</a>",
"<a href=\"Trees.GlobalAttributeTree.Node.Attributes.html\">.Attributes</a>."
]
},
{
"comment": "/**\n * Возвращает ссылку на ноду. В качестве идентификатора надо указать идентификатор ноды.<br>\n * <br> Работает через промис.\n *\n * @public\n * @function get\n * @param {v2.integer} nodeId Уникальный идентификатор ноды в дереве\n * @returns {tools.promise.native}\n * @memberof Trees.GlobalTree\n */",
"meta": {
"filename": "globalTree.js",
"lineno": 10,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles/trees",
"code": {},
"shortpath": "trees/globalTree.js"
},
"description": "Возвращает ссылку на ноду. В качестве идентификатора надо указать идентификатор ноды.<br>\n<br> Работает через промис.",
"access": "public",
"kind": "function",
"name": "get",
"params": [
{
"type": {
"names": [
"v2.integer"
]
},
"description": "Уникальный идентификатор ноды в дереве",
"name": "nodeId"
}
],
"returns": [
{
"type": {
"names": [
"tools.promise.native"
]
}
}
],
"memberof": "Trees.GlobalTree",
"scope": "static",
"longname": "Trees.GlobalTree.get",
"___id": "T000002R000038",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".get",
"signature": "<span class=\"signature\">(nodeId)</span><span class=\"type-signature\"> &rarr; {tools.promise.native}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>",
"<a href=\"Trees.GlobalTree.html\">.GlobalTree</a>."
]
},
{
"comment": "/**\n * Позволяет удалить динамический атрибут ноды. <br>\n * Возвращает булевое значение об операции\n *\n * @public\n * @function remove\n * @param {v2.string} nodeId Уникальный идентификатор ноды в дереве\n * @returns {boolean}\n * @memberof Trees.GlobalTree\n */",
"meta": {
"filename": "globalTree.js",
"lineno": 24,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles/trees",
"code": {},
"shortpath": "trees/globalTree.js"
},
"description": "Позволяет удалить динамический атрибут ноды. <br>\nВозвращает булевое значение об операции",
"access": "public",
"kind": "function",
"name": "remove",
"params": [
{
"type": {
"names": [
"v2.string"
]
},
"description": "Уникальный идентификатор ноды в дереве",
"name": "nodeId"
}
],
"returns": [
{
"type": {
"names": [
"boolean"
]
}
}
],
"memberof": "Trees.GlobalTree",
"scope": "static",
"longname": "Trees.GlobalTree.remove",
"___id": "T000002R000040",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".remove",
"signature": "<span class=\"signature\">(nodeId)</span><span class=\"type-signature\"> &rarr; {boolean}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>",
"<a href=\"Trees.GlobalTree.html\">.GlobalTree</a>."
]
},
{
"comment": "/**\n * Возвращает адрес дерева в системе\n *\n * @public\n * @function sys_addr\n * @returns {v2.address}\n * @memberof Trees.GlobalTree\n */",
"meta": {
"filename": "globalTree.js",
"lineno": 38,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles/trees",
"code": {},
"shortpath": "trees/globalTree.js"
},
"description": "Возвращает адрес дерева в системе",
"access": "public",
"kind": "function",
"name": "sys_addr",
"returns": [
{
"type": {
"names": [
"v2.address"
]
}
}
],
"memberof": "Trees.GlobalTree",
"scope": "static",
"longname": "Trees.GlobalTree.sys_addr",
"___id": "T000002R000042",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".sys_addr",
"signature": "<span class=\"signature\">()</span><span class=\"type-signature\"> &rarr; {v2.address}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>",
"<a href=\"Trees.GlobalTree.html\">.GlobalTree</a>."
]
},
{
"comment": "/**\n * Добавляет новый динамический атрибут в ноду.<br>\n * Ничего не возвращает.\n *\n * @public\n * @function add_node\n * @param {v2.vc} _attrs\n * @memberof Trees.GlobalTree.Node\n */",
"meta": {
"filename": "globalTree.js",
"lineno": 74,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles/trees",
"code": {},
"shortpath": "trees/globalTree.js"
},
"description": "Добавляет новый динамический атрибут в ноду.<br>\nНичего не возвращает.",
"access": "public",
"kind": "function",
"name": "add_node",
"params": [
{
"type": {
"names": [
"v2.vc"
]
},
"name": "_attrs"
}
],
"memberof": "Trees.GlobalTree.Node",
"scope": "static",
"longname": "Trees.GlobalTree.Node.add_node",
"___id": "T000002R000048",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".add_node",
"signature": "<span class=\"signature\">(_attrs)</span><span class=\"type-signature\"></span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>",
"<a href=\"Trees.GlobalTree.html\">.GlobalTree</a>",
"<a href=\"Trees.GlobalTree.Node.html\">.Node</a>."
]
},
{
"comment": "/**\n * Возвращает список потомков ноды.<br>\n * <br> Работает через промис.\n *\n * @public\n * @function children\n * @returns {tools.promise.native}\n * @memberof Trees.GlobalTree.Node\n */",
"meta": {
"filename": "globalTree.js",
"lineno": 99,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles/trees",
"code": {},
"shortpath": "trees/globalTree.js"
},
"description": "Возвращает список потомков ноды.<br>\n<br> Работает через промис.",
"access": "public",
"kind": "function",
"name": "children",
"returns": [
{
"type": {
"names": [
"tools.promise.native"
]
}
}
],
"memberof": "Trees.GlobalTree.Node",
"scope": "static",
"longname": "Trees.GlobalTree.Node.children",
"___id": "T000002R000052",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".children",
"signature": "<span class=\"signature\">()</span><span class=\"type-signature\"> &rarr; {tools.promise.native}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>",
"<a href=\"Trees.GlobalTree.html\">.GlobalTree</a>",
"<a href=\"Trees.GlobalTree.Node.html\">.Node</a>."
]
},
{
"comment": "/**\n * Доступ к менеджеру детей\n * @public\n * @function cm\n * @returns {Children}\n * @memberof Trees.GlobalTree.Node\n */",
"meta": {
"filename": "globalTree.js",
"lineno": 112,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles/trees",
"code": {},
"shortpath": "trees/globalTree.js"
},
"description": "Доступ к менеджеру детей",
"access": "public",
"kind": "function",
"name": "cm",
"returns": [
{
"type": {
"names": [
"Children"
]
}
}
],
"memberof": "Trees.GlobalTree.Node",
"scope": "static",
"longname": "Trees.GlobalTree.Node.cm",
"___id": "T000002R000054",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".cm",
"signature": "<span class=\"signature\">()</span><span class=\"type-signature\"> &rarr; {Children}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>",
"<a href=\"Trees.GlobalTree.html\">.GlobalTree</a>",
"<a href=\"Trees.GlobalTree.Node.html\">.Node</a>."
]
},
{
"comment": "/**\n * Возвращает ссылку на атрибут ноды.<br>\n * <br> Работает через промис.\n *\n * @public\n * @function get\n * @param {v2.string} attributeName Имя атрибута\n * @returns {tools.promise.native}\n * @memberof Trees.GlobalTree.Node\n */",
"meta": {
"filename": "globalTree.js",
"lineno": 60,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles/trees",
"code": {},
"shortpath": "trees/globalTree.js"
},
"description": "Возвращает ссылку на атрибут ноды.<br>\n<br> Работает через промис.",
"access": "public",
"kind": "function",
"name": "get",
"params": [
{
"type": {
"names": [
"v2.string"
]
},
"description": "Имя атрибута",
"name": "attributeName"
}
],
"returns": [
{
"type": {
"names": [
"tools.promise.native"
]
}
}
],
"memberof": "Trees.GlobalTree.Node",
"scope": "static",
"longname": "Trees.GlobalTree.Node.get",
"___id": "T000002R000046",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".get",
"signature": "<span class=\"signature\">(attributeName)</span><span class=\"type-signature\"> &rarr; {tools.promise.native}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>",
"<a href=\"Trees.GlobalTree.html\">.GlobalTree</a>",
"<a href=\"Trees.GlobalTree.Node.html\">.Node</a>."
]
},
{
"comment": "/**\n * Возвращает уникальный идентификатор ноды.\n *\n * @public\n * @function id\n * @returns {v2.integer}\n * @memberof Trees.GlobalTree.Node\n */",
"meta": {
"filename": "globalTree.js",
"lineno": 87,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles/trees",
"code": {},
"shortpath": "trees/globalTree.js"
},
"description": "Возвращает уникальный идентификатор ноды.",
"access": "public",
"kind": "function",
"name": "id",
"returns": [
{
"type": {
"names": [
"v2.integer"
]
}
}
],
"memberof": "Trees.GlobalTree.Node",
"scope": "static",
"longname": "Trees.GlobalTree.Node.id",
"___id": "T000002R000050",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".id",
"signature": "<span class=\"signature\">()</span><span class=\"type-signature\"> &rarr; {v2.integer}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>",
"<a href=\"Trees.GlobalTree.html\">.GlobalTree</a>",
"<a href=\"Trees.GlobalTree.Node.html\">.Node</a>."
]
},
{
"comment": "/**\n * Возвращает список потомков ноды\n *\n * @public\n * @function get\n * @returns {v2.list(v2.integer.type)}\n * @memberof Trees.GlobalTree.Node.Children\n */",
"meta": {
"filename": "globalTree.js",
"lineno": 131,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles/trees",
"code": {},
"shortpath": "trees/globalTree.js"
},
"description": "Возвращает список потомков ноды",
"access": "public",
"kind": "function",
"name": "get",
"returns": [
{
"type": {
"names": [
"v2.list(v2.integer.type)"
]
}
}
],
"memberof": "Trees.GlobalTree.Node.Children",
"scope": "static",
"longname": "Trees.GlobalTree.Node.Children.get",
"___id": "T000002R000058",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".get",
"signature": "<span class=\"signature\">()</span><span class=\"type-signature\"> &rarr; {v2.list(v2.integer.type)}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>",
"<a href=\"Trees.GlobalTree.html\">.GlobalTree</a>",
"<a href=\"Trees.GlobalTree.Node.html\">.Node</a>",
"<a href=\"Trees.GlobalTree.Node.Children.html\">.Children</a>."
]
},
{
"comment": "/**\n * Возвращает тип ноды, по ее идентификатору\n *\n * @public\n * @function get_type_by_id\n * @returns {v2.model_type}\n * @memberof Trees.GlobalTree.Node.Children\n */",
"meta": {
"filename": "globalTree.js",
"lineno": 143,
"columnno": 4,
"path": "/home/chichenkov/work/docsgen/docfiles/trees",
"code": {},
"shortpath": "trees/globalTree.js"
},
"description": "Возвращает тип ноды, по ее идентификатору",
"access": "public",
"kind": "function",
"name": "get_type_by_id",
"returns": [
{
"type": {
"names": [
"v2.model_type"
]
}
}
],
"memberof": "Trees.GlobalTree.Node.Children",
"scope": "static",
"longname": "Trees.GlobalTree.Node.Children.get_type_by_id",
"___id": "T000002R000060",
"___s": true,
"attribs": "<span class=\"type-signature\">(static) </span>",
"id": ".get_type_by_id",
"signature": "<span class=\"signature\">()</span><span class=\"type-signature\"> &rarr; {v2.model_type}</span>",
"ancestors": [
"<a href=\"Trees.html\">Trees</a>",
"<a href=\"Trees.GlobalTree.html\">.GlobalTree</a>",
"<a href=\"Trees.GlobalTree.Node.html\">.Node</a>",
"<a href=\"Trees.GlobalTree.Node.Children.html\">.Children</a>."
]
}
]

7
templates/initi/static/styles/jsdoc-default.css
View File

@ -1,3 +1,5 @@
@import url("min-method.css");
@font-face {
font-family: 'Open Sans';
font-weight: normal;
@ -24,6 +26,7 @@
url('../fonts/OpenSans-Light-webfont.svg#open_sanslight') format('svg');
}
html
{
overflow: auto;
@ -34,7 +37,7 @@ html
body
{
font-family: 'Open Sans', sans-serif;
line-height: 1.5;
/*line-height: 1.5;*/
color: #4d4e53;
background-color: white;
}
@ -428,4 +431,4 @@ article ul {
.__end {
color: #0037ff;
font-size: 17px;
}
}

53
templates/initi/static/styles/min-method.css Normal file
View File

@ -0,0 +1,53 @@
.min-methods{}
.min-methods .title {
font-size: 28px;
font-weight: bold;
margin-top: 20px;
}
.min-methods .list {
padding-left: 24px;
}
.min-methods .list .compact-method {
font-size: 20px;
font-weight: normal;
font-family: 'Open Sans', sans-serif !important;
}
.min-methods .list .compact-method .access{}
.min-methods .list .compact-method .name{
color: #0137ff;
font-size: 24px;
font-weight: normal;
}
.min-methods .list .compact-method .param {
font-weight: normal;
}
.min-methods .list .compact-method .param .left-circle-bracket{}
.min-methods .list .compact-method .param .right-circle-bracket{}
.min-methods .list .compact-method .param .type{}
.min-methods .list .compact-method .param .type .left-quad-bracket{}
.min-methods .list .compact-method .param .type .name{
color: #3d7700;
font-size: 20px;
}
.min-methods .list .compact-method .param .type .right-quad-bracket{}
.min-methods .list .compact-method .param .name{
color: #383838;
font-size: 20px;
}
.min-methods .list .compact-method .returns{}
.min-methods .list .compact-method .returns .arrow{}
.min-methods .list .compact-method .returns .left-figure-bracket{}
.min-methods .list .compact-method .returns .right-figure-bracket{}
.min-methods .list .compact-method .returns .name{
color: #5aa30e;
font-size: 20px;
font-weight: normal;
}

8
templates/initi/tmpl/container.tmpl
View File

@ -151,6 +151,14 @@
var methods = self.find({kind: 'function', memberof: isGlobalPage ? {isUndefined: true} : doc.longname});
if (methods && methods.length && methods.forEach) {
?>
<div class="min-methods">
<div class="title">Methods list:</div>
<div class="list">
<?js methods.forEach(function(m) { ?>
<?js= self.partial('method_list.tmpl', m) ?>
<?js }); ?>
</div>
</div>
<h3 class="subsection-title methods">Methods</h3>
<?js methods.forEach(function(m) { ?>
<?js= self.partial('method.tmpl', m) ?>

1
templates/initi/tmpl/method.tmpl
View File

@ -1,7 +1,6 @@
<?js
var data = obj;
var self = this;
console.log("!!!!!!!!!!!!!!! sdfasdfasdfasdf !!!!!!!!!!!!!!!!!");
?>
<?js if (data.kind !== 'module' && !data.hideconstructor) { ?>
<?js if (data.kind === 'class' && data.classdesc) { ?>

156
templates/initi/tmpl/method_list.tmpl
View File

@ -1,119 +1,47 @@
<?js
var data = obj;
var self = this;
//console.log(JSON.stringify(data, true, 3))
?>
<?js if (data.kind !== 'module' && !data.hideconstructor) { ?>
<?js if (data.kind === 'class' && data.classdesc) { ?>
<h2>Constructor</h2>
<div class="compact-method">
<span class="access"> <?js= data.access ?></span>
<span class="name"><a href="#<?js= data.id ?>"><?js= name ?></a></span>
<span class="params">
<span class="left-circle-bracket">(</span>
<?js
if(data.params){
var a = 0;
while(a < data.params.length){
var param = data.params[a];
if(!param) { a++; continue; }
var type = param.type.names[0];
?>
<span class="param">
<span class="type">
<span class="left-quad-bracket">[ </span>
<span class="name"><?js= type ?></span>
<span class="right-quad-bracket"> ]</span>
</span>
<span class="name"><?js= param.name ?></span>
</span>
<?js
a++;
}
}
?>
<span class="right-circle-bracket">)</span>
</span>
<?js if(data.returns) { ?>
<?js var rets = data.returns[0].type.names[0]; ?>
<span class="returns">
<span class="arrow"> → </span>
<span class="left-figure-bracket">{</span>
<span class="name"><?js= rets ?></span>
<span class="right-figure-bracket">}</span>
</span>
<?js } ?>
<?js if (data.kind !== 'namespace') { ?>
<h4 class="name" id="<?js= id ?>"><?js= data.attribs + (kind === 'class' ? 'new ' : '')
+ "<span class='method-name'>" + name + "</span>" + (data.signature || '') ?></h4>
<?js } ?>
<?js if (data.summary) { ?>
<p class="summary"><?js= summary ?></p>
<?js } ?>
<?js } ?>
<?js if (data.kind !== 'module' && data.description && !data.hideconstructor) { ?>
<div class="description">
<?js= data.description ?>
</div>
<?js } ?>
<?js if (data.augments && data.alias && data.alias.indexOf('module:') === 0) { ?>
<h5>Extends:</h5>
<?js= self.partial('augments.tmpl', data) ?>
<?js } ?>
<?js if (kind === 'event' && data.type && data.type.names) {?>
<h5>Type:</h5>
<ul>
<li>
<?js= self.partial('type.tmpl', data.type.names) ?>
</li>
</ul>
<?js } ?>
<?js if (data['this']) { ?>
<h5>This:</h5>
<ul><li><?js= this.linkto(data['this'], data['this']) ?></li></ul>
<?js } ?>
<?js if (data.params && params.length && !data.hideconstructor) { ?>
<h5>Parameters:</h5>
<?js= this.partial('params.tmpl', params) ?>
<?js } ?>
<?js= this.partial('details.tmpl', data) ?>
<?js if (data.kind !== 'module' && data.requires && data.requires.length) { ?>
<h5>Requires:</h5>
<ul><?js data.requires.forEach(function(r) { ?>
<li><?js= self.linkto(r) ?></li>
<?js }); ?></ul>
<?js } ?>
<?js if (data.fires && fires.length) { ?>
<h5>Fires:</h5>
<ul><?js fires.forEach(function(f) { ?>
<li><?js= self.linkto(f) ?></li>
<?js }); ?></ul>
<?js } ?>
<?js if (data.listens && listens.length) { ?>
<h5>Listens to Events:</h5>
<ul><?js listens.forEach(function(f) { ?>
<li><?js= self.linkto(f) ?></li>
<?js }); ?></ul>
<?js } ?>
<?js if (data.listeners && listeners.length) { ?>
<h5>Listeners of This Event:</h5>
<ul><?js listeners.forEach(function(f) { ?>
<li><?js= self.linkto(f) ?></li>
<?js }); ?></ul>
<?js } ?>
<?js if (data.exceptions && exceptions.length) { ?>
<h5>Throws:</h5>
<?js if (exceptions.length > 1) { ?><ul><?js
exceptions.forEach(function(r) { ?>
<li><?js= self.partial('exceptions.tmpl', r) ?></li>
<?js });
?></ul><?js } else {
exceptions.forEach(function(r) { ?>
<?js= self.partial('exceptions.tmpl', r) ?>
<?js });
} } ?>
<?js if (data.returns && returns.length) { ?>
<?js if (returns.length > 1) { ?><ul><?js
returns.forEach(function(r) { ?>
<li><?js= self.partial('returns.tmpl', r) ?></li>
<?js });
?></ul><?js } else {
returns.forEach(function(r) { ?>
<?js= self.partial('returns.tmpl', r) ?>
<?js });
} } ?>
<?js if (data.yields && yields.length) { ?>
<h5>Yields:</h5>
<?js if (yields.length > 1) { ?><ul><?js
yields.forEach(function(r) { ?>
<li><?js= self.partial('returns.tmpl', r) ?></li>
<?js });
?></ul><?js } else {
yields.forEach(function(r) { ?>
<?js= self.partial('returns.tmpl', r) ?>
<?js });
} } ?>
<?js if (data.examples && examples.length) { ?>
<h5>Example<?js= examples.length > 1? 's':'' ?></h5>
<?js= this.partial('examples.tmpl', examples) ?>
<?js } ?>
</div>