x-tools / xtools

src/AppBundle/Controller/ArticleInfoController.php

Doc Comments -1 removed lines

@@ -380,7 +380,6 @@
 
     /**
      * Get the size of the diff
-     * @param  int $rev The index of the revision within $this->pageHistory
      * @return int Size of the diff
      */
     private function getDiffSize($revIndex)

var/SymfonyRequirements.php

Doc Comments +2 added lines, -2 removed lines

@@ -223,7 +223,7 @@ 
      * Adds a mandatory requirement in form of a php.ini configuration.
      *
      * @param string        $cfgName           The configuration name used for ini_get()
-     * @param bool|callback $evaluation        Either a boolean indicating whether the configuration should evaluate to true or false,
+     * @param boolean|string $evaluation        Either a boolean indicating whether the configuration should evaluate to true or false,
      *                                         or a callback function receiving the configuration value as parameter to determine the fulfillment of the requirement
      * @param bool          $approveCfgAbsence If true the Requirement will be fulfilled even if the configuration option does not exist, i.e. ini_get() returns false.
      *                                         This is helpful for abandoned configs in later PHP versions or configs of an optional extension, like Suhosin.
@@ -241,7 +241,7 @@ 
      * Adds an optional recommendation in form of a php.ini configuration.
      *
      * @param string        $cfgName           The configuration name used for ini_get()
-     * @param bool|callback $evaluation        Either a boolean indicating whether the configuration should evaluate to true or false,
+     * @param string|false $evaluation        Either a boolean indicating whether the configuration should evaluate to true or false,
      *                                         or a callback function receiving the configuration value as parameter to determine the fulfillment of the requirement
      * @param bool          $approveCfgAbsence If true the Requirement will be fulfilled even if the configuration option does not exist, i.e. ini_get() returns false.
      *                                         This is helpful for abandoned configs in later PHP versions or configs of an optional extension, like Suhosin.

src/AppBundle/Twig/WikiExtension.php

Doc Comments +1 added lines, -2 removed lines

@@ -72,7 +72,6 @@ 
 
     /**
      * Get a link to the given user's userpage, or to Special:Contribs if $username is an IP
-     * @param  string $username   Username
      * @param  string $projectUrl Project domain and protocol such as https://en.wikipedia.org
      * @param  string [$label]    The link text, defaults to $username
      * @return string Markup
@@ -176,7 +175,7 @@ 
     /**
      * Get links to pageviews tools for the given page
      * @param  string $title      Title of page
-     * @param  string $projectUrl Project domain such as en.wikipedia.org
+     * @param  string $project Project domain such as en.wikipedia.org
      * @return string Markup
      */
     public function pageviewsLinks($title, $project)

src/Xtools/Project.php

Doc Comments +3 added lines

@@ -14,6 +14,9 @@
     /** @var string[] Basic metadata about the project */
     protected $metadata;
 
+    /**
+     * @param string $nameOrUrl
+     */
     public function __construct($nameOrUrl)
     {
         $this->nameUnnormalized = $nameOrUrl;

src/Xtools/Page.php

Doc Comments +2 added lines, -2 removed lines

@@ -52,7 +52,7 @@ 
 
     /**
      * Get this page's database ID.
-     * @return int
+     * @return \string|null
      */
     public function getId()
     {
@@ -75,7 +75,7 @@ 
     }
 
     /**
-     * @return string
+     * @return \string|null
      */
     public function getUrl()
     {

src/AppBundle/Helper/ApiHelper.php

Doc Comments +1 added lines, -1 removed lines

@@ -177,7 +177,7 @@
      * Get a list of namespaces on the given project.
      *
      * @param string    $project such as en.wikipedia.org
-     * @return string[] Array of namespace IDs (keys) to names (values).
+     * @return string Array of namespace IDs (keys) to names (values).
      */
     public function namespaces($project)
     {

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/Xtools/PagesRepository.php

Doc Comments +2 added lines, -3 removed lines

@@ -15,7 +15,7 @@ 
      * @param Project $project The project to which the page belongs.
      * @param string $pageTitle Page title.
      * @param boolean $followRedirects Whether or not to resolve redirects
-     * @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, $followRedirects = true)
@@ -63,9 +63,8 @@ 
 
     /**
      * Get revisions of a single page.
-     * @param Project $project
      * @param Page $page
-     * @param User|null $user
+     * @param User $user
      * @return string[] Each member with keys: id, timestamp, length-
      */
     public function getRevisions(Page $page, User $user)

src/Xtools/EditCounterRepository.php

Doc Comments +1 added lines, -3 removed lines

@@ -249,7 +249,6 @@ 
      * Get a user's total edit count on one or more project.
      * Requires the CentralAuth extension to be installed on the project.
      *
-     * @param string $username The username.
      * @param Project $project The project to start from.
      * @return mixed[]|boolean Array of total edit counts, or false if none could be found.
      */
@@ -296,7 +295,7 @@ 
 
     /**
      * Get total edit counts for the top 10 projects for this user.
-     * @param string $username The username.
+     * @param string $stopwatchName
      * @return string[] Elements are arrays with 'dbName', 'url', 'name', and 'total'.
      */
     protected function getRevisionCountsAllProjectsNoCentralAuth(
@@ -459,7 +458,6 @@ 
 
     /**
      * Get yearly edit totals for this user, grouped by namespace.
-     * @param string $username
      * @return string[] ['<namespace>' => ['<year>' => 'total', ... ], ... ]
      */
     public function getYearCounts(Project $project, User $user)