sanj/oxjs
1
0
Fork 0
forked from 0x2620/oxjs
Code Pull requests Activity

in documentation use foo, not <code>foo</code>

Browse source
This commit is contained in:
rolux 2012-06-02 13:06:44 +02:00
commit 73fa856900
16 changed files with 89 additions and 105 deletions
Download patch file Download diff file Expand all files Collapse all files

23
source/Ox/js/JavaScript.js
View file

@ -11,8 +11,7 @@ Ox.doc <f> Generates documentation for annotated JavaScript
callback <f> Callback function
doc <[o]> Array of doc objects
arguments <[o]|u> Arguments (array of doc objects)
Present if the <code>type</code> of the item is
<code>"function"</code>.
Present if the `type` of the item is `"function"`.
class <s|u> Class of the item
default <s|u> Default value of the item
description <s|u> Multi-line description with some Markdown
@ -28,9 +27,8 @@ Ox.doc <f> Generates documentation for annotated JavaScript
order <[s]> Order of returns, arguments, properties
Present if the type of the item is "function"
properties <[o]|u> Properties (array of doc objects)
Present if the <code>type</code> of the item is
<code>"event"</code>, <code>"function"</code>
or <code>"object"</code>.
May be present if the `type` of the item is `"event"`,
`"function"` or `"object"`.
section <s|u> Section in the file
source <[o]> Source code (array of tokens)
column <n> Column
@ -38,8 +36,7 @@ Ox.doc <f> Generates documentation for annotated JavaScript
type <s> Type (see Ox.tokenize for a list of types)
value <s> Value
returns <[o]> Return values (array of doc objects)
Present if the <code>type</code> of the item is
<code>"function"</code>.
Present if the `type` of the item is `"function"`.
summary <s> One-line summary, with some Markdown
See Ox.parseMarkdown for details
tests <[o]> Tests (array of test objects)
@ -467,9 +464,8 @@ Ox.doc = (function() {
/*@
Ox.identify <f> Returns the type of a JavaScript identifier
(str) -> <s> Type
Type can be <code>constant</code>, <code>identifier</code>,
<code>keyword</code>, <code>method</code>, <code>object</code> or
<code>property</code>
Type can be `constant`, `identifier`, `keyword`, `method`, `object` or
`property`.
@*/
Ox.identify = (function() {
// see https://developer.mozilla.org/en/JavaScript/Reference
@ -852,11 +848,8 @@ Ox.tokenize <f> Tokenizes JavaScript
column <n> Column of the token
line <n> Line of the token
type <s> Type of the token
Type can be <code>"comment"</code>, <code>"error"</code>,
<code>"identifier"</code>, <code>"linebreak"</code>,
<code>"number"</code>, <code>"operator"</code>,
<code>"regexp"</code>, <code>"string"</code> or
<code>"whitespace"</code>
Type can be `"comment"`, `"error"`, `"identifier"`, `"linebreak"`,
`"number"`, `"operator"`, `"regexp"`, `"string"` or `"whitespace"`
value <s> Value of the token
source <s> JavaScript source code
> Ox.tokenize('// comment\nvar foo = bar / baz;').length