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

See #49572.

git-svn-id: https://develop.svn.wordpress.org/trunk@48197 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Sergey Biryukov
2020-06-28 11:47:45 +00:00
parent b72fcb6a47
commit 6361798918
14 changed files with 83 additions and 75 deletions

View File

@@ -23,9 +23,10 @@ class WP_Http_Encoding {
*
* @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.
*/
public static function compress( $raw, $level = 9, $supports = null ) {
@@ -43,7 +44,7 @@ class WP_Http_Encoding {
* @since 2.8.0
*
* @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.
*/
public static function decompress( $compressed, $length = null ) {