lib/brine.rb in brine-dsl-0.7.0 vs lib/brine.rb in brine-dsl-0.8.0

- old
+ new

@@ -1,31 +1,36 @@ -# brine.rb -- loader file for the rest of brine +## +# @file brine.rb +# Loader file for the rest of brine. # # The primary goal of this file is to load all resources needed to use brine. -# A secondary goal which should inform how that is done is that loading this file by itself -# should provide new objects but not otherwise impact existing state such as by -# modifying the World or defining any Steps, Transforms, or similar. -# Those types of changes should be done by [#brine_mix]. +# A secondary goal which should inform how that is done is that loading this +# file by itself should provide new objects but not otherwise impact existing +# state such as by modifying the World or defining any Steps, Transforms, etc. +# Those types of changes should be done by @ref #brine_mix. require 'brine/cleaner_upper' require 'brine/mustache_binder' require 'brine/requester' require 'brine/util' require 'brine/selector' require 'brine/type_checks' -# Modules to add to World +## +# Meta-module for modules to mix into World. module Brine include CleanerUpper include MustacheBinder include Requesting include BrineUtil include Selection include TypeChecking end -# Load the more side effecty files and return the Module, -# expected to be called as `World(brine_mix)` +## +# Load the files with side effects and return @ref Brine. +# +# Expected to be called as `World(brine_mix)` def brine_mix require 'brine/step_definitions/assignment' require 'brine/step_definitions/request_construction' require 'brine/step_definitions/assertions' require 'brine/step_definitions/cleanup'