From 3de491981ad971c4d9d87dec260384fc5ac823f4 Mon Sep 17 00:00:00 2001 From: Ryunosuke SATO Date: Fri, 29 Mar 2013 03:15:33 +0900 Subject: [PATCH] Fix method comments `rake doc` shows some warnings. I fixed method comments to suppress it. --- middleman-core/lib/middleman-core/configuration.rb | 2 +- middleman-core/lib/middleman-core/sitemap/resource.rb | 2 +- middleman-core/lib/middleman-core/sitemap/store.rb | 2 -- middleman-core/lib/middleman-core/util.rb | 8 ++++---- .../lib/middleman-more/core_extensions/default_helpers.rb | 1 - 5 files changed, 6 insertions(+), 9 deletions(-) diff --git a/middleman-core/lib/middleman-core/configuration.rb b/middleman-core/lib/middleman-core/configuration.rb index 3dddef0d..7d8fc8db 100644 --- a/middleman-core/lib/middleman-core/configuration.rb +++ b/middleman-core/lib/middleman-core/configuration.rb @@ -19,7 +19,7 @@ module Middleman # @deprecated Prefer accessing settings through "config". # # @param [Symbol] key Name of the attribue - # @param value Attribute value + # @param default Attribute value # @return [void] def set(key, default=nil, &block) config.define_setting(key, default) diff --git a/middleman-core/lib/middleman-core/sitemap/resource.rb b/middleman-core/lib/middleman-core/sitemap/resource.rb index 50179b8c..ed213d12 100644 --- a/middleman-core/lib/middleman-core/sitemap/resource.rb +++ b/middleman-core/lib/middleman-core/sitemap/resource.rb @@ -143,7 +143,7 @@ module Middleman # Whether the source file is binary. # - # @retrun [Boolean] + # @return [Boolean] def binary? ::Middleman::Util.binary?(source_file) end diff --git a/middleman-core/lib/middleman-core/sitemap/store.rb b/middleman-core/lib/middleman-core/sitemap/store.rb index 5e3f3ea5..73902ecc 100644 --- a/middleman-core/lib/middleman-core/sitemap/store.rb +++ b/middleman-core/lib/middleman-core/sitemap/store.rb @@ -126,8 +126,6 @@ module Middleman # Register a handler to provide metadata on a url path # @param [Regexp] matcher - # @param [Symbol] origin an indicator of where this metadata came from - only one - # block per [matcher, origin] pair may exist. # @return [Array>] def provides_metadata_for_path(matcher=nil, &block) @_provides_metadata_for_path ||= [] diff --git a/middleman-core/lib/middleman-core/util.rb b/middleman-core/lib/middleman-core/util.rb index 4328341e..23d6f23e 100644 --- a/middleman-core/lib/middleman-core/util.rb +++ b/middleman-core/lib/middleman-core/util.rb @@ -27,12 +27,12 @@ module Middleman return false if Tilt.registered?(ext.sub('.','')) ext = ".#{ext}" unless ext.to_s[0] == ?. - mime = ::Rack::Mime.mime_type(ext, nil) + mime = ::Rack::Mime.mime_type(ext, nil) unless mime binary_bytes = [0, 1, 2, 3, 4, 5, 6, 11, 14, 15, 16, 17, 18, 19, 20, 21, 22, 23, 24, 25, 26, 28, 29, 30, 31] - s = File.read(filename, 4096) || '' + s = File.read(filename, 4096) || '' s.each_byte do |c| - return true if binary_bytes.include?(c) + return true if binary_bytes.include?(c) end return false end @@ -133,7 +133,7 @@ module Middleman # Get a recusive list of files inside a set of paths. # Works with symlinks. # - # @param path A path string or Pathname + # @param paths Some paths string or Pathname # @return [Array] An array of filenames def self.all_files_under(*paths) paths.flatten! diff --git a/middleman-more/lib/middleman-more/core_extensions/default_helpers.rb b/middleman-more/lib/middleman-more/core_extensions/default_helpers.rb index ffc5c4e6..50392538 100644 --- a/middleman-more/lib/middleman-more/core_extensions/default_helpers.rb +++ b/middleman-more/lib/middleman-more/core_extensions/default_helpers.rb @@ -50,7 +50,6 @@ module Middleman # Output a stylesheet link tag based on the current path # # @param [Symbol] asset_ext The type of asset - # @param [String] separator How to break up path in parts # @param [String] asset_dir Where to look for assets # @return [void] def auto_tag(asset_ext, asset_dir=nil)