From 1c618166fcd296b4e95f3a6ea9c415d3dca5ce0a Mon Sep 17 00:00:00 2001
From: Maximilian Krambach <maximilian.krambach@intevation.de>
Date: Wed, 5 Sep 2018 18:46:28 +0200
Subject: js: documentation cleanup

--
---
 lang/js/src/index.js | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

(limited to 'lang/js/src/index.js')

diff --git a/lang/js/src/index.js b/lang/js/src/index.js
index cf6e2d03..c52460cc 100644
--- a/lang/js/src/index.js
+++ b/lang/js/src/index.js
@@ -27,9 +27,11 @@ import { gpgme_error } from './Errors';
 import { Connection } from './Connection';
 
 /**
- * Initializes gpgme.js by testing the nativeMessaging connection once.
- * @returns {Promise<GpgME> | GPGME_Error}
- *
+ * Main entry point for gpgme.js. It initializes by testing the nativeMessaging
+ * connection once, and then offers the available functions as method of the
+ * response object.
+ * An unsuccessful attempt will reject as a GPGME_Error.
+ * @returns {Promise<GpgME>}
  * @async
  */
 function init (){
-- 
cgit v1.2.3