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

include/ruby/internal/intern/dir.h: add doxygen

Browse Source 
Must not be a bad idea to improve documents. [ci skip]
This commit is contained in:
卜部昌平 2021-05-07 14:49:09 +09:00
parent 0a7034258f
commit 974a9e4fba
Notes: git 2021-09-10 20:01:27 +09:00 
Merged: https://github.com/ruby/ruby/pull/4815
1 changed files with 9 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
include/ruby/internal/intern/dir.h
View File

@ -26,6 +26,15 @@
RBIMPL_SYMBOL_EXPORT_BEGIN() RBIMPL_SYMBOL_EXPORT_BEGIN()
/* dir.c */ /* dir.c */
/**
* Queries the path of the current working directory of the current process.
*
* @return An instance of ::rb_cString that holds the working directory.
* @note The returned string is in "filesystem" encoding. Most notably on
* Linux this is an alias of default external encoding. Most notably
* on Windows it can be an alias of OS codepage.
*/
VALUE rb_dir_getwd(void); VALUE rb_dir_getwd(void);
RBIMPL_SYMBOL_EXPORT_END() RBIMPL_SYMBOL_EXPORT_END()