Method: YARD::Handlers::Ruby::AttributeHandler#validated_attribute_names

Defined in:

lib/yard/handlers/ruby/attribute_handler.rb

#validated_attribute_names(params) ⇒ Array<String> (protected)

Strips out any non-essential arguments from the attr statement.

Parameters:

• params (Array<Parser::Ruby::AstNode>) —

  a list of the parameters in the attr call.

Returns:

• (Array<String>) —

  the validated attribute names

Raises:

• (Parser::UndocumentableError) —

  if the arguments are not valid.

# File 'lib/yard/handlers/ruby/attribute_handler.rb', line 70

def validated_attribute_names(params)
  params.map do |obj|
    case obj.type
    when :symbol_literal
      obj.jump(:ident, :op, :kw, :const).source
    when :string_literal
      obj.jump(:string_content).source
    else
      raise YARD::Parser::UndocumentableError, obj.source
    end
  end
end