From 7bf879af490bf82b95b341a2db9fa8eb85c7db8b Mon Sep 17 00:00:00 2001
From: Sergey Biryukov <sergeybiryukov@git.wordpress.org>
Date: Fri, 19 Jun 2020 17:54:56 +0000
Subject: [PATCH] Docs: Document globals in `WP_Sitemaps_*` classes the same
 way they are documented in the rest of core.

See #49572, #50117.

git-svn-id: https://develop.svn.wordpress.org/trunk@48093 602fd350-edb4-49c9-b593-d223f7449a82
---
 src/wp-includes/sitemaps.php                            | 9 ++-------
 src/wp-includes/sitemaps/class-wp-sitemaps-index.php    | 3 ++-
 src/wp-includes/sitemaps/class-wp-sitemaps-provider.php | 3 ++-
 src/wp-includes/sitemaps/class-wp-sitemaps-renderer.php | 6 ++++--
 src/wp-includes/sitemaps/class-wp-sitemaps.php          | 2 ++
 5 files changed, 12 insertions(+), 11 deletions(-)

diff --git a/src/wp-includes/sitemaps.php b/src/wp-includes/sitemaps.php
index 6c92763270..fcbdefe199 100644
--- a/src/wp-includes/sitemaps.php
+++ b/src/wp-includes/sitemaps.php
@@ -15,16 +15,11 @@
  *
  * @since 5.5.0
  *
+ * @global WP_Sitemaps $wp_sitemaps Global Core Sitemaps instance.
+ *
  * @return WP_Sitemaps|null Sitemaps instance, or null if sitemaps are disabled.
  */
 function wp_sitemaps_get_server() {
-	/**
-	 * Global Core Sitemaps instance.
-	 *
-	 * @since 5.5.0
-	 *
-	 * @var WP_Sitemaps $wp_sitemaps
-	 */
 	global $wp_sitemaps;
 
 	$is_enabled = (bool) get_option( 'blog_public' );
diff --git a/src/wp-includes/sitemaps/class-wp-sitemaps-index.php b/src/wp-includes/sitemaps/class-wp-sitemaps-index.php
index abaf9e539c..a51634b929 100644
--- a/src/wp-includes/sitemaps/class-wp-sitemaps-index.php
+++ b/src/wp-includes/sitemaps/class-wp-sitemaps-index.php
@@ -67,10 +67,11 @@ class WP_Sitemaps_Index {
 	 *
 	 * @since 5.5.0
 	 *
+	 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
+	 *
 	 * @return string The sitemap index url.
 	 */
 	public function get_index_url() {
-		/* @var WP_Rewrite $wp_rewrite */
 		global $wp_rewrite;
 
 		if ( ! $wp_rewrite->using_permalinks() ) {
diff --git a/src/wp-includes/sitemaps/class-wp-sitemaps-provider.php b/src/wp-includes/sitemaps/class-wp-sitemaps-provider.php
index 877ebd81e3..7226199f87 100644
--- a/src/wp-includes/sitemaps/class-wp-sitemaps-provider.php
+++ b/src/wp-includes/sitemaps/class-wp-sitemaps-provider.php
@@ -136,12 +136,13 @@ abstract class WP_Sitemaps_Provider {
 	 *
 	 * @since 5.5.0
 	 *
+	 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
+	 *
 	 * @param string $name The name of the sitemap.
 	 * @param int    $page The page of the sitemap.
 	 * @return string The composed URL for a sitemap entry.
 	 */
 	public function get_sitemap_url( $name, $page ) {
-		/* @var WP_Rewrite $wp_rewrite */
 		global $wp_rewrite;
 
 		if ( ! $wp_rewrite->using_permalinks() ) {
diff --git a/src/wp-includes/sitemaps/class-wp-sitemaps-renderer.php b/src/wp-includes/sitemaps/class-wp-sitemaps-renderer.php
index 373a9dbdaf..29071778dd 100644
--- a/src/wp-includes/sitemaps/class-wp-sitemaps-renderer.php
+++ b/src/wp-includes/sitemaps/class-wp-sitemaps-renderer.php
@@ -57,10 +57,11 @@ class WP_Sitemaps_Renderer {
 	 *
 	 * @since 5.5.0
 	 *
+	 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
+	 *
 	 * @return string The sitemap stylesheet url.
 	 */
 	public function get_sitemap_stylesheet_url() {
-		/* @var WP_Rewrite $wp_rewrite */
 		global $wp_rewrite;
 
 		$sitemap_url = home_url( '/wp-sitemap.xsl' );
@@ -87,10 +88,11 @@ class WP_Sitemaps_Renderer {
 	 *
 	 * @since 5.5.0
 	 *
+	 * @global WP_Rewrite $wp_rewrite WordPress rewrite component.
+	 *
 	 * @return string The sitemap index stylesheet url.
 	 */
 	public function get_sitemap_index_stylesheet_url() {
-		/* @var WP_Rewrite $wp_rewrite */
 		global $wp_rewrite;
 
 		$sitemap_url = home_url( '/wp-sitemap-index.xsl' );
diff --git a/src/wp-includes/sitemaps/class-wp-sitemaps.php b/src/wp-includes/sitemaps/class-wp-sitemaps.php
index 1e72f13d51..2ea71f9e14 100644
--- a/src/wp-includes/sitemaps/class-wp-sitemaps.php
+++ b/src/wp-includes/sitemaps/class-wp-sitemaps.php
@@ -139,6 +139,8 @@ class WP_Sitemaps {
 	 * Renders sitemap templates based on rewrite rules.
 	 *
 	 * @since 5.5.0
+	 *
+	 * @global WP_Query $wp_query WordPress Query object.
 	 */
 	public function render_sitemaps() {
 		global $wp_query;