sanj/oxjs
1
0
Fork 0
forked from 0x2620/oxjs
Code Pull requests Activity

update widget documentation (arguments first)

Browse source
This commit is contained in:
rolux 2012-07-04 13:29:18 +02:00
commit a0867f0da6
81 changed files with 250 additions and 251 deletions
Download patch file Download diff file Expand all files Collapse all files

4
source/Ox.UI/js/Core/App.js
View file

@ -2,13 +2,13 @@
/*@
Ox.App <f> Basic application instance that communicates with a JSON API
([options]) -> <o> App object
load <!> App loaded
options <o> Options object
name <s> App name
timeout <n> Request timeout
type <s> HTTP Request type, i.e. 'GET' or 'POST'
url <s> JSON API URL
([options]) -> <o> App object
load <!> App loaded
@*/
Ox.App = function(options) {

2
source/Ox.UI/js/Core/Container.js
View file

@ -6,9 +6,9 @@
// would append (length - 1)?
/*@
Ox.Container <f> Container element
([options[, self]]) -> <o:Ox.Element> Container object
options <o> Options object
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Container object
@*/
Ox.Container = function(options, self) {
var that = Ox.Element({}, self)

2
source/Ox.UI/js/Core/Event.js
View file

@ -1,7 +1,7 @@
'use strict';
/*@
Ox.Event <o> Used internally for events
Ox.Event <o> Event controller
@*/
Ox.Event = (function() {

2
source/Ox.UI/js/Core/Focus.js
View file

@ -1,7 +1,7 @@
'use strict';
/*@
Ox.Focus <o> Basic focus handler
Ox.Focus <o> Basic focus controller
@*/
Ox.Focus = (function() {

2
source/Ox.UI/js/Core/JQueryElement.js
View file

@ -2,8 +2,8 @@
/*@
Ox.JQueryElement <f> Wrapper for jQuery
($element) -> <o> Wrapped jQuery DOM element
$element <o> jQuery DOM Element
($element) -> <o> Wrapped jQuery DOM element
@*/
Ox.JQueryElement = function($element) {
//@ id <n> Unique id

2
source/Ox.UI/js/Core/Keyboard.js
View file

@ -1,7 +1,7 @@
'use strict';
/*@
Ox.Keyboard <o> Basic keyboard handler
Ox.Keyboard <o> Basic keyboard controller
@*/
Ox.Keyboard = (function() {

2
source/Ox.UI/js/Core/LoadingIcon.js
View file

@ -2,10 +2,10 @@
/*@
Ox.LoadingIcon <f> Loading Icon Element
([options[, self]]) -> <o:Ox.Element> Loading Icon Element
options <o> Options object
size <n|s|16> size of icon
self <o> Shared private variable
([options[, self]]) -> <o:Ox.Element> Loading Icon Element
@*/
Ox.LoadingIcon = function(options, self) {

17
source/Ox.UI/js/Core/Request.js
View file

@ -1,12 +1,12 @@
'use strict';
/*@
Ox.Request <o> Basic request handler object
FIXME: options is not a property, just documenting defaults
options <o> Options object
timeout <n|60000> request timeout
type <s|"POST"> request type, possible values POST, GET, PUT, DELETE
url <s> request url
Ox.Request <o> Basic request controller
# FIXME: options is not a property, just documenting defaults
# options <o> Options object
# timeout <n|60000> request timeout
# type <s|"POST"> request type, possible values POST, GET, PUT, DELETE
# url <s> request url
@*/
Ox.Request = (function() {
@ -74,11 +74,6 @@ Ox.Request = (function() {
$element.bindEvent.apply(this, arguments);
},
// fixme: remove
_leakCache: function() {
return cache;
},
/*@
options <f> get/set options
() -> <o> get options