1berry/ruby
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

include/ruby/internal/core/rfile.h: add doxygen

Browse Source 
Must not be a bad idea to improve documents. [ci skip]
This commit is contained in:
卜部昌平 2021-02-02 10:31:57 +09:00
parent b92a9af405
commit 0c486c5531
Notes: git 2021-09-10 20:01:41 +09:00 
Merged: https://github.com/ruby/ruby/pull/4815
1 changed files with 15 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
include/ruby/internal/core/rfile.h
View File

@ -27,10 +27,25 @@
* into ruby/ruby.h. We follow that tradition. */ * into ruby/ruby.h. We follow that tradition. */
struct rb_io_t; 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 { struct RFile {
/** Basic part, including flags and class. */
struct RBasic basic; struct RBasic basic;
/** IO's specific fields. */
struct rb_io_t *fptr; 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)) #define RFILE(obj) RBIMPL_CAST((struct RFile *)(obj))
#endif /* RBIMPL_RFILE_H */ #endif /* RBIMPL_RFILE_H */