updated documentation based on jsdoc

Author: Reflex-Gravity

src/strophe.ping.js

@@ -25,14 +25,13 @@ Strophe.addConnectionPlugin('ping', {
     },
 
     /**
-     * Function: ping
-     *
-     * Parameters:
-     * (String) to - The JID you want to ping
-     * (Function) success - Callback function on success
-     * (Function) error - Callback function on error
-     * (Integer) timeout - Timeout in milliseconds
-     */
+    * Function: ping
+    *
+    * @param {string} to - The JID you want to ping
+    * @param {function} success - Callback function on success
+    * @param {function} error - Callback function on error
+    * @param {number} timeout - Timeout in milliseconds
+    */
     ping: function(jid, success, error, timeout) {
         var id = this._c.getUniqueId('ping');
         var iq = $iq({type: 'get', to: jid, id: id}).c(
@@ -41,11 +40,10 @@ Strophe.addConnectionPlugin('ping', {
     },
 
     /**
-     * Function: pong
-     *
-     * Parameters:
-     * (Object) ping - The ping stanza from the server.
-     */
+    * Function: pong
+    *    
+    * @param {Object} ping - The ping stanza from the server 
+    */
     pong: function(ping) {
         var from = ping.getAttribute('from');
         var id = ping.getAttribute('id');
@@ -54,14 +52,12 @@ Strophe.addConnectionPlugin('ping', {
     },
 
     /**
-     * Function: addPingHandler
-     *
-     * Parameters:
-     * (Function) handler - Ping handler
-     *
-     * Returns:
-     * A reference to the handler that can be used to remove it.
-     */
+    * Function: addPingHandler
+    *    
+    * @param {Function} handler - Ping handler
+    *
+    * @returns A reference to the handler that can be used to remove it.
+    */
     addPingHandler: function(handler) {
         return this._c.addHandler(handler, Strophe.NS.PING, "iq", "get");
     }