From df2240ba08ae4d174ad9972f95223430a97c30cc Mon Sep 17 00:00:00 2001
From: Daniel Huigens <d.huigens@protonmail.com>
Date: Mon, 14 Jun 2021 11:15:37 +0200
Subject: [PATCH] CI: Check that JSDoc comments are valid (#1328)

Also, fix a JSDoc comment.
---
 .github/workflows/docs.yml | 19 +++++++++++++++++++
 src/key/helper.js          |  2 +-
 2 files changed, 20 insertions(+), 1 deletion(-)
 create mode 100644 .github/workflows/docs.yml

diff --git a/.github/workflows/docs.yml b/.github/workflows/docs.yml
new file mode 100644
index 00000000..0d868ab6
--- /dev/null
+++ b/.github/workflows/docs.yml
@@ -0,0 +1,19 @@
+name: Documentation
+
+on:
+  push:
+    branches: [master]
+  pull_request:
+    branches: [master]
+
+jobs:
+  lint:
+    name: JSDoc
+
+    runs-on: ubuntu-latest
+
+    steps:
+    - uses: actions/checkout@v2
+    - uses: actions/setup-node@v1
+    - run: npm ci
+    - run: npm run docs
diff --git a/src/key/helper.js b/src/key/helper.js
index 5d62f4d5..f6f59e2a 100644
--- a/src/key/helper.js
+++ b/src/key/helper.js
@@ -217,7 +217,7 @@ export async function createSignaturePacket(dataToSign, privateKey, signingKeyPa
  * @param {Object} dest
  * @param {String} attr
  * @param {Date} [date] - date to use for signature expiration check, instead of the current time
- * @param {(SignaturePacket) => Boolean} [checkFn] - signature only merged if true
+ * @param {Function} [checkFn] - signature only merged if true
  */
 export async function mergeSignatures(source, dest, attr, date = new Date(), checkFn) {
   source = source[attr];