lib/bovem/configuration.rb in bovem-0.8.1 vs lib/bovem/configuration.rb in bovem-1.0.0
- old
+ new
@@ -3,11 +3,11 @@
# This file is part of the bovem gem. Copyright (C) 2012 and above Shogun <shogun_panda@me.com>.
# Licensed under the MIT license, which can be found at http://www.opensource.org/licenses/mit-license.php.
#
module Bovem
- # This class holds the configuration of the applicaton.
+ # This class holds the configuration of an applicaton.
#
# Extend this class and add valid properties via {property property} method.
# Example:
#
# ```ruby
@@ -29,11 +29,11 @@
# @see #parse
def initialize(file = nil, overrides = {}, logger = nil)
self.parse(file, overrides, logger)
end
- # Creates a new configuration.
+ # Parses a configuration file.
#
# A configuration file is a plain Ruby file with a top-level {Configuration config} object.
#
# Example:
#
@@ -67,10 +67,10 @@
end
self
end
- # Defines a new property for the configuration
+ # Defines a new property for the configuration.
#
# @param name [Symbol] The name of the property.
# @param options [Hash] A set of options for the property. Currently, only `:default` (which holds the default value) is supported.
def self.property(name, options = {})
options = {} if !options.is_a?(::Hash)
\ No newline at end of file