mirror of
https://github.com/clusterio/clusterio.git
synced 2026-11-19 23:33:13 +09:00
Fix jsdoc for #462
Fix references and missing files from the jsdoc output after the refactor in #462.
This commit is contained in:
1 parent
51c025c79b
commit
ef74436cde
4 files changed
+8
-2
No files matched your search
@@ -13,7 +13,9 @@
|
|||||||
"include": [
|
"include": [
|
||||||
"packages/master/src/",
|
"packages/master/src/",
|
||||||
"packages/master/master.js",
|
"packages/master/master.js",
|
||||||
|
"packages/slave/src/",
|
||||||
"packages/slave/slave.js",
|
"packages/slave/slave.js",
|
||||||
|
"packages/ctl/src/",
|
||||||
"packages/ctl/ctl.js",
|
"packages/ctl/ctl.js",
|
||||||
"packages/lib/",
|
"packages/lib/",
|
||||||
"plugins/"
|
"plugins/"
|
||||||
|
|||||||
@@ -39,7 +39,7 @@ class BaseInstancePlugin {
|
|||||||
|
|
||||||
/**
|
/**
|
||||||
* Instance the plugin started for
|
* Instance the plugin started for
|
||||||
* @type {module:slave/slave~Instance}
|
* @type {module:slave/src/Instance}
|
||||||
*/
|
*/
|
||||||
this.instance = instance;
|
this.instance = instance;
|
||||||
|
|
||||||
@@ -49,7 +49,7 @@ class BaseInstancePlugin {
|
|||||||
* With the exepction of accessing the slave's config you should
|
* With the exepction of accessing the slave's config you should
|
||||||
* avoid ineracting with the slave object directly.
|
* avoid ineracting with the slave object directly.
|
||||||
*
|
*
|
||||||
* @type {module:slave/slave~Slave}
|
* @type {module:slave/src/Slave}
|
||||||
*/
|
*/
|
||||||
this.slave = slave;
|
this.slave = slave;
|
||||||
|
|
||||||
|
|||||||
@@ -108,6 +108,7 @@ const serverSettingsActions = {
|
|||||||
*
|
*
|
||||||
* @param {Instance} instance - Instance to link mods for
|
* @param {Instance} instance - Instance to link mods for
|
||||||
* @param {string} sharedMods - Path to folder to link mods from.
|
* @param {string} sharedMods - Path to folder to link mods from.
|
||||||
|
* @private
|
||||||
*/
|
*/
|
||||||
async function symlinkMods(instance, sharedMods) {
|
async function symlinkMods(instance, sharedMods) {
|
||||||
await fs.ensureDir(instance.path("mods"));
|
await fs.ensureDir(instance.path("mods"));
|
||||||
|
|||||||
@@ -70,6 +70,7 @@ function checkFilename(name) {
|
|||||||
*
|
*
|
||||||
* @param {string} name - Arbitrary name string
|
* @param {string} name - Arbitrary name string
|
||||||
* @returns {string} Filename suitable to use in the filesystem
|
* @returns {string} Filename suitable to use in the filesystem
|
||||||
|
* @private
|
||||||
*/
|
*/
|
||||||
function cleanFilename(name) {
|
function cleanFilename(name) {
|
||||||
// copied from checkFilename
|
// copied from checkFilename
|
||||||
@@ -119,6 +120,7 @@ function checkRequestSaveName(name) {
|
|||||||
* @param {string} instancesDir - Directory containing instances
|
* @param {string} instancesDir - Directory containing instances
|
||||||
* @returns {Map<integer, Object>}
|
* @returns {Map<integer, Object>}
|
||||||
* mapping between instance id and information about this instance.
|
* mapping between instance id and information about this instance.
|
||||||
|
* @private
|
||||||
*/
|
*/
|
||||||
async function discoverInstances(instancesDir) {
|
async function discoverInstances(instancesDir) {
|
||||||
let instanceInfos = new Map();
|
let instanceInfos = new Map();
|
||||||
@@ -159,6 +161,7 @@ async function discoverInstances(instancesDir) {
|
|||||||
* Handles running the slave
|
* Handles running the slave
|
||||||
*
|
*
|
||||||
* Connects to the master server over the WebSocket and manages intsances.
|
* Connects to the master server over the WebSocket and manages intsances.
|
||||||
|
* @alias module:slave/src/Slave
|
||||||
*/
|
*/
|
||||||
class Slave extends libLink.Link {
|
class Slave extends libLink.Link {
|
||||||
// I don't like God classes, but the alternative of putting all this state
|
// I don't like God classes, but the alternative of putting all this state
|
||||||
|
|||||||
Reference in new issue
Block a user