1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

[DOC] Use true/false for @retvals which are bool

Browse Source
This commit is contained in:
Nobuyoshi Nakada 2022-08-12 10:18:38 +09:00
parent a3a6d2d9a3
commit 9a11d50dc7
Notes: git 2022-08-12 15:56:52 +09:00 
Merged: https://github.com/ruby/ruby/pull/6235
1 changed files with 43 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

44
include/ruby/internal/encoding/ctype.h
View File

@ -36,8 +36,8 @@ RBIMPL_SYMBOL_EXPORT_BEGIN()
* @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)
@ -56,8 +56,8 @@ rb_enc_is_newline(const char *p, const char *e, rb_encoding *enc)
* @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.
* @retval true `c` is of `t` in `enc`.
* @retval false Otherwise.
*/
static inline bool
rb_enc_isctype(OnigCodePoint c, OnigCtype t, rb_encoding *enc)
@ -70,8 +70,8 @@ rb_enc_isctype(OnigCodePoint c, OnigCtype t, rb_encoding *enc)
*
* @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.
* @retval false `c` is out of range of ASCII character set in `enc`.
* @retval true Otherwise.
*
* @internal
*
@ -89,8 +89,8 @@ rb_enc_isascii(OnigCodePoint c, rb_encoding *enc)
*
* @param[in] c A code point.
* @param[in] enc An encoding.
* @retval 1 `enc` classifies `c` as "ALPHA".
* @retval 0 Otherwise.
* @retval true `enc` classifies `c` as "ALPHA".
* @retval false Otherwise.
*/
static inline bool
rb_enc_isalpha(OnigCodePoint c, rb_encoding *enc)
@ -103,8 +103,8 @@ rb_enc_isalpha(OnigCodePoint c, rb_encoding *enc)
*
* @param[in] c A code point.
* @param[in] enc An encoding.
* @retval 1 `enc` classifies `c` as "LOWER".
* @retval 0 Otherwise.
* @retval true `enc` classifies `c` as "LOWER".
* @retval false Otherwise.
*/
static inline bool
rb_enc_islower(OnigCodePoint c, rb_encoding *enc)
@ -117,8 +117,8 @@ rb_enc_islower(OnigCodePoint c, rb_encoding *enc)
*
* @param[in] c A code point.
* @param[in] enc An encoding.
* @retval 1 `enc` classifies `c` as "UPPER".
* @retval 0 Otherwise.
* @retval true `enc` classifies `c` as "UPPER".
* @retval false Otherwise.
*/
static inline bool
rb_enc_isupper(OnigCodePoint c, rb_encoding *enc)
@ -131,8 +131,8 @@ rb_enc_isupper(OnigCodePoint c, rb_encoding *enc)
*
* @param[in] c A code point.
* @param[in] enc An encoding.
* @retval 1 `enc` classifies `c` as "PUNCT".
* @retval 0 Otherwise.
* @retval true `enc` classifies `c` as "PUNCT".
* @retval false Otherwise.
*/
static inline bool
rb_enc_ispunct(OnigCodePoint c, rb_encoding *enc)
@ -145,8 +145,8 @@ rb_enc_ispunct(OnigCodePoint c, rb_encoding *enc)
*
* @param[in] c A code point.
* @param[in] enc An encoding.
* @retval 1 `enc` classifies `c` as "ANUM".
* @retval 0 Otherwise.
* @retval true `enc` classifies `c` as "ANUM".
* @retval false Otherwise.
*/
static inline bool
rb_enc_isalnum(OnigCodePoint c, rb_encoding *enc)
@ -159,8 +159,8 @@ rb_enc_isalnum(OnigCodePoint c, rb_encoding *enc)
*
* @param[in] c A code point.
* @param[in] enc An encoding.
* @retval 1 `enc` classifies `c` as "PRINT".
* @retval 0 Otherwise.
* @retval true `enc` classifies `c` as "PRINT".
* @retval false Otherwise.
*/
static inline bool
rb_enc_isprint(OnigCodePoint c, rb_encoding *enc)
@ -173,8 +173,8 @@ rb_enc_isprint(OnigCodePoint c, rb_encoding *enc)
*
* @param[in] c A code point.
* @param[in] enc An encoding.
* @retval 1 `enc` classifies `c` as "PRINT".
* @retval 0 Otherwise.
* @retval true `enc` classifies `c` as "PRINT".
* @retval false Otherwise.
*/
static inline bool
rb_enc_isspace(OnigCodePoint c, rb_encoding *enc)
@ -187,8 +187,8 @@ rb_enc_isspace(OnigCodePoint c, rb_encoding *enc)
*
* @param[in] c A code point.
* @param[in] enc An encoding.
* @retval 1 `enc` classifies `c` as "DIGIT".
* @retval 0 Otherwise.
* @retval true `enc` classifies `c` as "DIGIT".
* @retval false Otherwise.
*/
static inline bool
rb_enc_isdigit(OnigCodePoint c, rb_encoding *enc)