find_class_comment

find_class_comment(class_name, class_mod)

Instance Public methods

Look for class or module documentation above Init_+class_name+(void), in a Document-class class_name (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.

   This is a comment for Foo
 
Init_Foo(void) {
    VALUE cFoo = rb_define_class("Foo", rb_cObject);
}
 
   Document-class: Foo
   This is a comment for Foo
 
Init_foo(void) {
    VALUE cFoo = rb_define_class("Foo", rb_cObject);
}
 
/*
   This is a comment for Foo
  /
VALUE cFoo = rb_define_class("Foo", rb_cObject);

Links:

https://github.com/ruby/ruby/blob/d8c7695fbb2944aba9a69dce75f41b6881d1fc12/lib/rdoc/parser/c.rb#L691

doc_ruby_on_rails

2025-01-10 15:47:30

Comments