summaryrefslogtreecommitdiff
path: root/ext/pathname/pathname.c
diff options
context:
space:
mode:
authorzzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-03-08 04:21:43 +0000
committerzzak <zzak@b2dd03c8-39d4-4d8f-98ff-823fe69b080e>2013-03-08 04:21:43 +0000
commit7d183dab15665d34ad982348c3205c85b28017b5 (patch)
tree31afd844d7f4ab9a120b8d0b3a4858744e70ba31 /ext/pathname/pathname.c
parentdf9d847e0b6532e12ccc78e2d78d767b68364f66 (diff)
* ext/pathname/pathname.c (path_f_pathname): rdoc for Pathname()
git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@39634 b2dd03c8-39d4-4d8f-98ff-823fe69b080e
Diffstat (limited to 'ext/pathname/pathname.c')
-rw-r--r--ext/pathname/pathname.c15
1 files changed, 14 insertions, 1 deletions
diff --git a/ext/pathname/pathname.c b/ext/pathname/pathname.c
index 2bb6ce2..fa67226 100644
--- a/ext/pathname/pathname.c
+++ b/ext/pathname/pathname.c
@@ -1107,7 +1107,20 @@ path_unlink(VALUE self)
}
/*
- * Creates a new Pathname object.
+ * :call-seq:
+ * Pathname(path) -> pathname
+ *
+ * Creates a new Pathname object from the given string, +path+, and returns
+ * pathname object.
+ *
+ * In order to use this constuctor, you must first require the Pathname
+ * standard library extension.
+ *
+ * require 'pathname'
+ * Pathname("/home/zzak")
+ * #=> #<Pathname:/home/zzak>
+ *
+ * See also Pathname::new for more information.
*/
static VALUE
path_f_pathname(VALUE self, VALUE str)