tidal / PEIP

src/Factory/ServiceFactory.php

Doc Comments +1 added lines, -1 removed lines

@@ -71,7 +71,7 @@
      * @see GenericBuilder

      * @static

      * @access protected

-     * @param object $className name of class to build instance for.

+     * @param string $className name of class to build instance for.

      * @param array $arguments arguments for the constructor

      * @return object build and modified srvice instance

      */

src/INF/Channel/Channel.php

Doc Comments +3 added lines, -3 removed lines

@@ -33,10 +33,10 @@
      * Send a message, blocking until either the message is accepted or the

      * specified timeout period elapses.

      * 

-     * @param message the {@link Message} to send

-     * @param timeout the timeout in milliseconds

+     * @param message \PEIP\INF\Message\Message {@link Message} to send

+     * @param timeout integer timeout in milliseconds

      * 

-     * @return <code>true</code> if the message is sent successfully,

+     * @return void if the message is sent successfully,

      * <code>false</false> if the specified timeout period elapses or

      * the send is interrupted

      */

src/Message/TextMessage.php

Doc Comments -1 removed lines

@@ -64,7 +64,6 @@
      * @static

      * @access public

      * @implements \PEIP\INF\Base\Buildable

-     * @param string $name the name of the header

      * @return boolean wether the header is set

      */

     public static function build(array $arguments = array()){

src/Pipe/FixedEventPipe.php

Doc Comments +1 added lines, -1 removed lines

@@ -42,7 +42,7 @@
     

     /**

      * @access public

-     * @param $eventName 

+     * @param string $eventName 

      * @return 

      */

     public function setEventName($eventName){

src/Plugins/BasePlugin.php

Doc Comments +3 added lines, -2 removed lines

@@ -217,7 +217,7 @@ 
      *

      * @access protected

      * @param object $config configuration object to create arguments from.

-     * @return mixed build arguments

+     * @return \PEIP\INF\Channel\Channel[] build arguments

      */

     protected function getReplyHandlerArguments($config){

         $args = array(

@@ -262,7 +262,8 @@ 
      *

      * @access protected

      * @param string the configuration type ofthe channel (e.g.: 'reply', 'request')

-     * @param object $config configuration object to return channel from.

+     * @param object $config configuration object to return channel from.
+     * @param string $type

      * @return \PEIP\INF\Channel\Channel reply-channel

      */

     public function doGetChannel($type, $config){

src/Service/ServiceProvider.php

Doc Comments +3 added lines

@@ -112,6 +112,9 @@
         );

     }

 

+    /**
+     * @param string $key
+     */
     public function provideService($key){

         $this->doFireEvent(self::EVENT_BEFORE_PROVIDE_SERVICE, array(

             self::HEADER_KEY=>$key)

src/Dispatcher/ClassEventDispatcher.php

Doc Comments +2 added lines, -2 removed lines

@@ -23,7 +23,7 @@ 
      * @access public

      * @param string $name name of the event

      * @param \PEIP\INF\Event\Event $object an event object

-     * @return boolean

+     * @return boolean|null

      */

     public function notify($name, $object){ 

         if($object instanceof \PEIP\INF\Event\Event){

@@ -53,7 +53,7 @@ 
      * @param array $headers headers of the event-object as key/value pairs

      * @param string $eventClass event-class to create instances from

      * @return

-     * @see EventBuilder

+     boolean|null @see EventBuilder

      */

     public function buildAndNotify($name, $object, array $headers = array(), $eventClass = false, $type = false){

         if(!$this->hasListeners($name, ($object))){

src/Message/StringMessage.php

Doc Comments -1 removed lines

@@ -64,7 +64,6 @@
      * @static

      * @access public

      * @implements \PEIP\INF\Base\Buildable

-     * @param string $name the name of the header

      * @return boolean wether the header is set

      */

     public static function build(array $arguments = array()){

src/ABS/Base/Connectable.php

Doc Comments +1 added lines, -1 removed lines

@@ -38,7 +38,7 @@
     

     /**

      * @access public

-     * @param $name

+     * @param string $name

      * @param Callable|PEIP\INF\Handler\Handler $listener

      * @return

      */