handle_constants

handle_constants(type, var_name, const_name, definition)
Instance Public methods

Adds constants. By providing some_value: at the start of the comment you can override the C value of the comment to give a friendly definition.

   300: The perfect score in bowling   
rb_define_const(cFoo, "PERFECT", INT2FIX(300);

Will override INT2FIX(300) with the value 300 in the output RDoc. Values may include quotes and escaped colons (:).

doc_ruby_on_rails
2015-05-03 13:30:08
Comments
Leave a Comment

Please login to continue.