From 5e7e7ff85da3cdf6e12d73575474f49e639eb898 Mon Sep 17 00:00:00 2001 From: Dav Glass Date: Fri, 6 Jul 2012 15:23:30 -0500 Subject: [PATCH] Docs update --- conf/docs/project.json | 2 +- conf/yuidoc.json | 2 +- docs/args/partials/help.mustache | 2 +- output/api/classes/CLI.html | 2 +- output/api/classes/DocBuilder.html | 2 +- output/api/classes/DocParser.html | 2 +- output/api/classes/DocView.html | 2 +- output/api/classes/Files.html | 2 +- output/api/classes/Help.html | 2 +- output/api/classes/Main.html | 2 +- output/api/classes/Options.html | 2 +- output/api/classes/Server.html | 2 +- output/api/classes/Utils.html | 8 +-- output/api/classes/YUIDoc.html | 2 +- output/api/data.json | 8 +-- output/api/files/lib_builder.js.html | 2 +- output/api/files/lib_cli.js.html | 2 +- output/api/files/lib_docparser.js.html | 2 +- output/api/files/lib_docview.js.html | 2 +- output/api/files/lib_files.js.html | 2 +- output/api/files/lib_help.js.html | 2 +- output/api/files/lib_index.js.html | 2 +- output/api/files/lib_options.js.html | 2 +- output/api/files/lib_server.js.html | 2 +- output/api/files/lib_utils.js.html | 8 ++- output/api/files/lib_yuidoc.js.html | 2 +- output/api/index.html | 2 +- output/api/modules/yuidoc.html | 2 +- output/args/index.html | 2 +- output/assets/css/main.css | 80 +++++++++++--------------- output/index.html | 4 +- 31 files changed, 77 insertions(+), 83 deletions(-) diff --git a/conf/docs/project.json b/conf/docs/project.json index 32a067bd..ab193160 100644 --- a/conf/docs/project.json +++ b/conf/docs/project.json @@ -1,5 +1,5 @@ { "projectName": "YUIDoc - Javascript Documentation Tool", - "version": "0.3.14", + "version": "0.3.15", "yuiSeedUrl": "http://yui.yahooapis.com/3.5.1/build/yui/yui.js" } \ No newline at end of file diff --git a/conf/yuidoc.json b/conf/yuidoc.json index 819d5c8b..a1d4fb6e 100644 --- a/conf/yuidoc.json +++ b/conf/yuidoc.json @@ -1,7 +1,7 @@ { "name": "YUIDoc", "description": "YUIDoc documentation tool written in Javascript", - "version": "0.3.14", + "version": "0.3.15", "url": "http://github.com/yui/yuidoc/issues", "logo": "http://yuilibrary.com/img/yui-logo.png", "options": { diff --git a/docs/args/partials/help.mustache b/docs/args/partials/help.mustache index 0ba98a78..140787bb 100644 --- a/docs/args/partials/help.mustache +++ b/docs/args/partials/help.mustache @@ -1,7 +1,7 @@ YUI Doc generates API documentation from a modified JavaDoc syntax. -Current version (0.3.14) +Current version (0.3.15) Usage: yuidoc diff --git a/output/api/classes/CLI.html b/output/api/classes/CLI.html index 70a6b130..da662177 100644 --- a/output/api/classes/CLI.html +++ b/output/api/classes/CLI.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15
diff --git a/output/api/classes/DocBuilder.html b/output/api/classes/DocBuilder.html index fb501c32..9cd88224 100644 --- a/output/api/classes/DocBuilder.html +++ b/output/api/classes/DocBuilder.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/api/classes/DocParser.html b/output/api/classes/DocParser.html index a5cc8989..cab37841 100644 --- a/output/api/classes/DocParser.html +++ b/output/api/classes/DocParser.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/api/classes/DocView.html b/output/api/classes/DocView.html index 7f0bdeaa..0f7f5fef 100644 --- a/output/api/classes/DocView.html +++ b/output/api/classes/DocView.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/api/classes/Files.html b/output/api/classes/Files.html index 6539833c..dab9d6fd 100644 --- a/output/api/classes/Files.html +++ b/output/api/classes/Files.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/api/classes/Help.html b/output/api/classes/Help.html index d2332909..23876c8a 100644 --- a/output/api/classes/Help.html +++ b/output/api/classes/Help.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/api/classes/Main.html b/output/api/classes/Main.html index e55f9595..63ee8eb1 100644 --- a/output/api/classes/Main.html +++ b/output/api/classes/Main.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/api/classes/Options.html b/output/api/classes/Options.html index 9f97c5e3..22310dd1 100644 --- a/output/api/classes/Options.html +++ b/output/api/classes/Options.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/api/classes/Server.html b/output/api/classes/Server.html index 266900f9..0d349281 100644 --- a/output/api/classes/Server.html +++ b/output/api/classes/Server.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/api/classes/Utils.html b/output/api/classes/Utils.html index 76d2c2a3..6150d397 100644 --- a/output/api/classes/Utils.html +++ b/output/api/classes/Utils.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

@@ -398,7 +398,7 @@

fixType

- lib/utils.js:364 + lib/utils.js:368

@@ -502,7 +502,7 @@

getDirs

- lib/utils.js:268 + lib/utils.js:272

@@ -1384,7 +1384,7 @@

validatePaths

- lib/utils.js:295 + lib/utils.js:299

diff --git a/output/api/classes/YUIDoc.html b/output/api/classes/YUIDoc.html index 00acc356..2c9e44be 100644 --- a/output/api/classes/YUIDoc.html +++ b/output/api/classes/YUIDoc.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/api/data.json b/output/api/data.json index 8bcf4827..17c80399 100644 --- a/output/api/data.json +++ b/output/api/data.json @@ -2,7 +2,7 @@ "project": { "name": "YUIDoc", "description": "YUIDoc documentation tool written in Javascript", - "version": "0.3.14", + "version": "0.3.15", "url": "http://github.com/yui/yuidoc/issues", "logo": "http://yuilibrary.com/img/yui-logo.png" }, @@ -2074,7 +2074,7 @@ }, { "file": "lib/utils.js", - "line": 268, + "line": 272, "description": "Walks the tree from this dir and returns all the subdirs", "itemtype": "method", "name": "getDirs", @@ -2094,7 +2094,7 @@ }, { "file": "lib/utils.js", - "line": 295, + "line": 299, "description": "Make sure all the paths passed are directories and that they are not in the ignore list.", "itemtype": "method", "name": "validatePaths", @@ -2117,7 +2117,7 @@ }, { "file": "lib/utils.js", - "line": 364, + "line": 368, "description": "Takes a type string and converts it to a \"First letter upper cased\" type. e.g. `(string -> String, object -> Object)`", "itemtype": "method", "name": "fixType", diff --git a/output/api/files/lib_builder.js.html b/output/api/files/lib_builder.js.html index 9827421d..66a442a0 100644 --- a/output/api/files/lib_builder.js.html +++ b/output/api/files/lib_builder.js.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/api/files/lib_cli.js.html b/output/api/files/lib_cli.js.html index 8e003374..b5802e53 100644 --- a/output/api/files/lib_cli.js.html +++ b/output/api/files/lib_cli.js.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/api/files/lib_docparser.js.html b/output/api/files/lib_docparser.js.html index a699a667..e9d3b229 100644 --- a/output/api/files/lib_docparser.js.html +++ b/output/api/files/lib_docparser.js.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/api/files/lib_docview.js.html b/output/api/files/lib_docview.js.html index 480f0904..33a8633b 100644 --- a/output/api/files/lib_docview.js.html +++ b/output/api/files/lib_docview.js.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/api/files/lib_files.js.html b/output/api/files/lib_files.js.html index e1e3ae32..b51aa863 100644 --- a/output/api/files/lib_files.js.html +++ b/output/api/files/lib_files.js.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/api/files/lib_help.js.html b/output/api/files/lib_help.js.html index 6254e057..836d2213 100644 --- a/output/api/files/lib_help.js.html +++ b/output/api/files/lib_help.js.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/api/files/lib_index.js.html b/output/api/files/lib_index.js.html index 42078598..7d775b61 100644 --- a/output/api/files/lib_index.js.html +++ b/output/api/files/lib_index.js.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/api/files/lib_options.js.html b/output/api/files/lib_options.js.html index 187e4596..4af70aae 100644 --- a/output/api/files/lib_options.js.html +++ b/output/api/files/lib_options.js.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/api/files/lib_server.js.html b/output/api/files/lib_server.js.html index 285f6563..500dfbd8 100644 --- a/output/api/files/lib_server.js.html +++ b/output/api/files/lib_server.js.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/api/files/lib_utils.js.html b/output/api/files/lib_utils.js.html index 085ec01a..ebf433f4 100644 --- a/output/api/files/lib_utils.js.html +++ b/output/api/files/lib_utils.js.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

@@ -345,10 +345,14 @@

File: lib/utils.js

} var dirs = fs.readdirSync(dir); dirs.forEach(function(d) { + var p = path.join(dir, d); if (d.indexOf('.') === 0) { return; } - var p = path.join(dir, d); + if (d === 'node_modules') { + Y.log('Skipping node_modules directory while scanning for yuidoc.json', 'warn', 'yuidoc'); + return; + } if (projectData) { return; } diff --git a/output/api/files/lib_yuidoc.js.html b/output/api/files/lib_yuidoc.js.html index a3780647..5296a2ec 100644 --- a/output/api/files/lib_yuidoc.js.html +++ b/output/api/files/lib_yuidoc.js.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/api/index.html b/output/api/index.html index 06222482..a77e16be 100644 --- a/output/api/index.html +++ b/output/api/index.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/api/modules/yuidoc.html b/output/api/modules/yuidoc.html index 17110512..005222ad 100644 --- a/output/api/modules/yuidoc.html +++ b/output/api/modules/yuidoc.html @@ -19,7 +19,7 @@

- API Docs for: 0.3.14 + API Docs for: 0.3.15

diff --git a/output/args/index.html b/output/args/index.html index a9e39acc..7b739c5c 100644 --- a/output/args/index.html +++ b/output/args/index.html @@ -45,7 +45,7 @@

Running YUIDoc on the Command Line

YUI Doc generates API documentation from a modified JavaDoc syntax.
 
-Current version (0.3.14)
+Current version (0.3.15)
 
 Usage: yuidoc <options> <input path>
 
diff --git a/output/assets/css/main.css b/output/assets/css/main.css
index d1d1609c..143e5ca7 100644
--- a/output/assets/css/main.css
+++ b/output/assets/css/main.css
@@ -30,50 +30,6 @@ body {
     padding: 0;
 }
 
-
-ul.links {
-    list-style-type: none;
-    padding-left: 0;
-}
-
-ul.links li {
-    margin-bottom: 8px;
-}
-
-ul.links .button {
-    display: block;
-    text-align: left;
-}
-
-.crumbs {
-    background: whiteSmoke;
-    background: -moz-linear-gradient(top,#DCDBD9 0,#F6F5F3 100%);
-    background: -webkit-gradient(linear,left top,left bottom,color-stop(0%,#DCDBD9),color-stop(100%,#F6F5F3));
-    filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#dcdbd9',endColorstr='#F6F5F3',GradientType=0);
-    border-top: 1px solid #DFDFDF;
-    border-bottom: 1px solid #DFDFDF;
-    padding: 0.25em 1.25em 0.25em;
-    margin-bottom: 0.75em;
-}
-.crumbs a, .crumbs a:visited {
-    color: #30418C;
-}
-
-#hd {
-    background: whiteSmoke;
-    background: -moz-linear-gradient(top,#DCDBD9 0,#F6F5F3 100%);
-    background: -webkit-gradient(linear,left top,left bottom,color-stop(0%,#DCDBD9),color-stop(100%,#F6F5F3));
-    filter: progid:DXImageTransform.Microsoft.gradient(startColorstr='#dcdbd9',endColorstr='#F6F5F3',GradientType=0);
-    border-bottom: 1px solid #DFDFDF;
-    padding: 0.75em 0 0.5em;
-    margin-bottom: 15px;
-}
-
-#hd img {
-    margin-right: 10px;
-    vertical-align: middle;
-}
-
 /* -- Links ----------------------------------------------------------------- */
 a {
     color: #356de4;
@@ -144,7 +100,7 @@ code, kbd, pre, samp {
     line-height: 1.35;
 }
 
-p code, p kbd, p samp {
+p code, p kbd, p samp, li code, li kbd, li samp {
     background: #FCFBFA;
     border: 1px solid #EFEEED;
     padding: 0 3px;
@@ -234,6 +190,7 @@ th {
 /* -- Layout and Content ---------------------------------------------------- */
 #doc {
     margin: auto;
+    max-width: 1200px;
     min-width: 960px;
     padding-bottom: 50px;
 }
@@ -397,3 +354,36 @@ th {
 
 /* List with extra vertical spacing between items. */
 .spaced li { margin: 0.8em 0; }
+ada;
+    *padding-bottom: 5px;
+}
+
+.button:hover {
+    border-color: #466899;
+    -moz-box-shadow: 0 1px 4px rgba(0, 0, 0, 0.5);
+    -webkit-box-shadow: 0 1px 4px rgba(0, 0, 0, 0.5);
+    box-shadow: 0 1px 4px rgba(0, 0, 0, 0.5);
+    color: #fff;
+    text-decoration: none;
+    -moz-text-shadow: 1px 1px 0 #222;
+    -webkit-text-shadow: 1px 1px 0 #222;
+    text-shadow: 1px 1px 0 #222;
+
+    background: #6396D8; /* old browsers */
+    background: -moz-linear-gradient(top, #6396D8 0%, #5A83BC 50%, #547AB7 51%, #466899 100%); /* firefox */
+    background: -webkit-gradient(linear, left top, left bottom, color-stop(0%,#6396D8), color-stop(50%,#5A83BC), color-stop(51%,#547AB7), color-stop(100%,#466899)); /* webkit */
+    filter: progid:DXImageTransform.Microsoft.gradient( startColorstr='#6396D8', endColorstr='#466899',GradientType=0 ); /* ie */
+}
+
+/* Big download button, like on the Home page. */
+.button.download {
+    display: block;
+    font-size: 18px;
+    margin: 0 0 1em;
+    padding: 9px 17px 8px;
+}
+
+.newwindow { text-align: center; }
+
+/* List with extra vertical spacing between items. */
+.spaced li { margin: 0.8em 0; }
diff --git a/output/index.html b/output/index.html
index db3bb6fa..19fa131b 100644
--- a/output/index.html
+++ b/output/index.html
@@ -24,7 +24,7 @@ 
YUIDoc - Javascript Docume
     

         

             

-                
Welcome to YUIDoc 0.3.14!

+                
Welcome to YUIDoc 0.3.15!

 
 

     
YUIDoc is a Node.js application that
@@ -137,7 +137,7 @@ 
Table of Contents