[Groonga-commit] groonga/groonga-command at 45153f8 [master] tokenize: document

Back to archive index

Kouhei Sutou null+****@clear*****
Mon Oct 14 21:10:41 JST 2013


Kouhei Sutou	2013-10-14 21:10:41 +0900 (Mon, 14 Oct 2013)

  New Revision: 45153f855e51fb3ee5aea9090cc540bae0ab4f65
  https://github.com/groonga/groonga-command/commit/45153f855e51fb3ee5aea9090cc540bae0ab4f65

  Message:
    tokenize: document

  Modified files:
    lib/groonga/command/tokenize.rb

  Modified: lib/groonga/command/tokenize.rb (+15 -0)
===================================================================
--- lib/groonga/command/tokenize.rb    2013-10-14 21:08:11 +0900 (9d10901)
+++ lib/groonga/command/tokenize.rb    2013-10-14 21:10:41 +0900 (cf87889)
@@ -20,6 +20,9 @@ require "groonga/command/base"
 
 module Groonga
   module Command
+    # A command class that represents `tokenize` command.
+    #
+    # @since 1.0.6
     class Tokenize < Base
       Command.register("tokenize", self)
 
@@ -34,18 +37,30 @@ module Groonga
         end
       end
 
+      # @return [String] `tokenizer` parameter value.
+      # @since 1.0.6
       def tokenizer
         self[:tokenizer]
       end
 
+      # @return [String] `string` parameter value.
+      # @since 1.0.6
       def string
         self[:string]
       end
 
+      # @return [String] `normalizer` parameter value.
+      # @since 1.0.6
       def normalizer
         self[:normalizer]
       end
 
+      # @return [Array<String>] An array of flags specified in `flags`
+      #   parameter value. This array is extracted by parsing `flags`
+      #   parameter value. If `flags` parameter value is nil or empty,
+      #   an empty array is returned.
+      #
+      # @since 1.0.6
       def flags
         @flags ||= (self[:flags] || "").split(/\s*[| ]\s*/)
       end
-------------- next part --------------
HTML����������������������������...
Download 



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