Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Matreshka docs in English #6

Merged
merged 53 commits into from
Mar 17, 2015
Merged
Changes from 1 commit
Commits
Show all changes
53 commits
Select commit Hold shift + click to select a range
9beb918
Balalaika micro-library
fikuspikus Mar 15, 2015
96e87de
end globals.jsdoc
fikuspikus Mar 15, 2015
f546237
Matreshka.jsdoc Creating of the instance
fikuspikus Mar 15, 2015
2caa543
Matreshka.jsdoc method @Matreshka#onDebounce
fikuspikus Mar 15, 2015
55f795d
matreshka.jsdoc @method Matreshka#off & reload ru folder
fikuspikus Mar 15, 2015
17f4932
Matreshka.jsdoc @method Matreshka#bindNode
fikuspikus Mar 15, 2015
2d0f458
Matreshka.jsdoc @link Matreshka.defaultBinders
fikuspikus Mar 15, 2015
0007a35
matreshka.jsdoc @method Matreshka#bindNode
fikuspikus Mar 16, 2015
48e567f
matreshka.jsdoc @method Matreshka#bindNode var3
fikuspikus Mar 16, 2015
151b1ec
matreshka.jsdoc @method Matreshka#bindOptionalNode
fikuspikus Mar 16, 2015
373d051
matreshka.jsdoc @method Matreshka#unbindNode
fikuspikus Mar 16, 2015
33d2a74
matreshka.jsdoc before @method Matreshka#boundAll
fikuspikus Mar 16, 2015
3698a3b
matreshka.jsdoc before @method Matreshka#
fikuspikus Mar 16, 2015
b73b70b
matreshka.jsdoc @method Matreshka#selectAll
fikuspikus Mar 16, 2015
22d4bfe
matreshka.jsdoc @method Matreshka#$
fikuspikus Mar 16, 2015
d65939d
matreshka.jsdoc @method Matreshka#eq
fikuspikus Mar 16, 2015
5262ed1
matreshka.jsdoc @method Matreshka#defineGetter
fikuspikus Mar 16, 2015
914b2f4
matreshka.jsdoc @method Matreshka#defineSetter
fikuspikus Mar 16, 2015
991f5e7
matreshka.jsdoc @method Matreshka#mediate
fikuspikus Mar 16, 2015
02a01b2
matreshka.jsdoc @method Matreshka#linkProps
fikuspikus Mar 16, 2015
60d8936
matreshka.jsdoc @method Matreshka#get
fikuspikus Mar 16, 2015
c8fc67d
matreshka.jsdoc @method Matreshka#set
fikuspikus Mar 16, 2015
dc4b79d
matreshka.jsdoc @method Matreshka#remove
fikuspikus Mar 16, 2015
2f9bd94
matreshka.jsdoc @method Matreshka#define str994
fikuspikus Mar 16, 2015
51f7df8
matreshka.jsdoc str1029 @method Matreshka#delay
fikuspikus Mar 16, 2015
39e3dd8
matreshka.jsdoc str1052 @method Matreshka.extend
fikuspikus Mar 16, 2015
9b15f3e
matreshka.jsdoc str1074 @method Matreshka.Class
fikuspikus Mar 16, 2015
e815846
matreshka.jsdoc str1091 @method Matreshka.$
fikuspikus Mar 16, 2015
d2aa02d
matreshka.jsdoc str1108 @method Matreshka.useAs$
fikuspikus Mar 16, 2015
a11c8eb
matreshka.jsdoc str1168 @method Matreshka.noop
fikuspikus Mar 16, 2015
efd5677
matreshka.jsdoc str1194 @method Matreshka.debounce
fikuspikus Mar 16, 2015
861d91b
matreshka.jsdoc str1214 Matreshka.lookForBinder
fikuspikus Mar 16, 2015
3d6d107
matreshka.jsdoc finish
fikuspikus Mar 16, 2015
d05b960
matreshka.Object str72 Matreshka.Object#isMKObject
fikuspikus Mar 16, 2015
2118e5b
matreshka.Object str106 @method Matreshka.Object#hasOwnProperty
fikuspikus Mar 16, 2015
0b89cf3
matreshka.Object str172 @method Matreshka.Object#keyOf
fikuspikus Mar 16, 2015
9b86aae
matreshka.Object str239 @method Matreshka.Object#jset
fikuspikus Mar 16, 2015
7732fc3
matreshka.Object str279 @method Matreshka.Object#addDataKeys
fikuspikus Mar 16, 2015
c4ecf1c
matreshka.Object str301 @method Matreshka.Object#removeDataKeys
fikuspikus Mar 16, 2015
8f0bfa3
matreshka.Object finish him
fikuspikus Mar 16, 2015
1b73e88
Matreshka.Array.jsdoc str 330
fikuspikus Mar 16, 2015
ce46788
Matreshka.Array.jsdoc str507 @method Matreshka.Array#Model
fikuspikus Mar 16, 2015
e0b1b6b
Matreshka.Array.jsdoc str558 @method Matreshka.Array#mediateItem
fikuspikus Mar 16, 2015
2e017a3
Matreshka.Array.jsdoc str593 @method Matreshka.Array#on
fikuspikus Mar 16, 2015
514c197
Matreshka.Array.jsdoc str629 @method Matreshka.Array#toArray
fikuspikus Mar 16, 2015
37a50dc
Matreshka.Array.jsdoc str667 @method Matreshka.Array#hasOwnProperty
fikuspikus Mar 16, 2015
68f10d5
Matreshka.Array.jsdoc str730 @method Matreshka.Array#each
fikuspikus Mar 16, 2015
f1c51c4
Matreshka.Array.jsdoc str790 @method Matreshka.Array#METHOD_
fikuspikus Mar 16, 2015
434dd9e
Matreshka.Array.jsdoc finished
fikuspikus Mar 16, 2015
ccbe9ec
matreshka.binders str38 @function Matreshka.binders.visibility
fikuspikus Mar 16, 2015
34107af
matreshka.binders str98 @function Matreshka.binders.property
fikuspikus Mar 16, 2015
05cf5a6
matreshka.binders finish
fikuspikus Mar 16, 2015
2b4c909
finish all
fikuspikus Mar 16, 2015
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Matreshka.jsdoc method @matreshka#onDebounce
  • Loading branch information
