method

find_class_comment

v1_9_2_180 - Show latest stable - 0 notes - Class: C

1_8_6_287
1_8_7_72
1_8_7_330
1_9_1_378 (0)
1_9_2_180 (0)
1_9_3_125 (0)
1_9_3_392 (0)
2_1_10 (0)
2_2_9 (0)
2_4_6
2_5_5
2_6_3
What's this?

find_class_comment(class_name, class_mod) public

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

# File lib/rdoc/parser/c.rb, line 384
  def find_class_comment(class_name, class_mod)
    comment = nil

    if @content =~ %{
        ((?>/\*.*?\*/\s+))
        (static\s+)?
        void\s+
        Init_#{class_name}\s*(?:_\(\s*)?\(\s*(?:void\s*)?\)}mi then # )
      comment = $1
    elsif @content =~ %{Document-(?:class|module):\s+#{class_name}\s*?(?:<\s+[:,\w]+)?\n((?>.*?\*/))} then
      comment = $1
    elsif @content =~ %{((?>/\*.*?\*/\s+))
                         ([\w\.\s]+\s* = \s+)?rb_define_(class|module).*?"(#{class_name})"}m then # "
      comment = $1
    end

    return unless comment

    comment = strip_stars comment

    comment = look_for_directives_in class_mod, comment

    class_mod.comment = comment
  end

find_class_comment

Related methods