document block syntax for Environment

This commit is contained in:
Josh Holtrop 2013-08-04 15:46:13 -04:00
parent 5f4c6dffbc
commit 3f33336fff

View File

@ -14,6 +14,8 @@ module Rscons
# The variables hash can contain both construction variables, which are # The variables hash can contain both construction variables, which are
# uppercase strings (such as "CC" or "LDFLAGS"), and RScons options, # uppercase strings (such as "CC" or "LDFLAGS"), and RScons options,
# which are lowercase symbols (such as :echo). # which are lowercase symbols (such as :echo).
# If a block is given, the Environment object is yielded to the block and
# when the block returns, the {#process} method is automatically called.
def initialize(variables = {}) def initialize(variables = {})
@varset = VarSet.new(variables) @varset = VarSet.new(variables)
@targets = {} @targets = {}
@ -43,6 +45,8 @@ module Rscons
# The cloned environment will contain a copy of all environment options, # The cloned environment will contain a copy of all environment options,
# construction variables, builders, and build directories. It will not # construction variables, builders, and build directories. It will not
# contain a copy of the targets. # contain a copy of the targets.
# If a block is given, the Environment object is yielded to the block and
# when the block returns, the {#process} method is automatically called.
def clone(variables = {}) def clone(variables = {})
env = Environment.new() env = Environment.new()
@builders.each do |builder_name, builder| @builders.each do |builder_name, builder|