diff --git a/packages/ctl/ctl.js b/packages/ctl/ctl.js index 72031d88..42a56469 100755 --- a/packages/ctl/ctl.js +++ b/packages/ctl/ctl.js @@ -2,7 +2,7 @@ /** * Command line interface for controlling a Clusterio cluster - * @module + * @module ctl/ctl */ "use strict"; const fs = require("fs-extra"); diff --git a/packages/lib/command.js b/packages/lib/command.js index cb38c9b8..7e06b7a8 100644 --- a/packages/lib/command.js +++ b/packages/lib/command.js @@ -4,7 +4,7 @@ * Data types and utilites for commands to clusterioctl's CLI. * * @author Hornwitser - * @module + * @module lib/command */ "use strict"; const link = require("@clusterio/lib/link"); @@ -25,7 +25,7 @@ class Command { * @param {function(args, control)} handler - * Async function invoked when the command is executed. Is given * the parsed args and a reference to the {@link - * module:clusterctl.Control} instance. + * module:ctl/ctl.Control} instance. */ constructor({ definition, handler }) { if (definition[0] instanceof Array) { diff --git a/packages/lib/database.js b/packages/lib/database.js index 0b917115..7dce0451 100644 --- a/packages/lib/database.js +++ b/packages/lib/database.js @@ -1,7 +1,7 @@ /** * Implementation of master databases * - * @module + * @module lib/database * @author Hornwitser */ diff --git a/packages/lib/errors.js b/packages/lib/errors.js index 7ec888ea..40de8d80 100644 --- a/packages/lib/errors.js +++ b/packages/lib/errors.js @@ -1,6 +1,6 @@ /** * Errors thrown in Clusterio - * @module + * @module lib/errors */ "use strict"; diff --git a/packages/lib/hash.js b/packages/lib/hash.js index 147ebb50..5aa9d1ab 100644 --- a/packages/lib/hash.js +++ b/packages/lib/hash.js @@ -1,6 +1,6 @@ /** * Hashing functions - * @module + * @module lib/hash */ "use strict"; const crypto = require("crypto"); diff --git a/packages/lib/helpers.js b/packages/lib/helpers.js index 8fa63587..a31322ba 100644 --- a/packages/lib/helpers.js +++ b/packages/lib/helpers.js @@ -1,6 +1,6 @@ /** * Collection of small utilites that are useful in multiple places. - * @module + * @module lib/helpers */ "use strict"; diff --git a/packages/lib/luaTools.js b/packages/lib/luaTools.js index 48ad79dd..ac086b65 100644 --- a/packages/lib/luaTools.js +++ b/packages/lib/luaTools.js @@ -1,6 +1,6 @@ /** * Utilities for dealing with Lua - * @module + * @module lib/luaTools */ "use strict"; diff --git a/packages/lib/objectOps.js b/packages/lib/objectOps.js index 1fe093cc..47b9a4fa 100644 --- a/packages/lib/objectOps.js +++ b/packages/lib/objectOps.js @@ -1,6 +1,6 @@ /** * Helper functions related to objects - * @module + * @module lib/objectOps */ "use strict"; diff --git a/packages/lib/plugin.js b/packages/lib/plugin.js index fe9222f7..58f7a657 100644 --- a/packages/lib/plugin.js +++ b/packages/lib/plugin.js @@ -1,6 +1,6 @@ /** * Plugin interfaces and utilities. - * @module + * @module lib/plugin */ "use strict"; const fs = require("fs-extra"); @@ -42,7 +42,7 @@ class BaseInstancePlugin { /** * Instance the plugin started for - * @type {module:slave~Instance} + * @type {module:slave/slave~Instance} */ this.instance = instance; @@ -52,7 +52,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} + * @type {module:slave/slave~Slave} */ this.slave = slave; } @@ -181,7 +181,7 @@ class BaseInstancePlugin { * Plugins must stop sending messages to the master, or are forwarded * via the master server after the prepare disconnect has been handled. * - * @param {module:master~SlaveConnection} connection - + * @param {module:master/master~SlaveConnection} connection - * The connection to the slave preparing to disconnect. */ async onPrepareMasterDisconnect(connection) { } @@ -283,7 +283,7 @@ class BaseMasterPlugin { * * Invoked when the connection to the slave has been closed. * - * @param {module:master~SlaveConnection} connection - + * @param {module:master/master~SlaveConnection} connection - * The connection the event occured on. * @param {string} event - one of connect, drop, and close */ @@ -298,7 +298,7 @@ class BaseMasterPlugin { * Plugins must stop sending messages to the slave in question after the * prepare disconnect has been handled. * - * @param {module:master~SlaveConnection} connection - + * @param {module:master/master~SlaveConnection} connection - * The connection to the slave preparing to disconnect. */ async onPrepareSlaveDisconnect(connection) { } @@ -369,7 +369,7 @@ class BaseControlPlugin { * module:lib/command.CommandTree} to. * * @param {module:lib/command.CommandTree} rootCommand - - * Root of the clusterctl command tree. + * Root of the clusterioctl command tree. */ async addCommands(rootCommand) { } } diff --git a/packages/lib/schema.js b/packages/lib/schema.js index 66f038bd..4e781812 100644 --- a/packages/lib/schema.js +++ b/packages/lib/schema.js @@ -1,6 +1,6 @@ /** * JSON schemas used for validating link messages - * @module + * @module lib/schema */ "use strict"; const ajv = new (require("ajv"))({ diff --git a/packages/lib/users.js b/packages/lib/users.js index aa2803fb..7f69c390 100644 --- a/packages/lib/users.js +++ b/packages/lib/users.js @@ -4,7 +4,7 @@ * Defines data types for users, roles and permissions. * * @author Hornwitser - * @module + * @module lib/users */ "use strict"; const jwt = require("jsonwebtoken"); diff --git a/packages/master/master.js b/packages/master/master.js index be0d4c30..26628e5e 100755 --- a/packages/master/master.js +++ b/packages/master/master.js @@ -6,9 +6,9 @@ * Facilitates communication between slaves and control of the cluster * through WebSocet connections, and hosts a webserver for browser * interfaces and Prometheus statistics export. It is remotely controlled - * by {@link module:@clusterio/ctl/ctl}. + * by {@link module:ctl/ctl}. * - * @module + * @module master/master * @author Danielv123, Hornwitser * @example * npx clusteriomaster run diff --git a/packages/slave/slave.js b/packages/slave/slave.js index bb575dc3..bb5d609c 100755 --- a/packages/slave/slave.js +++ b/packages/slave/slave.js @@ -5,9 +5,9 @@ * * Connects to the master server and hosts Factorio servers that can * communicate with the cluster. It is remotely controlled by {@link - * module:master}. + * module:master/master}. * - * @module + * @module slave/slave * @author Danielv123, Hornwitser * @example * npx clusterioslave run @@ -1114,7 +1114,7 @@ class Slave extends link.Link { * Initialize and connect an unloaded instance * * @param {number} instanceId - ID of instance to initialize. - * @returns {module:slave~InstanceConnection} connection to instance. + * @returns {module:slave/slave~InstanceConnection} connection to instance. */ async _connectInstance(instanceId) { let instanceInfo = this.instanceInfos.get(instanceId);