1
0
Fork 0
forked from 0x2620/oxjs

add documentation stubs

This commit is contained in:
j 2012-05-21 12:38:18 +02:00
commit 509745407b
102 changed files with 613 additions and 163 deletions

View file

@ -1,5 +1,11 @@
'use strict';
/*@
Ox.InfoList <function> Info List
(options[, self]) -> <o> Info List
options <o> Options
self <o> Shared private variable
@*/
Ox.InfoList = function(options, self) {
self = self || {};
@ -171,44 +177,72 @@ Ox.InfoList = function(options, self) {
}
};
/*@
closePreivew <f> closePreview
@*/
that.closePreview = function() {
that.$element.closePreview();
return that;
};
/*@
gainFocus <f> gainFocus
@*/
that.gainFocus = function() {
that.$element.gainFocus();
return that;
};
/*@
hasFocus <f> hasFocus
@*/
that.hasFocus = function() {
return that.$element.hasFocus();
};
/*@
loseFocus <f> loseFocus
@*/
that.loseFocus = function() {
that.$element.loseFocus();
return that;
};
/*@
paste <f> paste
@*/
that.paste = function(data) {
that.$element.paste(data);
return that;
};
/*@
reloadList <f> reloadList
@*/
that.reloadList = function(stayAtPosition) {
that.$element.reloadList(stayAtPosition);
return that;
};
/*@
scrollToSelection <f> scrollToSelection
@*/
that.scrollToSelection = function() {
that.$element.scrollToSelection();
return that;
};
/*@
size <f> size
@*/
that.size = function() {
that.$element.size();
};
/*@
sortList <f> sortList
(key, operator) -> <o>
@*/
that.sortList = function(key, operator) {
self.options.sort = [{
key: key,
@ -219,6 +253,12 @@ Ox.InfoList = function(options, self) {
return that;
};
/*@
value <f> value
(id) -> values
(id, key) -> value
(id, key, value) -> <o>
@*/
that.value = function(id, key, value) {
// fixme: make this accept id, {k: v, ...}
if (arguments.length == 1) {
@ -233,4 +273,4 @@ Ox.InfoList = function(options, self) {
return that;
};
};