Added more help text

lsmith · Sep 7, 2011 · 20ff8b5 · 20ff8b5
1 parent 4ac0d94
commit 20ff8b5
Showing 1 changed file with 19 additions and 4 deletions.
diff --git a/lib/help.js b/lib/help.js
@@ -1,7 +1,10 @@
 YUI.add('help', function(Y) {
 
     var help = [
-        "YUI Doc generates api documentation from a modified JavaDoc syntax.",
+        "",
+        "YUI Doc generates API documentation from a modified JavaDoc syntax.",
+        "",
+        "Current version ({VERSION})",
         "",
         "Usage: yuidoc [options] [input path]",
         "",
@@ -14,14 +17,26 @@ YUI.add('help', function(Y) {
         "           for api documentation. (defaults to .js)",
         "  -x, --exclude <comma sep list of directorues> Directorys to exclude from parsing ",
         "           (defaults to '.DS_Store,.svn,CVS,.git,build_rollup_tmp,build_tmp')",
-        "",
-        ""
+        "  -v, --version Show the current YUIDoc version",
+        "  --project-version Set the doc version for the template",
+        "  -N, --no-color Turn off terminal colors (for automation)",
+        "  -n, --norecurse Do not recurse directories (default is to recurse)",
+        "  -S, --selleck Look for Selleck component data and attach to API meta data",
+        "  -V, --view Dump the Handlebars.js view data instead of writing template files",
+        "  -p, --parse-only Only parse the API docs and create the JSON data, do not render templates",
+        "  -o, --out <directory path> Path to put the generated files (defaults to ./out)",
+        "  -t, --themedir <directory path> Path to a custom theme directory containing Handlebars templates",
+        "  -h, --help Show this help",
+        "  -T, --theme <simple|default> Choose one of the built in themes (default is default)",
+        "  [input path] Supply a list of paths (shell globbing is handy here)",
     ].join('\n');
 
 
 
     Y.showHelp = function() {
-        console.error(help);
+        console.error(Y.Lang.sub(help, {
+            VERSION: Y.packageInfo.version
+        }));
         process.exit(1);
     }
 });