JSDoc: <?js= title ?>

commit 058104b10fe27e9efe7ddcdd4299ed7a7fd80e02 Author: Aleksey Chichenkov Date: Tue Sep 18 15:17:34 2018 +0300 first commit diff --git a/.idea/docs.iml b/.idea/docs.iml new file mode 100644 index 0000000..24643cc --- /dev/null +++ b/.idea/docs.iml @@ -0,0 +1,12 @@ + + + + + + + + + + + + \ No newline at end of file diff --git a/.idea/misc.xml b/.idea/misc.xml new file mode 100644 index 0000000..f868442 --- /dev/null +++ b/.idea/misc.xml @@ -0,0 +1,6 @@ + + + + + + \ No newline at end of file diff --git a/.idea/modules.xml b/.idea/modules.xml new file mode 100644 index 0000000..6049cfe --- /dev/null +++ b/.idea/modules.xml @@ -0,0 +1,8 @@ + + + + + + + + \ No newline at end of file diff --git a/.idea/workspace.xml b/.idea/workspace.xml new file mode 100644 index 0000000..d38e29f --- /dev/null +++ b/.idea/workspace.xml @@ -0,0 +1,446 @@ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + true + DEFINITION_ORDER + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + project + + + + + + + + + + + + + + + + + 1537187608733 + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + \ No newline at end of file diff --git a/conf.json b/conf.json new file mode 100644 index 0000000..a86c3bb --- /dev/null +++ b/conf.json @@ -0,0 +1,25 @@ +{ + "tags": { + "allowUnknownTags": true + }, + "recurseDepth": 10, + "source": { + "include": ["docfiles"], + "includePattern": ".+\\.js(doc|x)?$", + "excludePattern": "(^|\\/|\\\\)_" + }, + "opts" : { + "template": "templates/initi", + "encoding": "utf8", + "recurse": true, + "destination": "../documentation/" + }, + "plugins": [], + "templates": { + "cleverLinks": false, + "monospaceLinks": false, + "default": { + "outputSourceFiles": true + } + } +} diff --git a/docfiles/models.js b/docfiles/models.js new file mode 100644 index 0000000..378e12f --- /dev/null +++ b/docfiles/models.js @@ -0,0 +1,22 @@ +/** + * Менеджер моделей.
+ * Представляет собой интерфейс для доступа ко всем моделям
+ * Позволяет по адресу модели, получить на нее ссылку.
+ + * + * @namespace Models + */ +function Models() { + /** + * Вернет ссылку на модель. В качестве идентификатора следует указать адрес дерева. + * + * @public + * @function get + * @param {v2.address} address Адрес модели + * @returns {tools.promise.native} + * @memberof Models + */ + this.get = function (address) { + + }; +} \ No newline at end of file diff --git a/docfiles/trees.js b/docfiles/trees.js new file mode 100644 index 0000000..f864374 --- /dev/null +++ b/docfiles/trees.js @@ -0,0 +1,40 @@ +/** + * Менеджер деревьев.
+ * Представляет собой интерфейс для доступа ко всем деревьям
+ * Позволяет по тегу дерева получить на него ссылку.
+ * На текущий момент содержит в себе:
+ * - global_tree (Основное дерево)
+ * - global_attribute_tree (Дерево, которое предоставляет доступ к атрибутам)
+ * - desktop_tree (Представляет рабочий стол)
+ * - remote_modules_tree (Представляет собой дерево сборщиков)
+ * - scheme_tree (Топология)
+ * - user_attribute_tree (Пользовательские данные)
+ * + * @namespace Trees + */ +function Trees() { + /** + * Вернет ссылку на дерево. В качестве идентификатора следует указать тег дерева. + * + * @public + * @function get + * @param {v2.string} treeTag Тег дерева. Например: "rmt", "uat" + * @returns {tools.promise.native} + * @memberof Trees + */ + this.get = function (treeTag) { + + }; + /** + * Возвращает булевое значение о существовании дерева + * + * @public + * @function is_tree_exist + * @param {v2.string} treeTag Тег дерева. Например: "rmt", "uat" + * @returns {boolean} + * @memberof Trees + */ + this.is_tree_exist = function (treeTag) { + + } +} \ No newline at end of file diff --git a/docfiles/trees/desktopTree.js b/docfiles/trees/desktopTree.js new file mode 100644 index 0000000..3e01e6f --- /dev/null +++ b/docfiles/trees/desktopTree.js @@ -0,0 +1,17 @@ +/** + * @class DesktopTree + * @extends Trees.GlobalAttributeTree + * @memberof Trees + */ +function DesktopTree() { + +} + +/** + * @class Node + * @extends Trees.GlobalAttributeTree.Node + * @memberof Trees.DesktopTree + */ +function Node() { + +} \ No newline at end of file diff --git a/docfiles/trees/globalAttributeTree.js b/docfiles/trees/globalAttributeTree.js new file mode 100644 index 0000000..83945b3 --- /dev/null +++ b/docfiles/trees/globalAttributeTree.js @@ -0,0 +1,152 @@ +/** + * Отнаследовано от глобального дерева.
+ * Ноды этого дерева имеют доступ к атрибутам + * + * @class GlobalAttributeTree + * @extends Trees.GlobalTree + * @memberof Trees + */ +function GlobalAttributeTree() { + +} + +/** + * @class Node + * @extends Trees.GlobalTree.Node + * @memberof Trees.GlobalAttributeTree + */ +function Node() { + /** + * Возвращает список всех атрибутов, включая динамические
+ *
Работает через промис. + * + * @public + * @function attributes + * @returns {tools.promise.native} + * @memberof Trees.GlobalAttributeTree.Node + */ + this.attributes = function() { + + }; + + /** + * Возвращает список базовых атрибутов ноды (их нельзя удалить)
+ *
Работает через промис. + * + * @public + * @function base_attributes + * @returns {tools.promise.native} + * @memberof Trees.GlobalAttributeTree.Node + */ + this.base_attributes = function() { + + }; + + /** + * Возвращает менеджер атрибутов ноды. + * + * @public + * @function am + * @returns {tools.promise.native} + * @memberof Trees.GlobalAttributeTree.Node + */ + this.am = function() { + + }; +} + +/** + * Интерфейс позволяющей пользователю работать с атрибутами ноды + * + * @class Attributes + * @memberof Trees.GlobalAttributeTree.Node + */ +function Attributes() { + /** + * Возвращает список атрибутов ноды + * + * @public + * @function attributes + * @returns {v2.map(v2.string.type, v2.vc.type)} + * @memberof Trees.GlobalAttributeTree.Node.Attributes + */ + this.attributes = function() { + + }; + + /** + * Возвращает список базовых атрибутов ноды + * + * @public + * @function base_attributes + * @returns {v2.vc} + * @memberof Trees.GlobalAttributeTree.Node.Attributes + */ + this.base_attributes = function() { + + }; + + /** + * Возвращает ссылку на атрибут ноды + * + * @public + * @function get + * @returns {tools.promise.native} + * @memberof Trees.GlobalAttributeTree.Node.Attributes + */ + this.get = function(attributeName) { + + }; + + /** + * Проверяет наличие любого атрибута у ноды + * + * @public + * @function is_exist_attribute + * @params {v2.string} attributeName + * @returns {boolean} + * @memberof Trees.GlobalAttributeTree.Node.Attributes + */ + this.is_exist_attribute = function(attributeName) { + + }; + + /** + * Провеляет наличие базового атрибута у ноды + * + * @public + * @function has_base_attribute + * @params {v2.string} attributeName + * @returns {boolean} + * @memberof Trees.GlobalAttributeTree.Node.Attributes + */ + this.has_base_attribute = function(attributeName) { + + }; + + /** + * Добавляет динамические атрибуты в ноду + * + * @public + * @function add + * @returns {v2.model_type} + * @params {v2.vc} attributes список атрибутов + * @memberof Trees.GlobalAttributeTree.Node.Attributes + */ + this.add = function(attributes) { + + }; + + /** + * Удаляет динамические атрибуты из ноды + * + * @public + * @function remove + * @returns {v2.model_type} + * @params {v2.set(v2.string)} attributes + * @memberof Trees.GlobalAttributeTree.Node.Attributes + */ + this.remove = function(attributes) { + + }; +} diff --git a/docfiles/trees/globalTree.js b/docfiles/trees/globalTree.js new file mode 100644 index 0000000..573414d --- /dev/null +++ b/docfiles/trees/globalTree.js @@ -0,0 +1,155 @@ +/** + * Глобальное дерево, от которого отнаследованы все остальные.
+ * Копирует идеологию ядра.
+ * Ноды этого дерева имеют доступ только к списку своих потомков. + * + * @class GlobalTree + * @memberof Trees + */ +function GlobalTree() { + /** + * Возвращает ссылку на ноду. В качестве идентификатора надо указать идентификатор ноды.
+ *
Работает через промис. + * + * @public + * @function get + * @param {v2.integer} nodeId Уникальный идентификатор ноды в дереве + * @returns {tools.promise.native} + * @memberof Trees.GlobalTree + */ + this.get = function(nodeId) { + + }; + + /** + * Позволяет удалить динамический атрибут ноды.
+ * Возвращает булевое значение об операции + * + * @public + * @function remove + * @param {v2.string} nodeId Уникальный идентификатор ноды в дереве + * @returns {boolean} + * @memberof Trees.GlobalTree + */ + this.remove = function(nodeId) { + + }; + + /** + * Возвращает адрес дерева в системе + * + * @public + * @function sys_addr + * @returns {v2.address} + * @memberof Trees.GlobalTree + */ + this.sys_addr = function() { + + }; +} + +/** + * Нода дерева.
+ * Представляет интефрейс для доступа к данным глобальной ноды в ядре.
+ * Позволяет узнать потомков ноды
+ * + * @class Node + * @memberof Trees.GlobalTree + */ +function Node() { + /** + * Возвращает ссылку на атрибут ноды.
+ *
Работает через промис. + * + * @public + * @function get + * @param {v2.string} attributeName Имя атрибута + * @returns {tools.promise.native} + * @memberof Trees.GlobalTree.Node + */ + this.get = function(attributeName) { + + }; + + /** + * Добавляет новый динамический атрибут в ноду.
+ * Ничего не возвращает. + * + * @public + * @function add_node + * @param {v2.vc} _attrs + * @memberof Trees.GlobalTree.Node + */ + this.add_node = function(_attrs) { + + }; + + /** + * Возвращает уникальный идентификатор ноды. + * + * @public + * @function id + * @returns {v2.integer} + * @memberof Trees.GlobalTree.Node + */ + this.id = function() { + + }; + + /** + * Возвращает список потомков ноды.
+ *
Работает через промис. + * + * @public + * @function children + * @returns {tools.promise.native} + * @memberof Trees.GlobalTree.Node + */ + this.children = function() { + + }; + + /** + * Доступ к менеджеру детей + * @public + * @function cm + * @returns {Children} + * @memberof Trees.GlobalTree.Node + */ + this.cm = function() { + + }; +} + +/** + * Интерфейс позволяющей пользователю работать с потомками ноды + * + * @class Children + * @memberof Trees.GlobalTree.Node + */ +function Children() { + /** + * Возвращает список потомков ноды + * + * @public + * @function get + * @returns {v2.list(v2.integer.type)} + * @memberof Trees.GlobalTree.Node.Children + */ + this.children = function(attributeName) { + + }; + + /** + * Возвращает тип ноды, по ее идентификатору + * + * @public + * @function get_type_by_id + * @returns {v2.model_type} + * @memberof Trees.GlobalTree.Node.Children + */ + this.get_type_by_id = function(attributeName) { + + }; +} + diff --git a/docfiles/trees/remoteModulesTree.js b/docfiles/trees/remoteModulesTree.js new file mode 100644 index 0000000..cedb71b --- /dev/null +++ b/docfiles/trees/remoteModulesTree.js @@ -0,0 +1,20 @@ +/** + * Created by Aleksey Chichenkov on 9/17/18. + */ +/** + * @class RemoteModulesTree + * @extends Trees.GlobalAttributeTree + * @memberof Trees + */ +function RemoteModulesTree() { + +} + +/** + * @class Node + * @extends Trees.GlobalAttributeTree.Node + * @memberof Trees.RemoteModulesTree + */ +function Node() { + +} \ No newline at end of file diff --git a/docfiles/trees/schemeTree.js b/docfiles/trees/schemeTree.js new file mode 100644 index 0000000..e8ed444 --- /dev/null +++ b/docfiles/trees/schemeTree.js @@ -0,0 +1,17 @@ +/** + * @class SchemeTree + * @extends Trees.GlobalTree + * @memberof Trees + */ +function SchemeTree() { + +} + +/** + * @class Node + * @extends Trees.GlobalTree.Node + * @memberof Trees.SchemeTree + */ +function Node() { + +} diff --git a/docfiles/trees/userAttributeTree.js b/docfiles/trees/userAttributeTree.js new file mode 100644 index 0000000..fdfddaf --- /dev/null +++ b/docfiles/trees/userAttributeTree.js @@ -0,0 +1,17 @@ +/** + * @class UserAttributeTree + * @extends Trees.GlobalAttributeTree + * @memberof Trees + */ +function UserAttributeTree() { + +} + +/** + * @class Node + * @extends Trees.GlobalAttributeTree.Node + * @memberof Trees.UserAttributeTree + */ +function Node() { + +} diff --git a/gen.sh b/gen.sh new file mode 100755 index 0000000..3b1c250 --- /dev/null +++ b/gen.sh @@ -0,0 +1,4 @@ +#!/usr/bin/env bash + +rm -rf ../documentation +jsdoc -c conf.json \ No newline at end of file diff --git a/readme.txt b/readme.txt new file mode 100644 index 0000000..b15abc4 --- /dev/null +++ b/readme.txt @@ -0,0 +1,10 @@ +Установить nodejs +Установить npm + +Установить JSDoc +npm install -g jsdoc +или пойти на сайт https://www.npmjs.com/package/jsdoc + +запустить +jsdoc -c conf.json + diff --git a/templates/initi/README.md b/templates/initi/README.md new file mode 100644 index 0000000..1946bef --- /dev/null +++ b/templates/initi/README.md @@ -0,0 +1,12 @@ +The default template for JSDoc 3 uses: [the Taffy Database library](http://taffydb.com/) and the [Underscore Template library](http://underscorejs.org/). + + +## Generating Typeface Fonts + +The default template uses the [OpenSans](https://www.google.com/fonts/specimen/Open+Sans) typeface. The font files can be regenerated as follows: + +1. Open the [OpenSans page at Font Squirrel](). +2. Click on the 'Webfont Kit' tab. +3. Either leave the subset drop-down as 'Western Latin (Default)', or, if we decide we need more glyphs, than change it to 'No Subsetting'. +4. Click the 'DOWNLOAD @FONT-FACE KIT' button. +5. For each typeface variant we plan to use, copy the 'eot', 'svg' and 'woff' files into the 'templates/default/static/fonts' directory. diff --git a/templates/initi/publish.js b/templates/initi/publish.js new file mode 100644 index 0000000..e6ee5fb --- /dev/null +++ b/templates/initi/publish.js @@ -0,0 +1,833 @@ +'use strict'; + +var doop = require('jsdoc/util/doop'); +var env = require('jsdoc/env'); +var fs = require('jsdoc/fs'); +var helper = require('jsdoc/util/templateHelper'); +var logger = require('jsdoc/util/logger'); +var path = require('jsdoc/path'); +var taffy = require('taffydb').taffy; +var template = require('jsdoc/template'); +var util = require('util'); + +var htmlsafe = helper.htmlsafe; +var linkto = helper.linkto; +var resolveAuthorLinks = helper.resolveAuthorLinks; +var hasOwnProp = Object.prototype.hasOwnProperty; + +var data; +var view; + +var outdir = path.normalize(env.opts.destination); + +function find(spec) { + return helper.find(data, spec); +} + +function tutoriallink(tutorial) { + return helper.toTutorial(tutorial, null, { + tag: 'em', + classname: 'disabled', + prefix: 'Tutorial: ' + }); +} + +function getAncestorLinks(doclet) { + return helper.getAncestorLinks(data, doclet); +} + +function hashToLink(doclet, hash) { + var url; + + if ( !/^(#.+)/.test(hash) ) { + return hash; + } + + url = helper.createLink(doclet); + url = url.replace(/(#.+|$)/, hash); + + return '' + hash + ''; +} + +function needsSignature(doclet) { + var needsSig = false; + + // function and class definitions always get a signature + if (doclet.kind === 'function' || doclet.kind === 'class') { + needsSig = true; + } + // typedefs that contain functions get a signature, too + else if (doclet.kind === 'typedef' && doclet.type && doclet.type.names && + doclet.type.names.length) { + for (var i = 0, l = doclet.type.names.length; i < l; i++) { + if (doclet.type.names[i].toLowerCase() === 'function') { + needsSig = true; + break; + } + } + } + // and namespaces that are functions get a signature (but finding them is a + // bit messy) + else if (doclet.kind === 'namespace' && doclet.meta && doclet.meta.code && + doclet.meta.code.type && doclet.meta.code.type.match(/[Ff]unction/)) { + needsSig = true; + } + + return needsSig; +} + +function getSignatureAttributes(item) { + var attributes = []; + + if (item.optional) { + attributes.push('opt'); + } + + if (item.nullable === true) { + attributes.push('nullable'); + } + else if (item.nullable === false) { + attributes.push('non-null'); + } + + return attributes; +} + +function updateItemName(item) { + var attributes = getSignatureAttributes(item); + var itemName = item.name || ''; + + if (item.variable) { + itemName = '…' + itemName; + } + + if (attributes && attributes.length) { + itemName = util.format( '%s%s', itemName, + attributes.join(', ') ); + } + + return itemName; +} + +function addParamAttributes(params) { + return params.filter(function(param) { + return param.name && param.name.indexOf('.') === -1; + }).map(updateItemName); +} + +function buildItemTypeStrings(item) { + var types = []; + + if (item && item.type && item.type.names) { + item.type.names.forEach(function(name) { + types.push( linkto(name, htmlsafe(name)) ); + }); + } + + return types; +} + +function buildAttribsString(attribs) { + var attribsString = ''; + + if (attribs && attribs.length) { + attribsString = htmlsafe( util.format('(%s) ', attribs.join(', ')) ); + } + + return attribsString; +} + +function addNonParamAttributes(items) { + var types = []; + + items.forEach(function(item) { + types = types.concat( buildItemTypeStrings(item) ); + }); + + return types; +} + +function addSignatureParams(f) { + var params = f.params ? addParamAttributes(f.params) : []; + + f.signature = util.format( '%s(%s)', (f.signature || ''), params.join(', ') ); +} + +function addSignatureReturns(f) { + var attribs = []; + var attribsString = ''; + var returnTypes = []; + var returnTypesString = ''; + var source = f.yields || f.returns; + + // jam all the return-type attributes into an array. this could create odd results (for example, + // if there are both nullable and non-nullable return types), but let's assume that most people + // who use multiple @return tags aren't using Closure Compiler type annotations, and vice-versa. + if (source) { + source.forEach(function(item) { + helper.getAttribs(item).forEach(function(attrib) { + if (attribs.indexOf(attrib) === -1) { + attribs.push(attrib); + } + }); + }); + + attribsString = buildAttribsString(attribs); + } + + if (source) { + returnTypes = addNonParamAttributes(source); + } + if (returnTypes.length) { + returnTypesString = util.format( ' → %s{%s}', attribsString, returnTypes.join('|') ); + } + + f.signature = '' + (f.signature || '') + '' + + '' + returnTypesString + ''; +} + +function addSignatureTypes(f) { + var types = f.type ? buildItemTypeStrings(f) : []; + + f.signature = (f.signature || '') + '' + + (types.length ? ' :' + types.join('|') : '') + ''; +} + +function addAttribs(f) { + var attribs = helper.getAttribs(f); + var attribsString = buildAttribsString(attribs); + + f.attribs = util.format('%s', attribsString); +} + +function shortenPaths(files, commonPrefix) { + Object.keys(files).forEach(function(file) { + files[file].shortened = files[file].resolved.replace(commonPrefix, '') + // always use forward slashes + .replace(/\\/g, '/'); + }); + + return files; +} + +function getPathFromDoclet(doclet) { + if (!doclet.meta) { + return null; + } + + return doclet.meta.path && doclet.meta.path !== 'null' ? + path.join(doclet.meta.path, doclet.meta.filename) : + doclet.meta.filename; +} + +function generate(title, docs, filename, resolveLinks) { + var docData; + var html; + var outpath; + + resolveLinks = resolveLinks !== false; + + docData = { + env: env, + title: title, + docs: docs + }; + + outpath = path.join(outdir, filename); + html = view.render('container.tmpl', docData); + + if (resolveLinks) { + html = helper.resolveLinks(html); // turn {@link foo} into foo + } + + fs.writeFileSync(outpath, html, 'utf8'); +} + +function generateSourceFiles(sourceFiles, encoding) { + encoding = encoding || 'utf8'; + Object.keys(sourceFiles).forEach(function(file) { + var source; + // links are keyed to the shortened path in each doclet's `meta.shortpath` property + var sourceOutfile = helper.getUniqueFilename(sourceFiles[file].shortened); + + helper.registerLink(sourceFiles[file].shortened, sourceOutfile); + + try { + source = { + kind: 'source', + code: helper.htmlsafe( fs.readFileSync(sourceFiles[file].resolved, encoding) ) + }; + } + catch (e) { + logger.error('Error while generating source file %s: %s', file, e.message); + } + + generate('Source: ' + sourceFiles[file].shortened, [source], sourceOutfile, + false); + }); +} + +/** + * Look for classes or functions with the same name as modules (which indicates that the module + * exports only that class or function), then attach the classes or functions to the `module` + * property of the appropriate module doclets. The name of each class or function is also updated + * for display purposes. This function mutates the original arrays. + * + * @private + * @param {Array.} doclets - The array of classes and functions to + * check. + * @param {Array.} modules - The array of module doclets to search. + */ +function attachModuleSymbols(doclets, modules) { + var symbols = {}; + + // build a lookup table + doclets.forEach(function(symbol) { + symbols[symbol.longname] = symbols[symbol.longname] || []; + symbols[symbol.longname].push(symbol); + }); + + modules.forEach(function(module) { + if (symbols[module.longname]) { + module.modules = symbols[module.longname] + // Only show symbols that have a description. Make an exception for classes, because + // we want to show the constructor-signature heading no matter what. + .filter(function(symbol) { + return symbol.description || symbol.kind === 'class'; + }) + .map(function(symbol) { + symbol = doop(symbol); + + if (symbol.kind === 'class' || symbol.kind === 'function') { + symbol.name = symbol.name.replace('module:', '(require("') + '"))'; + } + + return symbol; + }); + } + }); +} + +function buildMemberNav(items, itemHeading, itemsSeen, linktoFn) { + var nav = ''; + + if (items.length) { + var itemsNav = ''; + items.forEach(function(item) { + var displayName; + + if ( !hasOwnProp.call(item, 'longname') ) { + itemsNav += '

