diff options
| author | Maximilian Krambach <[email protected]> | 2018-07-04 11:38:54 +0000 |
|---|---|---|
| committer | Maximilian Krambach <[email protected]> | 2018-07-04 11:38:54 +0000 |
| commit | 1919fa41b6da4dfd4f69e776caa6e6b1883eb208 (patch) | |
| tree | 1650ffd04145a4c4f6246d3cda2557ce2bc5f53c /lang/js/src/Connection.js | |
| parent | js: add Key lookup (diff) | |
| download | gpgme-1919fa41b6da4dfd4f69e776caa6e6b1883eb208.tar.gz gpgme-1919fa41b6da4dfd4f69e776caa6e6b1883eb208.zip | |
js: Add jsdoc, update webpack-cli dependency
--
* package.json:
- the old webpack-cli version depended on two packages
with vulnerabilities, set to minimum version 3.0.8 to fix this
(nodesecurity.io/advisories/157, nodesecurity.io/advisories/612)
- added License identifier
* README: Updated documentation
* jsdoc.conf: Added a configuration file for jsdoc
* some minor documentation changes, indentations
Diffstat (limited to '')
| -rw-r--r-- | lang/js/src/Connection.js | 7 |
1 files changed, 4 insertions, 3 deletions
diff --git a/lang/js/src/Connection.js b/lang/js/src/Connection.js index f399b22b..945932e9 100644 --- a/lang/js/src/Connection.js +++ b/lang/js/src/Connection.js @@ -40,9 +40,10 @@ export class Connection{ * Retrieves the information about the backend. * @param {Boolean} details (optional) If set to false, the promise will * just return a connection status - * @returns {Promise<Object>} - * {String} The property 'gpgme': Version number of gpgme - * {Array<Object>} 'info' Further information about the backends. + * @returns {Promise<Object>} result + * @returns {String} result.gpgme Version number of gpgme + * @returns {Array<Object>} result.info Further information about the + * backends. * Example: * "protocol": "OpenPGP", * "fname": "/usr/bin/gpg", |