rroonga 2.0.4 → 2.0.5

data/ext/groonga/rb-grn-index-column.c

@@ -96,39 +96,12 @@ rb_grn_index_column_deconstruct (RbGrnIndexColumn *rb_grn_index_column,
 }
 
 /*
- * call-seq:
- *   column[id] = value
- *   column[id] = options
- *
  * IDが _id_ であるレコードを高速に全文検索するため転置索引を作
  * 成する。多くの場合、Groonga::Table#define_index_columnで
  * +:source+ オプションを指定することにより、自動的に全文検索
  * 用の索引は更新されるので、明示的にこのメソッドを使うこと
  * は少ない。
  *
- * _value_ には文字列を指定する。
- *
- * _options_ を指定することにより、より索引の作成を制御できる。
- * @param [::Hash] options  The name and value
- *   pairs. Omitted names are initialized as the default value
- * @option options :section The section
- *
- *   段落番号を指定する。省略した場合は1を指定したとみなされ
- *   る。
- *   Groonga::Table#define_index_columnで
- *   <tt>{:with_section => true}</tt>を指定していなければい
- *   けない。
- *
- * @option options :old_value The old_value
- *
- *   以前の値を指定する。省略した場合は現在の値が用いられる。
- *   通常は指定する必要はない。
- *
- * @option options :value The value
- *   新しい値を指定する。 _value_ を指定した場合と _options_ で
- *   <tt>{:value => value}</tt>を指定した場合は同じ動作とな
- *   る。
- *
  * @example 記事の段落毎に索引を作成する。
  *   articles = Groonga::Array.create(:name => "<articles>")
  *   articles.define_column("title", "ShortText")
@@ -163,6 +136,27 @@ rb_grn_index_column_deconstruct (RbGrnIndexColumn *rb_grn_index_column,
  *   content_index.search("エンジン").collect do |record|
  *     p record.key["title"] # -> "groonga"
  *   end
+ *
+ * @overload []=(id, value)
+ *   @param [String] value 新しい値
+ * @overload []=(id, options)
+ *   _options_ を指定することにより、 _value_ を指定したときよりも索引の作
+ *   成を制御できる。
+ *   @param [::Hash] options The name and value
+ *     pairs. Omitted names are initialized as the default value
+ *   @option options :section
+ *     段落番号を指定する。省略した場合は1を指定したとみなされ
+ *     る。
+ *     Groonga::Table#define_index_columnで
+ *     <tt>{:with_section => true}</tt>を指定していなければい
+ *     けない。
+ *   @option options :old_value
+ *     以前の値を指定する。省略した場合は現在の値が用いられる。
+ *     通常は指定する必要はない。
+ *   @option options :value
+ *     新しい値を指定する。 _value_ を指定した場合と _options_ で
+ *     <tt>{:value => value}</tt>を指定した場合は同じ動作とな
+ *     る。
  */
 static VALUE
 rb_grn_index_column_array_set (VALUE self, VALUE rb_id, VALUE rb_value)
@@ -226,10 +220,11 @@ rb_grn_index_column_array_set (VALUE self, VALUE rb_id, VALUE rb_value)
 }
 
 /*
- * call-seq:
- *   column.sources -> Groonga::Columnの配列
- *
  * インデックス対象となっているカラムの配列を返す。
+ *
+ * @overload sources
+ * @return [::Array<Groonga::Column>] インデックス対象となっている
+ *   {Groonga::Column}の配列
  */
 static VALUE
 rb_grn_index_column_get_sources (VALUE self)
@@ -240,6 +235,7 @@ rb_grn_index_column_get_sources (VALUE self)
     grn_id *source_ids;
     VALUE rb_sources;
     int i, n;
+    VALUE exception;
 
     rb_grn_index_column_deconstruct(SELF(self), &column, &context,
 				    NULL, NULL,
@@ -258,6 +254,12 @@ rb_grn_index_column_get_sources (VALUE self)
 	VALUE rb_source;
 
 	source = grn_ctx_at(context, *source_ids);
+	exception = rb_grn_context_to_exception(context, self);
+	if (!NIL_P(exception)) {
+	    grn_obj_unlink(context, &sources);
+	    rb_exc_raise(exception);
+	}
+
 	rb_source = GRNOBJECT2RVAL(Qnil, context, source, GRN_FALSE);
 	rb_ary_push(rb_sources, rb_source);
 	source_ids++;
@@ -333,10 +335,10 @@ resolve_source_id (grn_ctx *context, grn_obj *column, grn_id range_id,
 }
 
 /*
- * call-seq:
- *   column.sources = Groonga::Columnの配列
- *
  * インデックス対象となる複数のカラムを配列で設定する。
+ *
+ * @overload sources=(columns)
+ *   @param [::Array<Groonga::Column>] columns インデックス対象となるカラムの配列
  */
 static VALUE
 rb_grn_index_column_set_sources (VALUE self, VALUE rb_sources)
@@ -381,10 +383,10 @@ rb_grn_index_column_set_sources (VALUE self, VALUE rb_sources)
 }
 
 /*
- * call-seq:
- *   column.source = Groonga::Column
- *
  * インデックス対象となるカラムを設定する。
+ *
+ * @overload source=(column)
+ *   @param [Groonga::Column] column インデックス対象とするカラム
  */
 static VALUE
 rb_grn_index_column_set_source (VALUE self, VALUE rb_source)
