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

Timestamp:

03/03/2026 01:10:51 PM (3 months ago)

Author:

jonsurrell

Message:

HTML API: Exclude internal classes and methods from documentation.

Add @ignore annotations to internal HTML API methods and classes to exclude them from generated documentation. The HTML API relies heavily on internal methods and classes and they create a lot of noise in documentation.

Developed in ​https://github.com/WordPress/wordpress-develop/pull/11078.

Props jonsurrell, westonruter.
See #64224.

File:

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

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

@@ -946 +946 @@
      *
      * @since 6.5.0
-     *
-     * @access private
+     * @ignore
      *
      * @return bool Whether a token was parsed.
@@ -1383 +1382 @@
      *
      * @since 6.3.2
+     * @ignore
      *
      * @see https://html.spec.whatwg.org/#generic-raw-text-element-parsing-algorithm
@@ -1402 +1402 @@
      *
      * @since 6.2.0
+     * @ignore
      *
      * @see https://html.spec.whatwg.org/multipage/parsing.html#rcdata-state
@@ -1493 +1494 @@
      *
      * @since 6.2.0
+     * @ignore
      *
      * @return bool Whether the script tag was closed before the end of the document.
@@ -1702 +1704 @@
      * @since 6.2.0
      * @since 6.2.1 Support abruptly-closed comments, invalid-tag-closer-comments, and empty elements.
+     * @ignore
      *
      * @return bool Whether a tag was found before the end of the document.
@@ -2123 +2126 @@
      *
      * @since 6.2.0
+     * @ignore
      *
      * @return bool Whether an attribute was found before the end of the document.
@@ -2260 +2264 @@
      *
      * @since 6.2.0
+     * @ignore
      */
     private function skip_whitespace(): void {
@@ -2269 +2274 @@
      *
      * @since 6.2.0
+     * @ignore
      */
     private function after_tag(): void {
@@ -2328 +2334 @@
      *
      * @since 6.2.0
+     * @ignore
      *
      * @see WP_HTML_Tag_Processor::$lexical_updates
@@ -2491 +2498 @@
      * @since 6.2.1 Accumulates shift for internal cursor and passed pointer.
      * @since 6.3.0 Invalidate any bookmarks whose targets are overwritten.
+     * @ignore
      *
      * @param int $shift_this_point Accumulate and return shift for this position.
@@ -2648 +2656 @@
      *
      * @since 6.2.0
+     * @ignore
      *
      * @param WP_HTML_Text_Replacement $a First attribute update.
@@ -2681 +2690 @@
      *
      * @since 6.2.0
+     * @ignore
      *
      * @param string $comparable_name The attribute name in its comparable form.
@@ -3927 +3937 @@
      *
      * @since 7.0.0
+     * @ignore
      *
      * @return 'javascript'|'json'|null Type of script element content if matched and recognized.
@@ -4200 +4211 @@
      *
      * @since 7.0.0
+     * @ignore
      *
      * @param string $sourcecode Raw contents intended to be serialized into an HTML SCRIPT element.
@@ -4665 +4677 @@
      *
      * @since 6.2.0
+     * @ignore
      *
      * @param array|string|null $query {
@@ -4731 +4744 @@
      *
      * @since 6.2.0
+     * @ignore
      *
      * @return bool Whether the given tag and its attribute match the search criteria.