Socket
Socket
Sign inDemoInstall

jsdoc-to-markdown

Package Overview
Dependencies
Maintainers
1
Versions
129
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

jsdoc-to-markdown - npm Package Compare versions

Comparing version 3.1.0-1 to 4.0.0

17

docs/API.md

@@ -31,3 +31,3 @@ <a name="module_jsdoc-to-markdown"></a>

**Kind**: instance method of <code>[JsdocToMarkdown](#exp_module_jsdoc-to-markdown--JsdocToMarkdown)</code>
**Kind**: instance method of [<code>JsdocToMarkdown</code>](#exp_module_jsdoc-to-markdown--JsdocToMarkdown)
**Category**: async

@@ -65,3 +65,3 @@ **Fulfil**: <code>string</code> - the rendered docs

**Kind**: instance method of <code>[JsdocToMarkdown](#exp_module_jsdoc-to-markdown--JsdocToMarkdown)</code>
**Kind**: instance method of [<code>JsdocToMarkdown</code>](#exp_module_jsdoc-to-markdown--JsdocToMarkdown)
**Category**: async

@@ -79,3 +79,3 @@ **Fulfil**: <code>object[]</code> - the json data

**Kind**: instance method of <code>[JsdocToMarkdown](#exp_module_jsdoc-to-markdown--JsdocToMarkdown)</code>
**Kind**: instance method of [<code>JsdocToMarkdown</code>](#exp_module_jsdoc-to-markdown--JsdocToMarkdown)
**Category**: async

@@ -91,3 +91,2 @@ **Fulfil**: <code>object[]</code>

| [options.configure] | <code>string</code> | The path to the [jsdoc configuration file](http://usejsdoc.org/about-configuring-jsdoc.html). Default: path/to/jsdoc/conf.json. |
| [options.html] | <code>boolean</code> | Enable experimental documentation of `.html` files. |

@@ -99,3 +98,3 @@ <a name="module_jsdoc-to-markdown--JsdocToMarkdown+clear"></a>

**Kind**: instance method of <code>[JsdocToMarkdown](#exp_module_jsdoc-to-markdown--JsdocToMarkdown)</code>
**Kind**: instance method of [<code>JsdocToMarkdown</code>](#exp_module_jsdoc-to-markdown--JsdocToMarkdown)
**Category**: async

@@ -107,3 +106,3 @@ <a name="module_jsdoc-to-markdown--JsdocToMarkdown+getNamepaths"></a>

**Kind**: instance method of <code>[JsdocToMarkdown](#exp_module_jsdoc-to-markdown--JsdocToMarkdown)</code>
**Kind**: instance method of [<code>JsdocToMarkdown</code>](#exp_module_jsdoc-to-markdown--JsdocToMarkdown)
**Category**: async

@@ -120,3 +119,3 @@

**Kind**: instance method of <code>[JsdocToMarkdown](#exp_module_jsdoc-to-markdown--JsdocToMarkdown)</code>
**Kind**: instance method of [<code>JsdocToMarkdown</code>](#exp_module_jsdoc-to-markdown--JsdocToMarkdown)
**Category**: sync

@@ -138,3 +137,3 @@ **Engine**: nodejs >= 0.12

**Kind**: instance method of <code>[JsdocToMarkdown](#exp_module_jsdoc-to-markdown--JsdocToMarkdown)</code>
**Kind**: instance method of [<code>JsdocToMarkdown</code>](#exp_module_jsdoc-to-markdown--JsdocToMarkdown)
**Category**: sync

@@ -151,3 +150,3 @@

**Kind**: instance method of <code>[JsdocToMarkdown](#exp_module_jsdoc-to-markdown--JsdocToMarkdown)</code>
**Kind**: instance method of [<code>JsdocToMarkdown</code>](#exp_module_jsdoc-to-markdown--JsdocToMarkdown)
**Category**: sync

@@ -154,0 +153,0 @@

@@ -114,3 +114,2 @@ 'use strict'

* @param [options.configure] {string} - The path to the [jsdoc configuration file](http://usejsdoc.org/about-configuring-jsdoc.html). Default: path/to/jsdoc/conf.json.
* @param [options.html] {boolean} - Enable experimental documentation of `.html` files.
* @return {Promise}

@@ -117,0 +116,0 @@ * @fulfil {object[]}

{
"name": "jsdoc-to-markdown",
"author": "Lloyd Brookes",
"version": "3.1.0-1",
"version": "4.0.0",
"description": "Generates markdown API documentation from jsdoc annotated source code",

@@ -33,3 +33,3 @@ "repository": "https://github.com/jsdoc2md/jsdoc-to-markdown",

"config-master": "^3.1.0",
"dmd": "^3.0.9",
"dmd": "^3.0.10",
"jsdoc-api": "^4.0.1",

@@ -36,0 +36,0 @@ "jsdoc-parse": "^3.0.1",

SocketSocket SOC 2 Logo

Product

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

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc