Fixed invalid PhpDoc tag.

This commit is contained in:
Juan Basso 2011-04-28 21:25:18 -04:00
parent 54429837b4
commit 50206f4315
2 changed files with 23 additions and 23 deletions

View file

@ -277,7 +277,7 @@ class CakeEmail {
* @param mixed $email * @param mixed $email
* @param string $name * @param string $name
* @return mixed * @return mixed
* @thrown SocketException * @throws SocketException
*/ */
public function from($email = null, $name = null) { public function from($email = null, $name = null) {
if ($email === null) { if ($email === null) {
@ -292,7 +292,7 @@ class CakeEmail {
* @param mixed $email * @param mixed $email
* @param string $name * @param string $name
* @return mixed * @return mixed
* @thrown SocketException * @throws SocketException
*/ */
public function sender($email = null, $name = null) { public function sender($email = null, $name = null) {
if ($email === null) { if ($email === null) {
@ -307,7 +307,7 @@ class CakeEmail {
* @param mixed $email * @param mixed $email
* @param string $name * @param string $name
* @return mixed * @return mixed
* @thrown SocketException * @throws SocketException
*/ */
public function replyTo($email = null, $name = null) { public function replyTo($email = null, $name = null) {
if ($email === null) { if ($email === null) {
@ -322,7 +322,7 @@ class CakeEmail {
* @param mixed $email * @param mixed $email
* @param string $name * @param string $name
* @return mixed * @return mixed
* @thrown SocketException * @throws SocketException
*/ */
public function readReceipt($email = null, $name = null) { public function readReceipt($email = null, $name = null) {
if ($email === null) { if ($email === null) {
@ -337,7 +337,7 @@ class CakeEmail {
* @param mixed $email * @param mixed $email
* @param string $name * @param string $name
* @return mixed * @return mixed
* @thrown SocketException * @throws SocketException
*/ */
public function returnPath($email = null, $name = null) { public function returnPath($email = null, $name = null) {
if ($email === null) { if ($email === null) {
@ -428,7 +428,7 @@ class CakeEmail {
* @param mixed $email * @param mixed $email
* @param mixed $name * @param mixed $name
* @return object $this * @return object $this
* @thrown SocketException * @throws SocketException
*/ */
protected function _setEmail($varName, $email, $name) { protected function _setEmail($varName, $email, $name) {
if (!is_array($email)) { if (!is_array($email)) {
@ -463,7 +463,7 @@ class CakeEmail {
* @param string $name * @param string $name
* @param string $throwMessage * @param string $throwMessage
* @return object $this * @return object $this
* @thrown SocketExpceiton * @throws SocketExpceiton
*/ */
protected function _setEmailSingle($varName, $email, $name, $throwMessage) { protected function _setEmailSingle($varName, $email, $name, $throwMessage) {
$current = $this->{$varName}; $current = $this->{$varName};
@ -527,7 +527,7 @@ class CakeEmail {
* *
* @param array Associative array containing headers to be set. * @param array Associative array containing headers to be set.
* @return object $this * @return object $this
* @thrown SocketException * @throws SocketException
*/ */
public function setHeaders($headers) { public function setHeaders($headers) {
if (!is_array($headers)) { if (!is_array($headers)) {
@ -542,7 +542,7 @@ class CakeEmail {
* *
* @param array $headers * @param array $headers
* @return mixed $this * @return mixed $this
* @thrown SocketException * @throws SocketException
*/ */
public function addHeaders($headers) { public function addHeaders($headers) {
if (!is_array($headers)) { if (!is_array($headers)) {
@ -720,7 +720,7 @@ class CakeEmail {
* *
* @param string $format * @param string $format
* @return mixed * @return mixed
* @thrown SocketException * @throws SocketException
*/ */
public function emailFormat($format = null) { public function emailFormat($format = null) {
if ($format === null) { if ($format === null) {
@ -752,7 +752,7 @@ class CakeEmail {
* Return the transport class * Return the transport class
* *
* @return object * @return object
* @thrown SocketException * @throws SocketException
*/ */
public function transportClass() { public function transportClass() {
if ($this->_transportClass) { if ($this->_transportClass) {
@ -775,7 +775,7 @@ class CakeEmail {
* *
* @param mixed $message True to generate a new Message-ID, False to ignore (not send in email), String to set as Message-ID * @param mixed $message True to generate a new Message-ID, False to ignore (not send in email), String to set as Message-ID
* @return mixed * @return mixed
* @thrown SocketException * @throws SocketException
*/ */
public function messageId($message = null) { public function messageId($message = null) {
if ($message === null) { if ($message === null) {
@ -797,7 +797,7 @@ class CakeEmail {
* *
* @param mixed $attachments String with the filename or array with filenames * @param mixed $attachments String with the filename or array with filenames
* @return mixed * @return mixed
* @thrown SocketException * @throws SocketException
*/ */
public function attachments($attachments = null) { public function attachments($attachments = null) {
if ($attachments === null) { if ($attachments === null) {
@ -832,7 +832,7 @@ class CakeEmail {
* *
* @param mixed $attachments String with the filename or array with filenames * @param mixed $attachments String with the filename or array with filenames
* @return object $this * @return object $this
* @thrown SocketException * @throws SocketException
*/ */
public function addAttachments($attachments) { public function addAttachments($attachments) {
$current = $this->_attachments; $current = $this->_attachments;
@ -885,7 +885,7 @@ class CakeEmail {
* Send an email using the specified content, template and layout * Send an email using the specified content, template and layout
* *
* @return boolean Success * @return boolean Success
* @thrown SocketException * @throws SocketException
*/ */
public function send($content = null) { public function send($content = null) {
if (is_string($this->_config)) { if (is_string($this->_config)) {

View file

@ -44,7 +44,7 @@ class SmtpTransport extends AbstractTransport {
* *
* @params object $email CakeEmail * @params object $email CakeEmail
* @return boolean * @return boolean
* @thrown SocketException * @throws SocketException
*/ */
public function send(CakeEmail $email) { public function send(CakeEmail $email) {
$this->_cakeEmail = $email; $this->_cakeEmail = $email;
@ -80,7 +80,7 @@ class SmtpTransport extends AbstractTransport {
* Connect to SMTP Server * Connect to SMTP Server
* *
* @return void * @return void
* @thrown SocketException * @throws SocketException
*/ */
protected function _connect() { protected function _connect() {
$this->_generateSocket(); $this->_generateSocket();
@ -112,7 +112,7 @@ class SmtpTransport extends AbstractTransport {
* Send authentication * Send authentication
* *
* @return void * @return void
* @thrown SocketException * @throws SocketException
*/ */
protected function _auth() { protected function _auth() {
if (isset($this->_config['username']) && isset($this->_config['password'])) { if (isset($this->_config['username']) && isset($this->_config['password'])) {
@ -134,7 +134,7 @@ class SmtpTransport extends AbstractTransport {
* Send emails * Send emails
* *
* @return void * @return void
* @thrown SocketException * @throws SocketException
*/ */
protected function _sendRcpt() { protected function _sendRcpt() {
$from = $this->_cakeEmail->from(); $from = $this->_cakeEmail->from();
@ -153,7 +153,7 @@ class SmtpTransport extends AbstractTransport {
* Send Data * Send Data
* *
* @return void * @return void
* @thrown SocketException * @throws SocketException
*/ */
protected function _sendData() { protected function _sendData() {
$this->_smtpSend('DATA', '354'); $this->_smtpSend('DATA', '354');
@ -168,7 +168,7 @@ class SmtpTransport extends AbstractTransport {
* Disconnect * Disconnect
* *
* @return void * @return void
* @thrown SocketException * @throws SocketException
*/ */
protected function _disconnect() { protected function _disconnect() {
$this->_smtpSend('QUIT', false); $this->_smtpSend('QUIT', false);
@ -179,7 +179,7 @@ class SmtpTransport extends AbstractTransport {
* Helper method to generate socket * Helper method to generate socket
* *
* @return void * @return void
* @thrown SocketException * @throws SocketException
*/ */
protected function _generateSocket() { protected function _generateSocket() {
$this->_socket = new CakeSocket($this->_config); $this->_socket = new CakeSocket($this->_config);
@ -191,7 +191,7 @@ class SmtpTransport extends AbstractTransport {
* @param string $data data to be sent to SMTP server * @param string $data data to be sent to SMTP server
* @param mixed $checkCode code to check for in server response, false to skip * @param mixed $checkCode code to check for in server response, false to skip
* @return void * @return void
* @thrown SocketException * @throws SocketException
*/ */
function _smtpSend($data, $checkCode = '250') { function _smtpSend($data, $checkCode = '250') {
if (!is_null($data)) { if (!is_null($data)) {