Changeset 53053 for trunk/src/wp-includes/functions.wp-scripts.php

Timestamp:

04/02/2022 01:53:06 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Further remove HTML markup from various function summaries.

Per the ​WordPress PHP documentation standards, no HTML markup or Markdown of any kind should be used in the summary. This ensures that the summary is displayed correctly in the ​WordPress Code Reference.

This commit also improves formatting of HTML special characters in descriptions in wp-includes/formatting.php.

Follow-up to [53048].

Props johnbillion, mukesh27.
Fixes #55506.

File:

• trunk/src/wp-includes/functions.wp-scripts.php (modified) (2 diffs)

trunk/src/wp-includes/functions.wp-scripts.php

@@ -167 +167 @@
  *                                    number is automatically added equal to current installed WordPress version.
  *                                    If set to null, no version is added.
- * @param bool             $in_footer Optional. Whether to enqueue the script before </body> instead of in the <head>.
+ * @param bool             $in_footer Optional. Whether to enqueue the script before `</body>` instead of in the `<head>`.
  *                                    Default 'false'.
  * @return bool Whether the script has been registered. True on success, false on failure.
@@ -341 +341 @@
  *                                    number is automatically added equal to current installed WordPress version.
  *                                    If set to null, no version is added.
- * @param bool             $in_footer Optional. Whether to enqueue the script before </body> instead of in the <head>.
+ * @param bool             $in_footer Optional. Whether to enqueue the script before `</body>` instead of in the `<head>`.
  *                                    Default 'false'.
  */