dmd - npm Package Compare versions

Comparing version 0.1.2 to 0.1.3

helpers/parent-name.js

@@ -15,5 +15,7 @@ var a = require("array-tools");
                     : parentClass.alias || parentClass.name;
+            } else {
+                return this.memberof;
             }
-        }        
+        }
     });
 };

lib/dmd.js

@@ -19,3 +19,3 @@ "use strict";
 @param {number} [options.heading-depth] - Root heading depth, defaults to 2.
-@return {stream} A readable stream containing the rendered markdown
+@return {stream} A transform stream - pipe doclet data in to receive rendered markdown.
 @alias module:dmd
@@ -22,0 +22,0 @@ */

package.json

 {
   "name": "dmd",
   "author": "Lloyd Brookes <[e-mail]>",
-  "version": "0.1.2",
+  "version": "0.1.3",
   "description": "dmd",
@@ -6,0 +6,0 @@ "repository": "https://github.com/75lb/dmd.git",

README.md

@@ -51,86 +51,5 @@ [![view on npm](http://img.shields.io/npm/v/dmd.svg)](https://www.npmjs.org/package/dmd)
 
-##Templating
-Running `jsdoc2md` without a `--template` generates documentation with the default template, which looks like this:
-
-    {{>index}}
-    {{>modules}}
-    {{>globals}}
-    {{>others}}
+##Plugins
+* [dmd-examples-highlight](https://github.com/75lb/dmd-examples-highlight)
     
-###{{>index}}
-Only output if there are at least two modules defined. 
-
-    #Index
-    
-    * Modules
-      * {{>module-name}}
-        * {{>member-names}}
-    * Global
-      * {{>global-name}}
-
-###{{>modules}}
-Outputs one {{>module}} partial per module.
-
-###{{>globals}}
-
-    #Global
-    {{>global-index}}
-    {{>members}}
-
-###{{>members}}
-
-    {{#each (members in=data)}}{{>member}}{{/each~}}
-    {{#each (functions in=data)}}{{>function}}{{/each~}}
-    {{#each (namespaces in=data)}}{{>namespace}}{{/each~}}
-    {{#each (constants in=data)}}{{>constant}}{{/each~}}
-    {{#each (typedefs in=data)}}{{>typedef}}{{/each~}}
-    {{#each (events in=data)}}{{>event}}{{/each~}}
-    {{#each (classes in=data)}}{{>class}}{{/each~}}
-
-###{{>module}}
-
-    {{>head}}
-    {{>body}}
-    {{>module-exported}}  (either a class with index, function or object with index)
-
-###{{>head}}
-
-    {{>anchor}}
-    {{>heading}}{{>name}}
-    
-###{{>body}}
-
-    {{>fields}}
-    
-###{{>fields}}
-
-    {{>description~}}
-    {{>params~}}
-    {{>deprecated~}}
-    {{>augments~}}
-    {{>memberof~}}
-    {{>type~}}
-    {{>default~}}
-    {{>returns~}}
-    {{>access~}}
-    {{>enum~}}
-    {{>readOnly~}}
-    {{>since~}}
-    {{>version~}}
-    {{>authors~}}
-    {{>license~}}
-    {{>copyright~}}
-    {{>examples~}}
-
-###{{>module-exported}}
-
-    {{>class}}, {{>function}} or {{>module-index}} and {{>members}}
-
-###{{>class}}
-
-    {{>head}}
-    {{>body~}}
-    {{>class-members-index~}}
-    {{>members-grouped~}}
-    
 #API Reference
@@ -150,5 +69,5 @@ <a name="module_dmd"></a>
 
-**Returns**: `stream` - A readable stream containing the rendered markdown  
+**Returns**: `stream` - A transform stream - pipe doclet data in to receive rendered markdown.  
 
 
 *documented by [jsdoc-to-markdown](https://github.com/75lb/jsdoc-to-markdown)*

No alert changes

Improved metrics

Lines of code

440

increased by0.46%

Worsened metrics

Total package byte prevSize

28371

decreased by-9.47%

Number of lines in readme file

72

decreased by-52.94%

No dependency changes