Socket
Socket
Sign inDemoInstall

jsdoc-to-markdown

Package Overview
Dependencies
Maintainers
1
Versions
130
Alerts
File Explorer

Advanced tools

License
Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

jsdoc-to-markdown - npm Package Compare versions

Comparing version 0.2.3 to 0.2.4

helpers/array-slice.js
helpers/regexp-test.js
helpers/string-split.js
test/input/globals/enum.js
test/input/globals/param-variable.js
test/output/globals/enum.md
test/output/globals/param-variable.md

11

helpers/link-to.js

@@ -14,3 +14,2 @@ var a = require("array-tools"),

var fullName = longname;
fullName = fullName.replace(/</g, "&lt;").replace(/>/g, "&gt;");
longname = longname.match(re)[1];

@@ -25,5 +24,9 @@ }

var linked = a.findWhere(options.data.root, { longname: longname });
return linked
? util.format("[%s](#%s)", fullName ? fullName.replace(longname, linked.name) : linked.name, handlebars.helpers.anchorName(longname))
: "`" + (fullName || longname) + "`";
if (linked){
if (fullName) fullName = fullName.replace(/</g, "&lt;").replace(/>/g, "&gt;");
var linkText = fullName ? fullName.replace(longname, linked.name) : linked.name;
return util.format("[%s](#%s)", linkText, handlebars.helpers.anchorName(longname))
} else {
return "`" + (fullName || longname) + "`";
}
}

@@ -30,0 +33,0 @@ }

2

helpers/method-sig.js

@@ -6,3 +6,3 @@ var a = require("array-tools");

