Class/Module Index [+]

Quicksearch

YARD::Handlers::Ruby::MethodHandler

Handles a method definition

Public Instance Methods

format_args(args) click to toggle source
# File lib/yard/handlers/ruby/method_handler.rb, line 76
def format_args(args)
  args = args.jump(:params)
  params = []
  params += args.required_params.map {|a| [a.source, nil] } if args.required_params
  params += args.optional_params.map {|a| [a[0].source, a[1].source] } if args.optional_params
  params << ["*" + args.splat_param.source, nil] if args.splat_param
  params += args.required_end_params.map {|a| [a.source, nil] } if args.required_end_params
  params << ["&" + args.block_param.source, nil] if args.block_param
  params
end
method_signature(method_name) click to toggle source
# File lib/yard/handlers/ruby/method_handler.rb, line 87
def method_signature(method_name)
  if statement[1]
    "def #{method_name}(#{statement[1].jump(:params).source})"
  else
    "def #{method_name}"
  end
end

[Validate]

Generated with the Darkfish Rdoc Generator 2.