Current File : //opt/alt/ruby18/share/ri/1.8/system/RDoc/C_Parser/find_class_comment-i.yaml
--- !ruby/object:RI::MethodDescription
aliases: []
block_params:
comment:
- !ruby/struct:SM::Flow::P
body: Look for class or module documentation above Init_+class_name+(void), in a Document-class <tt>class_name</tt> (or module) comment or above an rb_define_class (or module). If a comment is supplied above a matching Init_ and a rb_define_class the Init_ comment is used.
- !ruby/struct:SM::Flow::VERB
body: " /*\n * This is a comment for Foo\n */\n Init_Foo(void) {\n VALUE cFoo = rb_define_class("Foo", rb_cObject);\n }\n\n /*\n * Document-class: Foo\n * This is a comment for Foo\n */\n Init_foo(void) {\n VALUE cFoo = rb_define_class("Foo", rb_cObject);\n }\n\n /*\n * This is a comment for Foo\n */\n VALUE cFoo = rb_define_class("Foo", rb_cObject);\n"
full_name: RDoc::C_Parser#find_class_comment
is_singleton: false
name: find_class_comment
params: (class_name, class_meth)
visibility: private
Mini Shell