Skip to content

Commit

Permalink
Docs
Browse files Browse the repository at this point in the history
  • Loading branch information
tj committed Jun 26, 2010
1 parent b634ca1 commit da3f878
Show file tree
Hide file tree
Showing 3 changed files with 8 additions and 8 deletions.
6 changes: 3 additions & 3 deletions Readme.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,12 +3,12 @@
Dox is a JavaScript documentation generator written for [node](http://nodejs.org).

Dox is a 2 hour product of my frustration with documentation generators. I wanted
something that could parse my JavaScript using markdown and JSdoc tags, an easy
to use CLI, as well as a single deployment file, no external css or js, one file!
something that could parse my JavaScript using _markdown_ and _JSDoc_ tags, an easy
to use _executable_, as well as a _single deployment file_, no external css or js, one file!

## Features

* Supports JSdoc
* Supports JSDoc
* Markdown bodies
* Custom title / description
* Simple CLI `dox`
Expand Down
8 changes: 4 additions & 4 deletions docs.html
Original file line number Diff line number Diff line change
Expand Up @@ -196,7 +196,7 @@
<ul>
<li><strong>type</strong>: <em>String</em></li>
</ul>


</td>
<td class="code">
<pre><code><span class="keyword">var</span> <span class="variable">desc</span> = <span class="string">''</span>;</code></pre>
Expand Down Expand Up @@ -257,7 +257,7 @@ <h2></h2>
<li><p><strong>param</strong>: <em>Array</em> args</p></li>
<li><p><strong>api</strong>: <em>public</em></p></li>
</ul>


</td>
<td class="code">
<pre><code><span class="variable">exports</span>.<span class="variable">parse</span> = <span class="keyword">function</span>(<span class="variable">args</span>){
Expand Down Expand Up @@ -416,7 +416,7 @@ <h2></h2>
<span class="keyword">var</span> <span class="variable">part</span> = <span class="variable">part</span>.<span class="variable">replace</span>(<span class="regexp">/^ *\* ?/gm</span>, <span class="string">''</span>);
<span class="variable">blocks</span>.<span class="variable">push</span>({
<span class="variable">comment</span>: <span class="variable">markdown</span>.<span class="variable">parse</span>(<span class="variable">utils</span>.<span class="variable">toMarkdown</span>(<span class="variable">part</span>)),
<span class="variable">code</span>: <span class="variable">koala</span>.<span class="variable">render</span>(<span class="string">'.js'</span>, <span class="variable">utils</span>.<span class="variable">escape</span>(<span class="variable">next</span>))
<span class="variable">code</span>: <span class="variable">koala</span>.<span class="variable">render</span>(&<span class="variable">quot</span>;.<span class="variable">js</span>&<span class="variable">quot</span>;, <span class="variable">utils</span>.<span class="variable">escape</span>(<span class="variable">next</span>))
});
}
}
Expand Down Expand Up @@ -447,7 +447,7 @@ <h2></h2>
<li><p><strong>return</strong>: <em>Boolean</em></p></li>
<li><p><strong>api</strong>: <em>public</em></p></li>
</ul>


</td>
<td class="code">
<pre><code><span class="variable">exports</span>.<span class="variable">isPrivate</span> = <span class="keyword">function</span>(<span class="variable">str</span>) {
Expand Down
2 changes: 1 addition & 1 deletion lib/index.js
Original file line number Diff line number Diff line change
Expand Up @@ -242,7 +242,7 @@ var render = exports.render = function(str, file){
var part = part.replace(/^ *\* ?/gm, '');
blocks.push({
comment: markdown.parse(utils.toMarkdown(part)),
code: koala.render('.js', utils.escape(next))
code: koala.render(".js", utils.escape(next))
});
}
}
Expand Down

0 comments on commit da3f878

Please sign in to comment.