Changes from feedback

dmsnell · dmsnell · commit f2c715d6218e · 2023-12-09T17:29:20.000+01:00
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
@@ -15,7 +15,7 @@
  *
  * @access private
  * @since 6.2.0
- * @since {WP_VERSION} Replaced `end` with `length` to more closely match `substr()`.
+ * @since 6.5.0 Replaced `end` with `length` to more closely match `substr()`.
  *
  * @see WP_HTML_Tag_Processor
  */
@@ -57,7 +57,10 @@ class WP_HTML_Attribute_Token {
 	public $start;
 
 	/**
-	 * Byte length of the entire attribute name or name and value pair expression.
+	 * Byte length of text spanning the attribute inside a tag.
+	 *
+	 * This span starts at the first character of the attribute name
+	 * and it ends
 	 *
 	 * Example:
 	 *
@@ -70,7 +73,7 @@ class WP_HTML_Attribute_Token {
 	 *     <a rel=noopener>
 	 *        ------------ length is 11
 	 *
-	 * @since {WP_VERSION}
+	 * @since 6.5.0 Replaced `end` with `length` to more closely match `substr()`.
 	 *
 	 * @var int
 	 */
@@ -89,6 +92,7 @@ class WP_HTML_Attribute_Token {
 	 * Constructor.
 	 *
 	 * @since 6.2.0
+	 * @since 6.5.0 Replaced `end` with `length` to more closely match `substr()`.
 	 *
 	 * @param string $name         Attribute name.
 	 * @param int    $value_start  Attribute value.
diff --git a/src/wp-includes/html-api/class-wp-html-span.php b/src/wp-includes/html-api/class-wp-html-span.php
@@ -18,7 +18,7 @@
  *
  * @access private
  * @since 6.2.0
- * @since {WP_VERSION} Replaced `end` with `length` to more closely align with `substr()`.
+ * @since 6.5.0 Replaced `end` with `length` to more closely align with `substr()`.
  *
  * @see WP_HTML_Tag_Processor
  */
@@ -27,14 +27,16 @@ class WP_HTML_Span {
 	 * Byte offset into document where span begins.
 	 *
 	 * @since 6.2.0
+	 *
 	 * @var int
 	 */
 	public $start;
 
 	/**
 	 * Byte length of span.
 	 *
-	 * @since {WP_VERSION}
+	 * @since 6.5.0
+	 *
 	 * @var int
 	 */
 	public $length;
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
@@ -337,7 +337,7 @@ class WP_HTML_Tag_Processor {
 	 *     01234
 	 *     - token starts at 0
 	 *
-	 * @since {WP_VERSION}
+	 * @since 6.5.0
 	 *
 	 * @var int|null
 	 */
@@ -356,7 +356,7 @@ class WP_HTML_Tag_Processor {
 	 *     0123456789 123456789 123456789
 	 *     - token length is 17 - 2 = 15
 	 *
-	 * @since {WP_VERSION}
+	 * @since 6.5.0
 	 *
 	 * @var int|null
 	 */
@@ -372,6 +372,7 @@ class WP_HTML_Tag_Processor {
 	 *      - tag name starts at 1
 	 *
 	 * @since 6.2.0
+	 *
 	 * @var int|null
 	 */
 	private $tag_name_starts_at;
@@ -386,6 +387,7 @@ class WP_HTML_Tag_Processor {
 	 *      --- tag name length is 3
 	 *
 	 * @since 6.2.0
+	 *
 	 * @var int|null
 	 */
 	private $tag_name_length;
@@ -1995,6 +1997,14 @@ public function has_self_closing_flag() {
 			return false;
 		}
 
+		/*
+		 * The self-closing flag is the solidus at the _end_ of the tag, not the beginning.
+		 *
+		 * Example:
+		 *
+		 *     <figure />
+		 *             ^ this appears one character before the end of the closing ">".
+		 */
 		return '/' === $this->html[ $this->token_starts_at + $this->token_length - 1 ];
 	}
 

Original file line number	Diff line number	Diff line change
`@@ -15,7 +15,7 @@`
`15`	`15`	`*`
`16`	`16`	`* @access private`
`17`	`17`	`* @since 6.2.0`
`18`		- * @since {WP_VERSION} Replaced `end` with `length` to more closely match `substr()`.
	`18`	+ * @since 6.5.0 Replaced `end` with `length` to more closely match `substr()`.
`19`	`19`	`*`
`20`	`20`	`* @see WP_HTML_Tag_Processor`
`21`	`21`	`*/`
`@@ -57,7 +57,10 @@ class WP_HTML_Attribute_Token {`
`57`	`57`	`public $start;`
`58`	`58`
`59`	`59`	`/**`
`60`		`- * Byte length of the entire attribute name or name and value pair expression.`
	`60`	`+ * Byte length of text spanning the attribute inside a tag.`
	`61`	`+ *`
	`62`	`+ * This span starts at the first character of the attribute name`
	`63`	`+ * and it ends`
`61`	`64`	`*`
`62`	`65`	`* Example:`
`63`	`66`	`*`
`@@ -70,7 +73,7 @@ class WP_HTML_Attribute_Token {`
`70`	`73`	`* <a rel=noopener>`
`71`	`74`	`* ------------ length is 11`
`72`	`75`	`*`
`73`		`- * @since {WP_VERSION}`
	`76`	+ * @since 6.5.0 Replaced `end` with `length` to more closely match `substr()`.
`74`	`77`	`*`
`75`	`78`	`* @var int`
`76`	`79`	`*/`
`@@ -89,6 +92,7 @@ class WP_HTML_Attribute_Token {`
`89`	`92`	`* Constructor.`
`90`	`93`	`*`
`91`	`94`	`* @since 6.2.0`
	`95`	+ * @since 6.5.0 Replaced `end` with `length` to more closely match `substr()`.
`92`	`96`	`*`
`93`	`97`	`* @param string $name Attribute name.`
`94`	`98`	`* @param int $value_start Attribute value.`
Original file line number	Diff line number	Diff line change
`@@ -337,7 +337,7 @@ class WP_HTML_Tag_Processor {`
`337`	`337`	`* 01234`
`338`	`338`	`* - token starts at 0`
`339`	`339`	`*`
`340`		`- * @since {WP_VERSION}`
	`340`	`+ * @since 6.5.0`
`341`	`341`	`*`
`342`	`342`	`* @var int\|null`
`343`	`343`	`*/`
`@@ -356,7 +356,7 @@ class WP_HTML_Tag_Processor {`
`356`	`356`	`* 0123456789 123456789 123456789`
`357`	`357`	`* - token length is 17 - 2 = 15`
`358`	`358`	`*`
`359`		`- * @since {WP_VERSION}`
	`359`	`+ * @since 6.5.0`
`360`	`360`	`*`
`361`	`361`	`* @var int\|null`
`362`	`362`	`*/`
`@@ -372,6 +372,7 @@ class WP_HTML_Tag_Processor {`
`372`	`372`	`* - tag name starts at 1`
`373`	`373`	`*`
`374`	`374`	`* @since 6.2.0`
	`375`	`+ *`
`375`	`376`	`* @var int\|null`
`376`	`377`	`*/`
`377`	`378`	`private $tag_name_starts_at;`
`@@ -386,6 +387,7 @@ class WP_HTML_Tag_Processor {`
`386`	`387`	`* --- tag name length is 3`
`387`	`388`	`*`
`388`	`389`	`* @since 6.2.0`
	`390`	`+ *`
`389`	`391`	`* @var int\|null`
`390`	`392`	`*/`
`391`	`393`	`private $tag_name_length;`
`@@ -1995,6 +1997,14 @@ public function has_self_closing_flag() {`
`1995`	`1997`	`return false;`
`1996`	`1998`	`}`
`1997`	`1999`
	`2000`	`+ /*`
	`2001`	`+ * The self-closing flag is the solidus at the _end_ of the tag, not the beginning.`
	`2002`	`+ *`
	`2003`	`+ * Example:`
	`2004`	`+ *`
	`2005`	`+ * <figure />`
	`2006`	`+ * ^ this appears one character before the end of the closing ">".`
	`2007`	`+ */`
`1998`	`2008`	`return '/' === $this->html[ $this->token_starts_at + $this->token_length - 1 ];`
`1999`	`2009`	`}`
`2000`	`2010`