aboutsummaryrefslogtreecommitdiff
path: root/lib/mauve/configuration_builder.rb
diff options
context:
space:
mode:
Diffstat (limited to 'lib/mauve/configuration_builder.rb')
-rw-r--r--lib/mauve/configuration_builder.rb18
1 files changed, 16 insertions, 2 deletions
diff --git a/lib/mauve/configuration_builder.rb b/lib/mauve/configuration_builder.rb
index fb3c781..1d8d960 100644
--- a/lib/mauve/configuration_builder.rb
+++ b/lib/mauve/configuration_builder.rb
@@ -5,9 +5,11 @@ require 'mauve/people_list'
require 'mauve/source_list'
module Mauve
+ #
+ # This is the top-level configuration builder
+ #
class ConfigurationBuilder < ObjectBuilder
- #
# This overwrites the default ObjectBuilder initialize method, such that
# the context is set as a new configuration
#
@@ -16,19 +18,31 @@ module Mauve
# FIXME: need to test blocks that are not immediately evaluated
end
+ # Adds a source list
+ #
+ # @param [String] label
+ # @param [Array] list
+ #
+ # @return [Array] the whole source list for label
def source_list(label, *list)
_logger.warn "Duplicate source_list '#{label}'" if @result.source_lists.has_key?(label)
@result.source_lists[label] += list
end
+ # Adds a people list
+ #
+ # @param [String] label
+ # @param [Array] list
+ #
+ # @return [Array] the whole people list for label
def people_list(label, *list)
_logger.warn("Duplicate people_list '#{label}'") if @result.people_lists.has_key?(label)
@result.people_lists[label] += list
end
- #
# Have to use the method _logger here, cos logger is defined as a builder elsewhere.
#
+ # @return [Log4r::Logger]
def _logger
@logger ||= Log4r::Logger.new(self.class.to_s)
end