From e9c423ac6c90f760e65e3b528bc7c26996ccab02 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=8D=9C=E9=83=A8=E6=98=8C=E5=B9=B3?=
 <shyouhei@ruby-lang.org>
Date: Thu, 21 Jan 2021 14:45:12 +0900
Subject: [PATCH] include/ruby/internal/arithmetic/mode_t.h: add doxygen

Must not be a bad idea to improve documents. [ci skip]
---
 include/ruby/internal/arithmetic/mode_t.h | 3 +++
 1 file changed, 3 insertions(+)

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