Class: Documentation::Property

Inherits:
Base
  • Object
show all
Defined in:
lib/pdoc/parser/documentation_nodes.rb

Direct Known Subclasses

InstanceProperty, KlassProperty

Instance Method Summary collapse

Methods inherited from Base

#alias_of, #deprecated?, #description, #doc_parent, #ebnf_expressions, #full_name, #inspect, #klass_name, #name, #namespace, #namespace_string, #parent_id, #related_to, #root, #section_name, #src_code_line, #tags, #to_yaml

Methods included from Memoized

#avoid_infinite_method_added_loop, #memoize, #method_added

Instance Method Details

#klass ⇒ Object 



347
348
349
 
# File 'lib/pdoc/parser/documentation_nodes.rb', line 347

def klass
  namespace
end

#returns ⇒ Object 



355
356
357
 
# File 'lib/pdoc/parser/documentation_nodes.rb', line 355

def returns
  ebnf.returns
end

#serialize(serializer) ⇒ Object 



359
360
361
362
363
364
365
366
367
368
 
# File 'lib/pdoc/parser/documentation_nodes.rb', line 359

def serialize(serializer)
  str = to_yaml
  
  str << "\nsignatures:"
  str << "\n -"
  str << "\n  signature: #{signature.inspect}"
  str << "\n  return_value: #{returns.inspect}"

  serializer << str
end

#signature ⇒ Object 



351
352
353
 
# File 'lib/pdoc/parser/documentation_nodes.rb', line 351

def signature
  ebnf.signature
end