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

update oxdoc article

Browse source
This commit is contained in:
rolux 2012-06-24 17:14:56 +02:00
parent e0b1c238b9
commit 276bad6919
1 changed files with 14 additions and 11 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

25
readme/documentation.html → readme/oxdoc.html
View file

@ -1,31 +1,34 @@
<h1>OxDoc - A JavaScript Documentation Language</h1> <h1>OxDoc — A JavaScript Documentation Language</h1>
<p>Nothing to see here yet, please move along...</p> <p><code>OxDoc</code> is a new format for JavaScript documentation. It was developed for and is used throughout <code>OxJS</code>, which provides a <a href="#doc/Ox.doc">parser</a> and a <a href="#doc/Ox.DocPanel">browser</a> for it.</p>
<pre class="code" id="doc"> <p><code>OxDoc</code> itself isn't formally documented yet, but you may want to take a look at the extensive <a href="#examples/oxdoc_tutorial">tutorial</a>. The sample below should give you a rough first idea.</p>
<p>For now, <code>OxDoc</code> should be considered a proposal, and this introduction is, above all, a request for <a href="#development">comments</a>.</p>
<pre class="code">
//@ Section Name //@ Section Name
My = {}; this.My = {};
//@ My.foo &lt;number> One-line summary, with *some* `markdown` //@ My.foo &lt;number> One-line summary, with *some* `markdown`
My.foo = 23; My.foo = 23;
/*@ /*@
My.bar &lt;object> Summary My.bar &lt;object> Summary
Optional multi-line description, with *some* `markdown`. Optional multi-line description, with *some* `markdown`.
property &lt;object> A property of My.bar property &lt;object> A property of `My.bar`
Description Description of `property`.
foo &lt;number> A number foo &lt;number> A number
bar &lt;[string]> An array of strings bar &lt;[string]> An array of strings
method &lt;function> A method of My.bar method &lt;function> A method of `My.bar`
(foo[, bar], callback) -> &lt;undefined> Return value (foo[, bar], callback) -> &lt;undefined> Return value
foo &lt;number|string> Argument, number or string foo &lt;number|string> Argument, number or string
bar &lt;boolean|false> Optional argument, default is `false` bar &lt;boolean|false> Optional argument, default is `false`
callback &lt;function> Callback function callback &lt;function> Callback function
arg &lt;boolean> Argument arg &lt;boolean> Argument
baz &lt;event> An event triggered by My.bar baz &lt;event> An event triggered by `My.bar`
x &lt;number> Event property x &lt;number> Event property
y &lt;number> Event property y &lt;number> Event property
# This is a comment. Below are inline tests (the first one will fail, the # This is a comment. Below are inline tests. The last one is asynchronous.
# last one is asynchronous). > My.bar.property.foo &lt; 1
> My.bar.property.foo > 1
true true
> My.bar.property.bar.join('') > My.bar.property.bar.join('')
'string' 'string'