@@ -396,43 +398,37 @@ rb_grn_index_column_set_source (VALUE self, VALUE rb_source)
 }
 
 /*
- * Document-method: search
- *
- * call-seq:
- *   column.search(query, options={}) -> Groonga::Hash
- *
  * _object_ から _query_ に対応するオブジェクトを検索し、見つかっ
  * たオブジェクトのIDがキーになっているGroonga::Hashを返す。
  *
- * 利用可能なオプションは以下の通り。
- * @param [::Hash] options The name and value
- *   pairs. Omitted names are initialized as the default value
- * @option options [Groonga::Hash] :result The result
- *   結果を格納するGroonga::Hash。指定しない場合は新しく
- *   Groonga::Hashを生成し、それに結果を格納して返す。
- * @option options :operator The operator
- *
- *   以下のどれかの値を指定する。 +nil+ , <tt>"or"</tt>, <tt>"||"</tt>,
- *   <tt>"and"</tt>, <tt>"+"</tt>, <tt>"&&"</tt>, <tt>"but"</tt>,
- *   <tt>"not"</tt>, <tt>"-"</tt>, <tt>"adjust"</tt>, <tt>">"</tt>。
- *   それぞれ以下のようになる。（FIXME: 「以下」）
- * @option options :exact The exact
- *
- *   +true+ を指定すると完全一致で検索する
- * @option options :longest_common_prefix The longest_common_prefix
- *   +true+ を指定すると _query_ と同じ接頭辞をもつエントリのう
- *   ち、もっとも長いエントリを検索する
- * @option options :suffix The suffix
- *   +true+ を指定すると _query_ が後方一致するエントリを検索す
- *   る
- * @option options :prefix The prefix
- *   +true+ を指定すると _query_ が前方一致するレコードを検索す
- *   る
- * @option options :near The near
- *   +true+ を指定すると _query_ に指定した複数の語が近傍に含ま
- *   れるレコードを検索する
- * [...]
- *   ...
+ * @overload search(query, options={})
+ *   @param [::Hash] options The name and value
+ *     pairs. Omitted names are initialized as the default value
+ *   @option options [Groonga::Hash] :result
+ *     結果を格納するGroonga::Hash。指定しない場合は新しく
+ *     Groonga::Hashを生成し、それに結果を格納して返す。
+ *   @option options :operator
+ *     以下のどれかの値を指定する。 +nil+ , <tt>"or"</tt>, <tt>"||"</tt>,
+ *     <tt>"and"</tt>, <tt>"+"</tt>, <tt>"&&"</tt>, <tt>"but"</tt>,
+ *     <tt>"not"</tt>, <tt>"-"</tt>, <tt>"adjust"</tt>, <tt>">"</tt>。
+ *     それぞれ以下のようになる。（FIXME: 「以下」）
+ *   @option options :exact
+ *     +true+ を指定すると完全一致で検索する
+ *   @option options :longest_common_prefix
+ *     +true+ を指定すると _query_ と同じ接頭辞をもつエントリのう
+ *     ち、もっとも長いエントリを検索する
+ *   @option options :suffix
+ *     +true+ を指定すると _query_ が後方一致するエントリを検索す
+ *     る
+ *   @option options :prefix
+ *     +true+ を指定すると _query_ が前方一致するレコードを検索す
+ *     る
+ *   @option options :near
+ *     +true+ を指定すると _query_ に指定した複数の語が近傍に含ま
+ *     れるレコードを検索する
+ *   [...]
+ *     ...
+ * @return [Groonga::Hash]
  */
 static VALUE
 rb_grn_index_column_search (int argc, VALUE *argv, VALUE self)

data/ext/groonga/rb-grn-index-cursor.c

