fix typo, update docs

This commit is contained in:
rolux 2013-12-05 15:53:41 +01:00
parent 78aaaea9d3
commit de660af394

View file

@ -31,7 +31,7 @@ Ox.get = function(url, callback) {
/*@ /*@
Ox.getAsync <f> Runs an asynchonous loader for an array of URLs Ox.getAsync <f> Runs an asynchonous loader for an array of URLs
(urls, get, callback) -> <u> undefined (urls, get, callback) -> <u> undefined
urls <s|a> URL or array of URLs or array of such arrays urls <s|[s]> URL or array of URLs or array of such arrays
Multiple URLs in the same array will be processed simultaneously, but Multiple URLs in the same array will be processed simultaneously, but
multiple arrays of URLs will be processed sequentially multiple arrays of URLs will be processed sequentially
get <f> Asynchronous function that loads a URL (for example Ox.get) get <f> Asynchronous function that loads a URL (for example Ox.get)
@ -156,7 +156,7 @@ Ox.getAsync = function(urls, get, callback) {
/*@ /*@
Ox.getFile <f> Loads a file (image, script or stylesheet) Ox.getFile <f> Loads a file (image, script or stylesheet)
(file, callback) -> <u> undefined (file, callback) -> <u> undefined
file <s|a> Local path or remote URL, or array of those, or array of such arrays file <s|[s]> Local path or remote URL, or array of those, or array of such arrays
Multiple files in the same array will be processed simultaneously, Multiple files in the same array will be processed simultaneously,
but multiple arrays of files will be processed in that order. but multiple arrays of files will be processed in that order.
callback <f> Callback function callback <f> Callback function
@ -169,7 +169,7 @@ Ox.getAsync = function(urls, get, callback) {
/*@ /*@
Ox.getImage <f> Loads an image Ox.getImage <f> Loads an image
(file, callback) -> <u> undefined (file, callback) -> <u> undefined
file <s|a> Local path or remote URL, or array of those, or array of such arrays file <s|[s]> Local path or remote URL, or array of those, or array of such arrays
Multiple files in the same array will be processed simultaneously, Multiple files in the same array will be processed simultaneously,
but multiple arrays of files will be processed in that order. but multiple arrays of files will be processed in that order.
callback <f> Callback function callback <f> Callback function
@ -182,24 +182,24 @@ Ox.getAsync = function(urls, get, callback) {
/*@ /*@
Ox.getScript <f> Loads a script Ox.getScript <f> Loads a script
(file, callback) -> <u> undefined (file, callback) -> <u> undefined
file <s|a> Local path or remote URL, or array of those, or array of such arrays file <s|[s]> Local path or remote URL, or array of those, or array of such arrays
Multiple files in the same array will be processed simultaneously, Multiple files in the same array will be processed simultaneously,
but multiple arrays of files will be processed in that order. but multiple arrays of files will be processed in that order.
callback <f> Callback function callback <f> Callback function
@*/ @*/
Ox.getScript = function() { Ox.getScript = function(url, callback) {
getFiles('script', url, callback); getFiles('script', url, callback);
}; };
/*@ /*@
Ox.getStylesheet <f> Loads a stylesheet Ox.getStylesheet <f> Loads a stylesheet
(file, callback) -> <u> undefined (file, callback) -> <u> undefined
file <s|a> Local path or remote URL, or array of those, or array of such arrays file <s|[s]> Local path or remote URL, or array of those, or array of such arrays
Multiple files in the same array will be processed simultaneously, Multiple files in the same array will be processed simultaneously,
but multiple arrays of files will be processed in that order. but multiple arrays of files will be processed in that order.
callback <f> Callback function callback <f> Callback function
@*/ @*/
Ox.getStylesheet = function() { Ox.getStylesheet = function(url, callback) {
getFiles('stylesheet', url, callback); getFiles('stylesheet', url, callback);
}; };
@ -208,7 +208,7 @@ Ox.getAsync = function(urls, get, callback) {
/*@ /*@
Ox.getJSON <f> Get and parse one or more remote JSON files Ox.getJSON <f> Get and parse one or more remote JSON files
(url, callback) -> <u> undefined (url, callback) -> <u> undefined
url <s|a> One or more remote URLs url <s|[s]> One or more remote URLs
callback <f> Callback function callback <f> Callback function
data <*|o|null> Parsed contents, or `null` on error data <*|o|null> Parsed contents, or `null` on error
For multiple URLs, keys are URLs, values are data, `{}` on error For multiple URLs, keys are URLs, values are data, `{}` on error
@ -232,7 +232,7 @@ Ox.getJSON = function(url, callback, isJSONC) {
Ox.getJSONC <f> Get and parse a remote JSONC file Ox.getJSONC <f> Get and parse a remote JSONC file
JSONC is JSON with JavaScript line or block comments JSONC is JSON with JavaScript line or block comments
(url, callback) -> <u> undefined (url, callback) -> <u> undefined
url <s|a> One or more remote URLs url <s|[s]> One or more remote URLs
callback <f> Callback function callback <f> Callback function
data <*|o|null> Parsed contents, or `null` on error data <*|o|null> Parsed contents, or `null` on error
For multiple URLs, keys are URLs, values are data, `{}` on error For multiple URLs, keys are URLs, values are data, `{}` on error
@ -248,7 +248,7 @@ Ox.getJSONC = function(url, callback) {
/*@ /*@
Ox.getJSONP <f> Get and parse one or more remote JSONP files Ox.getJSONP <f> Get and parse one or more remote JSONP files
(url, callback) -> <u> undefined (url, callback) -> <u> undefined
url <s|a> One or more remote URLs url <s|[s]> One or more remote URLs
{callback} gets replaced with jsonp callback function name {callback} gets replaced with jsonp callback function name
callback <f> Callback function callback <f> Callback function
data <*|o|null> Parsed contents, or `null` on error data <*|o|null> Parsed contents, or `null` on error