silverstripe / silverstripe-staticpublishqueue

code/model/FilesystemPublisher.php

Doc Comments +1 added lines, -1 removed lines

@@ -470,7 +470,7 @@
     /**
      * @param string $url
      *
-     * @return array
+     * @return string[]
      */
     public function getMetadata($url)
     {

code/model/StaticPagesQueue.php

Doc Comments +3 added lines, -3 removed lines

@@ -161,8 +161,9 @@ 
      * If we are using MySQLDatabase with InnoDB, we do row-level locking when updating the dataobject to allow for
      * distributed cache rebuilds
      * @static
-     * @param $freshness
+     * @param string $freshness
      * @param $sortOrder
+     * @param string $interval
      */
     protected static function get_queue_object($freshness, $interval = null, $sortOrder = array('Priority'=>'DESC', 'ID'=>'ASC'))
     {
@@ -277,7 +278,7 @@ 
      * Removes all duplicates that has the same URLSegment as $ID
      *
      * @param int $ID - ID of the object whose duplicates we want to remove
-     * @return void
+     * @return integer|null
      */
     public static function remove_duplicates($ID)
     {
@@ -293,7 +294,6 @@ 
     /**
      *
      * @param string $url
-     * @param bool $onlyStale - Get only stale entries
      * @return DataObject || false - The first item matching the query
      */
     protected static function get_by_link($url)

code/model/StaticPagesQueueEvent.php

Doc Comments +1 added lines, -1 removed lines

@@ -56,7 +56,7 @@
 
     /**
      *
-     * @param StaticPagesQueue $eventClass
+     * @param StaticPagesQueueEvent $eventClass
      * @return bool - if the event was fired or not
      * @throws Exception 
      */

code/reports/BuildStaticCacheSummaryReport.php

Doc Comments +1 added lines, -1 removed lines

@@ -48,7 +48,7 @@
      * @param unknown $params
      * @param array $sort
      * @param int $limit
-     * @return DataObjectSet or false
+     * @return DataList or false
      */
     public function sourceRecords($params, $sort, $limit)
     {

code/reports/StaticPagesQueueReport.php

Doc Comments +1 added lines, -1 removed lines

@@ -29,7 +29,7 @@
      * @param array $params
      * @param array $sort
      * @param int $limit
-     * @return DataObjectSet or false
+     * @return ArrayList or false
      */
     public function sourceRecords(array $params, $sort, $limit)
     {

code/tasks/BuildStaticCacheFromQueue.php

Doc Comments +4 added lines, -2 removed lines

@@ -162,7 +162,7 @@ 
      * If a SubsiteID GET parameter is found in the URL, the page is generated into a directory,
      * regardless if it's from the main site or subsite.
      *
-     * @param array $URLSegments
+     * @param string[] $URLSegments
      */
     protected function createCachedFiles(array $URLSegments)
     {
@@ -311,6 +311,8 @@ 
     /**
      *
      * @param int $publishedPages - the number of pages published so far
+     * @param boolean $finished
+     * @param double $prePublishTime
      */
     protected function logSummary($publishedPages, $finished, $prePublishTime)
     {
@@ -357,6 +359,7 @@ 
      * Check if another instance is running with the regard to a timelimit.
      *
      * @var int $secondsBeforeDead
+     * @param integer $secondsBeforeDead
      * @return bool
      */
     protected function anotherInstanceRunning($secondsBeforeDead)
@@ -382,7 +385,6 @@ 
     /**
      * Adds information to the pid file
      *
-     * @param float $microtime
      * @return void
      */
     protected function updatePid()

code/tasks/SiteTreeFullBuildEngine.php

Doc Comments +2 added lines, -2 removed lines

@@ -50,7 +50,7 @@ 
     /**
      * 
      * @param SS_HTTPRequest $request
-     * @return bool
+     * @return boolean|null
      */
     public function run($request)
     {
@@ -99,7 +99,7 @@ 
 
     /**
      * Process a chunk of pages
-     * @param $start
+     * @param integer $start
      */
     protected function runFrom($start)
     {