humanmade / backupwordpress

classes/class-backup.php

Doc Comments +7 added lines, -3 removed lines

@@ -221,6 +221,9 @@ 
 
 	}
 
+	/**
+	 * @param string $ini_setting
+	 */
 	protected static function is_function_disabled( $ini_setting ) {
 
 		if ( array_intersect( array(
@@ -442,7 +445,7 @@ 
 	 *
 	 * @param string $existing_archive_filepath
 	 *
-	 * @return null
+	 * @return \WP_Error|null
 	 */
 	public function set_existing_archive_filepath( $existing_archive_filepath ) {
 
@@ -1370,6 +1373,7 @@ 
 	/**
 	 * Get the errors
 	 *
+	 * @param string $context
 	 */
 	public function get_errors( $context = null ) {
 
@@ -1385,7 +1389,7 @@ 
 	 * Add an error to the errors stack
 	 *
 	 * @param string $context
-	 * @param mixed $error
+	 * @param string $error
 	 */
 	public function error( $context, $error ) {
 
@@ -1402,7 +1406,7 @@ 
 	/**
 	 * Migrate errors to warnings
 	 *
-	 * @param null $context
+	 * @param string $context
 	 */
 	private function errors_to_warnings( $context = null ) {
 

classes/class-requirement.php

Doc Comments +3 added lines, -3 removed lines

@@ -19,14 +19,14 @@ 
 	abstract protected function test();
 
 	/**
-	 * @return mixed
+	 * @return string
 	 */
 	public function name() {
 		return $this->name;
 	}
 
 	/**
-	 * @return mixed|string
+	 * @return string
 	 */
 	public function result() {
 
@@ -524,7 +524,7 @@ 
 	var $name = 'WP Cron Test Failed';
 
 	/**
-	 * @return mixed
+	 * @return boolean
 	 */
 	protected function test() {
 		return (bool) get_option( 'hmbkp_wp_cron_test_failed' );

classes/class-path.php

Doc Comments -1 removed lines

@@ -282,7 +282,6 @@
 	 * Move backup files from an existing directory and the new
 	 * location
 	 *
-	 * @param string $path 	The path to move the backups from
 	 * @return void
 	 */
 	public function move_old_backups( $from ) {

classes/class-schedule.php

Doc Comments +5 added lines, -4 removed lines

@@ -270,7 +270,7 @@ 
 	 * Get the array of services options for this schedule
 	 *
 	 * @param      $service
-	 * @param null $option
+	 * @param string $option
 	 *
 	 * @return array
 	 */
@@ -344,7 +344,6 @@ 
 	/**
 	 * Convenience function to format the file size
 	 *
-	 * @param bool $cached
 	 *
 	 * @return bool|string
 	 */
@@ -355,7 +354,7 @@ 
 	/**
 	 * Whether the total filesize is being calculated
 	 *
-	 * @return int            The total of the file or directory
+	 * @return boolean            The total of the file or directory
 	 */
 	public function is_site_size_being_calculated() {
 		return false !== get_transient( 'hmbkp_directory_filesizes_running' );
@@ -598,7 +597,6 @@ 
 	/**
 	 * Set the schedule start time.
 	 *
-	 * @param array $args
 	 */
 	public function set_schedule_start_time( $time ) {
 
@@ -616,6 +614,7 @@ 
 	/**
 	 * Get the schedule reoccurrence
 	 *
+	 * @return string
 	 */
 	public function get_reoccurrence() {
 
@@ -979,6 +978,8 @@ 
 	 * Calculate schedule run time.
 	 *
 	 * @param int Timestamp $end
+	 * @param integer $start
+	 * @param integer $end
 	 */
 	public function update_average_schedule_run_time( $start, $end ) {
 

functions/interface.php

Doc Comments +2 added lines, -2 removed lines

@@ -232,7 +232,7 @@ 
  * output as a human readable message
  *
  * @access public
- * @return null
+ * @return string
  */
 function hmbkp_backup_errors_message() {
 
@@ -283,7 +283,7 @@ 
  *
  * @access public
  * @param HM\BackUpWordPress\Scheduled_Backup $schedule
- * @return void
+ * @return string|null
  */
 function hmbkp_schedule_status( HM\BackUpWordPress\Scheduled_Backup $schedule, $echo = true ) {