diff options
author | 卜部昌平 <shyouhei@ruby-lang.org> | 2021-01-21 11:43:31 +0900 |
---|---|---|
committer | 卜部昌平 <shyouhei@ruby-lang.org> | 2021-09-10 20:00:06 +0900 |
commit | edf1964bdfabbd25be3082f77986b9f5ad845ba1 (patch) | |
tree | 188416a41028fd45076027c966b5a0ed342b727b | |
parent | 0ea157136f1b255321722db1acd0be3c6229a77a (diff) | |
download | ruby-edf1964bdfabbd25be3082f77986b9f5ad845ba1.tar.gz |
include/ruby/internal/arithmetic/uid_t.h: add doxygen
Must not be a bad idea to improve documents. [ci skip]
-rw-r--r-- | include/ruby/internal/arithmetic/uid_t.h | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/include/ruby/internal/arithmetic/uid_t.h b/include/ruby/internal/arithmetic/uid_t.h index e0048a3dc9..12cde2a9c8 100644 --- a/include/ruby/internal/arithmetic/uid_t.h +++ b/include/ruby/internal/arithmetic/uid_t.h @@ -23,14 +23,17 @@ #include "ruby/internal/config.h" #include "ruby/internal/arithmetic/long.h" +/** Converts a C's `uid_t` into an instance of ::rb_cInteger. */ #ifndef UIDT2NUM # define UIDT2NUM RB_LONG2NUM #endif +/** Converts an instance of ::rb_cNumeric into C's `uid_t`. */ #ifndef NUM2UIDT # define NUM2UIDT RB_NUM2LONG #endif +/** A rb_sprintf() format prefix to be used for a `uid_t` parameter. */ #ifndef PRI_UIDT_PREFIX # define PRI_UIDT_PREFIX PRI_LONG_PREFIX #endif |