[TASK] Added Tags to the DocComments.

[TASK] Reformated some classes.
This commit is contained in:
Jan Philipp Timme 2010-12-19 14:26:32 +00:00
parent 26036e9994
commit 3880b59f94
10 changed files with 11 additions and 7 deletions

View File

@ -9,6 +9,7 @@ class Client_BotClient extends Client_AbstractClient {
/** /**
* Default constructor. * Default constructor.
* @return void
*/ */
public function __construct() { public function __construct() {

View File

@ -143,6 +143,7 @@ class Client_ClientManager {
/** /**
* Closes and removes the connection. * Closes and removes the connection.
* @param Connection_ConnectionHandler $connectionHandler * @param Connection_ConnectionHandler $connectionHandler
* @return void
*/ */
public function removeConnection($connectionHandler) { public function removeConnection($connectionHandler) {
unset($this->configPool[$connectionHandler->getID()]); unset($this->configPool[$connectionHandler->getID()]);

View File

@ -112,6 +112,7 @@ class Connection_ConnectionHandler {
/** /**
* Injector for the internal ConnectionPool access. * Injector for the internal ConnectionPool access.
* @param Connection_ConnectionPool $connectionPool * @param Connection_ConnectionPool $connectionPool
* @return void
*/ */
public function injectConnectionPool($connectionPool) { public function injectConnectionPool($connectionPool) {
$this->connectionPool = $connectionPool; $this->connectionPool = $connectionPool;
@ -149,6 +150,7 @@ class Connection_ConnectionHandler {
/** /**
* Sets the IPv6-flag. * Sets the IPv6-flag.
* @param boolean $IPv6 * @param boolean $IPv6
* @return void
*/ */
public function setIPv6($IPv6) { public function setIPv6($IPv6) {
$this->IPv6 = $IPv6; $this->IPv6 = $IPv6;
@ -157,6 +159,7 @@ class Connection_ConnectionHandler {
/** /**
* Sets reconnect_on_disconnect flag. * Sets reconnect_on_disconnect flag.
* @param boolean $reconnect * @param boolean $reconnect
* @return void
*/ */
public function setReconnect($reconnect) { public function setReconnect($reconnect) {
$this->reconnect_on_disconnect = $reconnect; $this->reconnect_on_disconnect = $reconnect;

View File

@ -164,6 +164,7 @@ class Connection_ConnectionPool {
* Writes the given data to the socket with $id. * Writes the given data to the socket with $id.
* @param int $id * @param int $id
* @param string $data * @param string $data
* @return void
*/ */
public function writeToID($id, $data) { public function writeToID($id, $data) {
foreach($this->connectionHandlers AS $connectionHandler) { foreach($this->connectionHandlers AS $connectionHandler) {

View File

@ -12,6 +12,7 @@ class Exception_GeneralException extends Exception {
* @throws UnknownException * @throws UnknownException
* @param string $message * @param string $message
* @param int $code * @param int $code
* @return void
*/ */
public function __construct($message = "", $code = 0) { public function __construct($message = "", $code = 0) {
if ($message === "") { if ($message === "") {

View File

@ -58,6 +58,7 @@ abstract class Protocol_AbstractProtocolHandler {
/** /**
* Adds the incoming data to the internal buffer. * Adds the incoming data to the internal buffer.
* @param string $rawData * @param string $rawData
* @return void
*/ */
public function pushRawData($rawData) { public function pushRawData($rawData) {
$this->buffer_incoming->addData($rawData); $this->buffer_incoming->addData($rawData);

View File

@ -4,7 +4,5 @@
* @author JPT * @author JPT
* @package Protocol * @package Protocol
*/ */
class Protocol_BotProtocolContentObject extends Protocol_AbstractProtocolContentObject { class Protocol_BotProtocolContentObject extends Protocol_AbstractProtocolContentObject {}
}
?> ?>

View File

@ -187,6 +187,5 @@ class Protocol_IrcProtocolHandler extends Protocol_AbstractProtocolHandler {
$this->sendRaw("PONG :" . $param); $this->sendRaw("PONG :" . $param);
} }
} }
?> ?>

View File

@ -4,7 +4,5 @@
* @author JPT * @author JPT
* @package Protocol * @package Protocol
*/ */
class Protocol_RawProtocolContentObject extends Protocol_AbstractProtocolContentObject { class Protocol_RawProtocolContentObject extends Protocol_AbstractProtocolContentObject {}
}
?> ?>

View File

@ -213,6 +213,7 @@ class Socket_SocketHandler {
/** /**
* Gets last error from socket. * Gets last error from socket.
* @throws Exception_SocketException * @throws Exception_SocketException
* @return void
*/ */
protected function error() { protected function error() {
if(is_resource($this->socket) === FALSE) throw new Exception_SocketException("No socket resource available!", 1290954177); if(is_resource($this->socket) === FALSE) throw new Exception_SocketException("No socket resource available!", 1290954177);