XoopsModules25x / xhelp

class/pear/Net/IMAPProtocol.php

Doc Comments +71 added lines, -7 removed lines

@@ -168,7 +168,7 @@ 
     /**
      * get the last cmd ID
      *
-     * @return string Returns the last cmdId
+     * @return integer Returns the last cmdId
      *
      * @access public
      * @since  1.0
@@ -296,7 +296,7 @@ 
      * A carriage return / linefeed (CRLF) sequence will be appended to each
      * command string before it is sent to the IMAP server.
      *
-     * @param string $commandid The IMAP commandid retrive from the server.
+     * @param string $commandId The IMAP commandid retrive from the server.
      *
      * @return string The result response.
      *
@@ -349,6 +349,8 @@ 
      *
      * @param string The userid to authenticate as.
      * @param string The password to authenticate with.
+     * @param string $uid
+     * @param string $pwd
      *
      * @return array Returns an array containing the response
      *
@@ -367,6 +369,9 @@ 
      * @param string The userid to authenticate as.
      * @param string The password to authenticate with.
      * @param string The cmdID.
+     * @param string $uid
+     * @param string $pwd
+     * @param string $userMethod
      *
      * @return array Returns an array containing the response
      *
@@ -419,6 +424,10 @@ 
      * @access private
      * @since  1.0
      */