' + linktoFn('', item.name) + '

'; + } + else if ( !hasOwnProp.call(itemsSeen, item.longname) ) { + if (env.conf.templates.default.useLongnameInNav) { + displayName = item.longname; + } else { + displayName = item.longname; + } + itemsNav += '

' + linktoFn(item.longname, displayName.replace(/\b(module|event):/g, '')) + '

'; + + itemsSeen[item.longname] = true; + } + }); + + if (itemsNav !== '') { + nav += '

' + itemHeading + '

' + itemsNav + ''; + } + } + + return nav; +} + + +function buildMemberNavNamespace(items, itemHeading, itemsSeen, linktoFn) { + var nav = ''; + + if (items.length) { + var itemsNav = ''; + items.forEach(function(item) { + var displayName; + + if ( !hasOwnProp.call(item, 'longname') ) { + itemsNav += '

' + linktoFn('', item.name) + '

'; + } + else if ( !hasOwnProp.call(itemsSeen, item.longname) ) { + displayName = item.longname; + + var arr = displayName.split("."); + var end_id = arr.length - 1; + var last = arr.pop(); + + var prev_name = arr.join("."); + var res = ""; + // res += ""; + if (arr.length > 0) res += "" +prev_name+ "."; + res += "" +last+ ""; + itemsNav += '

