Navigation Menu

Skip to content

Commit

Permalink
doc: put parameter name before parameter type
Browse files Browse the repository at this point in the history
  • Loading branch information
kou committed Apr 13, 2017
1 parent 9f32b9f commit 4a88f62
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 11 deletions.
4 changes: 2 additions & 2 deletions lib/groonga/client.rb
Expand Up @@ -37,7 +37,7 @@ def default_options
@@deafult_options
end

# @param [Hash] options The new default options for
# @param options [Hash] The new default options for
# {Groonga::Client.new}.
#
# @since 0.2.0
Expand All @@ -46,7 +46,7 @@ def default_options=(options)
end

# @!macro [new] initialize_options
# @param [Hash] options The options.
# @param options [Hash] The options.
# @option options [String, URI::Generic, URI::HTTP, URI::HTTPS]
# :url The URL of Groonga server.
# @option options [:gqtp, :http, :https] :protocol The
Expand Down
12 changes: 6 additions & 6 deletions lib/groonga/client/request/select.rb
Expand Up @@ -61,16 +61,16 @@ def query(value)
# The new request with the given condition.
#
# @overload filter(column_name, value)
# @param [String, Symbol] column_name The target column name.
# @param [Object] value The column value. It's escaped automatically.
# @param column_name [String, Symbol] The target column name.
# @param value [Object] The column value. It's escaped automatically.
#
# Adds a `#{column_name} == #{value}` condition.
#
# @overload filter(expression, values=nil)
# @param [String] expression The script syntax expression.
# @param expression [String] The script syntax expression.
# It can includes `%{name}`s as placeholder. They are expanded
# by `String#%` with the given `values` argument.
# @param [nil, ::Hash] values The values to be expanded.
# @param values [nil, ::Hash] The values to be expanded.
# If the given `expression` doesn't have placeholder, you
# should specify `nil`.
#
Expand Down Expand Up @@ -193,9 +193,9 @@ def initialize(request)
# filter.in_values("tags")
# # -> --filter ''
#
# @param [String, Symbol] column_name The target column name.
# @param column_name [String, Symbol] The target column name.
#
# @param [Object] values The column values that cover target
# @param values [Object] The column values that cover target
# column values.
#
# @return [Groonga::Client::Request::Select]
Expand Down
8 changes: 5 additions & 3 deletions lib/groonga/client/response/base.rb
Expand Up @@ -38,9 +38,11 @@ def find(name)
# Parses the response for the request of the command and returns
# response object.
#
# @param [Groonga::Command::Base] The command of the request.
# @param [String] The raw (not parsed) response returned by Groonga
# server.
# @param command [Groonga::Command::Base] The command of the request.
#
# @param raw_response [String] The raw (not parsed) response
# returned by Groonga server.
#
# @return [Base]
def parse(command, raw_response)
klass = find(command.command_name)
Expand Down

0 comments on commit 4a88f62

Please sign in to comment.