humanmade / backupwordpress

classes/backup/class-backup-utilities.php

Doc Comments +1 added lines, -1 removed lines

@@ -91,7 +91,7 @@
 	/**
 	 * Attempt to work out path to a cli executable.
 	 *
-	 * @param  array $paths An array of paths to check against.
+	 * @param  string[] $paths An array of paths to check against.
 	 *
 	 * @return string|false        The path to the executable.
 	 */

admin/schedule-sentence.php

Doc Comments +1 added lines, -1 removed lines

@@ -147,7 +147,7 @@
  * Returns a formatted string containing the calculated total site size or a message
  * to indicate it is being calculated.
  *
- * @param HM\BackUpWordPress\Scheduled_Backup $schedule
+ * @param Scheduled_Backup $schedule
  *
  * @return string
  */

classes/class-scheduled-backup.php

Doc Comments +6 added lines, -4 removed lines

@@ -158,7 +158,7 @@ 
 	/**
 	 * Get the exclude rules
 	 *
-	 * @return array
+	 * @return Excludes
 	 */
 	public function get_excludes() {
 		return new Excludes( $this->options['excludes'] );
@@ -167,7 +167,7 @@ 
 	/**
 	 * Set the exclude rules
 	 *
-	 * @param mixed $excludes A comma separated list or array of exclude rules
+	 * @param mixed $exclude_rules A comma separated list or array of exclude rules
 	 * @param bool $append Whether to replace or append to existing rules
 	 *
 	 * @return string
@@ -213,7 +213,7 @@ 
 	 * Get the array of services options for this schedule
 	 *
 	 * @param      $service
-	 * @param null $option
+	 * @param string $option
 	 *
 	 * @return array
 	 */
@@ -290,6 +290,7 @@ 
 	/**
 	 * Get the schedule reoccurrence
 	 *
+	 * @return string
 	 */
 	public function get_reoccurrence() {
 		return $this->options['reoccurrence'];
@@ -460,7 +461,7 @@ 
 	/**
 	 * Hook into the actions fired in the Backup class and set the status
 	 *
-	 * @param $action
+	 * @param string $action
 	 */
 	public function do_action( $action, Site_Backup $backup ) {
 
@@ -479,6 +480,7 @@ 
 	 * Calculate schedule run time.
 	 *
 	 * @param int Timestamp $end
+	 * @param integer $end
 	 */
 	public function update_average_schedule_run_time( $start, $end ) {
 

classes/class-site-size.php

Doc Comments +1 added lines, -1 removed lines

@@ -22,7 +22,7 @@
 	 *
 	 * @param string $type     Whether to calculate the size of the database, files
 	 *                         or both. Should be one of 'file', 'database' or 'complete'
-	 * @param array  $excludes An array of exclude rules
+	 * @param Excludes  $excludes An array of exclude rules
 	 */
 	public function __construct( $type = 'complete', Excludes $excludes = null ) {
 		$this->type = $type;

functions/interface.php

Doc Comments +1 added lines, -1 removed lines

@@ -258,7 +258,7 @@
  *
  * @access public
  * @param Scheduled_Backup $schedule
- * @return void
+ * @return string|null
  */
 function schedule_status( Scheduled_Backup $schedule, $echo = true ) {
 

classes/class-requirement.php

Doc Comments +1 added lines, -1 removed lines

@@ -16,7 +16,7 @@
 	protected $name = '';
 
 	/**
-	 * @return boolean Did the requirement pass or fail
+	 * @return boolean|null Did the requirement pass or fail
 	 */
 	protected static function test() {}