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
116
 
# File 'lib/seahorse/client/plugin.rb', line 110

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

Instance Attribute Details

#default ⇒ Object

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
  @default
end

#default_block ⇒ Object

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 default_block
  @default_block
end

#doc_default ⇒ Object

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. 



126
127
128
129
130
131
132
 
# File 'lib/seahorse/client/plugin.rb', line 126

def doc_default
  if @doc_default.nil? && !default.is_a?(Proc)
    default
  else
    @doc_default
  end
end

#doc_type ⇒ Object

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_type
  @doc_type
end

#docstring ⇒ Object

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. 



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

def docstring
  @docstring
end

#name ⇒ Object (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. 



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

def name
  @name
end

#required ⇒ Object

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 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) 


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

def documented?
  !!docstring
end