Skip to content

Commit

Permalink
updating API docs
Browse files Browse the repository at this point in the history
  • Loading branch information
thlorenz committed Apr 25, 2014
1 parent d9619b9 commit 9b26545
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 5 deletions.
18 changes: 14 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -105,7 +105,7 @@ In order to make your wicked API pages appear properly styled, please [install t
<li>
<a href="https://github.com/thlorenz/wicked/blob/master/index.js">index.js</a>
<span>, </span>
<a href="https://github.com/thlorenz/wicked/blob/master/index.js#L23">lineno 23</a>
<a href="https://github.com/thlorenz/wicked/blob/master/index.js#L25">lineno 25</a>
</li>
</ul></dd>
</dl>
Expand Down Expand Up @@ -162,14 +162,24 @@ by wicked under the hood.</p>
<td class="description last"><p>(false) if true, the temp directory into which wiki is checked out will <strong>not be removed</strong> when done</p></td>
</tr>
<tr>
<td class="name"><code>nocommit(false)</code></td>
<td class="name"><code>nocommit</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>if true, the updated wiki will <strong>not be committed automatically</strong></p></td>
<td class="description last"><p>(false) if true, the updated wiki will <strong>not be committed automatically</strong></p></td>
</tr>
<tr>
<td class="name"><code>toc</code></td>
<td class="type">
<span class="param-type">Boolean</span>
</td>
<td class="attributes">
&lt;optional><br>
</td>
<td class="description last"><p>(false) if true, a table of contents is added to each generated wiki</p></td>
</tr>
<tr>
<td class="name"><code>loglevel</code></td>
Expand Down Expand Up @@ -207,7 +217,7 @@ by wicked under the hood.</p>
<li>
<a href="https://github.com/thlorenz/wicked/blob/master/index.js">index.js</a>
<span>, </span>
<a href="https://github.com/thlorenz/wicked/blob/master/index.js#L27">lineno 27</a>
<a href="https://github.com/thlorenz/wicked/blob/master/index.js#L29">lineno 29</a>
</li>
</ul></dd>
</dl>
Expand Down
3 changes: 2 additions & 1 deletion index.js
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,8 @@ function tellmeWhere(repodir, cb) {
* @function
* @param {Object} args consumed by wicked
* @param {Boolean=} args.noclean (false) if true, the temp directory into which wiki is checked out will **not be removed** when done
* @param {Boolean=} args.nocommit(false) if true, the updated wiki will **not be committed automatically**
* @param {Boolean=} args.nocommit (false) if true, the updated wiki will **not be committed automatically**
* @param {Boolean=} args.toc (false) if true, a table of contents is added to each generated wiki
* @param {String=} args.loglevel (info) level at which to log: silly|verbose|info|warn|error|silent
* @param {Array.<String>} jsdocargs consumed by jsdoc
* @param {Function(Error)} cb called back when wicked finished generating the wiki page
Expand Down

0 comments on commit 9b26545

Please sign in to comment.