Changeset 49963 for trunk/src/wp-includes/class-wp-http-encoding.php

Timestamp:

01/15/2021 08:06:50 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: In various @return tags, list the expected type first, instead of false.

Follow-up to [46696], [47060], [49926], [49927], [49929].

See #51800.

File:

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

trunk/src/wp-includes/class-wp-http-encoding.php

@@ -28 +28 @@
      * @param string $supports Optional, not used. When implemented it will choose
      *                         the right compression based on what the server supports.
-     * @return string|false False on failure.
+     * @return string|false Compressed string on success, false on failure.
      */
     public static function compress( $raw, $level = 9, $supports = null ) {
@@ -46 +46 @@
      * @param string $compressed String to decompress.
      * @param int    $length     The optional length of the compressed data.
-     * @return string|false False on failure.
+     * @return string|false Decompressed string on success, false on failure.
      */
     public static function decompress( $compressed, $length = null ) {
@@ -99 +99 @@
      *
      * @param string $gzData String to decompress.
-     * @return string|false False on failure.
+     * @return string|false Decompressed string on success, false on failure.
      */
     public static function compatible_gzinflate( $gzData ) {