' + linktoFn(item.longname, res.replace(/\b(module|event):/g, '')) + '

'; + // itemsNav += ""; + itemsSeen[item.longname] = true; + } + }); + + if (itemsNav !== '') { + nav += '

' + itemHeading + '

' + itemsNav + ''; + } + } + + return nav; +} + +function buildMemberNavNamespacesTree(items, itemHeading, itemsSeen, linktoFn) { + var nav = ''; + + var restored_items = restoreSourceTree(items); + + var recursive_generate_namespaces_old = function (_tree) { + var items = _tree.items; + var a = 0; + var res = ""; + if (_tree.item_data) res = ""; + return res; + }; + + var g_id = 0; + var recursive_generate_namespaces = function (_tree) { + var lgid = g_id++; + var items = _tree.items; + var a = 0; + var res = ""; + if (_tree.item_data) res = "

"; + if (_tree.item_data) res += ""; + if (items.length != 0 && _tree.item_data) res += ""; + if (_tree.item_data) res += linktoFn(_tree.item_data.longname, _tree.item_data.name.replace(/\b(module|event):/g, '')); + + if (items.length != 0) { + if (_tree.item_data) res += "

"; + while (a < items.length) { + var name = items[a]; + var data = _tree[name]; + res += recursive_generate_namespaces(data); + a++; + } + if (_tree.item_data) res += ""; + } + if (_tree.item_data) res += "

