Class: YARD::Handlers::Ruby::AttributeHandler
Overview
Handles attr_* statements in modules/classes
Constant Summary
Constants included from CodeObjects
BUILTIN_ALL, BUILTIN_CLASSES, BUILTIN_EXCEPTIONS, BUILTIN_EXCEPTIONS_HASH, BUILTIN_MODULES, CONSTANTMATCH, CSEP, CSEPQ, ISEP, ISEPQ, METHODMATCH, METHODNAMEMATCH, NAMESPACEMATCH, NSEP, NSEPQ
Instance Attribute Summary
Attributes inherited from Base
extra_state, globals, namespace, owner, parser, scope, statement, visibility
Instance Method Summary (collapse)
-
- (Array<String>) validated_attribute_names(params)
protected
Strips out any non-essential arguments from the attr statement.
Methods inherited from Base
#call_params, #caller_method, handles?, meta_type, method_call, #parse_block
Methods included from Parser::Ruby
Methods inherited from Base
#call_params, #caller_method, clear_subclasses, #ensure_loaded!, #expand_macro, #find_or_create_macro, handlers, handles, handles?, in_file, #initialize, matches_file?, namespace_only, namespace_only?, #parse_block, #process, process, #push_state, #register, subclasses
Constructor Details
This class inherits a constructor from YARD::Handlers::Base
Instance Method Details
- (Array<String>) validated_attribute_names(params) (protected)
Strips out any non-essential arguments from the attr statement.
71 72 73 74 75 76 77 78 79 80 81 82 |
# File 'lib/yard/handlers/ruby/attribute_handler.rb', line 71 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 |