Haruka Yoshihara
null+****@clear*****
Thu Dec 6 16:24:49 JST 2012
Haruka Yoshihara 2012-12-06 16:24:49 +0900 (Thu, 06 Dec 2012) New Revision: 54dd57b1b1e46c2785a2506d5a8d18cebc8a0a4d https://github.com/groonga/groonga-command/commit/54dd57b1b1e46c2785a2506d5a8d18cebc8a0a4d Log: Document parser Modified files: lib/groonga/command/parser.rb Modified: lib/groonga/command/parser.rb (+14 -0) =================================================================== --- lib/groonga/command/parser.rb 2012-12-06 15:31:44 +0900 (b7ce248) +++ lib/groonga/command/parser.rb 2012-12-06 16:24:49 +0900 (a1240f9) @@ -72,6 +72,16 @@ module Groonga class Parser class << self + + # parses groonga command or HTTP (starts with "/d/") command. + # @overload parse(data) + # @!macro [new] parser.parse.argument + # @param [String] data parsed command. + # @return [Groonga::Command] Returns + # {Groonga::Command} including parsed data. + # @!macro parser.parse.argument + # @overload parse(data, &block) + # @!macro parser.parse.argument def parse(data, &block) if block_given? event_parse(data, &block) @@ -150,11 +160,15 @@ module Groonga initialize_hooks end + # Streaming parsing command. + # @param [String] chunk parsed chunk of command. def <<(chunk) @buffer << chunk consume_buffer end + # Finishes parsing. If Parser is loading values specified "load" + # command, this method raises {ParseError}. def finish if @loading raise ParseError.new("not completed", -------------- next part -------------- HTML����������������������������...Download