return a.arrayify(params).filter(function(param){
return param.name && param.name.indexOf(".") === -1;
return param.name && !/\w+\.\w+/.test(param.name);
}).map(function(param){

@@ -9,0 +9,0 @@ if (param.variable){

2

package.json
{
"name": "jsdoc-to-markdown",
"author": "Lloyd Brookes",
"version": "0.2.3",
"version": "0.2.4",
"description": "Render JSdoc documentation as markdown",

@@ -6,0 +6,0 @@ "repository": "https://github.com/75lb/jsdoc-to-markdown",

6

README.md

@@ -66,3 +66,3 @@ [![view on npm](http://img.shields.io/npm/v/jsdoc-to-markdown.svg)](https://www.npmjs.org/package/jsdoc-to-markdown)

####Example
**Example**
```js

@@ -73,3 +73,3 @@ var jsdoc2md = require("jsdoc-to-markdown");

###jsdoc2md.render(options, done)
**Params**
- options `object` - The render options

@@ -82,3 +82,3 @@ - done [onRender](#module_jsdoc-to-markdown.onRender) - a callback invoked on completion

**Params**
- err `object` - An error instance if applicable, else `null`

@@ -85,0 +85,0 @@ - result `string` - the rendered markdown

4

test/output/amd/file-set.md

@@ -6,3 +6,3 @@ <a name="module_file-set"></a>

####Example
**Example**
```js

@@ -20,4 +20,4 @@ var cowFiles = FileSet("cow/*");

**Params**
- paths `array` - the paths to delete

8

test/output/commonjs/file-set.md

@@ -5,7 +5,7 @@ <a name="module_file-set"></a>

**Params**
- `Array.<string>` - a list of file patterns
- `Array.&lt;string&gt;` - a list of file patterns
####Example
**Example**
```js

@@ -25,4 +25,4 @@ var fileSet = require("file-set");

**Params**
- paths `array` - the paths to delete

8

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

@@ -5,7 +5,7 @@ <a name="module_file-set"></a>

**Params**
- `Array.<string>` - a list of file patterns
- `Array.&lt;string&gt;` - a list of file patterns
####Example
**Example**
```js

@@ -29,4 +29,4 @@ var fileSet = require("file-set");

**Params**
- paths `array` - the paths to delete

4

test/output/commonjs/function.md

@@ -5,3 +5,3 @@ <a name="module_function"></a>

**Params**
- `string` - The input string

@@ -16,5 +16,5 @@ - `object` - a second input

**Returns**: `object` | `string` - this return has several types
####Example
**Example**
```js
allTogether(true);
```

2

test/output/commonjs/jacket.md

@@ -5,3 +5,3 @@ <a name="module_jacket"></a>

**Params**
- input `string` - the input

@@ -8,0 +8,0 @@

6

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

@@ -27,3 +27,3 @@ <a name="module_object"></a>

**Author**: 75lb <75pound@gmail.com>
####Example
**Example**
```js

@@ -36,3 +36,3 @@ var allTogether = true;

**Params**
- four `string` - The input string

@@ -44,5 +44,5 @@ - five `object` - a second input

**Returns**: `object` | `string` - this return has several types
####Example
**Example**
```js
allTogether(true);
```

6

test/output/commonjs/object.md

@@ -22,3 +22,3 @@ <a name="module_object"></a>

**Author**: 75lb <75pound@gmail.com>
####Example
**Example**
```js

@@ -31,3 +31,3 @@ var allTogether = true;

**Params**
- four `string` - The input string

@@ -39,5 +39,5 @@ - five `object` - a second input

**Returns**: `object` | `string` - this return has several types
####Example
**Example**
```js
allTogether(true);
```

4

test/output/commonjs/sum-alias.md

@@ -5,3 +5,3 @@ <a name="module_sum-alias"></a>

**Params**
- a `number` - first number

@@ -12,5 +12,5 @@ - b `number` - second number

**Returns**: `number` - the result
####Example
**Example**
```js
var sum = require("sum");
```

4

test/output/commonjs/sum.md

@@ -5,3 +5,3 @@ <a name="module_sum"></a>

**Params**
- a `number` - first number

@@ -12,3 +12,3 @@ - b `number` - second number

**Returns**: `number` - the result
####Example
**Example**
```js

@@ -15,0 +15,0 @@ var sum = require("sum");

92

test/output/globals/all.md

@@ -17,6 +17,13 @@ #Global scope

**Author**: Lloyd Brookes <lloyd@brookes.com>
####Example
**Example**
```js
var CONST_TWO = true;
```
<a name="eFileType"></a>
###eFileType
Enum for the `type` value
**Enum** with properties: `NOEXIST`, `FILE`, `DIR`
**Read only**: true
**Type**: `number`
<a name="variable"></a>

@@ -38,3 +45,3 @@ ###variable

####Example
**Example**
```js

@@ -48,7 +55,7 @@ var another = 100;

####Example
**Example**
```js
var another = 100;
```
####Example
**Example**
```js

@@ -100,3 +107,3 @@ var next = "p";

**Author**: 75lb <75pound@gmail.com>
####Example
**Example**
```js

@@ -107,3 +114,3 @@ var allTogether = true;

###read(filename, done)
**Params**
- filename `string` - the filename

@@ -120,3 +127,3 @@ - done [onComplete](#onComplete) - the callback

####Example
**Example**
```js

@@ -129,7 +136,7 @@ var result = exampled();

####Example
**Example**
```js
var another = 100;
```
####Example
**Example**
```js

@@ -155,3 +162,3 @@ var next = "p";

###withParam(one)
**Params**
- one `string` - The input string

@@ -161,3 +168,3 @@

###withParams(one, two)
**Params**
- one `string` - The input string

@@ -168,3 +175,3 @@ - two `object`

###withOptional(one, [two])
**Params**
- one `string` - The input string

@@ -182,3 +189,3 @@ - [two] `object` - this one is optional

**Params**
- one `string` - The input string

@@ -200,3 +207,3 @@ - two `object` - a second input

**Params**
- one `string` - The input string

@@ -210,3 +217,3 @@ - two `object` - a second input

**Returns**: `object` | `string` - this return has several types
####Example
**Example**
```js

@@ -217,12 +224,19 @@ allTogether(true);

###doSomething(options)
**Params**
- options `object` - the function options
- options.one `string` - first option
- options.two `string` - second option
- one `string` - first option
- two `string` - second option
<a name="doAnother"></a>
###doAnother(options)
**Params**
- options `Object` - the function options
<a name="pluck"></a>
###pluck(...prop)
This function takes variable input
**Params**
- ...prop `string` - the property(s) as input
<a name="requirer"></a>

@@ -236,3 +250,3 @@ ###requirer()

**Params**
- x [NumberLike](#NumberLike) - The magic number.

@@ -242,6 +256,6 @@

###doSomething(options)
**Params**
- options `object` - the function options
- options.one `string` - first option
- options.two `string` - second option
- one `string` - first option
- two `string` - second option

@@ -258,3 +272,3 @@ <a name="All"></a>

**Params**
- input `object` - an input

@@ -266,3 +280,3 @@ - [options] `object` - optional shit

**Author**: 75lb <75pound@gmail.com>
####Example
**Example**
```js

@@ -287,3 +301,3 @@ var yeah = new Everything(true);

**Params**
- one `string` - The input string

@@ -296,3 +310,3 @@ - two `object` - a second input

**Returns**: `object` | `string` - this return has several types
####Example
**Example**
```js

@@ -318,3 +332,3 @@ all.allTogether(true);

**Params**
- [options] `object` - optional shit

@@ -338,3 +352,3 @@

**Params**
- input `object` - an input

@@ -346,3 +360,3 @@ - [options] `object` - optional shit

**Author**: 75lb <75pound@gmail.com>
####Example
**Example**
```js

@@ -371,3 +385,3 @@ var yeah = new Everything(true);

**Params**
- one `string` - The input string

@@ -380,3 +394,3 @@ - two `object` - a second input

**Returns**: `object` | `string` - this return has several types
####Example
**Example**
```js

@@ -400,2 +414,14 @@ something.allTogether(true);

<a name="Plucker"></a>
##class: Plucker
<a name="Plucker#doPluck"></a>
###plucker.doPluck(one, ...prop, ...three)
This function takes variable input
**Params**
- one `string` - an input
- ...prop `string` - the property(s) as input
- ...three `string` - more input
<a name="onComplete"></a>

@@ -405,3 +431,3 @@ ###callback: onComplete

**Params**
- err `object` - an error, or `null`

@@ -408,0 +434,0 @@ - result `string` - the result info

4

test/output/globals/callback.md
#Global scope
<a name="read"></a>
###read(filename, done)
**Params**
- filename `string` - the filename

@@ -12,3 +12,3 @@ - done [onComplete](#onComplete) - the callback

**Params**
- err `object` - an error, or `null`

@@ -15,0 +15,0 @@ - result `string` - the result info

8

test/output/globals/class-all.md

@@ -12,3 +12,3 @@ #Global scope

**Params**
- input `object` - an input

@@ -20,3 +20,3 @@ - [options] `object` - optional shit

**Author**: 75lb <75pound@gmail.com>
####Example
**Example**
```js

@@ -41,3 +41,3 @@ var yeah = new Everything(true);

**Params**
- one `string` - The input string

@@ -50,5 +50,5 @@ - two `object` - a second input

**Returns**: `object` | `string` - this return has several types
####Example
**Example**
```js
all.allTogether(true);
```

6

test/output/globals/class-constructors.md

@@ -19,3 +19,3 @@ #Global scope

**Params**
- [options] `object` - optional shit

@@ -39,3 +39,3 @@

**Params**
- input `object` - an input

@@ -47,5 +47,5 @@ - [options] `object` - optional shit

**Author**: 75lb <75pound@gmail.com>
####Example
**Example**
```js
var yeah = new Everything(true);
```

4

test/output/globals/class-methods.md

@@ -13,3 +13,3 @@ #Global scope

**Params**
- one `string` - The input string

@@ -22,5 +22,5 @@ - two `object` - a second input

**Returns**: `object` | `string` - this return has several types
####Example
**Example**
```js
something.allTogether(true);
```

2

test/output/globals/constants.md

@@ -17,5 +17,5 @@ #Global scope

**Author**: Lloyd Brookes <lloyd@brookes.com>
####Example
**Example**
```js
var CONST_TWO = true;
```

18

test/output/globals/functions.md

@@ -10,3 +10,3 @@ #Global scope

####Example
**Example**
```js

@@ -19,7 +19,7 @@ var result = exampled();

####Example
**Example**
```js
var another = 100;
```
####Example
**Example**
```js

@@ -45,3 +45,3 @@ var next = "p";

###withParam(one)
**Params**
- one `string` - The input string

@@ -51,3 +51,3 @@

###withParams(one, two)
**Params**
- one `string` - The input string

@@ -58,3 +58,3 @@ - two `object`

###withOptional(one, [two])
**Params**
- one `string` - The input string

@@ -72,3 +72,3 @@ - [two] `object` - this one is optional

**Params**
- one `string` - The input string

@@ -90,3 +90,3 @@ - two `object` - a second input

**Params**
- one `string` - The input string

@@ -100,5 +100,5 @@ - two `object` - a second input

**Returns**: `object` | `string` - this return has several types
####Example
**Example**
```js
allTogether(true);
```

8

test/output/globals/members.md

@@ -18,3 +18,3 @@ #Global scope

####Example
**Example**
```js

@@ -28,7 +28,7 @@ var another = 100;

####Example
**Example**
```js
var another = 100;
```
####Example
**Example**
```js

@@ -80,5 +80,5 @@ var next = "p";

**Author**: 75lb <75pound@gmail.com>
####Example
**Example**
```js
var allTogether = true;
```

8

test/output/globals/options.md
#Global scope
<a name="doSomething"></a>
###doSomething(options)
**Params**
- options `object` - the function options
- options.one `string` - first option
- options.two `string` - second option
- one `string` - first option
- two `string` - second option
<a name="doAnother"></a>
###doAnother(options)
**Params**
- options `Object` - the function options

2

test/output/globals/typedef.md

@@ -6,3 +6,3 @@ #Global scope

**Params**
- x [NumberLike](#NumberLike) - The magic number.

@@ -9,0 +9,0 @@

6

test/output/globals/types.md
#Global scope
<a name="doSomething"></a>
###doSomething(options)
**Params**
- options `object` - the function options
- options.one `string` - first option
- options.two `string` - second option
- one `string` - first option
- two `string` - second option

4

test/render.js
"use strict";
var yuidoc2md = require("../"),
var jsdoc2md = require("../"),
fs = require("fs"),

@@ -13,3 +13,3 @@ path = require("path"),

function render(input, output, preset, index){
yuidoc2md.render({ preset: preset, src: input, index: index }, function(err, result){
jsdoc2md.render({ preset: preset, src: input, index: index }, function(err, result){
if (err) halt(err);

@@ -16,0 +16,0 @@ mfs.write(output, result);

partials/examples.hbs

Sorry, the diff of this file is not supported yet

partials/param-name.hbs

Sorry, the diff of this file is not supported yet

partials/param.hbs

Sorry, the diff of this file is not supported yet

partials/params.hbs

Sorry, the diff of this file is not supported yet

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

About

Packages

npm

Go

Maven

PyPI

Rubygems

Stay in touch

Get open source security insights delivered straight into your inbox.

  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc