Merge pull request #18 from Nimblr/jsdoc

Change to JSDoc type formatting {type}
This commit is contained in:
2017-06-24 13:08:21 +02:00
committed by GitHub
4 changed files with 59 additions and 59 deletions
+7 -7
View File
@@ -10,7 +10,7 @@ var log = require('winston'),
/**
* Try to log a connecting peer in
*
* @param obj pduObj
* @param {object} pduObj
*/
function login(pduObj) {
var that = this;
@@ -97,9 +97,9 @@ function resetEnqLinkTimer() {
/**
* Server session function - inherits from session()
*
* @param obj sock - socket object
* @param obj options - as derived from server()
* @return obj (returnObj)
* @param {object} sock - socket object
* @param {object} options - as derived from server()
* @return {object} (returnObj)
*/
function serverSession(sock, options) {
var returnObj = session(sock);
@@ -143,8 +143,8 @@ function serverSession(sock, options) {
/**
* Setup a server
*
* @param obj options - host, port, checkuserpass() etc (OPTIONAL)
* @param func callback(err, session)
* @param {object} options - host, port, checkuserpass() etc (OPTIONAL)
* @param {function} callback(err, session)
*/
function server(options, callback) {
var tlsOrNet;
@@ -174,7 +174,7 @@ function server(options, callback) {
var returnObj = serverSession(sock, options);
// We have a connection - a socket object is assigned to the connection automatically
log.verbose('larvitsmpp: lib/server.js: server() - Incomming connection! From: ' + sock.remoteAddress + ':' + sock.remotePort);
log.verbose('larvitsmpp: lib/server.js: server() - Incoming connection! From: ' + sock.remoteAddress + ':' + sock.remotePort);
callback(null, returnObj);
}).listen(options.port, options.host);