Class: Documentation::Constant

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

Instance Method Summary collapse

Methods inherited from Base

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

Methods included from Memoized

#avoid_infinite_method_added_loop, #memoize, #method_added

Instance Method Details

#klassObject



420
421
422
# File 'lib/pdoc/parser/documentation_nodes.rb', line 420

def klass
  namespace.is_a?(Klass) ? namespace : nil
end

#klass_nameObject



424
425
426
# File 'lib/pdoc/parser/documentation_nodes.rb', line 424

def klass_name
  klass ? klass.name : nil
end

#returnsObject



428
429
430
# File 'lib/pdoc/parser/documentation_nodes.rb', line 428

def returns
  ebnf.returns
end

#signatureObject



432
433
434
# File 'lib/pdoc/parser/documentation_nodes.rb', line 432

def signature
  ebnf.signature
end

#typeObject



436
437
438
# File 'lib/pdoc/parser/documentation_nodes.rb', line 436

def type
  "constant"
end