Merge branch 'edge'

Author: neogeek

CHANGELOG.md

@@ -1,5 +1,11 @@
 #Changelog
 
+##0.0.7 (August 18, 2014)
+
+- Added support for examples tag.
+- Added support for returns tag.
+- Added both `bower_components` and `gulpfile` to default walk exceptions.
+
 ##0.0.6 (August 17, 2014)
 
 - Added support for custom Handlebars templates.

lib/helpers.js

@@ -6,6 +6,10 @@ module.exports = function (hbs) {
         return a === b ? options.fn(this) : options.inverse(this);
     });
 
+    hbs.registerHelper('ifCondMatch', function (a, b, options) {
+        return String(a).match(new RegExp(b, 'i')) ? options.fn(this) : options.inverse(this);
+    });
+
     hbs.registerHelper('formatName', function (name) {
         return String(name).replace(/\.prototype/g, '');
     });

lib/utils.js

@@ -64,7 +64,7 @@ module.exports.walk = function (dir, opts) {
     }
 
     if (!opts.exception) {
-        opts.exception = /\.git|\.min|node_modules|test|gruntfile/i;
+        opts.exception = /\.git|\.min|node_modules|bower_components|test|gruntfile|gulpfile/i;
     }
 
     if (fs.existsSync(dir) && fs.statSync(dir).isDirectory()) {

package.json

@@ -1,7 +1,7 @@
 {
     "name": "doxdox",
     "description": "HTML and Markdown documentation generator.",
-    "version": "0.0.6",
+    "version": "0.0.7",
     "bin": "./bin/doxdox",
     "license": "MIT",
     "dependencies": {

templates/bootstrap.hbs

@@ -238,17 +238,23 @@ pre .hljs {
 
                                 {{/if}}
 
-                                {{#if description.body}}
-
                                 <section class="examples">
 
                                     <h3>Examples</h3>
 
                                     {{{description.body}}}
 
-                                </section>
+                                    {{#each tags}}
 
-                                {{/if}}
+                                        {{#ifCond type "example"}}
+
+                                            <pre><code>{{string}}</code></pre>
+
+                                        {{/ifCond}}
+
+                                    {{/each}}
+
+                                </section>
 
                                 <section class="code">
 
@@ -262,11 +268,11 @@ pre .hljs {
 
                                 {{#each tags}}
 
-                                    {{#ifCond type "return"}}
+                                    {{#ifCondMatch type "return"}}
 
                                         <p>{{#each types}}<code>{{.}}</code> {{/each}} {{{description}}}</p>
 
-                                    {{/ifCond}}
+                                    {{/ifCondMatch}}
 
                                 {{/each}}
 

templates/markdown.hbs

@@ -40,13 +40,19 @@
 
 {{/if}}
 
-{{#if description.body}}
-
 ###Examples
 
 {{{description.body}}}
 
-{{/if}}
+{{#each tags}}{{#ifCond type "example"}}```
+{{{string}}}
+```{{/ifCond}}{{/each}}
+
+###Returns
+
+{{#each tags}}{{#ifCondMatch type "return"}}
+{{#each types}}`{{.}}` {{/each}} {{{description}}}
+{{/ifCondMatch}}{{/each}}
 
 {{/if}}{{/unless}}{{/each}}{{/each}}