Skip to content

Commit

Permalink
Merge pull request #602 from shail-mehta/add/global-documentation-in-…
Browse files Browse the repository at this point in the history
…files

Added `@global` documentation in several files
  • Loading branch information
mukeshpanchal27 authored Sep 2, 2024
2 parents 0a74797 + ae1f736 commit 780ee9c
Show file tree
Hide file tree
Showing 4 changed files with 12 additions and 0 deletions.
3 changes: 3 additions & 0 deletions includes/Admin/Admin_AJAX.php
Original file line number Diff line number Diff line change
Expand Up @@ -145,6 +145,9 @@ public function set_up_environment() {
* Handles the AJAX request to cleanup the runtime environment.
*
* @since 1.0.0
*
* @global wpdb $wpdb WordPress database abstraction object.
* @global string $table_prefix The database table prefix.
*/
public function clean_up_environment() {
global $wpdb, $table_prefix;
Expand Down
3 changes: 3 additions & 0 deletions includes/Checker/Abstract_Check_Runner.php
Original file line number Diff line number Diff line change
Expand Up @@ -319,6 +319,9 @@ final public function prepare() {
*
* @since 1.0.0
*
* @global wpdb $wpdb WordPress database abstraction object.
* @global string $table_prefix The database table prefix.
*
* @return Check_Result An object containing all check results.
*/
final public function run() {
Expand Down
4 changes: 4 additions & 0 deletions includes/Checker/Runtime_Environment_Setup.php
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ final class Runtime_Environment_Setup {
* Sets up the WordPress environment for runtime checks
*
* @since 1.0.0
*
* @global wpdb $wpdb WordPress database abstraction object.
* @global string $table_prefix The database table prefix.
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*/
public function set_up() {
global $wpdb, $table_prefix, $wp_filesystem;
Expand Down
2 changes: 2 additions & 0 deletions includes/Utilities/Plugin_Request_Utility.php
Original file line number Diff line number Diff line change
Expand Up @@ -187,6 +187,8 @@ public static function get_files_to_ignore() {
*
* @since 1.1.0
*
* @global WP_Filesystem_Base $wp_filesystem WordPress filesystem subclass.
*
* @param string $plugin_url The URL of the plugin to download.
* @return string The plugin basename after downloading and installing the plugin.
*
Expand Down

0 comments on commit 780ee9c

Please sign in to comment.