Fix incorrect JSDoc async return annotations

The return type of an async function should be documented as a Promise
of what the function returns as this is what JSDoc expects.
This commit is contained in:
Hornwitser committed 2023-02-15 20:31:02 +01:00
1 parent a7dedcd3b7
commit 2d8b35291d
12 files changed
+33 -33

No files matched your search

+4 -4
View File
@@ -19,7 +19,7 @@ const path = require("path");
*
* @param {Map<string, string>} pluginList -
* Mapping of plugin name to require path for the plugins to load.
* @returns {Array<Object>} Array of plugin info modules.
* @returns {Promise<Array<Object>>} Array of plugin info modules.
* @static
*/
async function loadPluginInfos(pluginList) {
@@ -71,7 +71,7 @@ function loadPluginClass(entrypointName, className, pluginClass, pluginInfo) {
* @param {Object} pluginInfo -
* Plugin info object returned from {@link
* module:lib/plugin_loader.loadPluginInfos} to load class from.
* @returns {function} plugin class
* @returns {Promise<function>} plugin class
* @static
*/
async function loadMasterPluginClass(pluginInfo) {
@@ -84,7 +84,7 @@ async function loadMasterPluginClass(pluginInfo) {
* @param {Object} pluginInfo -
* Plugin info object returned from {@link
* module:lib/plugin_loader.loadPluginInfos} to load class from.
* @returns {function} plugin class
* @returns {Promise<function>} plugin class
* @static
*/
async function loadInstancePluginClass(pluginInfo) {
@@ -97,7 +97,7 @@ async function loadInstancePluginClass(pluginInfo) {
* @param {Object} pluginInfo -
* Plugin info object returned from {@link
* module:lib/plugin_loader.loadPluginInfos} to load class from.
* @returns {function} plugin class
* @returns {Promise<function>} plugin class
* @static
*/
async function loadControlPluginClass(pluginInfo) {