diff options
author | Nobuyoshi Nakada <nobu@ruby-lang.org> | 2022-08-07 13:09:46 +0900 |
---|---|---|
committer | Nobuyoshi Nakada <nobu@ruby-lang.org> | 2022-08-07 13:09:46 +0900 |
commit | 591ee9d068de174460f0e6fe81b36e7625b90f6c (patch) | |
tree | fd343ce00d6256383bbd68a6dc7b0bd70d6ccde9 /include/ruby | |
parent | 6d742c9412d444650d705b65bc2d5c850054c226 (diff) | |
download | ruby-591ee9d068de174460f0e6fe81b36e7625b90f6c.tar.gz |
[DOC] Add return values of rb_enc_mbcput
Diffstat (limited to 'include/ruby')
-rw-r--r-- | include/ruby/internal/encoding/encoding.h | 10 |
1 files changed, 6 insertions, 4 deletions
diff --git a/include/ruby/internal/encoding/encoding.h b/include/ruby/internal/encoding/encoding.h index 22deb8f8c9..4748ca806b 100644 --- a/include/ruby/internal/encoding/encoding.h +++ b/include/ruby/internal/encoding/encoding.h @@ -643,10 +643,12 @@ rb_enc_code_to_mbclen(int c, rb_encoding *enc) * Identical to rb_enc_uint_chr(), except it writes back to the passed buffer * instead of allocating one. * - * @param[in] c Code point. - * @param[out] buf Return buffer. - * @param[in] enc Target encoding scheme. - * @post `c` is encoded according to `enc`, then written to `buf`. + * @param[in] c Code point. + * @param[out] buf Return buffer. + * @param[in] enc Target encoding scheme. + * @retval <= 0 `c` is invalid in `enc`. + * @return otherwise Number of bytes written to `buf`. + * @post `c` is encoded according to `enc`, then written to `buf`. * * @internal * |