+
+    /**
+     * @param string $cmdid
+     */
     function _authDigest_MD5($uid , $pwd , $cmdid)
     {
 
@@ -469,6 +478,10 @@ 
      * @access private
      * @since  1.0
      */
+
+    /**
+     * @param string $cmdid
+     */
     function _authCRAM_MD5($uid, $pwd, $cmdid)
     {
 
@@ -509,6 +522,10 @@ 
      * @access private
      * @since  1.0
      */
+
+    /**
+     * @param string $cmdid
+     */
     function _authLOGIN($uid, $pwd, $cmdid)
     {
 
@@ -693,6 +710,7 @@ 
      * Send the  CREATE Mailbox Command
      *
      * @param string The mailbox to create.
+     * @param string $mailbox
      * @return array Returns an array containing the response
      *
      * @access public
@@ -728,6 +746,7 @@ 
      * Send the  DELETE Mailbox Command
      *
      * @param string The mailbox name to delete.
+     * @param string $mailbox
      *
      * @return array Returns an array containing the response
      *
@@ -745,6 +764,7 @@ 
      * Send the  SUSCRIBE  Mailbox Command
      *
      * @param string The mailbox name to suscribe.
+     * @param string $mailbox
      *
      * @return array Returns an array containing the response
      *
@@ -761,6 +781,7 @@ 
     /**
      * Send the  UNSUSCRIBE  Mailbox Command
      *
+     * @param string $mailbox
      * @return mixed Returns a PEAR_Error with an error message on any
      *               kind of failure, or true on success.
      * @access public
@@ -776,6 +797,7 @@ 
     /**
      * Send the  FETCH Command
      *
+     * @param string $fetchparam
      * @return mixed Returns a PEAR_Error with an error message on any
      *               kind of failure, or true on success.
      * @access public
@@ -845,6 +867,8 @@ 
     /**
      * Send the  LIST  Command
      *
+     * @param string $mailbox_base
+     * @param string $mailbox
      * @return mixed Returns a PEAR_Error with an error message on any
      *               kind of failure, or true on success.
      * @access public
@@ -861,6 +885,8 @@ 
     /**
      * Send the  LSUB  Command
      *
+     * @param string $mailbox_base
+     * @param string $mailbox
      * @return mixed Returns a PEAR_Error with an error message on any
      *               kind of failure, or true on success.
      * @access public
@@ -877,6 +903,8 @@ 
     /**
      * Send the  APPEND  Command
      *
+     * @param string $mailbox
+     * @param string $msg
      * @return mixed Returns a PEAR_Error with an error message on any
      *               kind of failure, or true on success.
      * @access public
@@ -997,6 +1025,7 @@ 
      *          -FLAGS.SILENT: Remove the flags whith $value but don't return untagged responses
      *
      * @param  string $value
+     * @param string $dataitem
      * @return mixed  Returns a PEAR_Error with an error message on any
      *                      kind of failure, or true on success.
      * @access public
@@ -1024,6 +1053,7 @@ 
     /**
      * Send the COPY command.
      *
+     * @param string $mailbox
      * @return mixed Returns a PEAR_Error with an error message on any
      *               kind of failure, or true on success.
      * @access public
@@ -1197,6 +1227,10 @@ 
      * @since  1.0
      */
     // TODO:  implement the quota by number of emails!!
+
+    /**
+     * @param string $mailbox_name
+     */
     function cmdSetQuota($mailbox_name, $storageQuota = null ,$messagesQuota = null )
     {
         //Check if the IMAP server has QUOTA support
@@ -1276,6 +1310,11 @@ 
      ***             RFC2086 IMAP4 ACL extension BEGINS HERE
      ********************************************************************/
 
+    /**
+     * @param string $mailbox_name
+     * @param string $user
+     * @param string $acl
+     */
     function cmdSetACL($mailbox_name, $user, $acl)
     {
 
@@ -1292,6 +1331,10 @@ 
         return $this->_genericCommand('SETACL', sprintf("%s %s \"%s\"",$mailbox_name,$user_name,$acl) );
     }
 
+    /**
+     * @param string $mailbox_name
+     * @param string $user
+     */
     function cmdDeleteACL($mailbox_name, $user)
     {
         //Check if the IMAP server has ACL support
@@ -1303,6 +1346,9 @@ 
         return $this->_genericCommand('DELETEACL', sprintf("%s \"%s\"",$mailbox_name,$user) );
     }
 
+    /**
+     * @param string $mailbox_name
+     */
     function cmdGetACL($mailbox_name)
     {
         //Check if the IMAP server has ACL support
@@ -1319,6 +1365,9 @@ 
         return $ret;
     }
 
+    /**
+     * @param string $mailbox_name
+     */
     function cmdListRights($mailbox_name, $user)
     {
         //Check if the IMAP server has ACL support
@@ -1334,6 +1383,9 @@ 
         return $ret;
     }
 
+    /**
+     * @param string $mailbox_name
+     */
     function cmdMyRights($mailbox_name)
     {
         //Check if the IMAP server has ACL support
@@ -1446,7 +1498,7 @@ 
     /**
      * tell if the server has capability $capability
      *
-     * @return true or false
+     * @return boolean or false
      *
      * @access public
      * @since  1.0
@@ -1465,7 +1517,8 @@ 
     /**
      * tell if the server has capability $capability
      *
-     * @return true or false
+     * @param string $capability
+     * @return boolean or false
      *
      * @access public
      * @since  1.0
@@ -1487,7 +1540,7 @@ 
     /**
      * tell if the server has Quota support
      *
-     * @return true or false
+     * @return boolean or false
      *
      * @access public
      * @since  1.0
@@ -1500,7 +1553,7 @@ 
     /**
      * tell if the server has Quota support
      *
-     * @return true or false
+     * @return boolean or false
      *
      * @access public
      * @since  1.0
@@ -1513,7 +1566,7 @@ 
     /**
      * tell if the server has support for the ANNOTATEMORE extension
      *
-     * @return true or false
+     * @return boolean or false
      *
      * @access public
      * @since  1.0
@@ -1527,6 +1580,8 @@ 
      * Parses the responses like RFC822.SIZE and INTERNALDATE
      *
      * @param string the IMAP's server response
+     * @param integer $line
+     * @param string $file
      *
      * @return string containing  the parsed response
      * @access private
@@ -2428,6 +2483,11 @@ 
         return $space;
     }
 
+    /**
+     * @param string $char
+     * @param integer $line
+     * @param string $file
+     */
     function _parseString( &$str , $char , $line , $file )
     {
         /*
@@ -2442,6 +2502,10 @@ 
         return $char_aux;
     }
 
+    /**
+     * @param string $str
+     * @param string $cmdid
+     */
     function _genericImapResponseParser( &$str , $cmdid = null )
     {
 

class/pear/Net/POP3.php

Doc Comments +12 added lines

@@ -362,6 +362,10 @@ 
      * @access private
      * @since  1.0
      */
+
+    /**
+     * @param boolean $userMethod
+     */
     function _cmdAuthenticate($uid , $pwd , $userMethod = null )
     {
 
@@ -958,6 +962,10 @@ 
      * @param  $num_lines Number of lines to retrieve
      * @return mixed Message data or false on error
      */
+
+    /**
+     * @param integer $num_lines
+     */
     function _cmdTop($msg_id, $num_lines)
     {
         if ($this->_state == NET_POP3_STATE_TRANSACTION) {
@@ -1011,6 +1019,10 @@ 
      * @param  $cmd  Command to send (\r\n will be appended)
      * @return mixed First line of response if successful, otherwise false
      */
+
+    /**
+     * @param string $cmd
+     */
     function _sendCmd($cmd)
     {
         $result = $this->_send($cmd);

class/pear/Net/Socket.php

Doc Comments +4 added lines, -2 removed lines

@@ -156,7 +156,7 @@ 
      * if there is no data available, whereas it will block until there
      * is data for blocking sockets.
      *
-     * @param $mode bool true for blocking sockets, false for nonblocking
+     * @param boolean $mode bool true for blocking sockets, false for nonblocking
      * @access public
      * @return mixed true on success or an error object otherwise
      */
@@ -222,6 +222,7 @@ 
      * Get a specified line of data
      *
      * @access public
+     * @param integer $size
      * @return $size bytes of data from the socket, or a PEAR_Error if
      *               not connected.
      */
@@ -241,7 +242,7 @@ 
      * chunk; if you know the size of the data you're getting
      * beforehand, this is definitely the way to go.
      *
-     * @param $size The number of bytes to read from the socket.
+     * @param integer $size The number of bytes to read from the socket.
      * @access public
      * @return $size bytes of data from the socket, or a PEAR_Error if
      *               not connected.
@@ -260,6 +261,7 @@ 
      * Write a specified amount of data.
      *
      * @access public
+     * @param string $data
      * @return mixed true on success or an error object otherwise
      */
     function write($data) {

class/report.php

Doc Comments +2 added lines, -2 removed lines

@@ -63,7 +63,7 @@ 
     /**
      * Generate graph to go along with report
      *
-     * @return mixed bool false on no graph / draw graph
+     * @return false|null bool false on no graph / draw graph
      * @access	public
      */
     function generateGraph()
@@ -76,7 +76,7 @@ 
     /**
      * Set SQL query to be run, and set results for class
      *
-     * @return bool true on success / false on failure
+     * @return boolean|null true on success / false on failure
      * @access	public
      */
     function _setResults()

class/reportParameter.php

Doc Comments +2 added lines, -2 removed lines

@@ -32,7 +32,7 @@ 
     /**
      * Create a new xhelpReportParameter
      *
-     * @return object {@link xhelpReportParameter}
+     * @return xhelpReportParameter {@link xhelpReportParameter}
      * @access	public
      */
     function &create()
@@ -54,7 +54,7 @@ 
      * @param string $dbfield
      * @param string $dbaction
      *
-     * @return object {@link xhelpReportParameter}
+     * @return xhelpReportParameter {@link xhelpReportParameter}
      * @access	public
      */
     function addParam($controltype, $name, $fieldname, $value, $values, $fieldlength, $dbfield, $dbaction)

class/reportRendererFactory.php

Doc Comments +3 added lines

@@ -11,6 +11,9 @@
         // Constructor
     }
 
+    /**
+     * @param string $type
+     */
     function &getRenderer($type, &$report)
     {
         $ret = false;

class/staff.php

Doc Comments +4 added lines, -6 removed lines

@@ -51,9 +51,9 @@ 
      * Used to make sure that the user has rights to do an action
      *
      * @param int   $task
-     * @param mixed $depts integer/array of department id(s)
+     * @param integer $depts integer/array of department id(s)
      *
-     * @return TRUE if success, FALSE if failure
+     * @return boolean if success, FALSE if failure
      *
      * @access public
      */
@@ -196,7 +196,7 @@ 
      * @param int $roleid role id
      * @param int $deptid department id
      *
-     * @return TRUE if success, FALSE if failure
+     * @return boolean if success, FALSE if failure
      * @access public
      */
     function addStaffRole($uid, $roleid, $deptid)
@@ -272,8 +272,6 @@ 
      * Remove user from a role
      *
      * @param int $uid    user id
-     * @param int $roleid role id
-     * @param int $deptid department id
      *
      * @return TRUE if success, FALSE if failure
      * @access public
@@ -292,7 +290,7 @@ 
      * @param int $uid    user id
      * @param int $roleid role id
      *
-     * @return TRUE on success, FALSE on failure
+     * @return boolean on success, FALSE on failure
      * @access public
      */
     function staffInRole($uid, $roleid)

class/staffService.php

Doc Comments +5 added lines, -8 removed lines

@@ -37,7 +37,7 @@ 
      * Update staff response time if first staff response
      * @param  xhelpTicket    $ticket   Ticket for response
      * @param  xhelpResponses $response Response
-     * @return bool           True on success, false on error
+     * @return boolean|null           True on success, false on error
      * @access public
      */
     function new_response($ticket, $response)
@@ -58,11 +58,9 @@ 
 
     /**
      * Update staff response time if first staff response
-     * @param  xhelpTicket    $ticket    Ticket for response
+     * @param  xhelpTicket    $tickets    Ticket for response
      * @param  xhelpResponses $response  Response
-     * @param  int            $timespent Number of minutes spent on ticket
-     * @param  bool           $private   Is the response private?
-     * @return bool           True on success, false on error
+     * @return boolean|null           True on success, false on error
      * @access public
      */
     function batch_response($tickets, $response)
@@ -88,7 +86,7 @@ 
      * Handler for the 'batch_status' event
      * @param  array $tickets   Array of xhelpTicket objects
      * @param  int   $newstatus New Status of all tickets
-     * @return bool  True on success, false on error
+     * @return boolean|null  True on success, false on error
      * @access public
      */
     function batch_status($tickets, $newstatus)
@@ -123,7 +121,6 @@ 
 
     /**
      * Callback function for the 'reopen_ticket' event
-     * @param  array $args Array of arguments passed to EventService
      * @return bool  True on success, false on error
      * @access public
      */
@@ -158,7 +155,7 @@ 
     /**
      * Event Handler for 'view_ticket'
      * @param  xhelpTicket $ticket Ticket being viewd
-     * @return bool        True on success, false on error
+     * @return boolean|null        True on success, false on error
      * @access public
      */
     function view_ticket($ticket)

class/ticketEmails.php

Doc Comments -2 removed lines

@@ -107,7 +107,6 @@ 
      * retrieve objects from the database
      *
      * @param  object $criteria  {@link CriteriaElement} conditions to be met
-     * @param  bool   $id_as_key Should the department ID be used as array key
      * @return array  array of {@link xhelpDepartment} objects
      * @access	public
      */
@@ -141,7 +140,6 @@ 
      * retrieve objects from the database
      *
      * @param  object $criteria  {@link CriteriaElement} conditions to be met
-     * @param  bool   $id_as_key Should the department ID be used as array key
      * @return array  array of {@link xhelpDepartment} objects
      * @access	public
      */