Docs

Adam Rudd · Adam Rudd · commit 435ee3f2f7d8 · 2013-05-27T20:42:51.000+02:00
diff --git a/lib/client.js b/lib/client.js
@@ -169,7 +169,8 @@ util.inherits(MqttClient, events.EventEmitter);
  * @api public
  *
  * @example client.publish('topic', 'message');
- * @example client.publish('topic', 'message', {qos: 1, retain: true});
+ * @example
+ *     client.publish('topic', 'message', {qos: 1, retain: true});
  * @example client.publish('topic', 'message', console.log);
  */
 MqttClient.prototype.publish = 
diff --git a/lib/mqtt.js b/lib/mqtt.js
@@ -17,9 +17,9 @@ var defaultPort = 1883
 /**
  * createClient - create an MQTT client
  *
- * @param <Number> [port] - broker port
- * @param <String> [host] - broker host
- * @param <Object> [opts] - see MqttClient#constructor
+ * @param {Number} [port] - broker port
+ * @param {String} [host] - broker host
+ * @param {Object} [opts] - see MqttClient#constructor
  * @api public
  */
 module.exports.createClient = function(port, host, opts) {
@@ -50,9 +50,9 @@ module.exports.createClient = function(port, host, opts) {
 /**
  * createSecureClient - create a tls secured MQTT client
  *
- * @param <Number> [port]
- * @param <String> [host]
- * @param <Object> opts
+ * @param {Number} [port]
+ * @param {String} [host]
+ * @param {Object} opts
  * @api public
  */
 module.exports.createSecureClient = function(port, host, opts) {
@@ -89,7 +89,7 @@ module.exports.createSecureClient = function(port, host, opts) {
 /**
  * createServer - create an MQTT server
  *
- * @param <Function> listener - called on new client connections
+ * @param {Function} listener - called on new client connections
  */
 
 module.exports.createServer = function(listener) {
@@ -99,9 +99,9 @@ module.exports.createServer = function(listener) {
 /**
  * createSecureServer - create a tls secured MQTT server
  *
- * @param <String> keyPath - path to private key
- * @param <String> certPath - path to public cert
- * @param <Function> listener - called on new client conns
+ * @param {String} keyPath - path to private key
+ * @param {String} certPath - path to public cert
+ * @param {Function} listener - called on new client conns
  */
 
 module.exports.createSecureServer =
@@ -112,9 +112,9 @@ function(keyPath, certPath, listener) {
 /**
  * createConnection - create a bare MQTT connection
  *
- * @param <Number> [port]
- * @param <String> [host]
- * @param <Function> [callback]
+ * @param {Number} [port]
+ * @param {String} [host]
+ * @param {Function} [callback]
  */
 module.exports.createConnection = function(port, host, callback) {
   var net_client, mqtt_conn;
diff --git a/lib/server.js b/lib/server.js
@@ -11,7 +11,7 @@ var fs = require('fs')
 /**
  * MqttServer
  *
- * @param <Function> listener
+ * @param {Function} listener - fired on client connection
  */
 var MqttServer = module.exports.MqttServer = 
 function Server(listener) {
@@ -36,9 +36,9 @@ util.inherits(MqttServer, net.Server);
 /**
  * MqttSecureServer
  *
- * @param <String> privateKeyPath
- * @param <String> publicCertPath
- * @param <Function> listener
+ * @param {String} privateKeyPath
+ * @param {String} publicCertPath
+ * @param {Function} listener
  */
 var MqttSecureServer = module.exports.MqttSecureServer = 
 function SecureServer(keyPath, certPath, listener) {
@@ -69,8 +69,8 @@ util.inherits(MqttSecureServer, tls.Server);
  * MqttServerClient - wrapper around Connection
  * Exists if we want to extend server functionality later
  *
- * @param <Stream> stream
- * @param <MqttServer> server
+ * @param {Stream} stream
+ * @param {MqttServer} server
  */
 
 var MqttServerClient = module.exports.MqttServerClient =
