Changeset 57077

Timestamp:

11/07/2023 12:12:24 AM (13 months ago)

Author:

SergeyBiryukov

Message:

Docs: Use proper case for @todo tags.

The correct tag is @todo, not @TODO or @todo: (note the trailing colon).

Reference: ​PHP Documentation Standards: PHPDoc tags.

Follow-up to [55203], [56274], [56565], [56698].

Props jrf.
See #59651.

Location:

trunk/src/wp-includes

Files:

• block-supports/layout.php (modified) (1 diff)
• html-api/class-wp-html-processor.php (modified) (2 diffs)
• html-api/class-wp-html-tag-processor.php (modified) (1 diff)

trunk/src/wp-includes/block-supports/layout.php

@@ -797 +797 @@
      * will also be present; rarely should classes be removed.
      *
-     * @TODO: Find a better way to match the first inner block. If it's possible to identify where the
-     *        first inner block starts, then it will be possible to find the last tag before it starts
-     *        and then that tag, if an opening tag, can be solidly identified as a wrapping element.
-     *        Can some unique value or class or ID be added to the inner blocks when they process
-     *        so that they can be extracted here safely without guessing? Can the block rendering function
-     *        return information about where the rendered inner blocks start?
+     * @todo Find a better way to match the first inner block. If it's possible to identify where the
+     *       first inner block starts, then it will be possible to find the last tag before it starts
+     *       and then that tag, if an opening tag, can be solidly identified as a wrapping element.
+     *       Can some unique value or class or ID be added to the inner blocks when they process
+     *       so that they can be extracted here safely without guessing? Can the block rendering function
+     *       return information about where the rendered inner blocks start?
      *
      * @var string|null

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

@@ -343 +343 @@
      * Finds the next tag matching the $query.
      *
-     * @TODO: Support matching the class name and tag name.
+     * @todo Support matching the class name and tag name.
      *
      * @since 6.4.0
@@ -552 +552 @@
      * They always include the entire path from the root HTML node to the matched element.
      *
-     * @TODO: It could be more efficient to expose a generator-based version of this function
-     *        to avoid creating the array copy on tag iteration. If this is done, it would likely
-     *        be more useful to walk up the stack when yielding instead of starting at the top.
+     * @todo It could be more efficient to expose a generator-based version of this function
+     *       to avoid creating the array copy on tag iteration. If this is done, it would likely
+     *       be more useful to walk up the stack when yielding instead of starting at the top.
      *
      * Example

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

@@ -2032 +2032 @@
          * @see https://html.spec.whatwg.org/#attributes-2
          *
-         * @TODO as the only regex pattern maybe we should take it out? are
-         *       Unicode patterns available broadly in Core?
+         * @todo As the only regex pattern maybe we should take it out?
+         *       Are Unicode patterns available broadly in Core?
          */
         if ( preg_match(