Changeset 30681 for trunk/src/wp-includes/class-wp-editor.php

Timestamp:

12/01/2014 01:33:34 AM (12 years ago)

Author:

wonderboymusic

Message:

Improve various @param docs for src/wp-includes/*.

See #30224.

File:

• trunk/src/wp-includes/class-wp-editor.php (modified) (3 diffs)

trunk/src/wp-includes/class-wp-editor.php

@@ -251 +251 @@
         }
 
+        /**
+         * @param string $editor_id
+         * @param array  $set
+         */
         public static function editor_settings($editor_id, $set) {
                 $first_run = false;
@@ -757 +761 @@
          * @param string $mce_locale The locale used for the editor.
          * @param bool $json_only optional Whether to include the Javascript calls to tinymce.addI18n() and tinymce.ScriptLoader.markDone().
-         * @return The translation object, JSON encoded.
+         * @return string Translation object, JSON encoded.
          */
         public static function wp_mce_translation( $mce_locale = '', $json_only = false ) {
@@ -1329 +1333 @@
          *
          * @param array $args Optional. Accepts 'pagenum' and 's' (search) arguments.
-         * @return array Results.
+         * @return false|array Results.
          */
         public static function wp_link_query( $args = array() ) {