Changeset 61793 for trunk/src/wp-includes/html-api/class-wp-html-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-processor.php (modified) (40 diffs)

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

@@ -584 +584 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @param string $message Explains support is missing in order to parse the current node.
@@ -792 +793 @@
      *
      * @since 6.7.2 Added for internal support.
-     *
-     * @access private
+     * @ignore
      *
      * @return bool
@@ -882 +882 @@
      *
      * @since 6.6.0
+     * @ignore
      *
      * @return bool Whether the current token is virtual.
@@ -1489 +1490 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -1560 +1562 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -1657 +1660 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -1754 +1758 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -1976 +1981 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -2079 +2085 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -2223 +2230 @@
      *
      * @since 6.4.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -3248 +3256 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -3504 +3513 @@
      *
      * @since 6.7.0 Stub implementation.
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -3523 +3533 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -3607 +3618 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -3714 +3726 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -3817 +3830 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -3927 +3941 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -4031 +4046 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -4206 +4222 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -4270 +4287 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -4399 +4417 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -4488 +4507 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -4607 +4627 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -4692 +4713 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -4755 +4777 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -4823 +4846 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -5144 +5168 @@
      * @since 6.4.0
      * @since 6.5.0 Renamed from bookmark_tag() to bookmark_token().
+     * @ignore
      *
      * @throws Exception When unable to allocate requested bookmark.
@@ -5797 +5822 @@
      *
      * @since 6.4.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -5812 +5838 @@
      * @since 6.4.0
      * @since 6.7.0 Full spec support.
+     * @ignore
      *
      * @see https://html.spec.whatwg.org/#generate-implied-end-tags
@@ -5849 +5876 @@
      * @since 6.4.0
      * @since 6.7.0 Full spec support.
+     * @ignore
      *
      * @see WP_HTML_Processor::generate_implied_end_tags
@@ -5891 +5919 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @return WP_HTML_Token|null The adjusted current node.
@@ -5910 +5939 @@
      *
      * @since 6.4.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -5952 +5982 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @see https://html.spec.whatwg.org/multipage/parsing.html#reset-the-insertion-mode-appropriately
@@ -6144 +6175 @@
      *
      * @since 6.4.0
+     * @ignore
      *
      * @throws WP_HTML_Unsupported_Exception When encountering unsupported HTML input.
@@ -6261 +6293 @@
      *
      * @since 6.7.0
+     * @ignore
      */
     private function close_cell(): void {
@@ -6279 +6312 @@
      *
      * @since 6.4.0
+     * @ignore
      *
      * @see https://html.spec.whatwg.org/#insert-a-foreign-element
@@ -6292 +6326 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @see https://html.spec.whatwg.org/#insert-a-foreign-element
@@ -6331 +6366 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @throws Exception When unable to allocate a bookmark for the next token in the input HTML document.
@@ -6358 +6394 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @see https://html.spec.whatwg.org/#mathml-text-integration-point
@@ -6394 +6431 @@
      *
      * @since 6.7.0
+     * @ignore
      *
      * @see https://html.spec.whatwg.org/#html-integration-point