diff options
| author | 卜部昌平 <shyouhei@ruby-lang.org> | 2021-05-07 14:49:09 +0900 |
|---|---|---|
| committer | 卜部昌平 <shyouhei@ruby-lang.org> | 2021-09-10 20:00:06 +0900 |
| commit | 974a9e4fba646727c9ba8ebfe898ad17286a5f12 (patch) | |
| tree | f1d04020690bcb0c9d8ab0dfca084829aedfcd23 /include/ruby | |
| parent | 0a7034258f765f057ad56d1210b890d44324f904 (diff) | |
| download | ruby-974a9e4fba646727c9ba8ebfe898ad17286a5f12.tar.gz | |
include/ruby/internal/intern/dir.h: add doxygen
Must not be a bad idea to improve documents. [ci skip]
Diffstat (limited to 'include/ruby')
| -rw-r--r-- | include/ruby/internal/intern/dir.h | 9 |
1 files changed, 9 insertions, 0 deletions
diff --git a/include/ruby/internal/intern/dir.h b/include/ruby/internal/intern/dir.h index 4b2608e5e6..da1873e068 100644 --- a/include/ruby/internal/intern/dir.h +++ b/include/ruby/internal/intern/dir.h @@ -26,6 +26,15 @@ RBIMPL_SYMBOL_EXPORT_BEGIN() /* 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); RBIMPL_SYMBOL_EXPORT_END() |