[前][次][番号順一覧][スレッド一覧]

ruby-changes:72912

From: Nobuyoshi <ko1@a...>
Date: Fri, 12 Aug 2022 15:56:42 +0900 (JST)
Subject: [ruby-changes:72912] 9a11d50dc7 (master): [DOC] Use `true`/`false` for `@retval`s which are `bool`

https://git.ruby-lang.org/ruby.git/commit/?id=9a11d50dc7

From 9a11d50dc7542cda4fc21352807df9f86b0d1093 Mon Sep 17 00:00:00 2001
From: Nobuyoshi Nakada <nobu@r...>
Date: Fri, 12 Aug 2022 10:18:38 +0900
Subject: [DOC] Use `true`/`false` for `@retval`s which are `bool`

---
 include/ruby/internal/encoding/ctype.h | 86 +++++++++++++++++-----------------
 1 file changed, 43 insertions(+), 43 deletions(-)

diff --git a/include/ruby/internal/encoding/ctype.h b/include/ruby/internal/encoding/ctype.h
index 64aaf0a990..70b6cc7909 100644
--- a/include/ruby/internal/encoding/ctype.h
+++ b/include/ruby/internal/encoding/ctype.h
@@ -36,8 +36,8 @@ RBIMPL_SYMBOL_EXPORT_BEGIN() https://github.com/ruby/ruby/blob/trunk/include/ruby/internal/encoding/ctype.h#L36
  * @param[in]  p          Pointer to a possibly-middle of a character.
  * @param[in]  end        End of the string.
  * @param[in]  enc        Encoding.
- * @retval     0          It isn't.
- * @retval     otherwise  It is.
+ * @retval     false      It isn't.
+ * @retval     true       It is.
  */
 static inline bool
 rb_enc_is_newline(const char *p,  const char *e, rb_encoding *enc)
@@ -53,11 +53,11 @@ rb_enc_is_newline(const char *p,  const char *e, rb_encoding *enc) https://github.com/ruby/ruby/blob/trunk/include/ruby/internal/encoding/ctype.h#L53
  * encoding.  The "character type" here is a set of macros defined in onigmo.h,
  * like `ONIGENC_CTYPE_PUNCT`.
  *
- * @param[in]  c    An `OnigCodePoint` value.
- * @param[in]  t    An `OnigCtype` value.
- * @param[in]  enc  A `rb_encoding*` value.
- * @retval     1    `c` is of `t` in `enc`.
- * @retval     0    Otherwise.
+ * @param[in]  c          An `OnigCodePoint` value.
+ * @param[in]  t          An `OnigCtype` value.
+ * @param[in]  enc        A `rb_encoding*` value.
+ * @retval     true       `c` is of `t` in `enc`.
+ * @retval     false      Otherwise.
  */
 static inline bool
 rb_enc_isctype(OnigCodePoint c, OnigCtype t, rb_encoding *enc)
@@ -68,10 +68,10 @@ rb_enc_isctype(OnigCodePoint c, OnigCtype t, rb_encoding *enc) https://github.com/ruby/ruby/blob/trunk/include/ruby/internal/encoding/ctype.h#L68
 /**
  * Identical to rb_isascii(), except it additionally takes an encoding.
  *
- * @param[in]  c    A code point.
- * @param[in]  enc  An encoding.
- * @retval     0    `c` is out of range of ASCII character set in `enc`.
- * @retval     1    Otherwise.
+ * @param[in]  c          A code point.
+ * @param[in]  enc        An encoding.
+ * @retval     false      `c` is out of range of ASCII character set in `enc`.
+ * @retval     true       Otherwise.
  *
  * @internal
  *
@@ -87,10 +87,10 @@ rb_enc_isascii(OnigCodePoint c, rb_encoding *enc) https://github.com/ruby/ruby/blob/trunk/include/ruby/internal/encoding/ctype.h#L87
 /**
  * Identical to rb_isalpha(), except it additionally takes an encoding.
  *
- * @param[in]  c    A code point.
- * @param[in]  enc  An encoding.
- * @retval     1    `enc` classifies `c` as "ALPHA".
- * @retval     0    Otherwise.
+ * @param[in]  c          A code point.
+ * @param[in]  enc        An encoding.
+ * @retval     true       `enc` classifies `c` as "ALPHA".
+ * @retval     false      Otherwise.
  */
 static inline bool
 rb_enc_isalpha(OnigCodePoint c, rb_encoding *enc)
@@ -101,10 +101,10 @@ rb_enc_isalpha(OnigCodePoint c, rb_encoding *enc) https://github.com/ruby/ruby/blob/trunk/include/ruby/internal/encoding/ctype.h#L101
 /**
  * Identical to rb_islower(), except it additionally takes an encoding.
  *
- * @param[in]  c    A code point.
- * @param[in]  enc  An encoding.
- * @retval     1    `enc` classifies `c` as "LOWER".
- * @retval     0    Otherwise.
+ * @param[in]  c          A code point.
+ * @param[in]  enc        An encoding.
+ * @retval     true       `enc` classifies `c` as "LOWER".
+ * @retval     false      Otherwise.
  */
 static inline bool
 rb_enc_islower(OnigCodePoint c, rb_encoding *enc)
