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

Timestamp:

06/28/2020 11:47:45 AM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Improve documentation for optional parameters per the documentation standards.

See #49572.

File:

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

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

@@ -24 +24 @@
      * @since 2.8.0
      *
-     * @param string $raw String to compress.
-     * @param int $level Optional, default is 9. Compression level, 9 is highest.
-     * @param string $supports Optional, not used. When implemented it will choose the right compression based on what the server supports.
+     * @param string $raw      String to compress.
+     * @param int    $level    Optional. Compression level, 9 is highest. Default 9.
+     * @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.
      */
@@ -44 +45 @@
      *
      * @param string $compressed String to decompress.
-     * @param int $length The optional length of the compressed data.
+     * @param int    $length     The optional length of the compressed data.
      * @return string|bool False on failure.
      */