Changeset 35964

Timestamp:

12/16/2015 05:37:33 PM (11 years ago)

Author:

DrewAPicture

Message:

Docs: Add a missing summary, @since version, and parameter descriptions to the DocBlock for wp_xmlrpc_server::pingback_error().

Introduced in [23329]. Also corrects return descriptions for two deprecated methods.

See #32246.

File:

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

trunk/src/wp-includes/class-wp-xmlrpc-server.php

@@ -4533 +4533 @@
          *
          * @param array $args Unused.
-         * @return IXR_Error Error message.
+         * @return IXR_Error Error object.
          */
         public function blogger_getTemplate($args) {
@@ -4546 +4546 @@
          *
          * @param array $args Unused.
-         * @return IXR_Error Error message.
+         * @return IXR_Error Error object.
          */
         public function blogger_setTemplate($args) {
@@ -6418 +6418 @@
 
         /**
-         * @param integer $code
-         * @param string $message
-         * @return IXR_Error
+         * Sends a pingback error based on the given error code and message.
+         *
+         * @since 3.6.0
+         *
+         * @param int    $code    Error code.
+         * @param string $message Error message.
+         * @return IXR_Error Error object.
          */
         protected function pingback_error( $code, $message ) {