phpDoc-Documentation

This commit is contained in:
Keith Crain 2020-06-13 00:32:36 -04:00
parent fdd6ea6a00
commit b146d215a1
2 changed files with 10 additions and 10 deletions

View file

@ -669,7 +669,7 @@ class MainWP_Child_Back_Up_WordPress {
/**
* Get the site size text.
*
* @param object HM\BackUpWordPress\Scheduled_Backup $schedule Object containing the schedule data.
* @param HM\BackUpWordPress\Scheduled_Backup $schedule Object containing the schedule data.
*
* @return string Site size text.
*/
@ -691,8 +691,8 @@ class MainWP_Child_Back_Up_WordPress {
/**
* Get the backup table row HTML.
*
* @param resource $file Backup file.
* @param object HM\BackUpWordPress\Scheduled_Backup $schedule Object containing the schedule data.
* @param resource $file Backup file.
* @param HM\BackUpWordPress\Scheduled_Backup $schedule Object containing the schedule data.
*/
public function hmbkp_get_backup_row( $file, HM\BackUpWordPress\Scheduled_Backup $schedule ) {
$encoded_file = rawurlencode( base64_encode( $file ) ); // phpcs:ignore WordPress.PHP.DiscouragedPHPFunctions -- base64_encode function is used for http encode compatible..

View file

@ -1,14 +1,9 @@
<?php
/**
* MainWP Updraft Plus Backups
* MainWP UpdraftPlus Backups handler.
*
* This code is used for the MainWP UpdraftPlus Extension.
*/
use MainWP\Child\MainWP_Helper;
use MainWP\Child\MainWP_Utility;
/**
*
* Credits
*
* Plugin-Name: UpdraftPlus - Backup/Restore
@ -19,9 +14,12 @@ use MainWP\Child\MainWP_Utility;
*
* The code is used for the MainWP UpdraftPlus Extension
* Extension URL: https://mainwp.com/extension/updraftplus/
*
*/
// phpcs:disable -- Third party credit.
use MainWP\Child\MainWP_Helper;
use MainWP\Child\MainWP_Utility;
/**
* Class MainWP_Child_Updraft_Plus_Backups
@ -1443,6 +1441,7 @@ class MainWP_Child_Updraft_Plus_Backups {
* Delete backup set.
*
* @return array Return results array.
* @throws Exception
*
* @uses $updraftplus::get_backup_history()
* @uses $updraftplus::backup_time_nonce()
@ -1630,6 +1629,7 @@ class MainWP_Child_Updraft_Plus_Backups {
* @param null $rescan Rescan $_POST data. Default: null
*
* @return array Return history status data.
* @throws Exception
*
* @uses MainWP_Child_Updraft_Plus_Backups::rebuild_backup_history()
* @uses MainWP_Child_Updraft_Plus_Backups::existing_backup_table()