diff --git a/docfiles/trees/globalAttributeTree.js b/docfiles/trees/globalAttributeTree.js index 83945b3..ce49cb0 100644 --- a/docfiles/trees/globalAttributeTree.js +++ b/docfiles/trees/globalAttributeTree.js @@ -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) { diff --git a/example.json b/example.json new file mode 100644 index 0000000..3b63d4b --- /dev/null +++ b/example.json @@ -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": "(static) ", + "id": ".get", + "signature": "(address) → {tools.promise.native}", + "ancestors": [ + "Models." + ] +}, +{ + "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": "(static) ", + "id": ".get", + "signature": "(treeTag) → {tools.promise.native}", + "ancestors": [ + "Trees." + ] +}, +{ + "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": "(static) ", + "id": ".is_tree_exist", + "signature": "(treeTag) → {boolean}", + "ancestors": [ + "Trees." + ] +}, +{ + "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": "(static) ", + "id": ".am", + "signature": "() → {tools.promise.native}", + "ancestors": [ + "Trees", + ".GlobalAttributeTree", + ".Node." + ] +}, +{ + "comment": "/**\n * Возвращает список всех атрибутов, включая динамические
\n *
Работает через промис.\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": "Возвращает список всех атрибутов, включая динамические
\n
Работает через промис.", + "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": "(static) ", + "id": ".attributes", + "signature": "() → {tools.promise.native}", + "ancestors": [ + "Trees", + ".GlobalAttributeTree", + ".Node." + ] +}, +{ + "comment": "/**\n * Возвращает список базовых атрибутов ноды (их нельзя удалить)
\n *
Работает через промис.\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": "Возвращает список базовых атрибутов ноды (их нельзя удалить)
\n
Работает через промис.", + "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": "(static) ", + "id": ".base_attributes", + "signature": "() → {tools.promise.native}", + "ancestors": [ + "Trees", + ".GlobalAttributeTree", + ".Node." + ] +}, +{ + "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": "(static) ", + "id": ".add", + "signature": "() → {v2.model_type}", + "ancestors": [ + "Trees", + ".GlobalAttributeTree", + ".Node", + ".Attributes." + ] +}, +{ + "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": "(static) ", + "id": ".attributes", + "signature": "() → {v2.map(v2.string.type, v2.vc.type)}", + "ancestors": [ + "Trees", + ".GlobalAttributeTree", + ".Node", + ".Attributes." + ] +}, +{ + "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": "(static) ", + "id": ".base_attributes", + "signature": "() → {v2.vc}", + "ancestors": [ + "Trees", + ".GlobalAttributeTree", + ".Node", + ".Attributes." + ] +}, +{ + "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": "(static) ", + "id": ".get", + "signature": "() → {tools.promise.native}", + "ancestors": [ + "Trees", + ".GlobalAttributeTree", + ".Node", + ".Attributes." + ] +}, +{ + "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": "(static) ", + "id": ".has_base_attribute", + "signature": "() → {boolean}", + "ancestors": [ + "Trees", + ".GlobalAttributeTree", + ".Node", + ".Attributes." + ] +}, +{ + "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": "(static) ", + "id": ".is_exist_attribute", + "signature": "() → {boolean}", + "ancestors": [ + "Trees", + ".GlobalAttributeTree", + ".Node", + ".Attributes." + ] +}, +{ + "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": "(static) ", + "id": ".remove", + "signature": "() → {v2.model_type}", + "ancestors": [ + "Trees", + ".GlobalAttributeTree", + ".Node", + ".Attributes." + ] +}, +{ + "comment": "/**\n * Возвращает ссылку на ноду. В качестве идентификатора надо указать идентификатор ноды.
\n *
Работает через промис.\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": "Возвращает ссылку на ноду. В качестве идентификатора надо указать идентификатор ноды.
\n
Работает через промис.", + "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": "(static) ", + "id": ".get", + "signature": "(nodeId) → {tools.promise.native}", + "ancestors": [ + "Trees", + ".GlobalTree." + ] +}, +{ + "comment": "/**\n * Позволяет удалить динамический атрибут ноды.
\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": "Позволяет удалить динамический атрибут ноды.
\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": "(static) ", + "id": ".remove", + "signature": "(nodeId) → {boolean}", + "ancestors": [ + "Trees", + ".GlobalTree." + ] +}, +{ + "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": "(static) ", + "id": ".sys_addr", + "signature": "() → {v2.address}", + "ancestors": [ + "Trees", + ".GlobalTree." + ] +}, +{ + "comment": "/**\n * Добавляет новый динамический атрибут в ноду.
\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": "Добавляет новый динамический атрибут в ноду.
\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": "(static) ", + "id": ".add_node", + "signature": "(_attrs)", + "ancestors": [ + "Trees", + ".GlobalTree", + ".Node." + ] +}, +{ + "comment": "/**\n * Возвращает список потомков ноды.
\n *
Работает через промис.\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": "Возвращает список потомков ноды.
\n
Работает через промис.", + "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": "(static) ", + "id": ".children", + "signature": "() → {tools.promise.native}", + "ancestors": [ + "Trees", + ".GlobalTree", + ".Node." + ] +}, +{ + "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": "(static) ", + "id": ".cm", + "signature": "() → {Children}", + "ancestors": [ + "Trees", + ".GlobalTree", + ".Node." + ] +}, +{ + "comment": "/**\n * Возвращает ссылку на атрибут ноды.
\n *
Работает через промис.\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": "Возвращает ссылку на атрибут ноды.
\n
Работает через промис.", + "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": "(static) ", + "id": ".get", + "signature": "(attributeName) → {tools.promise.native}", + "ancestors": [ + "Trees", + ".GlobalTree", + ".Node." + ] +}, +{ + "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": "(static) ", + "id": ".id", + "signature": "() → {v2.integer}", + "ancestors": [ + "Trees", + ".GlobalTree", + ".Node." + ] +}, +{ + "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": "(static) ", + "id": ".get", + "signature": "() → {v2.list(v2.integer.type)}", + "ancestors": [ + "Trees", + ".GlobalTree", + ".Node", + ".Children." + ] +}, +{ + "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": "(static) ", + "id": ".get_type_by_id", + "signature": "() → {v2.model_type}", + "ancestors": [ + "Trees", + ".GlobalTree", + ".Node", + ".Children." + ] +} +] \ No newline at end of file diff --git a/templates/initi/static/styles/jsdoc-default.css b/templates/initi/static/styles/jsdoc-default.css index cb92bcf..45c0317 100644 --- a/templates/initi/static/styles/jsdoc-default.css +++ b/templates/initi/static/styles/jsdoc-default.css @@ -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; -} +} \ No newline at end of file diff --git a/templates/initi/static/styles/min-method.css b/templates/initi/static/styles/min-method.css new file mode 100644 index 0000000..40861f6 --- /dev/null +++ b/templates/initi/static/styles/min-method.css @@ -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; +} \ No newline at end of file diff --git a/templates/initi/tmpl/container.tmpl b/templates/initi/tmpl/container.tmpl index e23b452..3fe471e 100644 --- a/templates/initi/tmpl/container.tmpl +++ b/templates/initi/tmpl/container.tmpl @@ -151,6 +151,14 @@ var methods = self.find({kind: 'function', memberof: isGlobalPage ? {isUndefined: true} : doc.longname}); if (methods && methods.length && methods.forEach) { ?> +
+
Methods list:
+
+ + + +
+

Methods

diff --git a/templates/initi/tmpl/method.tmpl b/templates/initi/tmpl/method.tmpl index a55da5c..dbfbdb4 100644 --- a/templates/initi/tmpl/method.tmpl +++ b/templates/initi/tmpl/method.tmpl @@ -1,7 +1,6 @@ diff --git a/templates/initi/tmpl/method_list.tmpl b/templates/initi/tmpl/method_list.tmpl index dbfbdb4..a264964 100644 --- a/templates/initi/tmpl/method_list.tmpl +++ b/templates/initi/tmpl/method_list.tmpl @@ -1,119 +1,47 @@ - - -

Constructor

+ +
+ + + + + ( + + + + [ + + ] + + + + + ) + + + + + + + { + + } + - - -

" + name + "" + (data.signature || '') ?>

- - - -

- - - - -
- -
- - - -
Extends:
- - - - -
Type:
- - - - -
This:
- - - - -
Parameters:
- - - - - - -
Requires:
- - - - -
Fires:
- - - - -
Listens to Events:
- - - - -
Listeners of This Event:
- - - - -
Throws:
- 1) { ?> - - - - - - 1) { ?> - - - - -
Yields:
- 1) { ?> - - - - -
Example 1? 's':'' ?>
- - +
\ No newline at end of file