fikuspikus committed Mar 15, 2015
commit 2caa543ec4de3d342b6e4cf8e71238a33376d884
26 changes: 13 additions & 13 deletions src/docs/en/Matreshka.jsdoc
Original file line number Diff line number Diff line change
Expand Up @@ -12,9 +12,9 @@ Version 2.0, January 2004
As a rule, this class, (like {@link Matreshka.Array} and {@link Matreshka.Object}), isn't used directly. Instead, it is inherited by the classes that you create. Therefore, the examples to the properties and methods in this documentation, as a rule, will be given with the use of the keyword ``this``.
@example <caption>Creating of the instance</caption>
var mk = new Matreshka;
@example <caption>Краткая запись: MK вместо Matreshka</caption>
@example <caption>In short: MK instead of Matreshka</caption>
var mk = new MK;
@example <caption>Наследование</caption>
@example <caption>Inheritance</caption>
var MyClass = Class({
'extends': Matreshka,
constructor: function() {
Expand All @@ -24,7 +24,7 @@ var MyClass = Class({
alert("Hello World!");
}
});
@example <caption>Матрешка использует прототипы для реализации наследования. Функция {@link Class} лишь вносит синтаксический сахар и добавляет хаки для Internet Explorer 8. Поэтому вы можете воспользоваться любым другим полюбившимся способом наследования, например, используя классы из ECMAScript 2015</caption>
@example <caption>Matreshka uses prototypes for implementing the inheritance. The {@link Class} function just brings in some syntactic sugar and adds some hacks for the Internet Explorer 8. That's why you can use any other way of the inheritance you like, for example, using classes from ECMAScript 2015</caption>
class MyClass extends Matreshka {
constructor() {
this.sayHello();
Expand All @@ -38,37 +38,37 @@ class MyClass extends Matreshka {

/**
@member {boolean} Matreshka#isMK
@summary ``isMK`` всегда равен ``true``. Это свойство используется для того, чтоб определить, является ли объект экземпляром класса {@link Matreshka}
@summary ``isMK`` always equals ``true``. This property is used for defining whether the object is an instance of the {@link Matreshka} class
@example
alert(object.isMK);
*/


/**
@method Matreshka#on
@summary Добавляет обработчик события
@desc Метод {@link Matreshka#on} добавляет обработчик события для экземпляра класса ``Matreshka``. Полный список возможных событий с описанием см. здесь: {@link #typedef-eventNames}.
@summary adds the event handler
@desc The {@link Matreshka#on} method adds the event handler for the instance of the ``Matreshka`` class. Refer to the complete list of possible events with the description here: {@link #typedef-eventNames}.
@see {@link Matreshka#onDebounce}
@see {@link Matreshka#once}
@see {@link Matreshka#off}
@see {@link Matreshka#trigger}
@param {eventNames} names - Имя события или несколько имен, разделенных пробелом (например, ``"change:x ajaxcomplete change:y"``)
@param {eventHandler} callback - Функция, которая вызывается по событию
@param {boolean} [triggerOnInit=false] - Если аргумент ``triggerOnInit`` равен ``true``, то обработчик будет вызван немедленно после инициализации.
@param {object} [context] - Контекст обработчика. Другими словами, ``this`` при вызове ``callback``
@param {eventNames} names - The event name or some names which are separated by a space (for example, ``"change:x ajaxcomplete change:y"``)
@param {eventHandler} callback - The function which is caused by the event
@param {boolean} [triggerOnInit=false] - If the ``triggerOnInit`` argument equals ``true``, the handler will be called immediately after the initialization.
@param {object} [context] - The context of the handler. In other words, ``this`` when called ``callback``
@returns {matreshka} self
@example
this.on( 'foo', function() {
alert( 'customEvent is fired' );
});
this.trigger( 'foo' );
@example <caption>Передача контекста</caption>
@example <caption>Passing the context</caption>
this.on( 'foo', function() {
alert( this.a ); // 5
}, { a: 5 } );
this.trigger( 'foo', 'Hello world' );
@example <caption>Вызов обработика сразу после инициализации</caption>
//Выводит на экран "bar" сиюсекундно и ждет генерации события "foo"
@example <caption>Calling the handler immediately after the initialization</caption>
//Displays "bar" at once and waits for the generation of the event "foo"
this.on( 'foo', function() {
alert( 'bar' );
}, true );
Expand Down