RSpec
Ruby on Rails
Ruby
method
find_class_comment
Ruby latest stable (v2_5_5)
-
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?
-
new
(<= v2_2_9)
-
reset
(<= v1_9_3_392)
-
deduplicate_call_seq
(<= v2_2_9)
-
deduplicate_method_name
(<= v2_2_9)
-
do_aliases
(<= v2_2_9)
-
do_attrs
(<= v2_2_9)
-
do_boot_defclass
(<= v2_2_9)
-
do_classes
(<= v2_2_9)
-
do_constants
(<= v2_2_9)
-
do_define_class
(<= v2_2_9)
-
do_define_class_under
(<= v2_2_9)
-
do_define_module
(<= v2_2_9)
-
do_define_module_under
(<= v2_2_9)
-
do_includes
(<= v2_2_9)
-
do_methods
(<= v2_2_9)
-
do_missing
(<= v2_2_9)
-
do_modules
(<= v2_2_9)
-
do_singleton_class
(<= v2_2_9)
-
do_struct_define_without_ac...
(<= v2_2_9)
-
find_alias_comment
(<= v2_2_9)
-
find_attr_comment
(<= v2_2_9)
-
find_body
(<= v2_2_9)
-
find_class
(<= v2_2_9)
-
find_class_comment
(<= v2_2_9)
-
find_const_comment
(<= v2_2_9)
-
find_modifiers
(<= v2_2_9)
-
find_override_comment
(<= v2_2_9)
-
handle_attr
(<= v2_2_9)
-
handle_class_module
(<= v2_2_9)
-
handle_constants
(<= v2_2_9)
-
handle_ifdefs_in
(<= v2_2_9)
-
handle_method
(<= v2_2_9)
-
handle_singleton
(<= v2_2_9)
-
handle_tab_width
(<= v2_2_9)
-
load_variable_map
(<= v2_2_9)
-
look_for_directives_in
(<= v2_2_9)
-
mangle_comment
(<= v1_9_1_378)
-
rb_scan_args
(<= v2_2_9)
-
remove_commented_out_lines
(<= v2_2_9)
-
remove_private_comments
(<= v1_9_3_392)
-
scan
(<= v2_2_9)
-
warn
(<= v1_9_1_378)
= private
= protected
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);