@@ -115,10 +115,10 @@ rb_enc_islower(OnigCodePoint c, rb_encoding *enc) https://github.com/ruby/ruby/blob/trunk/include/ruby/internal/encoding/ctype.h#L115
 /**
  * Identical to rb_isupper(), except it additionally takes an encoding.
  *
- * @param[in]  c    A code point.
- * @param[in]  enc  An encoding.
- * @retval     1    `enc` classifies `c` as "UPPER".
- * @retval     0    Otherwise.
+ * @param[in]  c          A code point.
+ * @param[in]  enc        An encoding.
+ * @retval     true       `enc` classifies `c` as "UPPER".
+ * @retval     false      Otherwise.
  */
 static inline bool
 rb_enc_isupper(OnigCodePoint c, rb_encoding *enc)
@@ -129,10 +129,10 @@ rb_enc_isupper(OnigCodePoint c, rb_encoding *enc) https://github.com/ruby/ruby/blob/trunk/include/ruby/internal/encoding/ctype.h#L129
 /**
  * Identical to rb_ispunct(), except it additionally takes an encoding.
  *
- * @param[in]  c    A code point.
- * @param[in]  enc  An encoding.
- * @retval     1    `enc` classifies `c` as "PUNCT".
- * @retval     0    Otherwise.
+ * @param[in]  c          A code point.
+ * @param[in]  enc        An encoding.
+ * @retval     true       `enc` classifies `c` as "PUNCT".
+ * @retval     false      Otherwise.
  */
 static inline bool
 rb_enc_ispunct(OnigCodePoint c, rb_encoding *enc)
@@ -143,10 +143,10 @@ rb_enc_ispunct(OnigCodePoint c, rb_encoding *enc) https://github.com/ruby/ruby/blob/trunk/include/ruby/internal/encoding/ctype.h#L143
 /**
  * Identical to rb_isalnum(), except it additionally takes an encoding.
  *
- * @param[in]  c    A code point.
- * @param[in]  enc  An encoding.
- * @retval     1    `enc` classifies `c` as "ANUM".
- * @retval     0    Otherwise.
+ * @param[in]  c          A code point.
+ * @param[in]  enc        An encoding.
+ * @retval     true       `enc` classifies `c` as "ANUM".
+ * @retval     false      Otherwise.
  */
 static inline bool
 rb_enc_isalnum(OnigCodePoint c, rb_encoding *enc)
@@ -157,10 +157,10 @@ rb_enc_isalnum(OnigCodePoint c, rb_encoding *enc) https://github.com/ruby/ruby/blob/trunk/include/ruby/internal/encoding/ctype.h#L157
 /**
  * Identical to rb_isprint(), except it additionally takes an encoding.
  *
- * @param[in]  c    A code point.
- * @param[in]  enc  An encoding.
- * @retval     1    `enc` classifies `c` as "PRINT".
- * @retval     0    Otherwise.
+ * @param[in]  c          A code point.
+ * @param[in]  enc        An encoding.
+ * @retval     true       `enc` classifies `c` as "PRINT".
+ * @retval     false      Otherwise.
  */
 static inline bool
 rb_enc_isprint(OnigCodePoint c, rb_encoding *enc)
@@ -171,10 +171,10 @@ rb_enc_isprint(OnigCodePoint c, rb_encoding *enc) https://github.com/ruby/ruby/blob/trunk/include/ruby/internal/encoding/ctype.h#L171
 /**
  * Identical to rb_isspace(), except it additionally takes an encoding.
  *
- * @param[in]  c    A code point.
- * @param[in]  enc  An encoding.
- * @retval     1    `enc` classifies `c` as "PRINT".
- * @retval     0    Otherwise.
+ * @param[in]  c          A code point.
+ * @param[in]  enc        An encoding.
+ * @retval     true       `enc` classifies `c` as "PRINT".
+ * @retval     false      Otherwise.
  */
 static inline bool
 rb_enc_isspace(OnigCodePoint c, rb_encoding *enc)
@@ -185,10 +185,10 @@ rb_enc_isspace(OnigCodePoint c, rb_encoding *enc) https://github.com/ruby/ruby/blob/trunk/include/ruby/internal/encoding/ctype.h#L185
 /**
  * Identical to rb_isdigit(), except it additionally takes an encoding.
  *
- * @param[in]  c    A code point.
- * @param[in]  enc  An encoding.
- * @retval     1    `enc` classifies `c` as "DIGIT".
- * @retval     0    Otherwise.
+ * @param[in]  c          A code point.
+ * @param[in]  enc        An encoding.
+ * @retval     true       `enc` classifies `c` as "DIGIT".
+ * @retval     false      Otherwise.
  */
 static inline bool
 rb_enc_isdigit(OnigCodePoint c, rb_encoding *enc)
-- 
cgit v1.2.1


--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/

[前][次][番号順一覧][スレッド一覧]