Changeset 55724 for trunk

Timestamp:

05/05/2023 12:41:29 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Correct the placement of @see tags in WP_HTML_Tag_Processor class.

This moves a reference link in ::get_attribute_names_with_prefix() below the code example, so that it is correctly displayed in the Developer Resources.

Includes updating some other @see tags for consistency as per the documentation standards.

Additionally, the example code for WP_HTML_Tag_Processor::get_tag() is updated to show lowercase tag names in the input HTML, so that it does not convey the wrong impression that the uppercase output from ::get_tag() depends on the case of the input HTML.

Follow-up to [55203].

Props dmsnell, johnbillion, audrasjb, SergeyBiryukov.
Fixes #58254.

File:

• trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php (modified) (9 diffs)

trunk/src/wp-includes/html-api/class-wp-html-tag-processor.php

@@ -254 +254 @@
          * any given time.
          *
-         * @see set_bookmark()
          * @since 6.2.0
          * @var int
+         *
+         * @see WP_HTML_Tag_Processor::set_bookmark()
          */
         const MAX_BOOKMARKS = 10;
@@ -264 +265 @@
          * Prevents accidental infinite loops.
          *
-         * @see seek()
          * @since 6.2.0
          * @var int
+         *
+         * @see WP_HTML_Tag_Processor::seek()
          */
         const MAX_SEEK_OPS = 1000;
@@ -499 +501 @@
          * Tracks and limits `seek()` calls to prevent accidental infinite loops.
          *
-         * @see seek
          * @since 6.2.0
          * @var int
+         *
+         * @see WP_HTML_Tag_Processor::seek()
          */
         protected $seek_count = 0;
@@ -721 +724 @@
          * Skips contents of title and textarea tags.
          *
+         * @since 6.2.0
+         *
          * @see https://html.spec.whatwg.org/multipage/parsing.html#rcdata-state
-         * @since 6.2.0
          *
          * @param string $tag_name – the lowercase tag name which will close the RCDATA region.
@@ -1282 +1286 @@
          * (they are accumulated in different data formats for performance).
          *
-         * @see $lexical_updates
-         * @see $classname_updates
-         *
-         * @since 6.2.0
+         * @since 6.2.0
+         *
+         * @see WP_HTML_Tag_Processor::$lexical_updates
+         * @see WP_HTML_Tag_Processor::$classname_updates
          *
          * @return void
@@ -1741 +1745 @@
          *     - HTML 5 spec
          *
-         * @see https://html.spec.whatwg.org/multipage/syntax.html#attributes-2:ascii-case-insensitive
-         *
          * Example:
          * ```php
@@ -1755 +1757 @@
          * @since 6.2.0
          *
+         * @see https://html.spec.whatwg.org/multipage/syntax.html#attributes-2:ascii-case-insensitive
+         *
          * @param string $prefix Prefix of requested attribute names.
          * @return array|null List of attribute names, or `null` when no tag opener is matched.
@@ -1779 +1783 @@
          * Example:
          * ```php
-         * $p = new WP_HTML_Tag_Processor( '<DIV CLASS="test">Test</DIV>' );
+         * $p = new WP_HTML_Tag_Processor( '<div class="test">Test</div>' );
          * $p->next_tag() === true;
          * $p->get_tag() === 'DIV';
@@ -2096 +2100 @@
          *
          * @since 6.2.0
-         * @see get_updated_html
+         *
+         * @see WP_HTML_Tag_Processor::get_updated_html()
          *
          * @return string The processed HTML.