Merge pull request #285 from stephane-monnot/feature/fixdocblockissues

Fix php docblock issues
FriendsOfSymfony · Aug 26, 2016 · cdb93fe · cdb93fe
2 parents f824ef8 + 342c31a
commit cdb93fe
Show file tree

Hide file tree

Showing 10 changed files with 25 additions and 23 deletions.
diff --git a/Document/Thread.php b/Document/Thread.php
@@ -57,7 +57,7 @@ abstract class Thread extends AbstractThread
     /**
      * Gets the users participating in this conversation
      *
-     * @return array of ParticipantInterface
+     * @return ParticipantInterface[]
      */
     public function getParticipants()
     {

diff --git a/DocumentManager/ThreadManager.php b/DocumentManager/ThreadManager.php
@@ -98,7 +98,7 @@ public function getParticipantInboxThreadsQueryBuilder(ParticipantInterface $par
      * In one word: an inbox.
      *
      * @param ParticipantInterface $participant
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function findParticipantInboxThreads(ParticipantInterface $participant)
     {
@@ -132,7 +132,7 @@ public function getParticipantSentThreadsQueryBuilder(ParticipantInterface $part
      * In one word: an sentbox.
      *
      * @param ParticipantInterface $participant
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function findParticipantSentThreads(ParticipantInterface $participant)
     {
@@ -192,7 +192,7 @@ public function getParticipantThreadsBySearchQueryBuilder(ParticipantInterface $
      *
      * @param ParticipantInterface $participant
      * @param string $search
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function findParticipantThreadsBySearch(participantinterface $participant, $search)
     {
@@ -203,7 +203,7 @@ public function findParticipantThreadsBySearch(participantinterface $participant
      * Gets threads created by a participant
      *
      * @param ParticipantInterface $participant
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function findThreadsCreatedBy(ParticipantInterface $participant)
     {

diff --git a/Entity/Thread.php b/Entity/Thread.php
@@ -58,7 +58,7 @@ abstract class Thread extends BaseThread
     /**
      * Gets the users participating in this conversation
      *
-     * @return array of ParticipantInterface
+     * @return ParticipantInterface[]
      */
     public function getParticipants()
     {

diff --git a/EntityManager/ThreadManager.php b/EntityManager/ThreadManager.php
@@ -117,7 +117,7 @@ public function getParticipantInboxThreadsQueryBuilder(ParticipantInterface $par
      * In one word: an inbox.
      *
      * @param ParticipantInterface $participant
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function findParticipantInboxThreads(ParticipantInterface $participant)
     {
@@ -168,7 +168,7 @@ public function getParticipantSentThreadsQueryBuilder(ParticipantInterface $part
      * In one word: an sentbox.
      *
      * @param ParticipantInterface $participant
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function findParticipantSentThreads(ParticipantInterface $participant)
     {
@@ -235,7 +235,7 @@ public function getParticipantThreadsBySearchQueryBuilder(ParticipantInterface $
      *
      * @param ParticipantInterface $participant
      * @param string $search
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function findParticipantThreadsBySearch(participantinterface $participant, $search)
     {
@@ -248,7 +248,7 @@ public function findParticipantThreadsBySearch(participantinterface $participant
      * Gets threads created by a participant
      *
      * @param ParticipantInterface $participant
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function findThreadsCreatedBy(ParticipantInterface $participant)
     {

diff --git a/Model/ThreadInterface.php b/Model/ThreadInterface.php
@@ -80,14 +80,14 @@ function getCreatedAt();
      * Sets the date this thread was created at
      * Generally the date of the first message
      *
-     * @param DateTime
+     * @param \DateTime $createdAt
      */
     function setCreatedAt(\DateTime $createdAt);
 
     /**
      * Gets the users participating in this conversation
      *
-     * @return array of ParticipantInterface
+     * @return ParticipantInterface[]
      */
     function getParticipants();
 
@@ -133,7 +133,9 @@ function setIsDeleted($isDeleted);
     /**
      * Get the participants this participant is talking with.
      *
-     * @return array of ParticipantInterface
+     * @param ParticipantInterface $participant
+     *
+     * @return ParticipantInterface[]
      */
     function getOtherParticipants(ParticipantInterface $participant);
 }
diff --git a/ModelManager/ThreadManagerInterface.php b/ModelManager/ThreadManagerInterface.php
@@ -40,7 +40,7 @@ function getParticipantInboxThreadsQueryBuilder(ParticipantInterface $participan
      * In one word: an inbox.
      *
      * @param ParticipantInterface $participant
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     function findParticipantInboxThreads(ParticipantInterface $participant);
 
@@ -62,7 +62,7 @@ function getParticipantSentThreadsQueryBuilder(ParticipantInterface $participant
      * In one word: an sentbox.
      *
      * @param ParticipantInterface $participant
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     function findParticipantSentThreads(ParticipantInterface $participant);
 
@@ -102,15 +102,15 @@ function getParticipantThreadsBySearchQueryBuilder(ParticipantInterface $partici
      *
      * @param ParticipantInterface $participant
      * @param string $search
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     function findParticipantThreadsBySearch(ParticipantInterface $participant, $search);
 
     /**
      * Gets threads created by a participant
      *
      * @param ParticipantInterface $participant
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     function findThreadsCreatedBy(ParticipantInterface $participant);
 

diff --git a/Provider/Provider.php b/Provider/Provider.php
@@ -64,7 +64,7 @@ public function __construct(ThreadManagerInterface $threadManager, MessageManage
     /**
      * Gets the thread in the inbox of the current user
      *
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function getInboxThreads()
     {
@@ -76,7 +76,7 @@ public function getInboxThreads()
     /**
      * Gets the thread in the sentbox of the current user
      *
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function getSentThreads()
     {

diff --git a/Provider/ProviderInterface.php b/Provider/ProviderInterface.php
@@ -12,14 +12,14 @@ interface ProviderInterface
     /**
      * Gets the thread in the inbox of the current user
      *
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     function getInboxThreads();
 
     /**
      * Gets the thread in the sentbox of the current user
      *
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
      function getSentThreads();
 

diff --git a/Search/Finder.php b/Search/Finder.php
@@ -36,7 +36,7 @@ public function __construct(ParticipantProviderInterface $participantProvider, T
      * Finds threads of a participant, matching a given query
      *
      * @param Query $query
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     public function find(Query $query)
     {

diff --git a/Search/FinderInterface.php b/Search/FinderInterface.php
@@ -13,7 +13,7 @@ interface FinderInterface
      * Finds threads of a participant, matching a given query
      *
      * @param Query $query
-     * @return array of ThreadInterface
+     * @return ThreadInterface[]
      */
     function find(Query $query);