Added jsdoc for the node part of etherpad. (#5983)

src/node/handler/APIHandler.js

@@ -165,12 +165,13 @@ exports.version = version;
 
 /**
  * Handles a HTTP API call
- * @param functionName the name of the called function
+ * @param {String} apiVersion the version of the api
+ * @param {String} functionName the name of the called function
  * @param fields the params of the called function
  * @req express request object
  * @res express response object
  */
-exports.handle = async function (apiVersion, functionName, fields, req, res) {
+exports.handle = async function (apiVersion, functionName, fields) {
   // say goodbye if this is an unknown API version
   if (!(apiVersion in version)) {
     throw new createHTTPError.NotFound('no such api version');

src/node/handler/ExportHandler.js

@@ -38,6 +38,11 @@ const tempDirectory = os.tmpdir();
 
 /**
  * do a requested export
+ * @param {Object} req the request object
+ * @param {Object} res the response object
+ * @param {String} padId the pad id to export
+ * @param {String} readOnlyId the read only id of the pad to export
+ * @param {String} type the type to export
  */
 exports.doExport = async (req, res, padId, readOnlyId, type) => {
   // avoid naming the read-only file as the original pad's id

src/node/handler/ImportHandler.js

@@ -73,6 +73,10 @@ const tmpDirectory = os.tmpdir();
 
 /**
  * do a requested import
+ * @param {Object} req the request object
+ * @param {Object} res the response object
+ * @param {String} padId the pad id to export
+ * @param {String} authorId the author id to use for the import
  */
 const doImport = async (req, res, padId, authorId) => {
   // pipe to a file
@@ -233,6 +237,14 @@ const doImport = async (req, res, padId, authorId) => {
   return false;
 };
 
+/**
+ * Handles the request to import a file
+ * @param {Request} req the request object
+ * @param {Response} res the response object
+ * @param {String} padId the pad id to export
+ * @param {String} authorId the author id to use for the import
+ * @return {Promise<void>} a promise
+ */
 exports.doImport = async (req, res, padId, authorId = '') => {
   let httpStatus = 200;
   let code = 0;

src/node/handler/SocketIORouter.js

@@ -35,8 +35,9 @@ const components = {};
 
 let io;
 
-/**
- * adds a component
+/** adds a component
+ * @param {string} moduleName
+ * @param {Module} module
  */
 exports.addComponent = (moduleName, module) => {
   if (module == null) return exports.deleteComponent(moduleName);
@@ -44,10 +45,15 @@ exports.addComponent = (moduleName, module) => {
   module.setSocketIO(io);
 };
 
+/**
+ * removes a component
+ * @param {Module} moduleName
+ */
 exports.deleteComponent = (moduleName) => { delete components[moduleName]; };
 
 /**
  * sets the socket.io and adds event functions for routing
+ * @param {Object} _io the socket.io instance
  */
 exports.setSocketIO = (_io) => {
   io = _io;