Class: Inch::Language::Elixir::Provider::Reader::Object::ModuleObject

Inherits:
Base
  • Object
show all
Defined in:
lib/inch/language/elixir/provider/reader/object/module_object.rb

Overview

Proxy class for modules

Constant Summary

Constants inherited from Base

Base::HIDDEN_TYPES

Instance Attribute Summary

Attributes inherited from Base

#children_fullnames

Instance Method Summary collapse

Methods inherited from Base

#aliased_object_fullname, #aliases_fullnames, #api_tag?, #attributes, #bang_name?, #constant?, #constructor?, #depth, #docstring, #filename, #files, #getter?, #has_children?, #has_code_example?, #has_doc?, #has_multiple_code_examples?, #has_unconsidered_tags?, #in_root?, #initialize, #method?, #name, #overridden?, #overridden_method_fullname, #parameters, #parent_fullname, #private?, #protected?, #public?, #questioning_name?, #return_described?, #return_mentioned?, #return_typed?, #setter?, #source, #tagged_as_internal_api?, #tagged_as_private?, #unconsidered_tag_count, #undocumented?, #visibility

Constructor Details

This class inherits a constructor from Inch::Language::Elixir::Provider::Reader::Object::Base

Instance Method Details

#fullnameObject


17
18
19
# File 'lib/inch/language/elixir/provider/reader/object/module_object.rb', line 17

def fullname
  @hash['id']
end

#namespace?Boolean

Returns:

  • (Boolean)

21
22
23
# File 'lib/inch/language/elixir/provider/reader/object/module_object.rb', line 21

def namespace?
  true
end

#nodoc?Boolean

Returns:

  • (Boolean)

13
14
15
# File 'lib/inch/language/elixir/provider/reader/object/module_object.rb', line 13

def nodoc?
  @hash['moduledoc'] == false || super
end

#original_docstringObject


9
10
11
# File 'lib/inch/language/elixir/provider/reader/object/module_object.rb', line 9

def original_docstring
  @hash['moduledoc']
end