jsdoc-to-markdown - npm Package Compare versions

Comparing version 0.2.10 to 0.2.11

package.json

 {
   "name": "jsdoc-to-markdown",
   "author": "Lloyd Brookes",
-  "version": "0.2.10",
-  "description": "Render JSdoc documentation as markdown",
+  "version": "0.2.11",
+  "description": "Markdown API documentation generator, good for Github projects",
   "repository": "https://github.com/75lb/jsdoc-to-markdown",
@@ -7,0 +7,0 @@ "main": "lib/jsdoc-to-markdown.js",

README.md

@@ -40,2 +40,5 @@ [![view on npm](http://img.shields.io/npm/v/jsdoc-to-markdown.svg)](https://www.npmjs.org/package/jsdoc-to-markdown)
 
+###As a grunt plug-in
+See [grunt-jsdoc-to-markdown](https://github.com/75lb/grunt-jsdoc-to-markdown).
+
 ##Usage
@@ -75,2 +78,3 @@ Document your source code using [correct jsdoc syntax](http://usejsdoc.org), then run it through `jsdoc2md`.
 **Params**
+
 - options `object` - The render options
@@ -90,2 +94,3 @@ - [template] `string` - A handlebars template to insert your documentation into.
 **Params**
+
 - err `object` - An error instance if applicable, else `null`
@@ -92,0 +97,0 @@ - result `string` - the rendered markdown

test/input/amd/file-set.js

@@ -21,3 +21,8 @@ /**
     */
-    var FileSet = function(num){};
+    var FileSet = function(num){
+        /**
+        an instance ting
+        */
+        this.instie = 0;
+    };
 
@@ -24,0 +29,0 @@ /**

test/output/amd/file-set.md

@@ -11,2 +11,7 @@ <a name="module_file-set"></a>
 ```
+<a name="module_file-set#instie"></a>
+###file-set.instie
+an instance ting
+
+  
 <a name="module_file-set#files"></a>
@@ -22,3 +27,4 @@ ###file-set.files
 **Params**
+
 - paths `array` - the paths to delete
 

test/output/commonjs/file-set.md

@@ -7,2 +7,3 @@ <a name="module_file-set"></a>
 **Params**
+
 -  `Array.<string>` - a list of file patterns
@@ -27,3 +28,4 @@
 **Params**
+
 - paths `array` - the paths to delete
 

test/output/commonjs/fileset-with-index.md

@@ -7,2 +7,3 @@ <a name="module_file-set"></a>
 **Params**
+
 -  `Array.<string>` - a list of file patterns
@@ -31,3 +32,4 @@
 **Params**
+
 - paths `array` - the paths to delete
 

test/output/commonjs/function.md

@@ -8,2 +8,3 @@ <a name="module_function"></a>
 **Params**
+
 -  `string` - The input string
@@ -10,0 +11,0 @@ -  `object` - a second input

test/output/commonjs/jacket.md

@@ -7,2 +7,3 @@ <a name="module_jacket"></a>
 **Params**
+
 - input `string` - the input
@@ -9,0 +10,0 @@

test/output/commonjs/object-with-index.md

@@ -37,2 +37,3 @@ <a name="module_object"></a>
 **Params**
+
 - four `string` - The input string
@@ -39,0 +40,0 @@ - five `object` - a second input

test/output/commonjs/object.md

@@ -32,2 +32,3 @@ <a name="module_object"></a>
 **Params**
+
 - four `string` - The input string
@@ -34,0 +35,0 @@ - five `object` - a second input

test/output/commonjs/sum-alias.md

@@ -7,2 +7,3 @@ <a name="module_sum-alias"></a>
 **Params**
+
 - a `number` - first number
@@ -9,0 +10,0 @@ - b `number` - second number

test/output/commonjs/sum.md

@@ -7,2 +7,3 @@ <a name="module_sum"></a>
 **Params**
+
 - a `number` - first number
@@ -9,0 +10,0 @@ - b `number` - second number

test/output/globals/all.md

@@ -116,2 +116,3 @@ #Global scope
 **Params**
+
 - filename `string` - the filename
@@ -162,2 +163,3 @@ - done [onComplete](#onComplete) - the callback
 **Params**
+
 - one `string` - The input string
@@ -168,2 +170,3 @@
 **Params**
+
 - one `string` - The input string
@@ -175,2 +178,3 @@ - two `object`
 **Params**
+
 - one `string` - The input string
@@ -189,2 +193,3 @@ - [two] `object` - this one is optional
 **Params**
+
 - one `string` - The input string
@@ -207,2 +212,3 @@ - two `object` - a second input
 **Params**
+
 - one `string` - The input string
@@ -223,2 +229,3 @@ - two `object` - a second input
 **Params**
+
 - options `object` - the function options
@@ -231,2 +238,3 @@ - one `string` - first option
 **Params**
+
 - options `Object` - the function options
@@ -239,2 +247,3 @@
 **Params**
+
 - ...prop `string` - the property(s) as input
@@ -251,2 +260,3 @@
 **Params**
+
 - x [NumberLike](#NumberLike) - The magic number.
@@ -257,2 +267,3 @@
 **Params**
+
 - options `object` - the function options
@@ -273,2 +284,3 @@ - one `string` - first option
 **Params**
+
 - input `object` - an input
@@ -301,2 +313,3 @@ - [options] `object` - optional shit
 **Params**
+
 - one `string` - The input string
@@ -331,2 +344,3 @@ - two `object` - a second input
 **Params**
+
 - [options] `object` - optional shit
@@ -351,2 +365,3 @@
 **Params**
+
 - input `object` - an input
@@ -383,2 +398,3 @@ - [options] `object` - optional shit
 **Params**
+
 - one `string` - The input string
@@ -418,2 +434,3 @@ - two `object` - a second input
 **Params**
+
 - one `string` - an input
@@ -428,2 +445,3 @@ - ...args `string` - the property(s) as input
 **Params**
+
 - err `object` - an error, or `null`
@@ -430,0 +448,0 @@ - result `string` - the result info

test/output/globals/callback.md

@@ -5,2 +5,3 @@ #Global scope
 **Params**
+
 - filename `string` - the filename
@@ -14,2 +15,3 @@ - done [onComplete](#onComplete) - the callback
 **Params**
+
 - err `object` - an error, or `null`
@@ -16,0 +18,0 @@ - result `string` - the result info

test/output/globals/class-all.md

@@ -13,2 +13,3 @@ #Global scope
 **Params**
+
 - input `object` - an input
@@ -41,2 +42,3 @@ - [options] `object` - optional shit
 **Params**
+
 - one `string` - The input string
@@ -43,0 +45,0 @@ - two `object` - a second input

test/output/globals/class-constructors.md

@@ -20,2 +20,3 @@ #Global scope
 **Params**
+
 - [options] `object` - optional shit
@@ -40,2 +41,3 @@
 **Params**
+
 - input `object` - an input
@@ -42,0 +44,0 @@ - [options] `object` - optional shit

test/output/globals/class-methods.md

@@ -14,2 +14,3 @@ #Global scope
 **Params**
+
 - one `string` - The input string
@@ -16,0 +17,0 @@ - two `object` - a second input

test/output/globals/functions.md

@@ -44,2 +44,3 @@ #Global scope
 **Params**
+
 - one `string` - The input string
@@ -50,2 +51,3 @@
 **Params**
+
 - one `string` - The input string
@@ -57,2 +59,3 @@ - two `object`
 **Params**
+
 - one `string` - The input string
@@ -71,2 +74,3 @@ - [two] `object` - this one is optional
 **Params**
+
 - one `string` - The input string
@@ -89,2 +93,3 @@ - two `object` - a second input
 **Params**
+
 - one `string` - The input string
@@ -91,0 +96,0 @@ - two `object` - a second input

test/output/globals/options.md

@@ -5,2 +5,3 @@ #Global scope
 **Params**
+
 - options `object` - the function options
@@ -13,3 +14,4 @@ - one `string` - first option
 **Params**
+
 - options `Object` - the function options
 

test/output/globals/param-variable.md

@@ -7,2 +7,3 @@ #Global scope
 **Params**
+
 - ...prop `string` - the property(s) as input
@@ -18,2 +19,3 @@
 **Params**
+
 - one `string` - an input
@@ -20,0 +22,0 @@ - ...args `string` - the property(s) as input

test/output/globals/typedef.md

@@ -7,2 +7,3 @@ #Global scope
 **Params**
+
 - x [NumberLike](#NumberLike) - The magic number.
@@ -9,0 +10,0 @@

test/output/globals/types.md

@@ -5,2 +5,3 @@ #Global scope
 **Params**
+
 - options `object` - the function options
@@ -7,0 +8,0 @@ - one `string` - first option

test/render.js

@@ -43,1 +43,2 @@ "use strict";
 render("test/input/commonjs/file-set.js", "test/output/commonjs/fileset-with-index.md", "modules", true);
+render("test/input/amd/file-set.js", "test/output/amd/fileset-with-index.md", "modules", true);

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

61368

increased by1.92%

Number of package files

129

increased by1.57%

Lines of code

1023

increased by0.59%

Number of lines in readme file

98

increased by5.38%

No dependency changes