Changeset 51319 for branches/5.8/src/wp-content/themes/twentytwentyone/inc/template-functions.php

Timestamp:

07/02/2021 07:05:46 PM (4 years ago)

Author:

desrosj

Message:

Twenty Twenty-One: Improve documentation per the documentation standards:

• Remove unnecessary @access tags that were previously removed from core.
• Remove an empty line between @param and @return tags.
• Correct alignment of @param tags.

Follow-up to [41161], [41162], [41168], [49216], [49220].

Props SergeyBiryukov.
Merges [51294] to the 5.8 branch.
See #52628, #53461.

Location:

branches/5.8

Files:

• . (modified) (1 prop)
• src/wp-content/themes/twentytwentyone/inc/template-functions.php (modified) (9 diffs)

branches/5.8/src/wp-content/themes/twentytwentyone/inc/template-functions.php

@@ -14 +14 @@
  *
  * @param array $classes Classes for the body element.
- *
  * @return array
  */
@@ -45 +44 @@
  *
  * @param array $classes An array of CSS classes.
- *
  * @return array
  */
@@ -87 +85 @@
  *
  * @param array $defaults The form defaults.
- *
  * @return array
  */
@@ -168 +165 @@
      *
      * @param string $title The title.
-     *
      * @return string
      */
@@ -183 +179 @@
  *
  * @param string $group The icon group.
- * @param string $icon The icon.
- * @param int    $size The icon size in pixels.
- *
+ * @param string $icon  The icon.
+ * @param int    $size  The icon size in pixels.
  * @return string
  */
@@ -196 +191 @@
  *
  * @param string $calendar_output The generated HTML of the calendar.
- *
  * @return string
  */
@@ -212 +206 @@
  *
  * @param string $type Whether to return CSS for the "front-end", "block-editor" or "classic-editor".
- *
  * @return string
  */
@@ -329 +322 @@
  *                                Example: `core/image`, `core-embed/*`.
  * @param string|null $content    The content to search in. Use null for get_the_content().
- * @param int         $instances  How many instances of the block will be printed (max). Defaults to 1.
- *
+ * @param int         $instances  How many instances of the block will be printed (max). Default  1.
  * @return bool Returns true if a block was located & printed, otherwise false.
  */
@@ -416 +408 @@
  * @param string|array $size       Requested size. Image size or array of width and height values
  *                                 (in that order). Default 'thumbnail'.
- *
  * @return array
  */