Login Register

documented?

documented?()

Instance Public methods

A method/attribute is documented if any of the following is true:

it was marked with :nodoc:;
it has a comment;
it is an alias for a documented method;
it has a #see method that is documented.

Links:

https://github.com/ruby/ruby/blob/1c279a7d2753949c725754e1302f791b76358114/lib/rdoc/method_attr.rb#L116

doc_ruby_on_rails

2015-05-03 08:13:04

Comments

Leave a Comment

Please login to continue.

Popular Articles

document document() Instance Public methods

documented? documented?() Instance Public methods A constant is documented if it has a comment, or is an alias for a documented class or module.

documented? documented?() Instance Public methods Does this object have a comment with content or is received_nodoc true?

documented? documented?() Instance Public methods Does this class or module have a comment with content or is received_nodoc true?

document document(options) Instance Public methods Generates documentation or a coverage report depending upon the settings in options. options c