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

update documentation (classes)

Browse source
This commit is contained in:
rolux 2012-05-31 12:32:54 +02:00
commit 8c347d9009
88 changed files with 177 additions and 227 deletions
Download patch file Download diff file Expand all files Collapse all files

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

@ -1,7 +1,7 @@
'use strict';
/*@
Ox.App <f:Ox.Element> Basic application instance that communicates with a JSON API
Ox.App <f> Basic application instance that communicates with a JSON API
([options]) -> <o> App object
options <o> Options object
timeout <n> request timeout

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

@ -5,10 +5,8 @@
// 0, 1, 2, etc, so that append would append 0, and appendTo
// would append (length - 1)?
/*@
Ox.Container <f:Ox.Element> Container element
() -> <o> Container object
(options) -> <o> Container object
(options, self) -> <o> Container object
Ox.Container <f> Container element
([options[, self]]) -> <o:Ox.Element> Container object
options <o> Options object
self <o> Shared private variable
@*/

9
source/Ox.UI/js/Core/Element.js
View file

@ -1,14 +1,11 @@
'use strict';
/*@
Ox.Element <f:Ox.JQueryElement> Basic UI element object
Ox.Element <function> Basic UI element object
# Usage --------------------------------------------------------------------
(element) -> <object> UI element
(options) -> <object> UI element
(options, self) -> <object> UI element
([options[, self]]) -> <object:Ox.JQueryElement> Element object
# Arguments ----------------------------------------------------------------
element <string> Tagname or CSS selector
options <object> Options of the element
options <object|string> Options of the element, or just `element` option
# Properties
element <string> Tagname or CSS selector
tooltip <string|function> Tooltip title, or a function that returns one

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

@ -1,10 +1,8 @@
'use strict';
/*@
Ox.LoadingIcon <f:Ox.Element> Loading Icon Element
() -> <f> Loading Icon Element
(options) -> <f> Loading Icon Element
(options, self) -> <f> Loading Icon Element
Ox.LoadingIcon <f> Loading Icon Element
([options[, self]]) -> <o:Ox.Element> Loading Icon Element
options <o> Options object
size <s|medium> size of icon
self <o> Shared private variable