Flowdock
method

find_class_comment

Importance_2
v1_8_6_287 - Show latest stable - 0 notes - Class: RDoc::C_Parser
find_class_comment(class_name, class_meth) private

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);
Show source
Register or log in to add new notes.