0x2620/oxjs
2
0
Fork 1
Code Issues 172 Pull requests Releases Wiki Activity

fix documentation

Browse source
This commit is contained in:
rolux 2012-05-30 00:28:52 +02:00
parent f3490dc8d5
commit 6847102507
4 changed files with 29 additions and 33 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -2,8 +2,7 @@
/*@ /*@
Ox.App <f:Ox.Element> Basic application instance that communicates with a JSON API Ox.App <f:Ox.Element> Basic application instance that communicates with a JSON API
() -> <f> App object ([options]) -> <o> App object
(options) -> <f> App object
options <o> Options object options <o> Options object
timeout <n> request timeout timeout <n> request timeout
type <s> HTTP Request type, i.e. 'GET' or 'POST' type <s> HTTP Request type, i.e. 'GET' or 'POST'

15
source/Ox.UI/js/List/List.js
View file

@ -1,18 +1,14 @@
'use strict'; 'use strict';
/*@ /*@
Ox.List <f:Ox.Container> List Element Ox.List <f:Ox.Container> List constructor
([options[, self]]) -> <f> List Object
options <o> Options object options <o> Options object
centered <b|false> if true, and orientation is 'horizontal', centered <b|false> if true, and orientation is 'horizontal', then keep the selected item centered
then keep the selected item centered
construct <f|null> (data) returns the list item HTML construct <f|null> (data) returns the list item HTML
draggable <b|false> If true, items can be dragged draggable <b|false> If true, items can be dragged
format <[]> ??? format <[]> ???
itemHeight <n|16> item height itemHeight <n|16> item height
items <a|f|null> <a> list of items, items <a|f|null> <a> list of items, <f> (data) returns {items, size, ...}, (data, callback) returns [items]
<f> (data) returns {items, size, ...}
(data, callback) returns [items]
itemWidth <n|16> item width itemWidth <n|16> item width
keys <a|[]> keys of the list items keys <a|[]> keys of the list items
max <n|-1> Maximum number of items that can be selected (-1 for all) max <n|-1> Maximum number of items that can be selected (-1 for all)
@ -22,10 +18,11 @@ Ox.List <f:Ox.Container> List Element
selected <a|[]> ids of the selected elements selected <a|[]> ids of the selected elements
sort <a|[]> sort order sort <a|[]> sort order
sortable <b|false> If true, items can be re-ordered sortable <b|false> If true, items can be re-ordered
sums <[]|[]> sums to be included in totals sums <[s]|[]> sums to be included in totals
type <s|'text'> type <s|'text'> type
unique <s|''> name of the key that acts as unique id unique <s|''> name of the key that acts as unique id
self <o> shared private variable self <o> shared private variable
([options[, self]]) -> <o> List object
add <!> item added add <!> item added
delete <!> item removed delete <!> item removed
draganddrop <!> Fires during drag draganddrop <!> Fires during drag

10
source/Ox.UI/js/List/TextList.js
View file

@ -2,7 +2,7 @@
/*@ /*@
Ox.TextList <f:Ox.Element> TextList Object Ox.TextList <f:Ox.Element> TextList Object
([options[, self]]) -> <f> TextList Object ([options[, self]]) -> <o> TextList Object
options <o> Options object options <o> Options object
columns <[o]|[]> Columns columns <[o]|[]> Columns
# Fixme: There's probably more... # Fixme: There's probably more...
@ -25,17 +25,17 @@ Ox.TextList <f:Ox.Element> TextList Object
columnsVisible <b|false> If true, columns are visible columnsVisible <b|false> If true, columns are visible
columnWidth <[n]|[40, 800]> Minimum and maximum column width columnWidth <[n]|[40, 800]> Minimum and maximum column width
draggable <b|false> If true, items can be dragged draggable <b|false> If true, items can be dragged
id <s|''> id <s|''> Id
items <f|null> function() {} {sort, range, keys, callback} or array items <f|null> function() {} {sort, range, keys, callback} or array
keys <[s]|[]> Additional keys (apart from keys of visible columns) keys <[s]|[]> Additional keys (apart from keys of visible columns)
max <n|-1> Maximum number of items that can be selected (-1 for all) max <n|-1> Maximum number of items that can be selected (-1 for all)
min <n|0> Minimum number of items that must be selected min <n|0> Minimum number of items that must be selected
pageLength <n|100> Number of items per page pageLength <n|100> Number of items per page
scrollbarVisible <b|false> If true, the scrollbar is always visible scrollbarVisible <b|false> If true, the scrollbar is always visible
selected <a|[]> selected <[s]|[]> Array of selected ids
sort <[]|[]> sort <[o]|[s]|[]> ['+foo', ...] or [{key: 'foo', operator: '+'}, ...]
sortable <b|false> If true, elements can be re-ordered sortable <b|false> If true, elements can be re-ordered
sums <[]|[]> Sums to be included in totals sums <[s]|[]> Sums to be included in totals
self <o> shared private variable self <o> shared private variable
@*/ @*/

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

@ -137,8 +137,8 @@ Ox.load = function() {
}; };
/*@ /*@
Ox.localStorage <o> localStorage wrapper Ox.localStorage <f> localStorage wrapper
(namespace) -> <f> localStorage object for a given namespace (namespace) -> storage <f> localStorage function for a given namespace
FIXME: there is a bug in Ox.doc here, FIXME: there is a bug in Ox.doc here,
will use "(namespace)" as function name will use "(namespace)" as function name
() -> <o> returns all key:value pairs () -> <o> returns all key:value pairs