[Groonga-commit] ranguba/groonga-client at 4a88f62 [master] doc: put parameter name before parameter type

Back to archive index

Kouhei Sutou null+****@clear*****
Thu Apr 13 13:33:28 JST 2017


Kouhei Sutou	2017-04-13 13:33:28 +0900 (Thu, 13 Apr 2017)

  New Revision: 4a88f62256fa6350032114618e1c70dd754f08f1
  https://github.com/ranguba/groonga-client/commit/4a88f62256fa6350032114618e1c70dd754f08f1

  Message:
    doc: put parameter name before parameter type

  Modified files:
    lib/groonga/client.rb
    lib/groonga/client/request/select.rb
    lib/groonga/client/response/base.rb

  Modified: lib/groonga/client.rb (+2 -2)
===================================================================
--- lib/groonga/client.rb    2017-04-13 13:30:59 +0900 (d9c93d4)
+++ lib/groonga/client.rb    2017-04-13 13:33:28 +0900 (bcb5c98)
@@ -37,7 +37,7 @@ module Groonga
         @@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
@@ -46,7 +46,7 @@ module Groonga
       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

  Modified: lib/groonga/client/request/select.rb (+6 -6)
===================================================================
--- lib/groonga/client/request/select.rb    2017-04-13 13:30:59 +0900 (f9a53bd)
+++ lib/groonga/client/request/select.rb    2017-04-13 13:33:28 +0900 (47a69c7)
@@ -61,16 +61,16 @@ module Groonga
         #   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`.
         #
@@ -193,9 +193,9 @@ module Groonga
           #      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]

  Modified: lib/groonga/client/response/base.rb (+5 -3)
===================================================================
--- lib/groonga/client/response/base.rb    2017-04-13 13:30:59 +0900 (7d76351)
+++ lib/groonga/client/response/base.rb    2017-04-13 13:33:28 +0900 (fe1d7c4)
@@ -38,9 +38,11 @@ module Groonga
         # 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)
-------------- next part --------------
HTML����������������������������...
Download 



More information about the Groonga-commit mailing list
Back to archive index