https://git.ruby-lang.org/ruby.git/commit/?id=0c486c5531

From 0c486c55310e5392e6773b04472404589c4ed9a0 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?=E5=8D=9C=E9=83=A8=E6=98=8C=E5=B9=B3?=
 <shyouhei@r...>
Date: Tue, 2 Feb 2021 10:31:57 +0900
Subject: include/ruby/internal/core/rfile.h: add doxygen

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

diff --git a/include/ruby/internal/core/rfile.h b/include/ruby/internal/core/rfile.h
index 71699a0..f8dddde 100644
--- a/include/ruby/internal/core/rfile.h
+++ b/include/ruby/internal/core/rfile.h
@@ -27,10 +27,25 @@ https://github.com/ruby/ruby/blob/trunk/include/ruby/internal/core/rfile.h#L27
  * into ruby/ruby.h.  We follow that tradition. */
 struct rb_io_t;
 
+/**
+ * Ruby's File  and IO.  Ruby's  IO are not  just file descriptors.   They have
+ * buffers.   They also  have  encodings.  Various  information are  controlled
+ * using this struct.
+ */
 struct RFile {
+
+    /** Basic part, including flags and class. */
     struct RBasic basic;
+
+    /** IO's specific fields. */
     struct rb_io_t *fptr;
 };
 
+/**
+ * Convenient casting macro.
+ *
+ * @param   obj  An object, which is in fact an ::RFile.
+ * @return  The passed object casted to ::RFile.
+ */
 #define RFILE(obj) RBIMPL_CAST((struct RFile *)(obj))
 #endif /* RBIMPL_RFILE_H */
-- 
cgit v1.1


--
ML: ruby-changes@q...
Info: http://www.atdot.net/~ko1/quickml/