x-tools / xtools

src/AppBundle/Controller/TopEditsController.php

Doc Comments +1 added lines, -1 removed lines

@@ -96,7 +96,7 @@
      * List top edits by this user for all pages in a particular namespace.
      * @param User $user The User.
      * @param Project $project The project.
-     * @param integer|string $namespaceId The namespace ID or 'all'
+     * @param integer $namespaceId The namespace ID or 'all'
      * @return \Symfony\Component\HttpFoundation\Response
      */
     protected function namespaceTopEdits(User $user, Project $project, $namespaceId)

src/AppBundle/Twig/AppExtension.php

Doc Comments +2 added lines, -2 removed lines

@@ -24,7 +24,7 @@ 
 
     /**
      * Get all functions that this class provides.
-     * @return array
+     * @return \Twig_SimpleFunction[]
      */
     public function getFunctions()
     {
@@ -520,7 +520,7 @@ 
 
     /**
      * Get all filters for this extension.
-     * @return array
+     * @return \Twig_SimpleFilter[]
      */
     public function getFilters()
     {

src/AppBundle/Twig/WikiExtension.php

Doc Comments +1 added lines, -1 removed lines

@@ -49,7 +49,7 @@
 
     /**
      * Get all functions provided by this extension.
-     * @return array
+     * @return \Twig_SimpleFilter[]
      */
     public function getFilters()
     {

src/AppBundle/Helper/ApiHelper.php

Doc Comments +1 added lines, -1 removed lines

@@ -255,7 +255,7 @@
      * Adapted from https://github.com/MusikAnimal/pageviews
      * @param  array       $params        Associative array of params to pass to API
      * @param  string      $project       Project to query, e.g. en.wikipedia.org
-     * @param  string|func $dataKey       The key for the main chunk of data, in the query hash
+     * @param  string $dataKey       The key for the main chunk of data, in the query hash
      *                                    (e.g. 'categorymembers' for API:Categorymembers).
      *                                    If this is a function it is given the response data,
      *                                    and expected to return the data we want to concatentate.

src/Xtools/Project.php

Doc Comments +1 added lines, -1 removed lines

@@ -200,7 +200,7 @@
     /**
      * Get an array of this project's namespaces and their IDs.
      *
-     * @return string[] Keys are IDs, values are names.
+     * @return string Keys are IDs, values are names.
      */
     public function getNamespaces()
     {

src/Xtools/Page.php

Doc Comments +5 added lines, -7 removed lines

@@ -59,7 +59,7 @@ 
 
     /**
      * Get this page's database ID.
-     * @return int
+     * @return \string|null
      */
     public function getId()
     {
@@ -69,7 +69,7 @@ 
 
     /**
      * Get this page's length in bytes.
-     * @return int
+     * @return \string|null
      */
     public function getLength()
     {
@@ -93,7 +93,7 @@ 
 
     /**
      * Get the full URL of this page.
-     * @return string
+     * @return \string|null
      */
     public function getUrl()
     {
@@ -103,7 +103,7 @@ 
 
     /**
      * Get the numerical ID of the namespace of this page.
-     * @return int
+     * @return \string|null
      */
     public function getNamespace()
     {
@@ -113,7 +113,7 @@ 
 
     /**
      * Get the number of page watchers.
-     * @return int
+     * @return \string|null
      */
     public function getWatchers()
     {
@@ -378,7 +378,6 @@ 
 
     /**
      * Get all wikidata items for the page, not just languages of sister projects
-     * @param Page $page
      * @return int Number of records.
      */
     public function getWikidataItems()
@@ -388,7 +387,6 @@ 
 
     /**
      * Count wikidata items for the page, not just languages of sister projects
-     * @param Page $page
      * @return int Number of records.
      */
     public function countWikidataItems()

src/Xtools/PagesRepository.php

Doc Comments +2 added lines, -2 removed lines

@@ -18,7 +18,7 @@ 
      * Get metadata about a single page from the API.
      * @param Project $project The project to which the page belongs.
      * @param string $pageTitle Page title.
-     * @return string[] Array with some of the following keys: pageid, title, missing, displaytitle,
+     * @return string|null Array with some of the following keys: pageid, title, missing, displaytitle,
      * url.
      */
     public function getPageInfo(Project $project, $pageTitle)
@@ -96,7 +96,7 @@ 
      * Get the statement for a single revision, so that you can iterate row by row.
      * @param Page $page The page.
      * @param User|null $user Specify to get only revisions by the given user.
-     * @return Doctrine\DBAL\Driver\PDOStatement
+     * @return \Doctrine\DBAL\Driver\Statement
      */
     public function getRevisionsStmt(Page $page, User $user = null)
     {

src/Xtools/UserRepository.php

Doc Comments +1 added lines, -1 removed lines

@@ -695,7 +695,7 @@
      * Get the combined regex and tags for all semi-automated tools,
      *   ready to be used in a query.
      * @param string $projectDomain Such as en.wikipedia.org
-     * @param $conn Doctrine\DBAL\Connection Used for proper escaping
+     * @param \Doctrine\DBAL\Connection $conn Doctrine\DBAL\Connection Used for proper escaping
      * @return string[] In the format:
      *    ['combined|regex', 'combined,tags']
      */

src/Xtools/RFA.php

Doc Comments +4 added lines, -1 removed lines

@@ -20,7 +20,7 @@ 
      * Returns matches.
      *
      * @param $input
-     * @param $matches
+     * @param string[] $matches
      *
      * @return int
      */
@@ -85,6 +85,9 @@ 
         return $this->userSectionFound;
     }
 
+    /**
+     * @param string $sectionName
+     */
     public function getSection($sectionName) {
         $sectionName = strtolower($sectionName);
         if (!isset($this->data[$sectionName])) {