@@ -1,6 +1,7 @@
 /* -*- coding: utf-8; c-file-style: "ruby" -*- */
 /*
   Copyright (C) 2011  Haruka Yoshihara <yoshihara@clear-code.com>
+  Copyright (C) 2012  Kouhei Sutou <kou@clear-code.com>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
@@ -78,6 +79,8 @@ rb_grn_index_cursor_each (VALUE self)
     grn_obj *cursor;
     grn_ctx *context;
 
+    RETURN_ENUMERATOR(self, 0, NULL);
+
     rb_grn_index_cursor_deconstruct(SELF(self), &cursor, &context,
 				    NULL, NULL, NULL, NULL);
 

data/ext/groonga/rb-grn-logger.c

@@ -249,50 +249,34 @@ rb_grn_logger_initialize (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   Groonga::Logger.register(options={})
-       {|level, time, title, message, location| ...}
- *
- * groongaがログを出力する度に呼び出されるブロックを登録す
- * る。
- *
- * ブロックに渡されてくる引数は _level_ ,  _time_ ,  _title_ ,
- * _message_ ,  _location_ の5つで、 _level_ はSymbol、それ以外は
- * 全て文字列で渡される。その4つについては _options_ で +false+
- * を指定することでブロックに渡さないようにすることができ、
- * その場合は空文字列が実際には渡される。
- *
- * _options_ に指定可能な値は以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :level (:notice) The log level
- *
- *   ログのレベルを +:none+ ,  +:emergency+ ,  +:alert+ ,
- *   +:critical+ , +:error+ , +:warning+ , +:notice+ , +:info+ ,
- *   +:debug+ ,  +:dump+ のいずれかで指定する。それより重要度が
- *   低いログはブロックに渡されなくなる。デフォルトでは
- *   +:notice+ 。
- *
- * @option options :time
- *
- *   ログが出力された時間をブロックに渡したいなら +true+ を指
- *   定する。デフォルトでは渡す。
+ * groongaがログを出力する度に呼び出されるブロックを登録する。
  *
- * @option options :title The title
- *
- *   ログのタイトルをブロックに渡したいなら +true+ を指定す
- *   る。デフォルトでは渡す。(FIXME: groongaで実装されてい
- *   ない?)
- *
- * @option options :message The message
- *   ログのメッセージをブロックに渡したいなら +true+ を指定す
- *   る。デフォルトでは渡す。
- *
- * @option options :location The location
- *
- *   ログの発生元のプロセスIDとgroongaのソースコードのファイ
- *   ル名、行番号、関数名をブロックに渡したいなら +true+ を指
- *   定する。デフォルトでは渡す。
+ * @overload register(options={})
+ *   @yield [level, time, title, message, location]
+ *     _level_ はSymbol、それ以外は全て文字列で渡される。 _level_ 以外
+ *     の4つについては _options_ で +false+ を指定することでブロックに
+ *     渡さないようにすることができ、その場合は空文字列が実際には渡される。
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :level (:notice)
+ *     ログのレベルを +:none+ ,  +:emergency+ ,  +:alert+ ,
+ *     +:critical+ , +:error+ , +:warning+ , +:notice+ , +:info+ ,
+ *     +:debug+ ,  +:dump+ のいずれかで指定する。それより重要度が
+ *     低いログはブロックに渡されなくなる。デフォルトでは +:notice+ 。
+ *   @option options :time
+ *     ログが出力された時間をブロックに渡したいなら +true+ を指
+ *     定する。デフォルトでは渡す。
+ *   @option options :title
+ *     ログのタイトルをブロックに渡したいなら +true+ を指定す
+ *     る。デフォルトでは渡す。
+ *     (FIXME: groongaで実装されていない?)
+ *   @option options :message
+ *     ログのメッセージをブロックに渡したいなら +true+ を指定す
+ *     る。デフォルトでは渡す。
+ *   @option options :location
+ *     ログの発生元のプロセスIDとgroongaのソースコードのファイ
+ *     ル名、行番号、関数名をブロックに渡したいなら +true+ を指
+ *     定する。デフォルトでは渡す。
  */
 static VALUE
 rb_grn_logger_s_register (int argc, VALUE *argv, VALUE klass)
@@ -396,11 +380,10 @@ rb_grn_logger_s_set_path (VALUE klass, VALUE rb_path,
 #endif
 
 /*
- * call-seq:
- *   Groonga::Logger.log_path # => path
+ * groongaのデフォルトロガーがログを出力するファイルのパスを返す。
  *
- * groongaのデフォルトロガーがログを出力するファイルの
- * パスを返す。
+ * @overload log_path
+ * @return [String] path ログを出力するファイルのパス
  */
 static VALUE
 rb_grn_logger_s_get_log_path (VALUE klass)
@@ -439,11 +422,10 @@ rb_grn_logger_s_set_log_path (VALUE klass, VALUE path)
 }
 
 /*
- * call-seq:
- *   Groonga::Logger.query_log_path # => path
+ * groongaのデフォルトロガーがクエリログを出力するファイルのパスを返す。
  *
- * groongaのデフォルトロガーがクエリログを出力するファイルの
- * パスを返す。
+ * @overload query_log_path
+ * @return [String] path ログを出力するファイルのパス
  */
 static VALUE
 rb_grn_logger_s_get_query_log_path (VALUE klass)

data/ext/groonga/rb-grn-object.c

@@ -49,6 +49,7 @@ rb_grn_object_from_ruby_object (VALUE object, grn_ctx **context)
 	    grn_object = rb_grn_context_get_backward_compatibility(*context,
 								   name,
 								   name_size);
