diff --git a/conf.json b/conf.json index a86c3bb..6006750 100644 --- a/conf.json +++ b/conf.json @@ -14,7 +14,9 @@ "recurse": true, "destination": "../documentation/" }, - "plugins": [], + "plugins": [ + "plugins/markdown" + ], "templates": { "cleverLinks": false, "monospaceLinks": false, diff --git a/docfiles/libraries/lowlevel/boolean.js b/docfiles/libraries/lowlevel/boolean.js new file mode 100644 index 0000000..be1d3a0 --- /dev/null +++ b/docfiles/libraries/lowlevel/boolean.js @@ -0,0 +1,12 @@ +/** + * + * @class boolean + * @memberof v2.ll + */ +function boolean() { + +} + +boolean.prototype = { + +}; diff --git a/docfiles/libraries/lowlevel/int64.js b/docfiles/libraries/lowlevel/int64.js new file mode 100644 index 0000000..c5d27da --- /dev/null +++ b/docfiles/libraries/lowlevel/int64.js @@ -0,0 +1,47 @@ +/** + * + * @class int64 + * @memberof v2.ll + * @param _low {number} + * @param _high {number} + * @param _unsigned {boolean} + */ +function int64(_low, _high, _unsigned) { + +} + +int64.prototype = { + /** + * + * + * @public + * @function = + * @memberof v2.ll.int64 + * @param {v2.ll.int64} _object + * @returns {this} + */ + "=": function (_object) {}, + + /** + * + * + * @public + * @function -= + * @memberof v2.ll.int64 + * @param {v2.ll.int64} _object + * @returns {this} + */ + "-=": function (_object) {}, + + /** + * + * + * @public + * @function - + * @memberof v2.ll.int64 + * @param {v2.ll.int64} _object + * @returns {this} + */ + "-": function (_object) {}, + +}; diff --git a/docfiles/libraries/lowlevel/ll.js b/docfiles/libraries/lowlevel/ll.js new file mode 100644 index 0000000..955e593 --- /dev/null +++ b/docfiles/libraries/lowlevel/ll.js @@ -0,0 +1,7 @@ +/** + * + * @group library + * @memberof v2 + * @namespace ll + */ +var ll = function () {}; \ No newline at end of file diff --git a/docfiles/libraries/lowlevel/string.js b/docfiles/libraries/lowlevel/string.js new file mode 100644 index 0000000..b6516d0 --- /dev/null +++ b/docfiles/libraries/lowlevel/string.js @@ -0,0 +1,153 @@ +/** + * + * @class string + * @memberof v2.ll + * @param _str {string} + */ +function string(_str) { + +} + +string.prototype = { + /** + * Членовозня + * + * @public + * @function = + * @memberof v2.ll.string + * @param {v2.ll.string} _str + * @returns {this} + */ + "=": function (_str) {}, + + /** + * + * + * @public + * @function copy + * @memberof v2.ll.string + * @return {v2.ll.string} + */ + copy: function (_str) {}, + + /** + * + * + * @public + * @function < + * @memberof v2.ll.string + * @param {v2.ll.string} _str + * @returns {boolean} + */ + "<": function (_str) {}, + + /** + * + * + * @public + * @function <= + * @memberof v2.ll.string + * @param {v2.ll.string} _str + * @returns {boolean} + */ + "<=": function (_str) {}, + + /** + * + * + * @public + * @function == + * @memberof v2.ll.string + * @param {v2.ll.string} _str + * @returns {boolean} + */ + "==": function (_str) {}, + + /** + * + * + * @public + * @function == + * @memberof v2.ll.string + * @param {v2.ll.string} _str + * @returns {boolean} + */ + "!=": function (_str) {}, + + /** + * + * + * @public + * @function > + * @memberof v2.ll.string + * @param {v2.ll.string} _str + * @returns {boolean} + */ + ">": function (_str) {}, + + /** + * + * + * @public + * @function >= + * @memberof v2.ll.string + * @param {v2.ll.string} _str + * @returns {boolean} + */ + ">=": function (_str) {}, + + /** + * + * + * @public + * @function + + * @memberof v2.ll.string + * @param {v2.ll.string} _str + * @returns {v2.ll.string} + */ + "+": function (_str) {}, + + /** + * + * + * @public + * @function += + * @memberof v2.ll.string + * @param {v2.ll.string} _str + * @returns {this} + */ + "+=": function (_str) {}, + + /** + * Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum + * + * @public + * @function assign + * @memberof v2.ll.string + * @param {v2.ll.string} _string asdfasfasdf + * @param {number} _first afasdfasdfasdf + * @param {number} _last asdfasfdasdfas + * @returns {this} + */ + assign: function (_string, _first, _last) {}, + + /** + * + * @public + * @function at + * @memberof v2.ll.string + * @param {number} _index + * @returns {string} + */ + at: function (_index) {}, + + /** + * + * @public + * @function back + * @memberof v2.ll.string + * @param {number} _index + * @returns {string} + */ + back: function (_index) {} +}; diff --git a/docfiles/libraries/std/deque.js b/docfiles/libraries/std/deque.js new file mode 100644 index 0000000..ad259f2 --- /dev/null +++ b/docfiles/libraries/std/deque.js @@ -0,0 +1,12 @@ +/** + * + * @class deque + * @memberof std + */ +function deque() { + +} + +deque.prototype = { + +}; diff --git a/docfiles/libraries/std/list.js b/docfiles/libraries/std/list.js new file mode 100644 index 0000000..ee752ff --- /dev/null +++ b/docfiles/libraries/std/list.js @@ -0,0 +1,12 @@ +/** + * + * @class list + * @memberof std + */ +function list() { + +} + +list.prototype = { + +}; diff --git a/docfiles/libraries/std/map.js b/docfiles/libraries/std/map.js new file mode 100644 index 0000000..3e5b194 --- /dev/null +++ b/docfiles/libraries/std/map.js @@ -0,0 +1,12 @@ +/** + * + * @class map + * @memberof std + */ +function map() { + +} + +map.prototype = { + +}; diff --git a/docfiles/libraries/std/set.js b/docfiles/libraries/std/set.js new file mode 100644 index 0000000..804f444 --- /dev/null +++ b/docfiles/libraries/std/set.js @@ -0,0 +1,12 @@ +/** + * + * @class set + * @memberof std + */ +function set() { + +} + +set.prototype = { + +}; diff --git a/docfiles/libraries/std/std.js b/docfiles/libraries/std/std.js new file mode 100644 index 0000000..f2dcff0 --- /dev/null +++ b/docfiles/libraries/std/std.js @@ -0,0 +1,6 @@ +/** + * + * @group library + * @namespace std + */ +function std() {} \ No newline at end of file diff --git a/docfiles/libraries/std/unordered_map.js b/docfiles/libraries/std/unordered_map.js new file mode 100644 index 0000000..5ce74c4 --- /dev/null +++ b/docfiles/libraries/std/unordered_map.js @@ -0,0 +1,12 @@ +/** + * + * @class unordered_map + * @memberof std + */ +function unordered_map() { + +} + +unordered_map.prototype = { + +}; diff --git a/docfiles/libraries/tools/methods.js b/docfiles/libraries/tools/methods.js new file mode 100644 index 0000000..533dfda --- /dev/null +++ b/docfiles/libraries/tools/methods.js @@ -0,0 +1,13 @@ +/** + * + * @function merge + * @memberof tools + * @param baseObject {Object} + * @param _obj2 {Object} + * @param _obj3 {Object} + * @param _obj4 {Object} + * @returns {Object} + */ +tools.merge = function (baseObject, _obj2, _obj3, _obj4) { + +}; \ No newline at end of file diff --git a/docfiles/libraries/tools/promise.js b/docfiles/libraries/tools/promise.js new file mode 100644 index 0000000..290bc98 --- /dev/null +++ b/docfiles/libraries/tools/promise.js @@ -0,0 +1,46 @@ +/** + * + * @class promise + * @memberof tools + */ +function promise() { + +} + +promise.prototype = { + /** + * @public + * @name native + * @memberof tools.promise + * @type {Promise} + */ + native: function(){ + + /** + * + * @function cancel + * @memberof Promise + */ + this.cancel = function () { + + } + }, + + /** + * + * @public + * @function resolve + * @memberof tools.promise + * @param {Object} _object + */ + resolve: function (_object) {}, + + /** + * + * @public + * @function reject + * @memberof tools.promise + * @param {Object} _object + */ + reject: function (_object) {} +}; diff --git a/docfiles/libraries/tools/tools.js b/docfiles/libraries/tools/tools.js new file mode 100644 index 0000000..99afa42 --- /dev/null +++ b/docfiles/libraries/tools/tools.js @@ -0,0 +1,6 @@ +/** + * + * @group library + * @namespace tools + */ +var tools = function () {}; \ No newline at end of file diff --git a/docfiles/libraries/v2/address.js b/docfiles/libraries/v2/address.js new file mode 100644 index 0000000..9997efb --- /dev/null +++ b/docfiles/libraries/v2/address.js @@ -0,0 +1,75 @@ +/** + * + * @class address + * @extends v2.base + * @extends std.deque + * @memberof v2 + */ +function address() { + +} + +address.prototype = { + /** + * @public + * @function = + * @memberof v2.address + * @param _object {v2.address} + * @returns {this} + */ + "=": function (_object) {}, + + + /** + * @public + * @function + + * @memberof v2.address + * @param _object {v2.address} + * @returns {this} + */ + "+": function (_object) {}, + + + /** + * @public + * @function += + * @memberof v2.address + * @param _object {v2.address} + * @returns {this} + */ + "+=": function (_object) {}, + + + /** + * @public + * @function copy + * @memberof v2.address + * @returns {v2.address} + */ + copy: function () {}, +}; + +/** + * Constructor from native array + * + * @static + * @function from_array + * @memberof v2.address + * @param _arr {string[]} + * @returns {v2.address} + */ +address.from_array = function (_arr) { + +}; + +/** + * + * @static + * @function type + * @memberof v2.address + * @param _first_type {v2.vt.base} + * @returns {v2.vt.one_param} + */ +address.type = function (_first_type) { + +}; \ No newline at end of file diff --git a/docfiles/libraries/v2/base.js b/docfiles/libraries/v2/base.js new file mode 100644 index 0000000..027c93b --- /dev/null +++ b/docfiles/libraries/v2/base.js @@ -0,0 +1,31 @@ +/** + * + * @class base + * @memberof v2 + * @param _type {number} + */ +function base(_type) { + +} + +base.prototype = { + /** + * + * @public + * @function type + * @memberof v2.base + * @returns {number} + */ + type: function () {} +}; + +/** + * + * @access static + * @function instance_of + * @memberof v2.base + * @param instance {v2} + */ +base.instance_of = function (instance) { + +}; \ No newline at end of file diff --git a/docfiles/libraries/v2/boolean.js b/docfiles/libraries/v2/boolean.js new file mode 100644 index 0000000..be2989f --- /dev/null +++ b/docfiles/libraries/v2/boolean.js @@ -0,0 +1,20 @@ +/** + * + * @class boolean + * @memberof v2 + * @extends v2.base + * @extends v2.ll.boolean + */ +function boolean() { + +} + +boolean.prototype = { + /** + * @public + * @function copy + * @memberof v2.boolean + * @returns {v2.boolean} + */ + copy: function () {}, +}; diff --git a/docfiles/libraries/v2/deque.js b/docfiles/libraries/v2/deque.js new file mode 100644 index 0000000..f6e2f43 --- /dev/null +++ b/docfiles/libraries/v2/deque.js @@ -0,0 +1,76 @@ +/** + * + * @class deque + * @extends v2.base + * @extends std.deque + * @param _first_type {v2.vt.base} + * @memberof v2 + */ +function deque(_first_type) { + +} + +deque.prototype = { + /** + * @public + * @function = + * @memberof v2.deque + * @param _object {v2.deque} + * @returns {this} + */ + "=": function (_object) {}, + + + /** + * @public + * @function + + * @memberof v2.deque + * @param _object {v2.deque} + * @returns {this} + */ + "+": function (_object) {}, + + + /** + * @public + * @function += + * @memberof v2.deque + * @param _object {v2.deque} + * @returns {this} + */ + "+=": function (_object) {}, + + + /** + * @public + * @function copy + * @memberof v2.deque + * @returns {v2.deque} + */ + copy: function () {}, +}; + +/** + * Constructor from native array + * + * @static + * @function from_array + * @memberof v2.deque + * @param _arr {v2.base[]} + * @returns {v2.deque} + */ +deque.from_array = function (_arr) { + +}; + +/** + * + * @static + * @function type + * @memberof v2.deque + * @param _first_type {v2.vt.base} + * @returns {v2.vt.one_param} + */ +deque.type = function (_first_type) { + +}; \ No newline at end of file diff --git a/docfiles/libraries/v2/integer.js b/docfiles/libraries/v2/integer.js index 6cb5a72..a4b6dc1 100644 --- a/docfiles/libraries/v2/integer.js +++ b/docfiles/libraries/v2/integer.js @@ -2,47 +2,18 @@ * * @class integer * @memberof v2 + * @extends v2.base + * @extends v2.ll.int64 + * @param low {number} + * @param high {number} */ -function integer() { +function integer(low, high) { } integer.prototype = { - /** - * - * - * @public - * @function = - * @memberof v2.integer - * @param {v2.integer} _o - * @returns {this} - */ - "=": function (_o) {}, /** - * - * - * @public - * @function -= - * @memberof v2.integer - * @param {v2.integer} _o - * @returns {this} - */ - "-=": function (_o) {}, - - /** - * - * - * @public - * @function - - * @memberof v2.integer - * @param {v2.integer} _o - * @returns {this} - */ - "-": function (_o) {}, - - /** - * * * @public * @function copy @@ -51,3 +22,27 @@ integer.prototype = { */ copy: function () {} }; + +/** + * + * @static + * @function from_number + * @memberof v2.integer + * @param _number {number} + * @returns {v2.integer} + */ +integer.from_number = function (_number) { + +}; + +/** + * + * @static + * @function from_string + * @memberof v2.integer + * @param _number {string} + * @returns {v2.integer} + */ +integer.from_string = function (_number) { + +}; diff --git a/docfiles/libraries/v2/list.js b/docfiles/libraries/v2/list.js new file mode 100644 index 0000000..4b397da --- /dev/null +++ b/docfiles/libraries/v2/list.js @@ -0,0 +1,76 @@ +/** + * + * @class list + * @extends v2.base + * @extends std.list + * @param _first_type {v2.vt.base} + * @memberof v2 + */ +function list(_first_type) { + +} + +list.prototype = { + /** + * @public + * @function = + * @memberof v2.list + * @param _object {v2.list} + * @returns {this} + */ + "=": function (_object) {}, + + + /** + * @public + * @function + + * @memberof v2.list + * @param _object {v2.list} + * @returns {this} + */ + "+": function (_object) {}, + + + /** + * @public + * @function += + * @memberof v2.list + * @param _object {v2.list} + * @returns {this} + */ + "+=": function (_object) {}, + + + /** + * @public + * @function copy + * @memberof v2.list + * @returns {v2.list} + */ + copy: function () {}, +}; + +/** + * Constructor from native array + * + * @static + * @function from_array + * @memberof v2.list + * @param _arr {v2.base[]} + * @returns {v2.list} + */ +list.from_array = function (_arr) { + +}; + +/** + * + * @static + * @function type + * @memberof v2.list + * @param _first_type {v2.vt.base} + * @returns {v2.vt.one_param} + */ +list.type = function (_first_type) { + +}; \ No newline at end of file diff --git a/docfiles/libraries/v2/map.js b/docfiles/libraries/v2/map.js new file mode 100644 index 0000000..29efded --- /dev/null +++ b/docfiles/libraries/v2/map.js @@ -0,0 +1,87 @@ +/** + * + * @class map + * @extends v2.base + * @extends std.map + * @param _first_type {v2.vt.base} + * @param _second_type {v2.vt.base} + * @memberof v2 + */ +function map(_first_type, _second_type) { + +} + +map.prototype = { + /** + * + * @public + * @function = + * @memberof v2.map + * @param _map {v2.map} + * @returns {this} + */ + "=": function (_map) {}, + + /** + * + * @public + * @function copy + * @memberof v2.map + * @returns {v2.map} + */ + copy: function () {}, + + /** + * + * @public + * @function put + * @memberof v2.map + * @param _key {v2.base} + * @param _value {v2.base} + */ + put: function (_key, _value) {}, + + /** + * + * @public + * @function exist + * @memberof v2.map + * @param _key {v2.base} + * @returns {boolean} + */ + exist: function (_key) {}, + + /** + * + * @public + * @function += + * @memberof v2.map + * @param _map {v2.map} + */ + "+=": function (_map) {}, +}; + +/** + * Constructor from native array + * + * @static + * @function from_array + * @memberof v2.map + * @param _arr {v2.base[]} + * @returns {v2.map} + */ +map.from_array = function (_arr) { + +}; + +/** + * + * @static + * @function type + * @memberof v2.map + * @param _first_type {v2.vt.base} + * @returns {v2.vt.one_param} + */ +map.type = function (_first_type) { + +}; \ No newline at end of file diff --git a/docfiles/libraries/v2/model_type.js b/docfiles/libraries/v2/model_type.js new file mode 100644 index 0000000..8693856 --- /dev/null +++ b/docfiles/libraries/v2/model_type.js @@ -0,0 +1,21 @@ +/** + * + * @class model_type + * @extends v2.base + * @extends v2.ll.string + * @param _str {string} + * @memberof v2 + */ +function model_type(_str) { + +} + +model_type.prototype = { + /** + * @public + * @function copy + * @memberof v2.model_type + * @returns {v2.model_type} + */ + copy: function () {}, +}; diff --git a/docfiles/libraries/v2/set.js b/docfiles/libraries/v2/set.js new file mode 100644 index 0000000..42d72f0 --- /dev/null +++ b/docfiles/libraries/v2/set.js @@ -0,0 +1,76 @@ +/** + * + * @class set + * @extends v2.base + * @extends std.set + * @param _first_type {v2.vt.base} + * @memberof v2 + */ +function set(_first_type) { + +} + +set.prototype = { + /** + * @public + * @function = + * @memberof v2.set + * @param _object {v2.set} + * @returns {this} + */ + "=": function (_object) {}, + + + /** + * @public + * @function + + * @memberof v2.set + * @param _object {v2.set} + * @returns {this} + */ + "+": function (_object) {}, + + + /** + * @public + * @function += + * @memberof v2.set + * @param _object {v2.set} + * @returns {this} + */ + "+=": function (_object) {}, + + + /** + * @public + * @function copy + * @memberof v2.set + * @returns {v2.set} + */ + copy: function () {}, +}; + +/** + * Constructor from native array + * + * @static + * @function from_array + * @memberof v2.set + * @param _arr {v2.base[]} + * @returns {v2.set} + */ +set.from_array = function (_arr) { + +}; + +/** + * + * @static + * @function type + * @memberof v2.set + * @param _first_type {v2.vt.base} + * @returns {v2.vt.one_param} + */ +set.type = function (_first_type) { + +}; \ No newline at end of file diff --git a/docfiles/libraries/v2/string.js b/docfiles/libraries/v2/string.js index b7cb3a7..f6e27bf 100644 --- a/docfiles/libraries/v2/string.js +++ b/docfiles/libraries/v2/string.js @@ -2,6 +2,8 @@ * * @class string * @memberof v2 + * @extends v2.ll.string + * @extends v2.base */ function string() { @@ -9,144 +11,11 @@ function string() { string.prototype = { /** - * Членовозня - * - * @public - * @function = - * @memberof v2.string - * @param {v2.string} _o фывафывафва - * @returns {this} - */ - "=": function (_o) {}, - - /** - * * * @public * @function copy * @memberof v2.string - * @return {v2.string} sdfasfaf + * @return {v2.string} */ - copy: function (_o) {}, - - /** - * - * - * @public - * @function < - * @memberof v2.string - * @param {v2.string} _o - * @returns {boolean} - */ - "<": function (_o) {}, - - /** - * - * - * @public - * @function <= - * @memberof v2.string - * @param {v2.string} _o - * @returns {boolean} - */ - "<=": function (_o) {}, - - /** - * - * - * @public - * @function == - * @memberof v2.string - * @param {v2.string} _o - * @returns {boolean} - */ - "==": function (_o) {}, - - /** - * - * - * @public - * @function == - * @memberof v2.string - * @param {v2.string} _o - * @returns {boolean} - */ - "!=": function (_o) {}, - - /** - * - * - * @public - * @function > - * @memberof v2.string - * @param {v2.string} _o - * @returns {boolean} - */ - ">": function (_o) {}, - - /** - * - * - * @public - * @function >= - * @memberof v2.string - * @param {v2.string} _o - * @returns {boolean} - */ - ">=": function (_o) {}, - - /** - * - * - * @public - * @function + - * @memberof v2.string - * @param {v2.string} _o - * @returns {v2.string} - */ - "+": function (_o) {}, - - /** - * - * - * @public - * @function += - * @memberof v2.string - * @param {v2.string} _o - * @returns {this} - */ - "+=": function (_o) {}, - - /** - * Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum - * - * @public - * @function assign - * @memberof v2.string - * @param {v2.string} _string asdfasfasdf - * @param {number} _first afasdfasdfasdf - * @param {number} _last asdfasfdasdfas - * @returns {this} - */ - assign: function (_string, _first, _last) {}, - - /** - * - * @public - * @function at - * @memberof v2.string - * @param {number} _index - * @returns {string} - */ - at: function (_index) {}, - - /** - * - * @public - * @function back - * @memberof v2.string - * @param {number} _index - * @returns {string} - */ - back: function (_index) {} + copy: function () {}, }; diff --git a/docfiles/libraries/v2/type.js b/docfiles/libraries/v2/type.js new file mode 100644 index 0000000..0f11fd5 --- /dev/null +++ b/docfiles/libraries/v2/type.js @@ -0,0 +1,60 @@ +/** + * + * @class type + * @extends v2.base + * @memberof v2 + */ +function type() { + +} + +type.prototype = { + /** + * @public + * @function copy + * @memberof v2.type + * @returns {v2.type} + */ + copy: function () { + + }, + + /** + * @public + * @function get_type + * @memberof v2.type + * @returns {v2.vt.base} + */ + get_type: function () { + + }, + + /** + * @public + * @function to_number + * @memberof v2.type + * @returns {number} + */ + to_number: function () { + + }, + + /** + * @public + * @function to_number + * @memberof v2.type + * @param other {v2.type} + * @returns {boolean} + */ + "==": function (other) { + + } +}; + +/** + * + * @static + * @name type + * @type {v2.vt.base} + */ +type.type = new v2.vt.base(-1); diff --git a/docfiles/libraries/v2.js b/docfiles/libraries/v2/v2.js similarity index 65% rename from docfiles/libraries/v2.js rename to docfiles/libraries/v2/v2.js index 6b59aed..42c2c68 100644 --- a/docfiles/libraries/v2.js +++ b/docfiles/libraries/v2/v2.js @@ -3,4 +3,4 @@ * @group library * @namespace v2 */ -function v2() {} \ No newline at end of file +var v2 = function () {}; \ No newline at end of file diff --git a/docfiles/libraries/v2/variable_container.js b/docfiles/libraries/v2/variable_container.js new file mode 100644 index 0000000..bbd35a4 --- /dev/null +++ b/docfiles/libraries/v2/variable_container.js @@ -0,0 +1,99 @@ +/** @typedef {v2.variable_container} v2.vc */ + +/** + * + * @class variable_container + * @extends v2.base + * @extends std.unordered_map + * @memberof v2 + */ +function variable_container() { + +} + +variable_container.prototype = { + /** + * + * @public + * @function = + * @memberof v2.variable_container + * @param _variable_container {v2.variable_container} + * @returns {this} + */ + "=": function (_variable_container) {}, + + /** + * + * @public + * @function = + * @memberof v2.variable_container + * @param _variable_container {v2.variable_container} + * @returns {boolean} + */ + "==": function (_variable_container) {}, + + /** + * + * @public + * @function += + * @memberof v2.variable_container + * @param _variable_container {v2.variable_container} + */ + "+=": function (_variable_container) {}, + + /** + * + * @public + * @function copy + * @memberof v2.variable_container + * @returns {v2.variable_container} + */ + copy: function () {}, + + /** + * + * @public + * @function put + * @memberof v2.variable_container + * @param _key {v2.base} + * @param _value {v2.base} + */ + put: function (_key, _value) {}, + + /** + * + * @public + * @function exist + * @memberof v2.variable_container + * @param _key {v2.base} + * @returns {boolean} + */ + exist: function (_key) {} +}; + +/** + * Constructor from native array + * + * @static + * @function from_array + * @memberof v2.variable_container + * @param _arr {v2.base[]} + * @returns {v2.variable_container} + */ +variable_container.from_array = function (_arr) { + +}; + + +/** + * Constructor from native object + * + * @static + * @function from_object + * @memberof v2.variable_container + * @param _obj {Object} + * @returns {v2.variable_container} + */ +variable_container.from_object = function (_obj) { + +}; \ No newline at end of file diff --git a/docfiles/providers/managers/models/groups/base_group.js b/docfiles/providers/managers/models/groups/base_group.js new file mode 100644 index 0000000..bb29bbc --- /dev/null +++ b/docfiles/providers/managers/models/groups/base_group.js @@ -0,0 +1,12 @@ +/** @typedef {Models.Model.Groups.BaseGroup} ModelBaseGroup */ + + /** + * + * @group manager + * @class BaseGroup + * @extends Models.Model.Groups.Group + * @memberof Models.Model.Groups + */ +var BaseGroup = function () { + +}; \ No newline at end of file diff --git a/docfiles/providers/managers/models/groups/bg_components/manager.js b/docfiles/providers/managers/models/groups/bg_components/manager.js new file mode 100644 index 0000000..79996ff --- /dev/null +++ b/docfiles/providers/managers/models/groups/bg_components/manager.js @@ -0,0 +1,8 @@ +/** + * + * @group manager + * @class BGComponents + * @extends Models.Model.Groups.Group.Components + * @memberof Models.Model.Groups.Group + */ +var BGComponents = function () {}; \ No newline at end of file diff --git a/docfiles/providers/managers/models/groups/components/attributes/attribute.js b/docfiles/providers/managers/models/groups/components/attributes/attribute.js new file mode 100644 index 0000000..74502d9 --- /dev/null +++ b/docfiles/providers/managers/models/groups/components/attributes/attribute.js @@ -0,0 +1,54 @@ +/** @typedef {Models.Model.Groups.Group.Components.Component.Attributes.Attribute} ComponentAttribute */ + +/** + * + * @group manager + * @class Attribute + * @extends item + * @memberof Models.Model.Groups.Group.Components.Component.Attributes + */ +var Attribute = function () { + /** + * + * @public + * @function name + * @memberof Models.Model.Groups.Group.Components.Component.Attributes.Attribute + * @returns {v2.string} + */ + this.name = function () { + + }; + + /** + * + * @public + * @function type + * @memberof Models.Model.Groups.Group.Components.Component.Attributes.Attribute + * @returns {v2.type} + */ + this.type = function () { + + }; + + /** + * + * @public + * @function last_change + * @memberof Models.Model.Groups.Group.Components.Component.Attributes.Attribute + * @returns {v2.time} + */ + this.last_change = function () { + + }; + + /** + * + * @public + * @function value + * @memberof Models.Model.Groups.Group.Components.Component.Attributes.Attribute + * @returns {v2} + */ + this.value = function () { + + }; +}; \ No newline at end of file diff --git a/docfiles/providers/managers/models/groups/components/attributes/manager.js b/docfiles/providers/managers/models/groups/components/attributes/manager.js new file mode 100644 index 0000000..7ff9f15 --- /dev/null +++ b/docfiles/providers/managers/models/groups/components/attributes/manager.js @@ -0,0 +1,31 @@ +/** + * + * @group manager + * @class Attributes + * @extends manager + * @memberof Models.Model.Groups.Group.Components.Component + */ +var Attributes = function () { + /** + * + * @public + * @function attributes + * @memberof Models.Model.Groups.Group.Components.Component.Attributes + * @returns {v2.map(v2.string, v2.vc)} + */ + this.attributes = function () { + + }; + + /** + * + * @public + * @function get + * @memberof Models.Model.Groups.Group.Components.Component.Attributes + * @param name {v2.string} + * @returns {tools.promise(ModelComponent)} + */ + this.get = function (name) { + + }; +}; \ No newline at end of file diff --git a/docfiles/providers/managers/models/groups/components/component.js b/docfiles/providers/managers/models/groups/components/component.js new file mode 100644 index 0000000..13dd8af --- /dev/null +++ b/docfiles/providers/managers/models/groups/components/component.js @@ -0,0 +1,44 @@ +/** @typedef {Models.Model.Groups.Group.Components.Component} ModelComponent */ + +/** + * + * @group manager + * @class Component + * @extends item + * @memberof Models.Model.Groups.Group.Components + */ +var Component = function () { + /** + * + * @public + * @function address + * @memberof Models.Model.Groups.Group.Components.Component + * @returns {v2.address} + */ + this.address = function () { + + }; + + /** + * + * @public + * @function attributes + * @memberof Models.Model.Groups.Group.Components.Component + * @returns {v2.map(v2.string, v2.vc)} + */ + this.attributes = function () { + + }; + + /** + * + * @public + * @function address + * @memberof Models.Model.Groups.Group.Components.Component + * @param attrName {v2.string} + * @returns {tools.promise(ComponentAttribute)} + */ + this.get = function (attrName) { + + }; +}; \ No newline at end of file diff --git a/docfiles/providers/managers/models/groups/components/manager.js b/docfiles/providers/managers/models/groups/components/manager.js new file mode 100644 index 0000000..3727e49 --- /dev/null +++ b/docfiles/providers/managers/models/groups/components/manager.js @@ -0,0 +1,43 @@ +/** + * + * @group manager + * @class Components + * @extends manager + * @memberof Models.Model.Groups.Group + */ +var Components = function () { + /** + * + * @public + * @function is_component_exist + * @memberof Models.Model.Groups.Group.Components + * @param componentId {v2.string} + * @returns {boolean} + */ + this.is_component_exist = function (componentId) { + + }; + + /** + * + * @public + * @function get + * @memberof Models.Model.Groups.Group.Components + * @param componentId {v2.string} + * @returns {tools.promise(ModelComponent)} + */ + this.get = function (componentId) { + + }; + + /** + * + * @public + * @function components + * @memberof Models.Model.Groups.Group.Components + * @returns {tools.promise(v2.set(v2.string))} + */ + this.components = function () { + + }; +}; \ No newline at end of file diff --git a/docfiles/providers/managers/models/groups/group.js b/docfiles/providers/managers/models/groups/group.js new file mode 100644 index 0000000..ec745ca --- /dev/null +++ b/docfiles/providers/managers/models/groups/group.js @@ -0,0 +1,44 @@ +/** @typedef {Models.Model.Groups.Group} ModelGroup */ + +/** + * + * @group manager + * @class Group + * @extends item + * @memberof Models.Model.Groups + */ +var Group = function () { + /** + * + * @public + * @function components + * @memberof Models.Model.Groups.Group + * @returns {tools.promise()} + */ + this.components = function () { + + }; + + /** + * + * @public + * @function attributes + * @memberof Models.Model.Groups.Group + * @returns {v2.map(v2.string, v2.vc)} + */ + this.attributes = function () { + + }; + + /** + * + * @public + * @function get + * @memberof Models.Model.Groups.Group + * @param componentId {v2.string} + * @returns {tools.promise(ModelComponent)} + */ + this.get = function (componentId) { + + } +}; \ No newline at end of file diff --git a/docfiles/providers/managers/models/groups/manager.js b/docfiles/providers/managers/models/groups/manager.js new file mode 100644 index 0000000..9c0b3a3 --- /dev/null +++ b/docfiles/providers/managers/models/groups/manager.js @@ -0,0 +1,42 @@ +/** + * + * @group manager + * @class Groups + * @extends manager + * @memberof Models.Model + */ +var Groups = function () { + /** + * + * @public + * @function all + * @memberof Models.Model.Groups + * @returns {v2.deque(v2.string)} + */ + this.all = function () { + + }; + + /** + * + * @public + * @function is_group_exist + * @memberof Models.Model.Groups + * @returns {boolean} + */ + this.is_group_exist = function () { + + }; + + /** + * + * @public + * @function get + * @memberof Models.Model.Groups + * @param alias {v2.string} + * @returns {tools.promise(Models.Model.Groups.Group)} + */ + this.get = function (alias) { + + } +}; \ No newline at end of file diff --git a/docfiles/providers/managers/models/manager.js b/docfiles/providers/managers/models/manager.js index 3fdb4d5..577c53a 100644 --- a/docfiles/providers/managers/models/manager.js +++ b/docfiles/providers/managers/models/manager.js @@ -5,6 +5,7 @@ * * @group manager * @namespace Models + * @extends manager */ function Models() { /** diff --git a/docfiles/providers/managers/models/model.js b/docfiles/providers/managers/models/model.js index c59e297..78ae740 100644 --- a/docfiles/providers/managers/models/model.js +++ b/docfiles/providers/managers/models/model.js @@ -7,6 +7,15 @@ * @memberof Models */ function Model() { + /** + * + * @public + * @name static + * @type {Models.Model.static_data} + */ + this.static = new Models.Model.static_data(); + + /** * * @public @@ -29,6 +38,19 @@ function Model() { }; + + /** + * + * @public + * @function get_group + * @memberof Models.Model + * @param groupType {v2.model_type} + * @returns {tools.promise(ModelGroup)} + */ + this.get_group = function(groupType) { + + }; + /** * * @public diff --git a/docfiles/providers/managers/models/static.js b/docfiles/providers/managers/models/static.js new file mode 100644 index 0000000..9f6dc3b --- /dev/null +++ b/docfiles/providers/managers/models/static.js @@ -0,0 +1,62 @@ +/** + * @class static + * @memberof Models.Model + * @extends item + */ +var static_data = function () { + + /** + * + * @public + * @function label_attrs + * @memberof Models.Model.static + * @returns {v2.set(v2.string)} + */ + this.label_attrs = function () { + + }; + + /** + * + * @public + * @function popup_attrs + * @memberof Models.Model.static + * @returns {v2.set(v2.string)} + */ + this.popup_attrs = function () { + + }; + + /** + * + * @public + * @function is_container + * @memberof Models.Model.static + * @returns {v2.boolean} + */ + this.is_container = function () { + + }; + + /** + * + * @public + * @function base_component_type + * @memberof Models.Model.static + * @returns {v2.model_type} + */ + this.base_component_type = function () { + + }; + + /** + * + * @public + * @function touch + * @memberof Models.Model.static + * @returns {tools.promise} + */ + this.touch = function () { + + } +}; \ No newline at end of file diff --git a/docfiles/providers/managers/publishers/items/attributes/attribute.js b/docfiles/providers/managers/publishers/items/attributes/attribute.js new file mode 100644 index 0000000..15867ed --- /dev/null +++ b/docfiles/providers/managers/publishers/items/attributes/attribute.js @@ -0,0 +1,51 @@ +/** @typedef {Publishers.Publisher.Items.Item.Attributes.Attribute} PublisherItemAttribute */ + +/** + * + * @group manager + * @class Attribute + * @memberof Publishers.Publisher.Items.Item.Attributes + */ +var Attribute = function () { + /** + * + * @name s_size_change + * @public + * @memberof Publishers.Publisher.Items.Item.Attributes.Attribute + * @type {number} + */ + this.s_size_change = -1; + + /** + * + * @public + * @function name + * @memberof Publishers.Publisher.Items.Item.Attributes.Attribute + * @returns {v2.string} + */ + this.name = function () { + + }; + + /** + * + * @public + * @function value + * @memberof Publishers.Publisher.Items.Item.Attributes.Attribute + * @returns {v2} + */ + this.value = function () { + + }; + + /** + * + * @public + * @function type + * @memberof Publishers.Publisher.Items.Item.Attributes.Attribute + * @returns {v2.type} + */ + this.type = function () { + + } +}; \ No newline at end of file diff --git a/docfiles/providers/managers/publishers/items/attributes/manager.js b/docfiles/providers/managers/publishers/items/attributes/manager.js new file mode 100644 index 0000000..8ab1be5 --- /dev/null +++ b/docfiles/providers/managers/publishers/items/attributes/manager.js @@ -0,0 +1,32 @@ +/** + * + * @group manager + * @class Attributes + * @memberof Publishers.Publisher.Items.Item + */ +var Attributes = function () { + + /** + * + * @public + * @function get + * @memberof Publishers.Publisher.Items.Item.Attributes + * @param _id {v2.integer} + * @returns {tools.promise(PublisherItemAttribute)} + */ + this.get = function (_id) { + + }; + + /** + * + * @public + * @function attributes + * @memberof Publishers.Publisher.Items.Item.Attributes + * @returns {v2.list(v2.string)} + */ + this.attributes = function () {} + + + +}; \ No newline at end of file diff --git a/docfiles/providers/managers/publishers/items/item.js b/docfiles/providers/managers/publishers/items/item.js new file mode 100644 index 0000000..3a6d411 --- /dev/null +++ b/docfiles/providers/managers/publishers/items/item.js @@ -0,0 +1,32 @@ +/** @typedef {Publishers.Publisher.Items.Item} PublisherItem */ + +/** + * + * @group manager + * @class Item + * @memberof Publishers.Publisher.Items + */ +var Item = function () { + /** + * + * @function id + * @public + * @memberof Publishers.Publisher.Items.Item + * @type {v2.integer} + */ + this.id = function () { + + }; + + /** + * + * @public + * @function get + * @memberof Publishers.Publisher.Items.Item + * @param _index {v2.integer} + * @returns {tools.promise(PublisherItemAttribute)} + */ + this.get = function (_index) { + + }; +}; \ No newline at end of file diff --git a/docfiles/providers/managers/publishers/items/items.js b/docfiles/providers/managers/publishers/items/items.js deleted file mode 100644 index 4794489..0000000 --- a/docfiles/providers/managers/publishers/items/items.js +++ /dev/null @@ -1,151 +0,0 @@ -/** @typedef {Publishers.Publisher.Items.Item} PublisherItem */ -/** @typedef {Publishers.Publisher.Items.Item.Attributes.Attribute} PublisherItemAttribute */ - -/** - * - * @group manager - * @class Items - * @memberof Publishers.Publisher - */ -var Items = function () { - - /** - * - * @public - * @function get - * @memberof Publishers.Publisher.Items - * @param _id {v2.integer} - * @returns {tools.promise(PublisherItem)} - */ - this.get = function (_id) { - - }; - - /** - * - * @public - * @function is_exist - * @memberof Publishers.Publisher.Items - * @param _id {v2.integer} - * @returns {boolean} - */ - this.is_exist = function (_id) { - - }; - - /** - * - * @group manager - * @class Item - * @memberof Publishers.Publisher.Items - */ - var Item = function () { - /** - * - * @name id - * @public - * @memberof Publishers.Publisher.Items.Item - * @type {v2.integer} - */ - this.id = function () { - - }; - - /** - * - * @public - * @function get - * @memberof Publishers.Publisher.Items.Item - * @param _index {v2.integer} - * @returns {tools.promise(PublisherItemAttribute)} - */ - this.get = function (_index) { - - }; - }; - -}; - - -/** - * - * @group manager - * @class Attributes - * @memberof Publishers.Publisher.Items.Item - */ -var Attributes = function () { - - /** - * - * @public - * @function get - * @memberof Publishers.Publisher.Items.Item.Attributes - * @param _id {v2.integer} - * @returns {tools.promise(PublisherItemAttribute)} - */ - this.get = function (_id) { - - }; - - /** - * - * @public - * @function attributes - * @memberof Publishers.Publisher.Items.Item.Attributes - * @returns {v2.list(v2.string)} - */ - this.attributes = function () {} - - - /** - * - * @group manager - * @class Attribute - * @memberof Publishers.Publisher.Items.Item.Attributes - */ - var Attribute = function () { - /** - * - * @name s_size_change - * @public - * @memberof Publishers.Publisher.Items.Item.Attributes.Attribute - * @type {number} - */ - this.s_size_change = -1; - - /** - * - * @public - * @function name - * @memberof Publishers.Publisher.Items.Item.Attributes.Attribute - * @returns {v2.string} - */ - this.name = function () { - - }; - - /** - * - * @public - * @function value - * @memberof Publishers.Publisher.Items.Item.Attributes.Attribute - * @returns {v2} - */ - this.value = function () { - - }; - - /** - * - * @public - * @function type - * @memberof Publishers.Publisher.Items.Item.Attributes.Attribute - * @returns {v2.type} - */ - this.type = function () { - - } - }; -}; - - diff --git a/docfiles/providers/managers/publishers/items/manager.js b/docfiles/providers/managers/publishers/items/manager.js new file mode 100644 index 0000000..f2df74b --- /dev/null +++ b/docfiles/providers/managers/publishers/items/manager.js @@ -0,0 +1,34 @@ +/** + * + * @group manager + * @class Items + * @memberof Publishers.Publisher + */ +var Items = function () { + + /** + * + * @public + * @function get + * @memberof Publishers.Publisher.Items + * @param _id {v2.integer} + * @returns {tools.promise(PublisherItem)} + */ + this.get = function (_id) { + + }; + + /** + * + * @public + * @function is_exist + * @memberof Publishers.Publisher.Items + * @param _id {v2.integer} + * @returns {boolean} + */ + this.is_exist = function (_id) { + + }; +}; + + diff --git a/docfiles/providers/managers/trees/globalTree/children/manager.js b/docfiles/providers/managers/trees/globalTree/children/manager.js index 7aa188d..707e109 100644 --- a/docfiles/providers/managers/trees/globalTree/children/manager.js +++ b/docfiles/providers/managers/trees/globalTree/children/manager.js @@ -1,3 +1,5 @@ +/** @typedef {Trees.GlobalTree.Node.Children} NodeChildren */ + /** * Интерфейс позволяющей пользователю работать с потомками ноды * @@ -29,7 +31,7 @@ function Children() { * * @public * @function get - * @returns {v2.list(v2.integer.type)} + * @returns {v2.list(v2.integer)} * @memberof Trees.GlobalTree.Node.Children */ this.children = function(attributeName) { diff --git a/docfiles/providers/managers/trees/globalTree/node.js b/docfiles/providers/managers/trees/globalTree/node.js index 986ab3b..a57b5fb 100644 --- a/docfiles/providers/managers/trees/globalTree/node.js +++ b/docfiles/providers/managers/trees/globalTree/node.js @@ -63,7 +63,7 @@ function Node() { * Доступ к менеджеру детей * @public * @function cm - * @returns {Children} + * @returns {NodeChildren} * @memberof Trees.GlobalTree.Node */ this.cm = function() { diff --git a/docfiles/providers/managers/trees/globalTree/node_types/node_type.js b/docfiles/providers/managers/trees/globalTree/node_types/node_type.js index ab194fe..56cdcf2 100644 --- a/docfiles/providers/managers/trees/globalTree/node_types/node_type.js +++ b/docfiles/providers/managers/trees/globalTree/node_types/node_type.js @@ -1,4 +1,4 @@ -/** @typedef {Trees.GlobalTree.Node.NodeTypes.NodeType} NodeType +/** @typedef {Trees.GlobalTree.Node.NodeTypes.NodeType} NodeType */ /** * diff --git a/docfiles/providers/managers/trees/manager.js b/docfiles/providers/managers/trees/manager.js index 4f00e02..8552904 100644 --- a/docfiles/providers/managers/trees/manager.js +++ b/docfiles/providers/managers/trees/manager.js @@ -1,14 +1,24 @@ -/** +/** * Менеджер деревьев. * Представляет собой интерфейс для доступа ко всем деревьям * Позволяет по тегу дерева получить на него ссылку. - * На текущий момент содержит в себе: - * - global_tree (Основное дерево) - * - global_attribute_tree (Дерево, которое предоставляет доступ к атрибутам) - * - desktop_tree (Представляет рабочий стол) - * - remote_modules_tree (Представляет собой дерево сборщиков) - * - scheme_tree (Топология) - * - user_attribute_tree (Пользовательские данные) + * На текущий момент содержит в себе: + * + * @example + * // Работа с деревом + * // Доступ к менеджеру деревьев находится в переменной ps.pl.tm (провайдеры -> мастер платформа -> менеджер деревьев) + * // доступ к конкретному дереву осуществляется по тагу дерева например ("st", "rmt", "uat") + * // где st - дерево топологии, rmt - дерево сборщиков данных, uat - дерево в котором хранится информация о + * // данных пользователя + * ps.pl.tm(new v2.string("rmt")).then(function(ref){ + * // ref - это ссылка на объект + * // метод value возвращает целевой объект. В данном случае дерево {@type Trees.GlobalTree} + * var tree = ref.value(); + * }, function(err){ + * // в случае неудачи придет ошибка. + * // обычно в ошибке содержится три переменные err - код ошибки, message - краткое описание, sub - если к этому + * // привела другая ошибка внутри системы. + * }) * * @group manager * @namespace Trees @@ -38,4 +48,4 @@ function Trees() { this.is_tree_exist = function (treeTag) { } -} \ 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 86b0f27..8342ff7 100644 --- a/templates/initi/static/styles/jsdoc-default.css +++ b/templates/initi/static/styles/jsdoc-default.css @@ -139,6 +139,7 @@ nav padding-left: 16px; padding-right: 16px; + padding-bottom: 20px; } /*nav ul {*/ @@ -218,6 +219,20 @@ h5, .container-overview .subsection-title margin: 8px 0 3px 0; } +.container-overview > h3 { + margin-top: 16px; + margin-bottom: 0px; + padding-bottom: 0px; +} + +.container-overview > pre { + margin-top: 5px; +} +.container-overview > div.description > p { + margin-top: 0; + margin-bottom: 0; +} + /*article .container-overview {*/ /*padding-bottom: 30px;*/ /*}*/ diff --git a/templates/initi/static/styles/min-method.css b/templates/initi/static/styles/min-method.css index 48bc4bd..d331c55 100644 --- a/templates/initi/static/styles/min-method.css +++ b/templates/initi/static/styles/min-method.css @@ -19,6 +19,8 @@ } .min-methods .list .compact-method .access{ padding-right: 10px; + display: inline-block; + width: 50px; } .min-methods .list .compact-method .name{ color: #0137ff; @@ -63,4 +65,9 @@ font-size: 20px; font-weight: normal; min-width: initial; +} + +.parameter > .description > p { + margin-top: 0; + margin-bottom: 0; } \ No newline at end of file diff --git a/templates/initi/static/styles/prettify-tomorrow.css b/templates/initi/static/styles/prettify-tomorrow.css index b6f92a7..7e8d4ac 100644 --- a/templates/initi/static/styles/prettify-tomorrow.css +++ b/templates/initi/static/styles/prettify-tomorrow.css @@ -9,15 +9,18 @@ @media screen { /* string content */ .str { - color: #718c00; } + color: #c51916; } /* a keyword */ .kwd { - color: #8959a8; } + color: #ab0d90; + } /* a comment */ .com { - color: #8e908c; } + color: hsl(120, 100%, 23%); + font-style: italic; + } /* a type name */ .typ { diff --git a/templates/initi/tmpl/container.tmpl b/templates/initi/tmpl/container.tmpl index 1b73b6c..d22f14a 100644 --- a/templates/initi/tmpl/container.tmpl +++ b/templates/initi/tmpl/container.tmpl @@ -66,7 +66,7 @@
- +

Example 1? 's':'' ?>

diff --git a/templates/initi/tmpl/full_method/main.tmpl b/templates/initi/tmpl/full_method/main.tmpl index 407211d..eb5b0fc 100644 --- a/templates/initi/tmpl/full_method/main.tmpl +++ b/templates/initi/tmpl/full_method/main.tmpl @@ -15,7 +15,7 @@ var ryba = "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eius
- () + () diff --git a/templates/initi/tmpl/method.tmpl b/templates/initi/tmpl/method.tmpl index f88f3b4..efccb24 100644 --- a/templates/initi/tmpl/method.tmpl +++ b/templates/initi/tmpl/method.tmpl @@ -43,8 +43,10 @@ var self = this; -
Parameters:
- +
+
Params
+ +
diff --git a/templates/initi/tmpl/method_compact.tmpl b/templates/initi/tmpl/method_compact.tmpl index 613cab0..5efa050 100644 --- a/templates/initi/tmpl/method_compact.tmpl +++ b/templates/initi/tmpl/method_compact.tmpl @@ -6,7 +6,7 @@ var self = this; ?>
- +