XoopsModules25x / xhelp

class/mailboxPOP3.php

Doc Comments +4 added lines, -2 removed lines

@@ -85,7 +85,7 @@ 
     /**
      * Get Message Body
      * @param  $msg_id Message number
-     * @return mixed Either message body or false on error
+     * @return string|false Either message body or false on error
      */
     function getBody($i)
     {
@@ -96,7 +96,8 @@ 
      * Returns the entire message with given message number.
      *
      * @param  $msg_id Message number
-     * @return mixed Either entire message or false on error
+     * @param integer $i
+     * @return string|false Either entire message or false on error
      */
     function getMsg($i)
     {
@@ -108,6 +109,7 @@ 
      * disconnect() method is called.
      *
      * @param  $msg_id Message to delete
+     * @param integer $i
      * @return bool Success/Failure
      */
     function deleteMessage($i)

class/membership.php

Doc Comments +3 added lines, -3 removed lines

@@ -215,7 +215,7 @@ 
      *
      * @param  mixed $staff  single or array of uids or {@link xhelpStaff} objects
      * @param  int   $deptid Department ID
-     * @return bool  True if successful, False if not
+     * @return boolean|null  True if successful, False if not
      * @access public
      */
     function addStaffToDept(&$staff, $deptid)
@@ -263,7 +263,7 @@ 
      *
      * @param  mixed $staff  single or array of uids or {@link xhelpStaff} objects
      * @param  int   $deptid Department ID
-     * @return bool  True if successful, False if not
+     * @return boolean|null  True if successful, False if not
      * @access public
      */
     function  removeStaffFromDept(&$staff, $deptid)
@@ -287,7 +287,7 @@ 
      *
      * @param  mixed $dept single or array of department id's or {@link xhelpDepartment} objects
      * @param  int   $uid  User ID
-     * @return bool  True if successful, False if not
+     * @return boolean|null  True if successful, False if not
      * @access public
      */
     function removeDeptFromStaff(&$dept, $uid)

class/msgParser.php

Doc Comments +6 added lines

@@ -154,6 +154,9 @@ 
         return implode("\r\n",$msg);
     }
 
+    /**
+     * @param string $msg
+     */
     function _stripMd5Key($msg)
     {
         $pattern = '/^\*{4}\s'. _XHELP_TICKET_MD5SIGNATURE . '\s(.)*\*{4}/im';
@@ -262,6 +265,9 @@ 
         return $this->_name;
     }
 
+    /**
+     * @param string $header
+     */
     function getHeader($header)
     {
         if (isset($this->_headers[$header])) {

class/msgStore.php

Doc Comments +6 added lines

@@ -17,6 +17,9 @@ 
         $this->_errors     = array();
     }
 
+    /**
+     * @param string $desc
+     */
     function _setError($desc)
     {
         if(is_array($desc)){
@@ -178,6 +181,9 @@ 
         }
     }
 
+    /**
+     * @param string $fname
+     */
     function _addAttachmentError($errors, $msg, $fname)
     {
         if($errors <> 0){

class/notificationService.php

Doc Comments +2 added lines, -3 removed lines

@@ -239,7 +239,6 @@ 
     /**
      * Returns emails of staff belonging to an event
      *
-     * @param int $dept        ID of department
      * @param int $event_id    bit_value of event
      * @param int $submittedBy ID of user submitting event - should only be used when there is a response
      *
@@ -649,7 +648,7 @@ 
     /**
      * Confirm submission to user and notify staff members when new_ticket is triggered
      * @param  xhelpTicket $ticket Ticket that was added
-     * @return bool        True on success, false on error
+     * @return boolean|null        True on success, false on error
      * @access	public
      */
     function new_ticket(&$ticket)
@@ -1211,7 +1210,7 @@ 
      * Event: edit_response
      * Triggered after a response has been modified
      * Also See: new_response
-     * @param xhelpTicket    $nticket     Ticket after modifications
+     * @param xhelpTicket    $ticket     Ticket after modifications
      * @param xhelpResponses $response    Modified response
      * @param xhelpTicket    $oldticket   Ticket before modifications
      * @param xhelpResponses $oldresponse Response modifications

class/pear/Mail/mime.php

Doc Comments +8 added lines

@@ -277,6 +277,10 @@ 
      * @return object  The text mimePart object
      * @access private
      */
+
+    /**
+     * @param string $text
+     */
     function &_addTextPart(&$obj, $text){
 
         $params['content_type'] = 'text/plain';
@@ -335,6 +339,10 @@ 
      * @return object  The multipart/mixed mimePart object
      * @access private
      */
+
+    /**
+     * @param null|Mail_mimePart $obj
+     */
     function &_addAlternativePart(&$obj){
 
         $params['content_type'] = 'multipart/alternative';

class/pear/Mail/mimeDecode.php

Doc Comments +4 added lines

@@ -196,6 +196,8 @@ 
      *
      * @param string Header section
      * @param string Body section
+     * @param string $headers
+     * @param string $body
      * @return object Results of decoding process
      * @access private
      */
@@ -477,6 +479,7 @@ 
      * examples (in RFC2047).
      *
      * @param string Input header value to decode
+     * @param string $input
      * @return string Decoded header value
      * @access private
      */
@@ -762,6 +765,7 @@ 
      * @param  string  Name of header
      * @param  string  Value of header
      * @param  integer Number of tabs to indent
+     * @param integer $indent
      * @return string XML version of input
      * @access private
      */

class/pear/Mail/mimePart.php

Doc Comments +4 added lines, -4 removed lines

@@ -208,7 +208,7 @@ 
      * Encodes and returns the email. Also stores
      * it in the encoded member variable
      *
-     * @return An associative array containing two elements,
+     * @return string associative array containing two elements,
      *            body and headers. The headers element is itself
      *            an indexed array.
      * @access public
@@ -255,7 +255,7 @@ 
      * @param $body   The body of the subpart, if any.
      * @param $params The parameters for the subpart, same
      *                as the $params argument for constructor.
-     * @return A reference to the part you just added. It is
+     * @return Mail_mimePart reference to the part you just added. It is
      *           crucial if using multipart/* in your subparts that
      *           you use =& in your script when calling this function,
      *           otherwise you will not be able to add further subparts.
@@ -273,8 +273,8 @@ 
      *
      * Returns encoded data based upon encoding passed to it
      *
-     * @param $data     The data to encode.
-     * @param $encoding The encoding type to use, 7bit, base64,
+     * @param string $data     The data to encode.
+     * @param string $encoding The encoding type to use, 7bit, base64,
      *                  or quoted-printable.
      * @access private
      */

class/pear/Net/IMAP.php

Doc Comments +9 added lines, -8 removed lines

@@ -175,6 +175,10 @@ 
      *
      * @return bool Success/Pear_Error Failure
      */
+
+    /**
+     * @param string $mailbox
+     */
     function selectMailbox($mailbox)
     {
         $ret=$this->cmdSelect($mailbox);
@@ -595,8 +599,6 @@ 
      * Copies mail from one folder to another
      *
      * @param string $dest_mailbox   mailbox name to copy sessages to
-     * @param mixed  $message_set    the messages that I want to copy (all by default) it also
-     *                               can be an array
      * @param string $source_mailbox mailbox name from where the messages are copied
      *
      * @return mixed true on Success/PearError on Failure
@@ -694,9 +696,7 @@ 
     /**
      * Returns an array containing the names of the selected mailboxes
      *
-     * @param string $mailbox_base       base mailbox to start the search
-     *                                   $mailbox_base     if $mailbox_base == ''     then $mailbox_base is the curent selected mailbox
-     * @param string $restriction_search false or 0 means return all mailboxes  true or 1 return only the mailbox that contains that exact name
+     * @param integer $restriction_search false or 0 means return all mailboxes  true or 1 return only the mailbox that contains that exact name
      2  return all mailboxes in that hierarchy level
      * @param string $returnAttributes true means return an assoc array containing mailbox names and mailbox attributes
      false - the default - means return an array of mailboxes
@@ -825,7 +825,7 @@ 
     /**
      * Renames the mailbox $mailbox
      *
-     * @param string $mailbox mailbox name to rename
+     * @param string $oldmailbox mailbox name to rename
      *
      * @return mixed true on Success/PearError on Failure
      * @since 1.0
@@ -891,8 +891,6 @@ 
     /**
      * Lists the subscription to mailboxes
      *
-     * @param string $mailbox_base mailbox name start the search (see to getMailboxes() )
-     * @param string $mailbox_name mailbox name filter the search (see to getMailboxes() )
      *
      * @return mixed true on Success/PearError on Failure
      * @since 1.0
@@ -1064,6 +1062,9 @@ 
         return $this->hasFlag( $message_nro, "\\Deleted" );
     }
 
+    /**
+     * @param string $flag
+     */
     function hasFlag($message_nro,$flag)
     {
         if ( PEAR::isError( $resp = $this->getFlags( $message_nro ) ) ) {