From 92150fde85f028a5d60cf670cf66a2036cdb3a15 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:39:13 +0900
Subject: [PATCH] include/ruby/internal/arithmetic/off_t.h: add doxygen

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

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