Class | YARD::CodeObjects::MethodObject |
In: |
lib/yard/code_objects/method_object.rb
|
Parent: | Base |
Represents a Ruby method in source
explicit | [RW] |
Whether the object is explicitly defined in source or whether it was
inferred by a handler. For instance, attribute methods are generally
inferred and therefore not explicitly defined in source.
@return [Boolean] whether the object is explicitly defined in source. |
parameters | [RW] |
Returns the list of parameters parsed out of the method signature with
their default values.
@return [Array<Array(String, String)>] a list of parameter names followed by their default values (or nil) |
scope | [R] |
The scope of the method (+:class+ or +:instance+)
@return [Symbol] the scope |
Creates a new method object in namespace with name and an instance or class scope
If scope is +:module+, this object is instantiated as a public method in +:class+ scope, but also creates a new (empty) method as a private +:instance+ method on the same class or module.
@param [NamespaceObject] namespace the namespace @param [String, Symbol] name the method name @param [Symbol] scope +:instance+, +:class+, or +:module+
Returns the read/writer info for the attribute if it is one @return [SymbolHash] if there is information about the attribute @return [nil] if the method is not an attribute @since 0.5.3
Tests if the object is defined as an alias of another method @return [Boolean] whether the object is an alias
Tests if the object is defined as an attribute in the namespace @return [Boolean] whether the object is an attribute
Tests boolean {explicit} value.
@return [Boolean] whether the method is explicitly defined in source
Returns the name of the object.
@example The name of an instance method (with prefix)
an_instance_method.name(true) # => "#mymethod"
@example The name of a class method (with prefix)
a_class_method.name(true) # => "mymethod"
@param [Boolean] prefix whether or not to show the prefix @return [String] returns {sep} + name for an instance method if
prefix is true
@return [Symbol] the name without {sep} if prefix is set to false
@return [MethodObject] the object that this method overrides @return [nil] if it does not override a method @since 0.6.0
Override separator to differentiate between class and instance methods. @return [String] "#" for an instance method, "." for class