deac/middleman
1
0
Fork 0
Code Issues Pull requests Releases Wiki Activity

Fix method comments

Browse source 
`rake doc` shows some warnings.
I fixed method comments to suppress it.
This commit is contained in:
Ryunosuke SATO 2013-03-29 03:15:33 +09:00
parent 92954a7c95
commit 3de491981a
5 changed files with 6 additions and 9 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

2
middleman-core/lib/middleman-core/configuration.rb
View file

@ -19,7 +19,7 @@ module Middleman
# @deprecated Prefer accessing settings through "config". # @deprecated Prefer accessing settings through "config".
# #
# @param [Symbol] key Name of the attribue # @param [Symbol] key Name of the attribue
# @param value Attribute value # @param default Attribute value
# @return [void] # @return [void]
def set(key, default=nil, &block) def set(key, default=nil, &block)
config.define_setting(key, default) config.define_setting(key, default)

2
middleman-core/lib/middleman-core/sitemap/resource.rb
View file

@ -143,7 +143,7 @@ module Middleman
# Whether the source file is binary. # Whether the source file is binary.
# #
# @retrun [Boolean] # @return [Boolean]
def binary? def binary?
::Middleman::Util.binary?(source_file) ::Middleman::Util.binary?(source_file)
end end

2
middleman-core/lib/middleman-core/sitemap/store.rb
View file

@ -126,8 +126,6 @@ module Middleman
# Register a handler to provide metadata on a url path # Register a handler to provide metadata on a url path
# @param [Regexp] matcher # @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<Array<Proc, Regexp>>] # @return [Array<Array<Proc, Regexp>>]
def provides_metadata_for_path(matcher=nil, &block) def provides_metadata_for_path(matcher=nil, &block)
@_provides_metadata_for_path ||= [] @_provides_metadata_for_path ||= []

8
middleman-core/lib/middleman-core/util.rb
View file

@ -27,12 +27,12 @@ module Middleman
return false if Tilt.registered?(ext.sub('.','')) return false if Tilt.registered?(ext.sub('.',''))
ext = ".#{ext}" unless ext.to_s[0] == ?. ext = ".#{ext}" unless ext.to_s[0] == ?.
mime = ::Rack::Mime.mime_type(ext, nil) mime = ::Rack::Mime.mime_type(ext, nil)
unless mime 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] 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| s.each_byte do |c|
return true if binary_bytes.include?(c) return true if binary_bytes.include?(c)
end end
return false return false
end end
@ -133,7 +133,7 @@ module Middleman
# Get a recusive list of files inside a set of paths. # Get a recusive list of files inside a set of paths.
# Works with symlinks. # Works with symlinks.
# #
# @param path A path string or Pathname # @param paths Some paths string or Pathname
# @return [Array] An array of filenames # @return [Array] An array of filenames
def self.all_files_under(*paths) def self.all_files_under(*paths)
paths.flatten! paths.flatten!

1
middleman-more/lib/middleman-more/core_extensions/default_helpers.rb
View file

@ -50,7 +50,6 @@ module Middleman
# Output a stylesheet link tag based on the current path # Output a stylesheet link tag based on the current path
# #
# @param [Symbol] asset_ext The type of asset # @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 # @param [String] asset_dir Where to look for assets
# @return [void] # @return [void]
def auto_tag(asset_ext, asset_dir=nil) def auto_tag(asset_ext, asset_dir=nil)