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

update documentation example

Browse source
This commit is contained in:
rolux 2012-06-25 09:16:46 +02:00
parent 6fcfc2f2d6
commit 2194a5fb8b
1 changed files with 6 additions and 6 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
examples/documentation/oxdoc_tutorial/js/example.js
View file

@ -174,9 +174,9 @@ just a special case of `name <type> summary`, where `name` has the form
If an item can be of more than one type (in this case `string` or `function`),
this is documented as `<s|f>`. If it has a default value (in this case the
string `'GET'`), this is documented as `<s|'GET'>`. For a `function`-type
argument (usually a callback function), there is no return value to document,
only the arguments it gets passed.
string `'GET'`), this is documented as `<s|'GET'>`. For a function-type argument
(usually a callback function), there is no return value to document, only the
arguments it gets passed.
*/
/*@
My.readURL <f> Asynchronously reads a remote resource
@ -299,8 +299,8 @@ My.localStorage <f> Returns a localStorage handler for a given namespace
'baz'
> My.test.storage.delete('bar')('foo')
'bar'
> Object.keys(My.test.storage())
['foo']
> My.test.storage.delete()()
{}
*/
My.localStorage = function(ns) {
function storage(key, value) {
@ -598,7 +598,7 @@ Ox.SyntaxHighlighter and Ox.DocPanel, and they'll do the rest.
*/
Ox.load('UI', function() {
var file = 'example.js',
path = Ox.PATH + '../examples/documentation/oxdoc/js/';
path = Ox.PATH + '../examples/documentation/oxdoc_tutorial/js/';
Ox.get(path + file, function(source) {
Ox.TabPanel({
content: function(id) {