diff options
| author | 卜部昌平 <shyouhei@ruby-lang.org> | 2021-01-21 14:39:13 +0900 |
|---|---|---|
| committer | 卜部昌平 <shyouhei@ruby-lang.org> | 2021-09-10 20:00:06 +0900 |
| commit | 92150fde85f028a5d60cf670cf66a2036cdb3a15 (patch) | |
| tree | e9f0eb7e1a2d8f34239aa3e4189b90236b9f9a18 /include | |
| parent | 5289552e53d0d4874b70d652b8e7da76de27de4d (diff) | |
| download | ruby-92150fde85f028a5d60cf670cf66a2036cdb3a15.tar.gz | |
include/ruby/internal/arithmetic/off_t.h: add doxygen
Must not be a bad idea to improve documents. [ci skip]
Diffstat (limited to 'include')
| -rw-r--r-- | include/ruby/internal/arithmetic/off_t.h | 3 |
1 files changed, 3 insertions, 0 deletions
diff --git a/include/ruby/internal/arithmetic/off_t.h b/include/ruby/internal/arithmetic/off_t.h index 0226eb4f25..0ec9362cc9 100644 --- a/include/ruby/internal/arithmetic/off_t.h +++ b/include/ruby/internal/arithmetic/off_t.h @@ -26,6 +26,7 @@ #include "ruby/internal/arithmetic/long_long.h" #include "ruby/backward/2/long_long.h" +/** Converts a C's `off_t` into an instance of ::rb_cInteger. */ #ifdef OFFT2NUM # /* take that. */ #elif SIZEOF_OFF_T == SIZEOF_LONG_LONG @@ -36,6 +37,7 @@ # define OFFT2NUM RB_INT2NUM #endif +/** Converts an instance of ::rb_cNumeric into C's `off_t`. */ #ifdef NUM2OFFT # /* take that. */ #elif SIZEOF_OFF_T == SIZEOF_LONG_LONG @@ -46,6 +48,7 @@ # define NUM2OFFT RB_NUM2INT #endif +/** A rb_sprintf() format prefix to be used for an `off_t` parameter. */ #ifdef PRI_OFFT_PREFIX # /* take that. */ #elif SIZEOF_OFF_T == SIZEOF_LONG_LONG |