Class: ActiveDoc::Descriptions::MethodArgumentDescription::Reference

Inherits:
ActiveDoc::Descriptions::MethodArgumentDescription show all
Includes:
Traceable
Defined in:
lib/active_doc/descriptions/method_argument_description.rb

Instance Attribute Summary

Attributes inherited from ActiveDoc::Descriptions::MethodArgumentDescription

#conjunction, #name, #origin_file

Instance Method Summary collapse

Methods included from Traceable

#origin_file, #origin_line

Methods inherited from ActiveDoc::Descriptions::MethodArgumentDescription

#last_line

Constructor Details

#initialize(name, target_description, origin, options) ⇒ Reference

Returns a new instance of Reference.



393
394
395
396
397
398
399
 
# File 'lib/active_doc/descriptions/method_argument_description.rb', line 393

def initialize(name, target_description, origin, options)
  @name = name
  @klass, @method = target_description.split("#")
  @klass = Object.const_get(@klass)
  @method = @method.to_sym
  @origin = origin
end

Instance Method Details

#to_rdoc(*args) ⇒ Object 



406
407
408
 
# File 'lib/active_doc/descriptions/method_argument_description.rb', line 406

def to_rdoc(*args)
    referenced_argument_description.to_rdoc
end

#validate(*args) ⇒ Object 



401
402
403
404
 
# File 'lib/active_doc/descriptions/method_argument_description.rb', line 401

def validate(*args)
  # we validate only in target method
  return @name
end