From 9b26545d0260aaea8521278916528a8f40991ed6 Mon Sep 17 00:00:00 2001
From: Thorsten Lorenz
Date: Fri, 25 Apr 2014 16:18:14 -0400
Subject: [PATCH] updating API docs
---
README.md | 18 ++++++++++++++----
index.js | 3 ++-
2 files changed, 16 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 1db2f7b..07d1ec2 100644
--- a/README.md
+++ b/README.md
@@ -105,7 +105,7 @@ In order to make your wicked API pages appear properly styled, please [install t
index.js
,
-lineno 23
+lineno 25
@@ -162,14 +162,24 @@ by wicked under the hood.
(false) if true, the temp directory into which wiki is checked out will not be removed when done |
-nocommit(false) |
+nocommit |
Boolean
|
<optional>
|
-if true, the updated wiki will not be committed automatically |
+(false) if true, the updated wiki will not be committed automatically |
+
+
+toc |
+
+Boolean
+ |
+
+<optional>
+ |
+(false) if true, a table of contents is added to each generated wiki |
loglevel |
@@ -207,7 +217,7 @@ by wicked under the hood.
index.js
,
-lineno 27
+lineno 29
diff --git a/index.js b/index.js
index 060fbf3..e1b1a64 100644
--- a/index.js
+++ b/index.js
@@ -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.} jsdocargs consumed by jsdoc
* @param {Function(Error)} cb called back when wicked finished generating the wiki page