[PHP-doc 946] マルチバイト文字列の一部で説明部分が実際と合わない

KOMURA Takaaki komura.db2r1e @ gmail.com
2013年 1月 12日 (土) 18:18:41 JST


komura です。

マルチバイト文字列のマニュアルを見ていていくつか気になる点がありました。
英語のマニュアルも同様です。

時間がありましたら、修正を検討していただければ幸いです。


1. mb_convert_case(): http://php.net/mb_convert_case

 mb_convert_case()の第2引数にデフォルト値が設定されていますが、第2引数は
 省略不可なので、デフォルト値は意味がありません。
 以下のように修正した方が良いのではないでしょうか。

    string mb_convert_case ( string $str , int $mode = MB_CASE_UPPER [, string $encoding = mb_internal_encoding() ] )
 ⇒ string mb_convert_case ( string $str , int $mode [, string $encoding = mb_internal_encoding() ] )

2. mb_decode_numericentity(): http://php.net/mb_decode_numericentity

 mb_decode_numericentity()の第3引数はオプションです。また、PHP 5.4.0 からは、
 第4引数が指定可能になりました。

    string mb_decode_numericentity ( string $str , array $convmap , string $encoding )
 ⇒ string mb_decode_numericentity ( string $str , array $convmap [, string $encoding [, bool $is_hex ]] )

3. mb_encode_numericentity(): http://php.net/mb_encode_numericentity

 2と同様に、mb_encode_numericentity()の第3引数はオプションです。
 また、PHP 5.4.0 からは、第4引数が指定可能になりました。

    string mb_encode_numericentity ( string $str , array $convmap , string $encoding )
 ⇒ string mb_encode_numericentity ( string $str , array $convmap [, string $encoding [, bool $is_hex ]] )

4. mb_regex_set_options(): http://php.net/mb_regex_set_options

 マニュアルの返り値の説明に、引数が省略された場合、「現在のデフォルトの
 オプションを返します」とあります。引数のデフォルト値はない方が良いので
 はないでしょうか。

    string mb_regex_set_options ([ string $options = "msr" ] )
 ⇒ string mb_regex_set_options ([ string $options ] )

-- 
komura <komura.db2r1e @ gmail.com>


PHP-doc メーリングリストの案内