Class: Rscons::Task::Param

Inherits:
Object
  • Object
show all
Defined in:
lib/rscons/task.rb

Overview

Class to represent a task parameter.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(name, value, takes_arg, description) ⇒ Param

Construct a Param.

Parameters:

  • name (String) —

    Param name.

  • value (String, nil) —

    Param value.

  • takes_arg (String) —

    Whether the parameter takes an argument.

  • description (String) —

    Param description.



81
82
83
84
85
86
 
# File 'lib/rscons/task.rb', line 81

def initialize(name, value, takes_arg, description)
  @name = name
  @value = value
  @takes_arg = takes_arg
  @description = description
end

Instance Attribute Details

#description ⇒ String (readonly)

Returns Param description.

Returns:

  • (String) —

    Param description.



61
62
63
 
# File 'lib/rscons/task.rb', line 61

def description
  @description
end

#name ⇒ String (readonly)

Returns Param name.

Returns:

  • (String) —

    Param name.



57
58
59
 
# File 'lib/rscons/task.rb', line 57

def name
  @name
end

#takes_arg ⇒ Boolean (readonly)

Returns Whether the parameter takes an argument.

Returns:

  • (Boolean) —

    Whether the parameter takes an argument.



65
66
67
 
# File 'lib/rscons/task.rb', line 65

def takes_arg
  @takes_arg
end

#value ⇒ String?

Returns Param value.

Returns:

  • (String, nil) —

    Param value.



69
70
71
 
# File 'lib/rscons/task.rb', line 69

def value
  @value
end