Make sure all files are used when generating API docs

This commit is contained in:
JC Brand 2021-09-14 15:04:12 +02:00
parent ad501d4309
commit 2b7624e622
3 changed files with 4 additions and 4 deletions

View File

@ -245,4 +245,4 @@ doc: node_modules docsdev apidoc
PHONY: apidoc PHONY: apidoc
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

View File

@ -48,7 +48,7 @@ export async function getAffiliationList (affiliation, muc_jid) {
/** /**
* Given an occupant model, see which affiliations may be assigned to that user. * Given an occupant model, see which affiliations may be assigned to that user.
* @param { Model } occupant * @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) { export function getAssignableAffiliations (occupant) {
let disabled = api.settings.get('modtools_disable_assign'); 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. * Send IQ stanzas to the server to modify affiliations for users in this groupchat.
* See: https://xmpp.org/extensions/xep-0045.html#modifymember * 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 { string } users[].jid - The JID of the user whose affiliation will change
* @param { Array } users[].affiliation - The new affiliation for this user * @param { Array } users[].affiliation - The new affiliation for this user
* @param { string } [users[].reason] - An optional reason for the affiliation change * @param { string } [users[].reason] - An optional reason for the affiliation change

View File

@ -9,7 +9,7 @@ const { Strophe, sizzle, u } = converse.env;
/** /**
* Given an occupant model, see which roles may be assigned to that user. * Given an occupant model, see which roles may be assigned to that user.
* @param { Model } occupant * @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) { export function getAssignableRoles (occupant) {
let disabled = api.settings.get('modtools_disable_assign'); let disabled = api.settings.get('modtools_disable_assign');