Class: Seahorse::Client::Plugin::PluginOption Private

Inherits:
Object
  • Object
show all
Defined in:
lib/seahorse/client/plugin.rb

This class is part of a private API. You should avoid using this class if possible, as it may be removed or be changed in the future.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, options = {}) ⇒ PluginOption

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns a new instance of PluginOption



110
111
112
113
114
115
# File 'lib/seahorse/client/plugin.rb', line 110

def initialize(name, options = {})
  @name = name
  options.each_pair do |opt_name, opt_value|
    self.send("#{opt_name}=", opt_value)
  end
end

Instance Attribute Details

#defaultObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



118
119
120
# File 'lib/seahorse/client/plugin.rb', line 118

def default
  @default
end

#default_blockObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



119
120
121
# File 'lib/seahorse/client/plugin.rb', line 119

def default_block
  @default_block
end

#doc_defaultObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



122
123
124
# File 'lib/seahorse/client/plugin.rb', line 122

def doc_default
  @doc_default
end

#doc_typeObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



121
122
123
# File 'lib/seahorse/client/plugin.rb', line 121

def doc_type
  @doc_type
end

#docstringObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



123
124
125
# File 'lib/seahorse/client/plugin.rb', line 123

def docstring
  @docstring
end

#nameObject (readonly)

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



117
118
119
# File 'lib/seahorse/client/plugin.rb', line 117

def name
  @name
end

#requiredObject

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.



120
121
122
# File 'lib/seahorse/client/plugin.rb', line 120

def required
  @required
end

Instance Method Details

#documented?Boolean

This method is part of a private API. You should avoid using this method if possible, as it may be removed or be changed in the future.

Returns:

  • (Boolean)


133
134
135
# File 'lib/seahorse/client/plugin.rb', line 133

def documented?
  !!docstring
end