diff --git a/docs/jsdoc.json b/docs/jsdoc.json index 4a90978a..d2b4df6a 100644 --- a/docs/jsdoc.json +++ b/docs/jsdoc.json @@ -13,7 +13,9 @@ "include": [ "packages/master/src/", "packages/master/master.js", + "packages/slave/src/", "packages/slave/slave.js", + "packages/ctl/src/", "packages/ctl/ctl.js", "packages/lib/", "plugins/" diff --git a/packages/lib/plugin.js b/packages/lib/plugin.js index 72c6dbc1..b9810254 100644 --- a/packages/lib/plugin.js +++ b/packages/lib/plugin.js @@ -39,7 +39,7 @@ class BaseInstancePlugin { /** * Instance the plugin started for - * @type {module:slave/slave~Instance} + * @type {module:slave/src/Instance} */ this.instance = instance; @@ -49,7 +49,7 @@ class BaseInstancePlugin { * With the exepction of accessing the slave's config you should * avoid ineracting with the slave object directly. * - * @type {module:slave/slave~Slave} + * @type {module:slave/src/Slave} */ this.slave = slave; diff --git a/packages/slave/src/Instance.js b/packages/slave/src/Instance.js index a7169ec2..99d7aebd 100644 --- a/packages/slave/src/Instance.js +++ b/packages/slave/src/Instance.js @@ -108,6 +108,7 @@ const serverSettingsActions = { * * @param {Instance} instance - Instance to link mods for * @param {string} sharedMods - Path to folder to link mods from. + * @private */ async function symlinkMods(instance, sharedMods) { await fs.ensureDir(instance.path("mods")); diff --git a/packages/slave/src/Slave.js b/packages/slave/src/Slave.js index c894b745..4c28b605 100644 --- a/packages/slave/src/Slave.js +++ b/packages/slave/src/Slave.js @@ -70,6 +70,7 @@ function checkFilename(name) { * * @param {string} name - Arbitrary name string * @returns {string} Filename suitable to use in the filesystem + * @private */ function cleanFilename(name) { // copied from checkFilename @@ -119,6 +120,7 @@ function checkRequestSaveName(name) { * @param {string} instancesDir - Directory containing instances * @returns {Map} * mapping between instance id and information about this instance. + * @private */ async function discoverInstances(instancesDir) { let instanceInfos = new Map(); @@ -159,6 +161,7 @@ async function discoverInstances(instancesDir) { * Handles running the slave * * Connects to the master server over the WebSocket and manages intsances. + * @alias module:slave/src/Slave */ class Slave extends libLink.Link { // I don't like God classes, but the alternative of putting all this state