Class: Inch::Language::JavaScript::Provider::JSDoc::Object::FunctionParameterObject

Inherits:

Object

• Object
• Inch::Language::JavaScript::Provider::JSDoc::Object::FunctionParameterObject

Defined in:

lib/inch/language/javascript/provider/jsdoc/object/function_parameter_object.rb

Overview

Proxy class for function parameters

Instance Attribute Summary

• #name ⇒ String readonly

Instance Method Summary

• #block? ⇒ Boolean

  true if the parameter is a block.

• #described? ⇒ Boolean

  true if an additional description is given?.

• #initialize(method, name) ⇒ FunctionParameterObject constructor

  A new instance of FunctionParameterObject.

• #mentioned? ⇒ Boolean

  true if the parameter is mentioned in the docs.

• #splat? ⇒ Boolean

  true if the parameter is a splat argument.

• #typed? ⇒ Boolean

  true if the type of the parameter is defined.

• #wrongly_mentioned? ⇒ Boolean

  true if the parameter is mentioned in the docs, but not present in the method’s signature.

Constructor Details

#initialize(method, name) ⇒ FunctionParameterObject

# File 'lib/inch/language/javascript/provider/jsdoc/object/function_parameter_object.rb', line 14

def initialize(method, name)
  @method = method
  @name = name
end

Instance Attribute Details

#name ⇒ String (readonly)

# File 'lib/inch/language/javascript/provider/jsdoc/object/function_parameter_object.rb', line 9

def name
  @name
end

Instance Method Details

#block? ⇒ Boolean

# File 'lib/inch/language/javascript/provider/jsdoc/object/function_parameter_object.rb', line 20

def block?
  false
end

#described? ⇒ Boolean

# File 'lib/inch/language/javascript/provider/jsdoc/object/function_parameter_object.rb', line 25

def described?
  described_by_docstring?
end

#mentioned? ⇒ Boolean

# File 'lib/inch/language/javascript/provider/jsdoc/object/function_parameter_object.rb', line 31

def mentioned?
  mentioned_by_docstring?
end

#splat? ⇒ Boolean

# File 'lib/inch/language/javascript/provider/jsdoc/object/function_parameter_object.rb', line 36

def splat?
  false
end

#typed? ⇒ Boolean

# File 'lib/inch/language/javascript/provider/jsdoc/object/function_parameter_object.rb', line 41

def typed?
  described_by_docstring?
end

#wrongly_mentioned? ⇒ Boolean

# File 'lib/inch/language/javascript/provider/jsdoc/object/function_parameter_object.rb', line 47

def wrongly_mentioned?
  false
end