Changeset 57644 for trunk/src/wp-includes/general-template.php

Timestamp:

02/16/2024 09:45:18 PM (11 months ago)

Author:

johnbillion

Message:

Docs: Various improvements and corrections to inline documentation.

See #59651

File:

• trunk/src/wp-includes/general-template.php (modified) (5 diffs)

trunk/src/wp-includes/general-template.php

@@ -1320 +1320 @@
  *                            Default '»'.
  * @param bool   $display     Optional. Whether to display or retrieve title. Default true.
- * @param string $seplocation Optional. Location of the separator ('left' or 'right').
+ * @param string $seplocation Optional. Location of the separator (either 'left' or 'right').
  * @return string|void String when `$display` is false, nothing otherwise.
  */
@@ -1440 +1440 @@
      * @param string $title       Page title.
      * @param string $sep         Title separator.
-     * @param string $seplocation Location of the separator ('left' or 'right').
+     * @param string $seplocation Location of the separator (either 'left' or 'right').
      */
     $title = apply_filters( 'wp_title', $title, $sep, $seplocation );
@@ -3464 +3464 @@
 
         /**
-         * Filters domains and URLs for resource hints of relation type.
+         * Filters domains and URLs for resource hints of the given relation type.
          *
          * @since 4.6.0
@@ -3484 +3484 @@
          *     }
          * }
-         * @param string $relation_type The relation type the URLs are printed for,
-         *                              e.g. 'preconnect' or 'prerender'.
+         * @param string $relation_type The relation type the URLs are printed for. One of
+         *                              'dns-prefetch', 'preconnect', 'prefetch', or 'prerender'.
          */
         $urls = apply_filters( 'wp_resource_hints', $urls, $relation_type );
@@ -3758 +3758 @@
  * Finds out which editor should be displayed by default.
  *
- * Works out which of the two editors to display as the current editor for a
+ * Works out which of the editors to display as the current editor for a
  * user. The 'html' setting is for the "Text" editor tab.
  *
  * @since 2.5.0
  *
- * @return string Either 'tinymce', or 'html', or 'test'
+ * @return string Either 'tinymce', 'html', or 'test'
  */
 function wp_default_editor() {