aboutsummaryrefslogtreecommitdiffstats
path: root/include/ruby
diff options
context:
space:
mode:
author卜部昌平 <shyouhei@ruby-lang.org>2021-01-21 14:11:27 +0900
committer卜部昌平 <shyouhei@ruby-lang.org>2021-09-10 20:00:06 +0900
commit5289552e53d0d4874b70d652b8e7da76de27de4d (patch)
tree09ccfeaed0be79d780574f29fc3c24d058f8ca8a /include/ruby
parent009c6b742b5a1e301daaf7f73ed87a60005503be (diff)
downloadruby-5289552e53d0d4874b70d652b8e7da76de27de4d.tar.gz
include/ruby/internal/arithmetic/pid_t.h: add doxygen
Must not be a bad idea to improve documents. [ci skip]
Diffstat (limited to 'include/ruby')
-rw-r--r--include/ruby/internal/arithmetic/pid_t.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/include/ruby/internal/arithmetic/pid_t.h b/include/ruby/internal/arithmetic/pid_t.h
index 205c181fc8..df9704e8f5 100644
--- a/include/ruby/internal/arithmetic/pid_t.h
+++ b/include/ruby/internal/arithmetic/pid_t.h
@@ -23,14 +23,17 @@
#include "ruby/internal/config.h"
#include "ruby/internal/arithmetic/long.h"
+/** Converts a C's `pid_t` into an instance of ::rb_cInteger. */
#ifndef PIDT2NUM
# define PIDT2NUM RB_LONG2NUM
#endif
+/** Converts an instance of ::rb_cNumeric into C's `pid_t`. */
#ifndef NUM2PIDT
# define NUM2PIDT RB_NUM2LONG
#endif
+/** A rb_sprintf() format prefix to be used for a `pid_t` parameter. */
#ifndef PRI_PIDT_PREFIX
# define PRI_PIDT_PREFIX PRI_LONG_PREFIX
#endif