From 974a9e4fba646727c9ba8ebfe898ad17286a5f12 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: Fri, 7 May 2021 14:49:09 +0900
Subject: [PATCH] include/ruby/internal/intern/dir.h: add doxygen

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

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()