aboutsummaryrefslogtreecommitdiffstats
path: root/include
diff options
context:
space:
mode:
author卜部昌平 <shyouhei@ruby-lang.org>2021-01-25 10:51:04 +0900
committer卜部昌平 <shyouhei@ruby-lang.org>2021-09-10 20:00:06 +0900
commit98ab28619575a766f90dfcbfa54a73c9274e387d (patch)
tree6224c73d2b25e7842b607fbb63c9fbb97d5f18cd /include
parent5e1caeb15ce7590621facf93d87207e73dd8a3a9 (diff)
downloadruby-98ab28619575a766f90dfcbfa54a73c9274e387d.tar.gz
include/ruby/internal/arithmetic/gid_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/gid_t.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/include/ruby/internal/arithmetic/gid_t.h b/include/ruby/internal/arithmetic/gid_t.h
index 9b74225492..361220bfab 100644
--- a/include/ruby/internal/arithmetic/gid_t.h
+++ b/include/ruby/internal/arithmetic/gid_t.h
@@ -23,14 +23,17 @@
#include "ruby/internal/config.h"
#include "ruby/internal/arithmetic/long.h"
+/** Converts a C's `gid_t` into an instance of ::rb_cInteger. */
#ifndef GIDT2NUM
# define GIDT2NUM RB_LONG2NUM
#endif
+/** Converts an instance of ::rb_cNumeric into C's `gid_t`. */
#ifndef NUM2GIDT
# define NUM2GIDT RB_NUM2LONG
#endif
+/** A rb_sprintf() format prefix to be used for a `gid_t` parameter. */
#ifndef PRI_GIDT_PREFIX
# define PRI_GIDT_PREFIX PRI_LONG_PREFIX
#endif