new /readme structure
This commit is contained in:
rolux
parent
6145b889e5
commit
7302759ab0
11 changed files with 6 additions and 175 deletions
|
|
@ -48,7 +48,8 @@ Ox.load({UI: {showScreen: true}, Geo: {}}, function() {
|
|||
latSize = Math.sqrt(area) / Ox.EARTH_CIRCUMFERENCE * 360,
|
||||
lngSize = Math.sqrt(area) * Ox.getDegreesPerMeter(data.latitude);
|
||||
/*
|
||||
Our city object will look like this:<pre>
|
||||
Our city object will look like this:
|
||||
<pre>
|
||||
{
|
||||
"area": 1460851200,
|
||||
"capital": false,
|
||||
|
|
@ -65,7 +66,8 @@ Ox.load({UI: {showScreen: true}, Geo: {}}, function() {
|
|||
"region": "Asia, Eastern Asia, China",
|
||||
"south": 31.050547083986842,
|
||||
"west": 121.25731130524166
|
||||
}</pre>
|
||||
}
|
||||
</pre>
|
||||
Obviously, in a real-world scenario, you would make sure that the
|
||||
data already comes in this form.
|
||||
*/
|
||||
|
|
|
|||
|
|
@ -1,150 +0,0 @@
|
|||
<script>
|
||||
Ox.tmp = {
|
||||
dialog: function(id) {
|
||||
var source = Ox.decodeHTMLEntities(Ox.stripTags(
|
||||
$('#' + id).html()
|
||||
.replace(/ /g, ' ')
|
||||
.replace(/<br>/g, '\n')
|
||||
)),
|
||||
doc = Ox.doc(source);
|
||||
Ox.Dialog({
|
||||
closeButton: true,
|
||||
content: Ox.TabPanel({
|
||||
content: {
|
||||
source: Ox.SyntaxHighlighter({
|
||||
showLineNumbers: true,
|
||||
source: source
|
||||
}),
|
||||
doc: Ox.TreeList({
|
||||
data: doc,
|
||||
width: 640
|
||||
}).css({height: 360}),
|
||||
docpage: Ox.DocPage({
|
||||
item: doc[0]
|
||||
})
|
||||
},
|
||||
tabs: [
|
||||
{id: 'source', title: 'source'},
|
||||
{id: 'doc', title: 'doc=Ox.doc(source)'},
|
||||
{id: 'docpage', title: 'Ox.DocPage(doc[0])'}
|
||||
]
|
||||
}),
|
||||
height: 360,
|
||||
title: 'OxDoc',
|
||||
width: 640
|
||||
}).open();
|
||||
}
|
||||
}
|
||||
</script>
|
||||
<h1>Ox.doc - A JavaScript Documentation Language</h1>
|
||||
|
||||
<p>At its core, Ox.doc is list of lines like this:</p>
|
||||
<pre class="code">//@ name <type> summary</pre>
|
||||
<p>...</p>
|
||||
<pre class="code">/*@
|
||||
name <type> summary
|
||||
Longer description
|
||||
that may contain HTML.
|
||||
@*/
|
||||
</pre>
|
||||
|
||||
<p>If you are documenting an object with properties, these lines can be nested:</p>
|
||||
<pre class="code">/*@
|
||||
My.team <object> Some sports team
|
||||
name <string> The team's name
|
||||
lastMatch <object> The most recent result
|
||||
for <number> Goals for
|
||||
against <number> Goals against
|
||||
won <boolean> If true, last match was a win
|
||||
@*/</pre>
|
||||
|
||||
<p>The same goes for functions and events:</p>
|
||||
<pre class="code">/*@
|
||||
My.readURL <function> Reads data from a remote URL
|
||||
(url, callback) -> <o> Request handler
|
||||
cancel <function> The handler's only property. Takes no arguments. Cancels the request.
|
||||
url <string> Remote URL
|
||||
callback <function> Callback function
|
||||
result <object> Result object
|
||||
status <number> HTTP status code
|
||||
data <string> Data read from URL, or empty string
|
||||
stalled <event> Fires when the connection is stalled
|
||||
reason <string> Potential cause of the network problem
|
||||
@*/</pre>
|
||||
|
||||
|
||||
<p></p>
|
||||
|
||||
<pre class="code">/*@
|
||||
foo <o> Demo object
|
||||
array <a> An array (and we don't care about the type of its elements)
|
||||
boolean <b> True or false
|
||||
date <d> Date object
|
||||
element <e> DOM element
|
||||
function <f> A function
|
||||
number <n> A number
|
||||
object <o> An object
|
||||
regexp <r> Regular Expression
|
||||
string <s> A string
|
||||
undefined <u> undefined
|
||||
Makes most sense for the result of a function that doesn't return,
|
||||
or as the last of multiple types, to indicate a property may be missing
|
||||
any_value <*> anything
|
||||
event <!> A custom event
|
||||
example1 <[n]|u> An array of numbers, or undefined
|
||||
example2 <s|'foo'> A string, default 'foo'
|
||||
@*/
|
||||
</pre>
|
||||
|
||||
<p>foo bar</p>
|
||||
|
||||
<pre class="code" id="foo">//@ My.TYPES <number> Request timeout, in seconds
|
||||
My.REQUEST_TIMEOUT = 60;</pre>
|
||||
<a href="javascript:Ox.tmp.dialog('foo')">try it out</a>
|
||||
|
||||
<p>foo bar</p>
|
||||
|
||||
<pre class="code">/*@
|
||||
My.getProtocol <function> Returns the protocol part of a URL
|
||||
(url) -> <string> Protocol, like "https", otherwise ""
|
||||
url <string> Just some URL
|
||||
@*/
|
||||
My.getProtocol = function(url) {
|
||||
var match = url.match(/^(.+):\/\//);
|
||||
return match ? match[1] : '';
|
||||
};</pre>
|
||||
|
||||
<p>foo bar</p>
|
||||
|
||||
<pre class="code" id="xxx">/*@
|
||||
My.readURL <f> Reads data from a remote URL
|
||||
(url, callback) -> <o> Request handler
|
||||
(url, options, callback) -> <o> Request handler
|
||||
cancel <f> Function to cancel the request
|
||||
url <s> Remote URL
|
||||
options <o> Optional config object
|
||||
timeout <n|60> Timeout in seconds
|
||||
type <s|'GET'> Request type ('GET', 'POST', 'PUT' or 'DELETE')
|
||||
callback <f> Callback function
|
||||
result <o> Result object
|
||||
status <n> HTTP status code
|
||||
data <s> Data read from URL, or empty string
|
||||
@*/
|
||||
My.readURL = function(url, options, callback) {
|
||||
if (arguments.length == 2) {
|
||||
callback = options;
|
||||
options = {timeout: 60, type: 'GET'};
|
||||
}
|
||||
};</pre>
|
||||
<a href="javascript:Ox.tmp.dialog('xxx')">try it out</a>
|
||||
|
||||
|
||||
<p>foo bar</p>
|
||||
|
||||
<pre class="code">/*@
|
||||
My.Request <o> Remote request utility
|
||||
@*/
|
||||
My.Request = (function()
|
||||
// ...
|
||||
r
|
||||
)();</pre>
|
||||
|
|
@ -1,23 +0,0 @@
|
|||
<h1>Parasitical Inheritance</h1>
|
||||
|
||||
<p>This will be a text about Parasitical Inheritance</p>
|
||||
|
||||
<p><pre class="code">
|
||||
Ox.IconList = function(options, self) {
|
||||
self = self || {};
|
||||
var that = Ox.Element({}, self)
|
||||
.defaults({
|
||||
...
|
||||
pageLength: 100,
|
||||
selected: [],
|
||||
size: 128,
|
||||
sort: [],
|
||||
...
|
||||
})
|
||||
.options(options || {});
|
||||
|
||||
...
|
||||
|
||||
return that;
|
||||
}</pre>
|
||||
</p>
|
||||
|
|
@ -6,6 +6,8 @@
|
|||
|
||||
<blockquote>blockquote</blockquote>
|
||||
|
||||
<a href="#readme/test2">test</a>
|
||||
|
||||
<p><pre class="code">
|
||||
/*
|
||||
|
||||
Loading…
Reference in a new issue