aboutsummaryrefslogtreecommitdiffstats
path: root/include/ruby
diff options
context:
space:
mode:
author卜部昌平 <shyouhei@ruby-lang.org>2021-01-21 14:45:12 +0900
committer卜部昌平 <shyouhei@ruby-lang.org>2021-09-10 20:00:06 +0900
commite9c423ac6c90f760e65e3b528bc7c26996ccab02 (patch)
tree920857325273b838dffb1d8cae4ae3e52988607a /include/ruby
parent92150fde85f028a5d60cf670cf66a2036cdb3a15 (diff)
downloadruby-e9c423ac6c90f760e65e3b528bc7c26996ccab02.tar.gz
include/ruby/internal/arithmetic/mode_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/mode_t.h3
1 files changed, 3 insertions, 0 deletions
diff --git a/include/ruby/internal/arithmetic/mode_t.h b/include/ruby/internal/arithmetic/mode_t.h
index 57844fedf5..5b7ad35fbc 100644
--- a/include/ruby/internal/arithmetic/mode_t.h
+++ b/include/ruby/internal/arithmetic/mode_t.h
@@ -23,14 +23,17 @@
#include "ruby/internal/config.h"
#include "ruby/internal/arithmetic/int.h"
+/** Converts a C's `mode_t` into an instance of ::rb_cInteger. */
#ifndef NUM2MODET
# define NUM2MODET RB_NUM2INT
#endif
+/** Converts an instance of ::rb_cNumeric into C's `mode_t`. */
#ifndef MODET2NUM
# define MODET2NUM RB_INT2NUM
#endif
+/** A rb_sprintf() format prefix to be used for a `mode_t` parameter. */
#ifndef PRI_MODET_PREFIX
# define PRI_MODET_PREFIX PRI_INT_PREFIX
#endif