From 2b7624e6228a9ed33cdfe3685e88248e56446a6d Mon Sep 17 00:00:00 2001
From: JC Brand <jc@opkode.com>
Date: Tue, 14 Sep 2021 15:04:12 +0200
Subject: [PATCH] Make sure all files are used when generating API docs

---
 Makefile                                       | 2 +-
 src/headless/plugins/muc/affiliations/utils.js | 4 ++--
 src/headless/plugins/muc/utils.js              | 2 +-
 3 files changed, 4 insertions(+), 4 deletions(-)

diff --git a/Makefile b/Makefile
index 1cf72814f..d19fb8496 100644
--- a/Makefile
+++ b/Makefile
@@ -245,4 +245,4 @@ doc: node_modules docsdev apidoc
 
 PHONY: apidoc
 apidoc:
-	$(JSDOC) --private --readme docs/source/jsdoc_intro.md -c docs/source/conf.json -d docs/html/api src/templates/*.js src/*.js src/**/*.js src/headless/**/*.js src/shared/**/*.js
+	find ./src -type d -name node_modules -prune -false -o -name "*.js" | xargs $(JSDOC) --private --readme docs/source/jsdoc_intro.md -c docs/source/conf.json -d docs/html/api
diff --git a/src/headless/plugins/muc/affiliations/utils.js b/src/headless/plugins/muc/affiliations/utils.js
index 7f6fdf508..64f6aab86 100644
--- a/src/headless/plugins/muc/affiliations/utils.js
+++ b/src/headless/plugins/muc/affiliations/utils.js
@@ -48,7 +48,7 @@ export async function getAffiliationList (affiliation, muc_jid) {
 /**
  * Given an occupant model, see which affiliations may be assigned to that user.
  * @param { Model } occupant
- * @returns { ('owner', 'admin', 'member', 'outcast', 'none')[] } - An array of assignable affiliations
+ * @returns { Array<('owner'|'admin'|'member'|'outcast'|'none')> } - An array of assignable affiliations
  */
 export function getAssignableAffiliations (occupant) {
     let disabled = api.settings.get('modtools_disable_assign');
@@ -70,7 +70,7 @@ _converse.getAssignableAffiliations = getAssignableAffiliations;
 /**
  * Send IQ stanzas to the server to modify affiliations for users in this groupchat.
  * See: https://xmpp.org/extensions/xep-0045.html#modifymember
- * @param { Object[] } users
+ * @param { Array<Object> } users
  * @param { string } users[].jid - The JID of the user whose affiliation will change
  * @param { Array } users[].affiliation - The new affiliation for this user
  * @param { string } [users[].reason] - An optional reason for the affiliation change
diff --git a/src/headless/plugins/muc/utils.js b/src/headless/plugins/muc/utils.js
index 600c7c8b2..b98065467 100644
--- a/src/headless/plugins/muc/utils.js
+++ b/src/headless/plugins/muc/utils.js
@@ -9,7 +9,7 @@ const { Strophe, sizzle, u } = converse.env;
 /**
  * Given an occupant model, see which roles may be assigned to that user.
  * @param { Model } occupant
- * @returns { ('moderator', 'participant', 'visitor')[] } - An array of assignable roles
+ * @returns { Array<('moderator'|'participant'|'visitor')> } - An array of assignable roles
  */
 export function getAssignableRoles (occupant) {
     let disabled = api.settings.get('modtools_disable_assign');