From bf1100536664ed8a4476626cf88a88fcf4bd86ca Mon Sep 17 00:00:00 2001
From: Sergey Biryukov <sergeybiryukov@git.wordpress.org>
Date: Tue, 9 May 2023 11:17:14 +0000
Subject: [PATCH] Docs: Improve HTML API file and class headers per the
 documentation standards.

Follow-up to [55203], [55304], [55718], [55724], [55727].

See #57840.

git-svn-id: https://develop.svn.wordpress.org/trunk@55734 602fd350-edb4-49c9-b593-d223f7449a82
---
 .../html-api/class-wp-html-attribute-token.php           | 5 +++--
 src/wp-includes/html-api/class-wp-html-span.php          | 9 +++++----
 src/wp-includes/html-api/class-wp-html-tag-processor.php | 4 +++-
 .../html-api/class-wp-html-text-replacement.php          | 5 +++--
 .../class-wp-style-engine-css-declarations.php           | 2 +-
 5 files changed, 15 insertions(+), 10 deletions(-)

diff --git a/src/wp-includes/html-api/class-wp-html-attribute-token.php b/src/wp-includes/html-api/class-wp-html-attribute-token.php
index 2c52164a97..f938609e41 100644
--- a/src/wp-includes/html-api/class-wp-html-attribute-token.php
+++ b/src/wp-includes/html-api/class-wp-html-attribute-token.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * HTML Tag Processor: Attribute token structure class.
+ * HTML API: WP_HTML_Attribute_Token class
  *
  * @package WordPress
  * @subpackage HTML-API
@@ -8,7 +8,8 @@
  */
 
 /**
- * Data structure for the attribute token that allows to drastically improve performance.
+ * Core class used by the HTML tag processor as a data structure for the attribute token,
+ * allowing to drastically improve performance.
  *
  * This class is for internal usage of the WP_HTML_Tag_Processor class.
  *
diff --git a/src/wp-includes/html-api/class-wp-html-span.php b/src/wp-includes/html-api/class-wp-html-span.php
index d92778cd3a..46227ebd02 100644
--- a/src/wp-includes/html-api/class-wp-html-span.php
+++ b/src/wp-includes/html-api/class-wp-html-span.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * HTML Span: Represents a textual span inside an HTML document.
+ * HTML API: WP_HTML_Span class
  *
  * @package WordPress
  * @subpackage HTML-API
@@ -8,10 +8,11 @@
  */
 
 /**
- * Represents a textual span inside an HTML document.
+ * Core class used by the HTML tag processor to represent a textual span
+ * inside an HTML document.
  *
- * This is a two-tuple in disguise, used to avoid the memory
- * overhead involved in using an array for the same purpose.
+ * This is a two-tuple in disguise, used to avoid the memory overhead
+ * involved in using an array for the same purpose.
  *
  * This class is for internal usage of the WP_HTML_Tag_Processor class.
  *
diff --git a/src/wp-includes/html-api/class-wp-html-tag-processor.php b/src/wp-includes/html-api/class-wp-html-tag-processor.php
index ab61cd14be..54721df406 100644
--- a/src/wp-includes/html-api/class-wp-html-tag-processor.php
+++ b/src/wp-includes/html-api/class-wp-html-tag-processor.php
@@ -1,5 +1,7 @@
 <?php
 /**
+ * HTML API: WP_HTML_Tag_Processor class
+ *
  * Scans through an HTML document to find specific tags, then
  * transforms those tags by adding, removing, or updating the
  * values of the HTML attributes within that tag (opener).
@@ -27,7 +29,7 @@
  */
 
 /**
- * Modifies attributes in an HTML document for tags matching a query.
+ * Core class used to modify attributes in an HTML document for tags matching a query.
  *
  * ## Usage
  *
diff --git a/src/wp-includes/html-api/class-wp-html-text-replacement.php b/src/wp-includes/html-api/class-wp-html-text-replacement.php
index 912b4a56a5..26b7bb2d28 100644
--- a/src/wp-includes/html-api/class-wp-html-text-replacement.php
+++ b/src/wp-includes/html-api/class-wp-html-text-replacement.php
@@ -1,6 +1,6 @@
 <?php
 /**
- * HTML Tag Processor: Text replacement class.
+ * HTML API: WP_HTML_Text_Replacement class
  *
  * @package WordPress
  * @subpackage HTML-API
@@ -8,7 +8,8 @@
  */
 
 /**
- * Data structure used to replace existing content from start to end that allows to drastically improve performance.
+ * Core class used by the HTML tag processor as a data structure for replacing
+ * existing content from start to end, allowing to drastically improve performance.
  *
  * This class is for internal usage of the WP_HTML_Tag_Processor class.
  *
diff --git a/src/wp-includes/style-engine/class-wp-style-engine-css-declarations.php b/src/wp-includes/style-engine/class-wp-style-engine-css-declarations.php
index c8bbeb0dd6..ae12dd1abf 100644
--- a/src/wp-includes/style-engine/class-wp-style-engine-css-declarations.php
+++ b/src/wp-includes/style-engine/class-wp-style-engine-css-declarations.php
@@ -1,7 +1,7 @@
 <?php
 /**
  * Style Engine: WP_Style_Engine_CSS_Declarations class
- * 
+ *
  * @package WordPress
  * @subpackage StyleEngine
  * @since 6.1.0