"; + + return res; + }; + + var req_res = recursive_generate_namespaces(restored_items); + + debugger; + if (items.length) { + var itemsNav = ''; + + itemsNav += req_res; + + if (itemsNav !== '') { + nav += '

' + itemHeading + '

'; + } + } + + return nav; +} +function restoreSourceTree(items) { + var out_tree = {items:[]}; + var a = 0; + while( a < items.length){ + var item = items[a]; + var path = item.longname.split("."); + // console.log(item.longname); + var cur_path = out_tree; + var b = 0; + while(b < path.length){ + var hop = path[b]; + var is_exist = !!cur_path[hop]; + // console.log("current hop: " + hop); + if(!is_exist){ + // console.log("new hop: " + hop); + cur_path[hop] = {}; + cur_path[hop].item_data = item; + cur_path[hop].items = []; + cur_path.items.push(hop) + } else { + // console.log("exist hop: " + hop); + cur_path = cur_path[hop]; + } + b++; + } + // console.log("------------"); + a++; + } + return out_tree; +} + +function linktoTutorial(longName, name) { + return tutoriallink(name); +} + +function linktoExternal(longName, name) { + return linkto(longName, name.replace(/(^"|"$)/g, '')); +} + +/** + * Create the navigation sidebar. + * @param {object} members The members that will be used to create the sidebar. + * @param {array

' + itemHeading + '

' + itemHeading + '

' + itemHeading + '

Home

' + linkto('global', 'Global') + '

Global

Example 1? 's':'' ?>

Extends

Requires

Classes

Interfaces

Mixins

Namespaces

Members

Methods

Type Definitions

Events

Properties:

Type:

Fires:

Example 1? 's':'' ?>

Constructor

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

Extends:

Type:

This:

Parameters:

Requires:

Fires:

Listens to Events:

Listeners of This Event:

Throws:

Yields:

Example 1? 's':'' ?>

Constructor

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

Extends:

Type:

This:

Parameters:

Requires:

Fires:

Listens to Events:

Listeners of This Event:

Throws:

Yields:

Example 1? 's':'' ?>

Properties

Properties