lib/middleman-targets/extension.rb in middleman-targets-1.0.8 vs lib/middleman-targets/extension.rb in middleman-targets-1.0.9
- old
+ new
@@ -22,13 +22,12 @@
# @!attribute [rw] config[:target]=
# Indicates the current target that is being built or served. When
# set in `config.rb` it indicates the default target if one is not
# specified on the command line.
- # @param [Symbol] value The target from `config[:targets]` that should
+ # @return [Symbol] The target from `config[:targets]` that should
# be used as the default.
- # @return [Symbol] Returns the current target.
# @note This is a Middleman application level config option.
# @!attribute [rw] config[:targets]=
# A hash that defines all of the characteristics of your individual targets.
@@ -59,35 +58,32 @@
# :insults_user => false,
# :grants_wishes => true,
# }
# },
# }
- # @param [Hash] value The complete definition of your targets, their
+ # @return [Hash] The complete definition of your targets, their
# features, and other keys-value pairs that you wish to include.
- # @return [Hash] Returns the attributes of your targets.
# @note This is a Middleman application level config option.
# @!attribute [rw] config[:target_magic_images]=
# This option is used to enable or disable the target magic images feature.
# If it's `true` then the `image_tag` helper will attempt to substitute
# target-specific images instead of the specified image, if the specified
# image begins with `:target_magic_word`.
- # @param [Boolean] value Specify whether or not automatic target-specific
+ # @return [Boolean] Specify whether or not automatic target-specific
# image substitution should be enabled.
- # @return [Boolean] Returns the current state of this option.
# @note This is a Middleman application level config option.
# @!attribute [rw] config[:target_magic_word]=
# Indicates the magic image prefix for image substitution with the
# `image_tag` helper when `:target_magic_images` is enabled. For example
# if you specify `all-image.png` and `pro-image.png` exists, then the
# latter will be used by the helper instead of the former.
- # @param [String] value Indicate the prefix that should indicate and image
- # the should be substituted, such as `all`.
- # @return [String] Returns the current magic prefix.
+ # @return [String] Indicate the prefix that should indicate an image
+ # that should be substituted, such as `all`.
# @note This is a Middleman application level config option.
# @!attribute [rw] config[:build_dir]=
# Indicates where **Middleman** will put build output. This standard config
@@ -95,13 +91,12 @@
# `:pro` and this value is set to its default `build`, then the actual build
# directory will be `build (pro)/`.
#
# If the `build_dir` key is present for any of the `config[:targets]`, they
# will override this setting.
- # @param [String] value Indicate the build directory prefix that should be
+ # @return [String] Indicate the build directory prefix that should be
# used for build output.
- # @return [String] Returns the current value of this configuration setting.
# @note This is a Middleman application level config option.
# @!endgroup
@@ -324,10 +319,10 @@
# tag will only be applied if the current target is
# `target`.
# @option params [String, Symbol] :feature This image
# tag will only be applied if the current target
# enables the feature `feature`.
- # @return [Void]
+ # @return [String] A properly formed image tag.
# @group Extended Helpers
#--------------------------------------------------------
def image_tag(path, params={})
params.symbolize_keys!