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

correct documentation, use markdown

Browse source
This commit is contained in:
rolux 2012-05-30 13:31:42 +02:00
parent ca05f24a6a
commit 1c98a3198a
1 changed files with 7 additions and 3 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

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

@ -20,7 +20,7 @@ Ox.doc <f> Generates documentation for annotated JavaScript
file <s> File name file <s> File name
line <n> Line number line <n> Line number
name <s> Name of the item name <s> Name of the item
order <[s]> Order of signature, arguments, properties order <[s]> Order of returns, arguments, properties
Present if the type of the item is "function" Present if the type of the item is "function"
properties <[o]|u> Properties (array of doc objects) properties <[o]|u> Properties (array of doc objects)
Present if the <code>type</code> of the item is Present if the <code>type</code> of the item is
@ -114,7 +114,7 @@ Ox.doc = (function() {
'\'"'.indexOf(matches[2].slice(-2, -1)) > -1 '\'"'.indexOf(matches[2].slice(-2, -1)) > -1
) ? Ox.extend( ) ? Ox.extend(
parseName(matches[1]), parseName(matches[1]),
parseType(matches[2]), parseTypes(matches[2]),
{summary: matches[3].trim()} {summary: matches[3].trim()}
) : null; ) : null;
} }
@ -158,6 +158,10 @@ Ox.doc = (function() {
} }
} }
}); });
item.summary = Ox.parseMarkdown(item.summary);
if (item.description) {
item.description = Ox.parseMarkdown(item.description)
}
if (item.types[0] == 'function') { if (item.types[0] == 'function') {
item.order = Ox.unique(order); item.order = Ox.unique(order);
} }
@ -303,7 +307,7 @@ Ox.doc = (function() {
} }
return node; return node;
} }
function parseType(string) { function parseTypes(string) {
// returns {types: [""]} // returns {types: [""]}
// or {types: [""], default: ""} // or {types: [""], default: ""}
// or {types: [""], super: ""} // or {types: [""], super: ""}