Fix JSDoc module references

Fix module names, which are incorrectly deduced by JSDoc, and references
to master, slave and ctl modules that are now in separate packages.
This commit is contained in:
Hornwitser committed 2020-09-21 18:00:07 +02:00
1 parent 3485c9ac68
commit bd8f685a18
13 files changed
+23 -23

No files matched your search

+1 -1
View File
@@ -2,7 +2,7 @@
/**
* Command line interface for controlling a Clusterio cluster
* @module
* @module ctl/ctl
*/
"use strict";
const fs = require("fs-extra");
+2 -2
View File
@@ -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) {
+1 -1
View File
@@ -1,7 +1,7 @@
/**
* Implementation of master databases
*
* @module
* @module lib/database
* @author Hornwitser
*/
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* Errors thrown in Clusterio
* @module
* @module lib/errors
*/
"use strict";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* Hashing functions
* @module
* @module lib/hash
*/
"use strict";
const crypto = require("crypto");
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* Collection of small utilites that are useful in multiple places.
* @module
* @module lib/helpers
*/
"use strict";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* Utilities for dealing with Lua
* @module
* @module lib/luaTools
*/
"use strict";
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* Helper functions related to objects
* @module
* @module lib/objectOps
*/
"use strict";
+7 -7
View File
@@ -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) { }
}
+1 -1
View File
@@ -1,6 +1,6 @@
/**
* JSON schemas used for validating link messages
* @module
* @module lib/schema
*/
"use strict";
const ajv = new (require("ajv"))({
+1 -1
View File
@@ -4,7 +4,7 @@
* Defines data types for users, roles and permissions.
*
* @author Hornwitser
* @module
* @module lib/users
*/
"use strict";
const jwt = require("jsonwebtoken");
+2 -2
View File
@@ -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
+3 -3
View File
@@ -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);