+	    rb_grn_context_check(*context, object);
 	    if (!grn_object)
 		rb_raise(rb_eArgError,
 			 "unregistered groonga object: name: <%s>",
@@ -56,6 +57,7 @@ rb_grn_object_from_ruby_object (VALUE object, grn_ctx **context)
 	    return grn_object;
 	} else if (RVAL2CBOOL(rb_obj_is_kind_of(object, rb_cInteger))) {
 	    grn_object = grn_ctx_at(*context, NUM2UINT(object));
+	    rb_grn_context_check(*context, object);
 	    if (!grn_object)
 		rb_raise(rb_eArgError,
 			 "unregistered groonga object: ID: <%s>",

data/ext/groonga/rb-grn-operator.c

@@ -54,7 +54,7 @@ void
 rb_grn_init_operator (VALUE mGrn)
 {
     rb_mGrnOperator = rb_define_module_under(mGrn, "Operator");
-    /* deprecated: backward compatibility. */
+    /* @deprecated backward compatibility. */
     rb_define_const(mGrn, "Operation", rb_mGrnOperator);
 
     rb_define_const(rb_mGrnOperator, "PUSH",

data/ext/groonga/rb-grn-patricia-trie.c

@@ -35,91 +35,10 @@ VALUE rb_cGrnPatriciaTrie;
  */
 
 /*
- * call-seq:
- *   Groonga::PatriciaTrie.create(options={}) -> Groonga::PatriciaTrie
- *   Groonga::PatriciaTrie.create(options={}) {|table| ... }
- *
  * 各レコードをパトリシアトライで管理するテーブルを生成する。
  * ブロックを指定すると、そのブロックに生成したテーブルが渡さ
  * れ、ブロックを抜けると自動的にテーブルが破棄される。
  *
- * _options_ に指定可能な値は以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options [Groonga::Context] :context (Groonga::Context.default)
- *
- *   テーブルが利用するGroonga::Context。
- *
- * @option options :name The table name
- *
- *   テーブルの名前。名前をつけると、Groonga::Context#[]に名
- *   前を指定してテーブルを取得することができる。省略すると
- *   無名テーブルになり、テーブルIDでのみ取得できる。
- *
- * @option options :path The path
- *
- *   テーブルを保存するパス。パスを指定すると永続テーブルとな
- *   り、プロセス終了後もレコードは保持される。次回起動時に
- *   Groonga::Context#[]で保存されたレコードを利用する
- *   ことができる。省略すると一時テーブルになり、プロセスが終
- *   了するとレコードは破棄される。
- *
- * @option options :persistent The persistent
- *
- *   +true+ を指定すると永続テーブルとなる。 +path+ を省略した
- *   場合は自動的にパスが付加される。 +:context+ で指定した
- *   Groonga::Contextに結びついているデータベースが一時デー
- *   タベースの場合は例外が発生する。
- *
- * @option options :key_normalize The key_normalize
- *
- *   +true+ を指定するとキーを正規化する。
- *
- * @option options :key_with_sis The key_with_sis
- *
- *   +true+ を指定するとキーの文字列の全suffixが自動的に登
- *   録される。
- *
- * @option options :key_type The key_type
- *
- *   キーの種類を示すオブジェクトを指定する。キーの種類には型
- *   名（"Int32"や"ShortText"など）またはGroonga::Typeまたは
- *   テーブル（Groonga::Array、Groonga::Hash、
- *   Groonga::PatriciaTrieのどれか）を指定する。
- *
- *   Groonga::Typeを指定した場合は、その型が示す範囲の値をキー
- *   として使用する。ただし、キーの最大サイズは4096バイトで
- *   あるため、Groonga::Type::TEXTやGroonga::Type::LONG_TEXT
- *   は使用できない。
- *
- *   テーブルを指定した場合はレコードIDをキーとして使用する。
- *   指定したテーブルのGroonga::Recordをキーとして使用するこ
- *   ともでき、その場合は自動的にGroonga::Recordからレコード
- *   IDを取得する。
- *
- *   省略した場合はShortText型をキーとして使用する。この場合、
- *   4096バイトまで使用可能である。
- *
- * @option options :value_type The value_type
- *
- *   値の型を指定する。省略すると値のための領域を確保しない。
- *   値を保存したい場合は必ず指定すること。
- *
- *   参考: Groonga::Type.new
- *
- * @option options :default_tokenizer The default_tokenizer
- *
- *   Groonga::IndexColumnで使用するトークナイザを指定する。
- *   デフォルトでは何も設定されていないので、テーブルに
- *   Groonga::IndexColumnを定義する場合は
- *   <tt>"TokenBigram"</tt>などを指定する必要がある。
- *
- * @option options :sub_records The sub_records
- *
- *   +true+ を指定すると#groupでグループ化したときに、
- *   Groonga::Record#n_sub_recordsでグループに含まれるレコー
- *   ドの件数を取得できる。
- *
  * @example
  *   #無名一時テーブルを生成する。
  *   Groonga::PatriciaTrie.create
@@ -162,6 +81,123 @@ VALUE rb_cGrnPatriciaTrie;
  *                                        :default_tokenizer => "TokenBigram")
  *   terms.define_index_column("content", bookmarks,
  *                             :source => "Bookmarks.comment")
+ *
+ * @overload create(options={})
+ *   @return [Groonga::PatriciaTrie]
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options [Groonga::Context] :context (Groonga::Context.default)
+ *     テーブルが利用するGroonga::Context。
+ *   @option options :name
+ *     テーブルの名前。名前をつけると、Groonga::Context#[]に名
+ *     前を指定してテーブルを取得することができる。省略すると
+ *     無名テーブルになり、テーブルIDでのみ取得できる。
+ *   @option options :path
+ *     テーブルを保存するパス。パスを指定すると永続テーブルとな
+ *     り、プロセス終了後もレコードは保持される。次回起動時に
+ *     Groonga::Context#[]で保存されたレコードを利用する
+ *     ことができる。省略すると一時テーブルになり、プロセスが終
+ *     了するとレコードは破棄される。
+ *   @option options :persistent
+ *     +true+ を指定すると永続テーブルとなる。 +path+ を省略した
+ *     場合は自動的にパスが付加される。 +:context+ で指定した
+ *     Groonga::Contextに結びついているデータベースが一時デー
+ *     タベースの場合は例外が発生する。
+ *   @option options :key_normalize
+ *     +true+ を指定するとキーを正規化する。
+ *   @option options :key_with_sis
+ *     +true+ を指定するとキーの文字列の全suffixが自動的に登
+ *     録される。
+ *   @option options :key_type
+ *     キーの種類を示すオブジェクトを指定する。キーの種類には型
+ *     名（"Int32"や"ShortText"など）またはGroonga::Typeまたは
+ *     テーブル（Groonga::Array、Groonga::Hash、
+ *     Groonga::PatriciaTrieのどれか）を指定する。
+ *
+ *     Groonga::Typeを指定した場合は、その型が示す範囲の値をキー
+ *     として使用する。ただし、キーの最大サイズは4096バイトで
+ *     あるため、Groonga::Type::TEXTやGroonga::Type::LONG_TEXT
+ *     は使用できない。
+ *
+ *     テーブルを指定した場合はレコードIDをキーとして使用する。
+ *     指定したテーブルのGroonga::Recordをキーとして使用するこ
+ *     ともでき、その場合は自動的にGroonga::Recordからレコード
+ *     IDを取得する。
+ *
+ *     省略した場合はShortText型をキーとして使用する。この場合、
+ *     4096バイトまで使用可能である。
+ *   @option options :value_type
+ *     値の型を指定する。省略すると値のための領域を確保しない。
+ *     値を保存したい場合は必ず指定すること。
+ *
+ *     参考: Groonga::Type.new
+ *   @option options :default_tokenizer
+ *     Groonga::IndexColumnで使用するトークナイザを指定する。
+ *     デフォルトでは何も設定されていないので、テーブルに
+ *     Groonga::IndexColumnを定義する場合は
+ *     <tt>"TokenBigram"</tt>などを指定する必要がある。
+ *   @option options :sub_records
+ *     +true+ を指定すると#groupでグループ化したときに、
+ *     Groonga::Record#n_sub_recordsでグループに含まれるレコー
+ *     ドの件数を取得できる。
+ * @overload create(options={})
+ *   @yield [table]
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options [Groonga::Context] :context (Groonga::Context.default)
+ *     テーブルが利用するGroonga::Context。
+ *   @option options :name
+ *     テーブルの名前。名前をつけると、Groonga::Context#[]に名
+ *     前を指定してテーブルを取得することができる。省略すると
+ *     無名テーブルになり、テーブルIDでのみ取得できる。
+ *   @option options :path
+ *     テーブルを保存するパス。パスを指定すると永続テーブルとな
+ *     り、プロセス終了後もレコードは保持される。次回起動時に
+ *     Groonga::Context#[]で保存されたレコードを利用する
+ *     ことができる。省略すると一時テーブルになり、プロセスが終
+ *     了するとレコードは破棄される。
+ *   @option options :persistent
+ *     +true+ を指定すると永続テーブルとなる。 +path+ を省略した
+ *     場合は自動的にパスが付加される。 +:context+ で指定した
+ *     Groonga::Contextに結びついているデータベースが一時デー
+ *     タベースの場合は例外が発生する。
+ *   @option options :key_normalize
+ *     +true+ を指定するとキーを正規化する。
+ *   @option options :key_with_sis
+ *     +true+ を指定するとキーの文字列の全suffixが自動的に登
+ *     録される。
+ *   @option options :key_type
+ *     キーの種類を示すオブジェクトを指定する。キーの種類には型
+ *     名（"Int32"や"ShortText"など）またはGroonga::Typeまたは
+ *     テーブル（Groonga::Array、Groonga::Hash、
+ *     Groonga::PatriciaTrieのどれか）を指定する。
+ *
+ *     Groonga::Typeを指定した場合は、その型が示す範囲の値をキー
+ *     として使用する。ただし、キーの最大サイズは4096バイトで
+ *     あるため、Groonga::Type::TEXTやGroonga::Type::LONG_TEXT
+ *     は使用できない。
+ *
+ *     テーブルを指定した場合はレコードIDをキーとして使用する。
+ *     指定したテーブルのGroonga::Recordをキーとして使用するこ
+ *     ともでき、その場合は自動的にGroonga::Recordからレコード
+ *     IDを取得する。
+ *
+ *     省略した場合はShortText型をキーとして使用する。この場合、
+ *     4096バイトまで使用可能である。
+ *   @option options :value_type
+ *     値の型を指定する。省略すると値のための領域を確保しない。
+ *     値を保存したい場合は必ず指定すること。
+ *
+ *     参考: Groonga::Type.new
+ *   @option options :default_tokenizer
+ *     Groonga::IndexColumnで使用するトークナイザを指定する。
+ *     デフォルトでは何も設定されていないので、テーブルに
+ *     Groonga::IndexColumnを定義する場合は
+ *     <tt>"TokenBigram"</tt>などを指定する必要がある。
+ *   @option options :sub_records
+ *     +true+ を指定すると#groupでグループ化したときに、
+ *     Groonga::Record#n_sub_recordsでグループに含まれるレコー
+ *     ドの件数を取得できる。
  */
 static VALUE
 rb_grn_patricia_trie_s_create (int argc, VALUE *argv, VALUE klass)
@@ -243,43 +279,14 @@ rb_grn_patricia_trie_s_create (int argc, VALUE *argv, VALUE klass)
 }
 
 /*
- * call-seq:
- *   patricia_trie.search(key, options=nil) -> Groonga::Hash
- *
- * _key_ にマッチするレコードのIDがキーに入っている
- * Groonga::Hashを返す。マッチするレコードがない場合は空の
- * Groonga::Hashが返る。
+ * _key_ にマッチするレコードのIDがキーに入っているGroonga::Hashを返す。
+ * マッチするレコードがない場合は空のGroonga::Hashが返る。
  *
- * _options_ で +:result+ を指定することにより、そのテーブルにマッ
- * チしたレコードIDがキーのレコードを追加することができる。
+ * _options_ で +:result+ を指定することにより、そのテーブルにマッチした
+ * レコードIDがキーのレコードを追加することができる。
  * +:result+ にテーブルを指定した場合は、そのテーブルが返る。
  *
- * _options_ に指定可能な値は以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :result The result
- *
- *   結果を格納するテーブル。
- * @option options :operator (Groonga::Operator::OR)
- *
- *   マッチしたレコードをどのように扱うか。指定可能な値は以
- *   下の通り。
- *
- *   [Groonga::Operator::OR]
- *     マッチしたレコードを追加。すでにレコードが追加され
- *     ている場合は何もしない。
- *   [Groonga::Operator::AND]
- *     マッチしたレコードのスコアを増加。マッチしなかった
- *     レコードを削除。
- *   [Groonga::Operator::BUT]
- *     マッチしたレコードを削除。
- *   [Groonga::Operator::ADJUST]
- *     マッチしたレコードのスコアを増加。
- *
- * [+:type+]
- *   ?????
- *
- * 複数のキーで検索し、結果を1つのテーブルに集める。
+ * @example 複数のキーで検索し、結果を1つのテーブルに集める。
  *   result = nil
  *   keys = ["morita", "gunyara-kun", "yu"]
  *   keys.each do |key|
@@ -289,6 +296,30 @@ rb_grn_patricia_trie_s_create (int argc, VALUE *argv, VALUE klass)
  *     user = record.key
  *     p user.key # -> "morita"または"gunyara-kun"または"yu"
  *   end
+ *
+ * @overload search(key, options=nil)
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :result
+ *     結果を格納するテーブル。
+ *   @option options :operator (Groonga::Operator::OR)
+ *     マッチしたレコードをどのように扱うか。指定可能な値は以
+ *     下の通り。
+ *
+ *     [Groonga::Operator::OR]
+ *       マッチしたレコードを追加。すでにレコードが追加され
+ *       ている場合は何もしない。
+ *     [Groonga::Operator::AND]
+ *       マッチしたレコードのスコアを増加。マッチしなかった
+ *       レコードを削除。
+ *     [Groonga::Operator::BUT]
+ *       マッチしたレコードを削除。
+ *     [Groonga::Operator::ADJUST]
+ *       マッチしたレコードのスコアを増加。
+ *
+ *   [+:type+]
+ *     ?????
+ * @return [Groonga::Hash]
  */
 static VALUE
 rb_grn_patricia_trie_search (int argc, VALUE *argv, VALUE self)
@@ -598,57 +629,68 @@ rb_grn_patricia_trie_open_grn_prefix_cursor (int argc, VALUE *argv, VALUE self,
 
 
 /*
- * call-seq:
- *   table.open_prefix_cursor(prefix, options={}) -> Groonga::PatriciaTrieCursor
- *   table.open_prefix_cursor(prefix, options={}) {|cursor| ... }
- *
  * _prefix_ に前方一致検索をするカーソルを生成して返す。ブロッ
  * クを指定すると、そのブロックに生成したカーソルが渡され、ブ
  * ロックを抜けると自動的にカーソルが破棄される。
  *
- * _options_ に指定可能な値は以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :key_bytes The key_bytes
- *
- *  _prefix_ のサイズ（byte）
- *
- * @option options :key_bits The key_bits
- *
- *  _prefix_ のサイズ（bit）
- *
- * @option options :offset The offset
- *
- *   該当する範囲のレコードのうち、(0ベースで) _:offset_ 番目
- *   からレコードを取り出す。
- *
- * @option options :limit The limit
- *
- *   該当する範囲のレコードのうち、 _:limit_ 件のみを取り出す。
- *   省略された場合または-1が指定された場合は、全件が指定され
- *   たものとみなす。
- *
- * @option options :order The order
- *
- *   +:asc+ または +:ascending+ を指定すると昇順にレコードを取
- *   り出す。
- *   +:desc+ または +:descending+ を指定すると降順にレコードを
- *   取り出す。
- *
- * @option options :order_by (:id) The order_by
- *
- *   +:id+ を指定するとID順にレコードを取り出す。（デフォルト）
- *   +:key+指定するとキー順にレコードを取り出す。
- *
- * @option options :greater_than The greater_than
- *
- *   +true+ を指定すると _prefix_ で指定した値に一致した [ +key+ ] を
- *   範囲に含まない。
- *
- * @option options :less_than The less_than
- *
- *   +true+ を指定すると _prefix_ で指定した値に一致した [ +key+ ] を
- *   範囲に含まない。
+ * @overload open_prefix_cursor(prefix, options={})
+ *   @return [Groonga::PatriciaTrieCursor]
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :key_bytes
+ *    _prefix_ のサイズ（byte）
+ *   @option options :key_bits
+ *    _prefix_ のサイズ（bit）
+ *   @option options :offset
+ *     該当する範囲のレコードのうち、(0ベースで) _:offset_ 番目
+ *     からレコードを取り出す。
+ *   @option options :limit
+ *     該当する範囲のレコードのうち、 _:limit_ 件のみを取り出す。
+ *     省略された場合または-1が指定された場合は、全件が指定され
+ *     たものとみなす。
+ *   @option options :order
+ *     +:asc+ または +:ascending+ を指定すると昇順にレコードを取
+ *     り出す。
+ *     +:desc+ または +:descending+ を指定すると降順にレコードを
+ *     取り出す。
+ *   @option options :order_by (:id)
+ *     +:id+ を指定するとID順にレコードを取り出す。（デフォルト）
+ *     +:key+指定するとキー順にレコードを取り出す。
+ *   @option options :greater_than
+ *     +true+ を指定すると _prefix_ で指定した値に一致した [ +key+ ] を
+ *     範囲に含まない。
+ *   @option options :less_than
+ *     +true+ を指定すると _prefix_ で指定した値に一致した [ +key+ ] を
+ *     範囲に含まない。
+ * @overload open_prefix_cursor(prefix, options={})
+ *   @yield [cursor]
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :key_bytes
+ *    _prefix_ のサイズ（byte）
+ *   @option options :key_bits
+ *    _prefix_ のサイズ（bit）
+ *   @option options :offset
+ *     該当する範囲のレコードのうち、(0ベースで) _:offset_ 番目
+ *     からレコードを取り出す。
+ *   @option options :limit
+ *     該当する範囲のレコードのうち、 _:limit_ 件のみを取り出す。
+ *     省略された場合または-1が指定された場合は、全件が指定され
+ *     たものとみなす。
+ *   @option options :order
+ *     +:asc+ または +:ascending+ を指定すると昇順にレコードを取
+ *     り出す。
+ *     +:desc+ または +:descending+ を指定すると降順にレコードを
+ *     取り出す。
+ *   @option options :order_by (:id)
+ *     +:id+ を指定するとID順にレコードを取り出す。（デフォルト）
+ *     +:key+指定するとキー順にレコードを取り出す。
+ *   @option options :greater_than
+ *     +true+ を指定すると _prefix_ で指定した値に一致した [ +key+ ] を
+ *     範囲に含まない。
+ *   @option options :less_than
+ *     +true+ を指定すると _prefix_ で指定した値に一致した [ +key+ ] を
+ *     範囲に含まない。
  */
 static VALUE
 rb_grn_patricia_trie_open_prefix_cursor (int argc, VALUE *argv, VALUE self)
@@ -729,10 +771,6 @@ rb_grn_patricia_trie_open_grn_rk_cursor (int argc, VALUE *argv, VALUE self,
 }
 
 /*
- * call-seq:
- *   table.open_rk_cursor(key, options={}) -> Groonga::PatriciaTrieCursor
- *   table.open_rk_cursor(key, options={}) {|cursor| ... }
- *
  * _table_ のキーはカタカナである必要がある。また、エンコーディ
  * ングはUTF-8である必要がある。ローマ字やひらがなで _key_ を指
  * 定しても、 _key_ に対応するカタカナのキーを検索するカーソル
@@ -740,37 +778,46 @@ rb_grn_patricia_trie_open_grn_rk_cursor (int argc, VALUE *argv, VALUE self,
  * たカーソルが渡され、ブロックを抜けると自動的にカーソルが破
  * 棄される。
  *
- * _options_ に指定可能な値は以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :key_bytes The key_bytes
- *
- *  _key_のサイズ（byte）
- *
- * @option options :key_bits The key_bits
- *
- *  _key_のサイズ（bit）（現在は未サポート）
- *
- * @option options :offset The offset
- *
- *   該当する範囲のレコードのうち、(0ベースで)_:offset_番目
- *   からレコードを取り出す。
- *
- * @option options :limit The limit
- *
- *   該当する範囲のレコードのうち、 _:limit_ 件のみを取り出す。
- *   省略された場合または-1が指定された場合は、全件が指定され
- *   たものとみなす。
- *
- * @option options :greater_than The greater_than
- *
- *   +true+ を指定すると _key_ で指定した値に一致した [ +key+ ] を
- *   範囲に含まない。
- *
- * @option options :less_than The less_than
- *
- *   +true+ を指定すると _key_ で指定した値に一致した [ +key+ ] を
- *   範囲に含まない。
+ * @overload open_rk_cursor(key, options={})
+ *   @return [Groonga::PatriciaTrieCursor]
+ *   @param options [::Hash]
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :key_bytes
+ *    _key_のサイズ（byte）
+ *   @option options :key_bits
+ *    _key_のサイズ（bit）（現在は未サポート）
+ *   @option options :offset
+ *     該当する範囲のレコードのうち、(0ベースで)_:offset_番目から
+ *     レコードを取り出す。
+ *   @option options :limit
+ *     該当する範囲のレコードのうち、 _:limit_ 件のみを取り出す。
+ *     省略された場合または-1が指定された場合は、全件が指定されたものとみなす。
+ *   @option options :greater_than
+ *     +true+ を指定すると _key_ で指定した値に一致した [ +key+ ] を
+ *     範囲に含まない。
+ *   @option options :less_than
+ *     +true+ を指定すると _key_ で指定した値に一致した [ +key+ ] を
+ *     範囲に含まない。
+ * @overload open_rk_cursor(key, options={})
+ *   @yield [cursor]
+ *   @param options [::Hash]
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :key_bytes
+ *    _key_のサイズ（byte）
+ *   @option options :key_bits
+ *    _key_のサイズ（bit）（現在は未サポート）
+ *   @option options :offset
+ *     該当する範囲のレコードのうち、(0ベースで)_:offset_番目から
+ *     レコードを取り出す。
+ *   @option options :limit
+ *     該当する範囲のレコードのうち、 _:limit_ 件のみを取り出す。
+ *     省略された場合または-1が指定された場合は、全件が指定されたものとみなす。
+ *   @option options :greater_than
+ *     +true+ を指定すると _key_ で指定した値に一致した [ +key+ ] を
+ *     範囲に含まない。
+ *   @option options :less_than
+ *     +true+ を指定すると _key_ で指定した値に一致した [ +key+ ] を
+ *     範囲に含まない。
  */
 static VALUE
 rb_grn_patricia_trie_open_rk_cursor (int argc, VALUE *argv, VALUE self)
@@ -820,7 +867,8 @@ rb_grn_patricia_trie_open_grn_near_cursor (int argc, VALUE *argv, VALUE self,
 			NULL);
 
     key_p = RVAL2GRNBULK_WITH_TYPE(rb_key, *context, key_p,
-				   table->header.domain, grn_ctx_at(*context, table->header.domain));
+				   table->header.domain,
+				   grn_ctx_at(*context, table->header.domain));
     GRN_OBJ_INIT(&casted_key, GRN_BULK, 0, table->header.domain);
     if (key_p->header.domain != table->header.domain) {
 	grn_obj_cast(*context, key_p, &casted_key, 0);
@@ -851,41 +899,48 @@ rb_grn_patricia_trie_open_grn_near_cursor (int argc, VALUE *argv, VALUE self,
 }
 
 /*
- * call-seq:
- *   table.open_near_cursor(key, options={}) -> Groonga::PatriciaTrieCursor
- *   table.open_near_cursor(key, options={}) {|cursor| ... }
- *
  * _key_ に近い順にレコードを取り出すカーソルを生成して返す。
- * ブロックを指定すると、そのブロックに生成したカーソルが渡さ
- * れ、ブロックを抜けると自動的にカーソルが破棄される。
- *
- * _options_ に指定可能な値は以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :size The size
- *
- *   _size_バイト以降のデータが同じキーのレコードに限定する。
- *
- * @option options :offset The offset
- *
- *   該当する範囲のレコードのうち、(0ベースで)_:offset_番目
- *   からレコードを取り出す。
- *
- * @option options :limit The limit
- *
- *   該当する範囲のレコードのうち、_:limit_件のみを取り出す。
- *   省略された場合または-1が指定された場合は、全件が指定され
- *   たものとみなす。
- *
- * @option options :greater_than The greater_than
- *
- *   +true+ を指定すると _key_ で指定した値に一致した [ +key+ ] を
- *   範囲に含まない。
- *
- * @option options :less_than
- *
- *   +true+ を指定すると _key_ で指定した値に一致した [ +key+ ] を
- *   範囲に含まない。
+ * ブロックを指定すると、そのブロックに生成したカーソルが渡され、
+ * ブロックを抜けると自動的にカーソルが破棄される。
+ *
+ * @overload open_near_cursor(key, options={})
+ *   @return [Groonga::PatriciaTrieCursor]
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :size
+ *     _size_ バイト以降のデータが同じキーのレコードに限定する。
+ *   @option options :offset
+ *     該当する範囲のレコードのうち、(0ベースで)_:offset_番目
+ *     からレコードを取り出す。
+ *   @option options :limit
+ *     該当する範囲のレコードのうち、_:limit_件のみを取り出す。
+ *     省略された場合または-1が指定された場合は、全件が指定され
+ *     たものとみなす。
+ *   @option options :greater_than
+ *     +true+ を指定すると _key_ で指定した値に一致した [ +key+ ] を
+ *     範囲に含まない。
+ *   @option options :less_than
+ *     +true+ を指定すると _key_ で指定した値に一致した [ +key+ ] を
+ *     範囲に含まない。
+ * @overload open_near_cursor(key, options={})
+ *   @yield [cursor]
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :size
+ *     _size_ バイト以降のデータが同じキーのレコードに限定する。
+ *   @option options :offset
+ *     該当する範囲のレコードのうち、(0ベースで)_:offset_番目
+ *     からレコードを取り出す。
+ *   @option options :limit
+ *     該当する範囲のレコードのうち、_:limit_件のみを取り出す。
+ *     省略された場合または-1が指定された場合は、全件が指定され
+ *     たものとみなす。
+ *   @option options :greater_than
+ *     +true+ を指定すると _key_ で指定した値に一致した [ +key+ ] を
+ *     範囲に含まない。
+ *   @option options :less_than
+ *     +true+ を指定すると _key_ で指定した値に一致した [ +key+ ] を
+ *     範囲に含まない。
  */
 static VALUE
 rb_grn_patricia_trie_open_near_cursor (int argc, VALUE *argv, VALUE self)