From aa3b5062707b72189b42a912dc6df58ab3bb68f8 Mon Sep 17 00:00:00 2001 From: nobu Date: Mon, 28 Jul 2014 11:28:55 +0000 Subject: add some documents [ci skip] * bignum.c (Init_Bignum): [DOC] Bignum::GMP_VERSION. * complex.c (Init_Complex): [DOC] ignore an internal class. * dir.c (Init_Dir): [DOC] File::FNM_SYSCASE. * file.c (rb_file_exists_p): [DOC] File.exists? is deprecated. * object.c (rb_mod_initialize_clone): [DOC] ignore implementation detail. git-svn-id: svn+ssh://ci.ruby-lang.org/ruby/trunk@46990 b2dd03c8-39d4-4d8f-98ff-823fe69b080e --- bignum.c | 1 + complex.c | 2 +- dir.c | 6 ++++++ file.c | 7 ++++++- object.c | 1 + 5 files changed, 15 insertions(+), 2 deletions(-) diff --git a/bignum.c b/bignum.c index 1357de0e87..08b4337262 100644 --- a/bignum.c +++ b/bignum.c @@ -7037,6 +7037,7 @@ Init_Bignum(void) rb_define_method(rb_cBignum, "even?", rb_big_even_p, 0); #ifdef USE_GMP + /* The version of loaded GMP. */ rb_define_const(rb_cBignum, "GMP_VERSION", rb_sprintf("GMP %s", gmp_version)); #endif diff --git a/complex.c b/complex.c index bebce43df9..6b14ae6907 100644 --- a/complex.c +++ b/complex.c @@ -2167,7 +2167,7 @@ Init_Complex(void) rb_define_method(rb_cComplex, "inspect", nucomp_inspect, 0); rb_define_private_method(rb_cComplex, "marshal_dump", nucomp_marshal_dump, 0); - compat = rb_define_class_under(rb_cComplex, "compatible", rb_cObject); + compat = rb_define_class_under(rb_cComplex, "compatible", rb_cObject); /* :nodoc: */ rb_define_private_method(compat, "marshal_load", nucomp_marshal_load, 1); rb_marshal_define_compat(rb_cComplex, compat, nucomp_dumper, nucomp_loader); diff --git a/dir.c b/dir.c index c784a6f162..176c5f5b01 100644 --- a/dir.c +++ b/dir.c @@ -2316,5 +2316,11 @@ Init_Dir(void) * Allows file globbing through "{a,b}" in File.fnmatch patterns. */ rb_file_const("FNM_EXTGLOB", INT2FIX(FNM_EXTGLOB)); + + /* Document-const: File::Constants::FNM_SYSCASE + * + * System default case insensitiveness, equals to FNM_CASEFOLD or + * 0. + */ rb_file_const("FNM_SYSCASE", INT2FIX(FNM_SYSCASE)); } diff --git a/file.c b/file.c index 4fc5f771cf..34b2693430 100644 --- a/file.c +++ b/file.c @@ -1429,7 +1429,6 @@ rb_file_chardev_p(VALUE obj, VALUE fname) /* * call-seq: * File.exist?(file_name) -> true or false - * File.exists?(file_name) -> true or false * * Return true if the named file exists. * @@ -1447,6 +1446,12 @@ rb_file_exist_p(VALUE obj, VALUE fname) return Qtrue; } +/* + * call-seq: + * File.exists?(file_name) -> true or false + * + * Deprecated method. Don't use. + */ static VALUE rb_file_exists_p(VALUE obj, VALUE fname) { diff --git a/object.c b/object.c index 84360ac0e4..21772deb56 100644 --- a/object.c +++ b/object.c @@ -1707,6 +1707,7 @@ rb_mod_initialize(VALUE module) return Qnil; } +/* :nodoc: */ static VALUE rb_mod_initialize_clone(VALUE clone, VALUE orig) { -- cgit v1.2.3