rroonga 2.0.4 → 2.0.5

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

@@ -399,17 +399,13 @@ rb_grn_context_s_set_default_options (VALUE self, VALUE options)
 }
 
 /*
- * call-seq:
- *   Groonga::Context.new(options=nil)
- *
- * コンテキストを作成する。 _options_ に指定可能な値は以下の通
- * り。
- * @param [::Hash] options The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :encoding The encoding
- *
- *   エンコーディングを指定する。エンコーディングの指定方法
- *   はGroonga::Encodingを参照。
+ * コンテキストを作成する。
+ * @overload new(options=nil)
+ *   @param [::Hash] options The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options [Groonga::Encoding] :encoding The encoding
+ *     エンコーディングを指定する。エンコーディングの指定方法
+ *     はGroonga::Encodingを参照。
  */
 static VALUE
 rb_grn_context_initialize (int argc, VALUE *argv, VALUE self)
@@ -570,6 +566,28 @@ rb_grn_context_set_encoding (VALUE self, VALUE rb_encoding)
     return rb_encoding;
 }
 
+/*
+ * Gets the encoding used by the context as Ruby's encoding object.
+ *
+ * @overload ruby_encoding
+ *
+ * @return [::Encoding] the encoding used by the context
+ *
+ * @since 2.0.5
+ */
+static VALUE
+rb_grn_context_get_ruby_encoding (VALUE self)
+{
+#ifdef HAVE_RUBY_ENCODING_H
+    grn_encoding encoding;
+
+    encoding = GRN_CTX_GET_ENCODING(SELF(self));
+    return rb_grn_encoding_to_ruby_encoding_object(encoding);
+#else
+    return Qnil;
+#endif
+}
+
 /*
  * call-seq:
  *   context.match_escalation_threshold -> Integer
@@ -667,21 +685,15 @@ rb_grn_context_get_database (VALUE self)
 }
 
 /*
- * call-seq:
- *   context.connect(options=nil)
- *
- * groongaサーバに接続する。 _options_ に指定可能な値は以下の通
- * り。
- * @param [::Hash] options The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :host (localhost) The groonga server host name
- *
- *   groongaサーバのホスト名。またはIPアドレス。省略すると
- *   "localhost"に接続する。
- * @option options :port (10041) The port number
- *
- *   groongaサーバのポート番号。省略すると10041番ポートに接
- *   続する。
+ * groongaサーバに接続する。
+ * @overload connect(options=nil)
+ *   @param [::Hash] options 利用可能なオプションは次の通り。
+ *   @option options :host (localhost)
+ *     groongaサーバのホスト名。またはIPアドレス。省略すると
+ *     "localhost"に接続する。
+ *   @option options :port (10041)
+ *     groongaサーバのポート番号。省略すると10041番ポートに接
+ *     続する。
  */
 static VALUE
 rb_grn_context_connect (int argc, VALUE *argv, VALUE self)
@@ -721,10 +733,10 @@ rb_grn_context_connect (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   context.send(string) -> ID
- *
  * groongaサーバにクエリ文字列を送信する。
+ * @return [Integer] ID
+ * @overload send(string)
+ *   @param [String] string クエリ文字列
  */
 static VALUE
 rb_grn_context_send (VALUE self, VALUE rb_string)
@@ -745,10 +757,9 @@ rb_grn_context_send (VALUE self, VALUE rb_string)
 }
 
 /*
- * call-seq:
- *   context.receive -> [ID, String]
- *
  * groongaサーバからクエリ実行結果文字列を受信する。
+ * @overload receive
+ * @return [[ID, String]] クエリ実行結果
  */
 static VALUE
 rb_grn_context_receive (VALUE self)
@@ -889,6 +900,7 @@ rb_grn_context_array_reference (VALUE self, VALUE name_or_id)
 		 rb_grn_inspect(name_or_id));
 	break;
     }
+    rb_grn_context_check(context, name_or_id);
 
     return GRNOBJECT2RVAL(Qnil, context, object, GRN_FALSE);
 }
@@ -920,6 +932,8 @@ rb_grn_init_context (VALUE mGrn)
 
     rb_define_method(cGrnContext, "encoding", rb_grn_context_get_encoding, 0);
     rb_define_method(cGrnContext, "encoding=", rb_grn_context_set_encoding, 1);
+    rb_define_method(cGrnContext, "ruby_encoding",
+		     rb_grn_context_get_ruby_encoding, 0);
     rb_define_method(cGrnContext, "match_escalation_threshold",
 		     rb_grn_context_get_match_escalation_threshold, 0);
     rb_define_method(cGrnContext, "match_escalation_threshold=",

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

@@ -164,29 +164,24 @@ reset_floating_objects (VALUE rb_context)
 }
 
 /*
- * call-seq:
- *   Groonga::Database.create(options=nil) -> Groonga::Database
- *
  * 新しくデータベースを作成する。
- *
- * _options_ にはハッシュでオプションを指定する。指定できるオ
- * プションは以下の通り。
- * @param option [::Hash] options The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :path The path
- *
- *   データベースを保存するパス。省略すると一時データベース
- *   となる。
- * @option options :context (Groonga::Context.default) The context
- *
- *   データベースを結びつけるコンテキスト。省略すると
- *   Groonga::Context.defaultを利用する。
+ * _options_ にはハッシュでオプションを指定する。
+ * @return [Groonga::Database] 作成されたデータベース
+ * @overload create(options=nil)
+ *   @param option [::Hash] options The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :path
+ *     データベースを保存するパス。省略すると一時データベース
+ *     となる。
+ *   @option options :context (Groonga::Context.default)
+ *     データベースを結びつけるコンテキスト。省略すると
+ *     Groonga::Context.defaultを利用する。
  *
  * @example
- *   一時データベースを作成:
+ *   # 一時データベースを作成:
  *   Groonga::Database.create
  *
- *   永続データベースを作成:
+ *   # 永続データベースを作成:
  *   Groonga::Database.create(:path => "/tmp/db.groonga")
  */
 static VALUE
@@ -236,22 +231,24 @@ rb_grn_database_s_create (int argc, VALUE *argv, VALUE klass)
 }
 
 /*
- * call-seq:
- *   Groonga::Database.new(path, options=nil) -> Groonga::Database
- *   Groonga::Database.new(path, options=nil) {|database| ...}
- *
  * 既存のデータベースを開く。ブロックを指定した場合はブロッ
  * クに開いたデータベースを渡し、ブロックを抜けるときに閉じ
  * る。
- *
- * _options_ にはハッシュでオプションを指定する。指定できるオ
- * プションは以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :context (Groonga::Context.default) The context
- *
- *   データベースを結びつけるコンテキスト。省略すると
- *   Groonga::Context.defaultを利用する。
+ * @overload new(path, options=nil)
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :context (Groonga::Context.default)
+ *     データベースを結びつけるコンテキスト。省略すると
+ *     Groonga::Context.defaultを利用する。
+ *   @return [Groonga::Database]
+ * @overload new(path, options=nil)
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :context (Groonga::Context.default)
+ *     データベースを結びつけるコンテキスト。省略すると
+ *     Groonga::Context.defaultを利用する。
+ *   @yield [database]
+ *   @yieldparam [Groonga::Database] database 開いたデータベース
  */
 static VALUE
 rb_grn_database_initialize (int argc, VALUE *argv, VALUE self)
@@ -286,21 +283,22 @@ rb_grn_database_initialize (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   Groonga::Database.open(path, options=nil) -> Groonga::Database
- *   Groonga::Database.open(path, options=nil) {|database| ...}
- *
  * 既存のデータベースを開く。ブロックを指定した場合はブロッ
  * クに開いたデータベースを渡し、ブロックを抜けるときに閉じ
- * る。
- *
- * _options_ にはハッシュでオプションを指定する。指定できるオ
- * プションは以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :context (Groonga::Context.default) The context
- *
- *   データベースを結びつけるコンテキスト。
+ * る。 _options_ にはハッシュでオプションを指定する。
+ * @overload open(path, options=nil)
+ *   @return [Groonga::Database]
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :context (Groonga::Context.default) The context
+ *     データベースを結びつけるコンテキスト。
+ * @overload open(path, options=nil)
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :context (Groonga::Context.default) The context
+ *     データベースを結びつけるコンテキスト。
+ *   @yield [database]
+ *   @yieldparam [Groonga::Database] database 開いたデータベース
  */
 static VALUE
 rb_grn_database_s_open (int argc, VALUE *argv, VALUE klass)
@@ -316,12 +314,7 @@ rb_grn_database_s_open (int argc, VALUE *argv, VALUE klass)
 }
 
 /*
- * call-seq:
- *   database.each {|object| ...}
- *   database.each(options=nil) {|object| ...}
- *
  * データベース内のオブジェクトを順番にブロックに渡す。
- *
  * @example すべてのオブジェクトの名前を表示する:
  *   database.each do |object|
  *     p object.name
@@ -337,20 +330,28 @@ rb_grn_database_s_open (int argc, VALUE *argv, VALUE klass)
  *     p object.name
  *   end
  *
- * @param options [::Hash]
- * @option options :order The order
- *   +:asc+ または +:ascending+ を指定すると昇順にレコードを取
- *   り出す。（デフォルト）
- *
- *   +:desc+ または +:descending+ を指定すると降順にレコードを
- *   取り出す。
- *
- * @option options :order_by (:key) The ordef by
- *   +:id+ を指定するとID順にレコードを取り出す。
- *
- *   +:key+ 指定するとキー順にレコードを取り出す。（デフォル
- *   ト）
- *
+ * @overload each(options=nil)
+ *   @macro [new] database.each.options
+ *     @param options [::Hash]
+ *     @yield [object]
+ *     @option options :order
+ *       +:asc+ または +:ascending+ を指定すると昇順にレコードを取
+ *       り出す。（デフォルト）
+ *       +:desc+ または +:descending+ を指定すると降順にレコードを
+ *       取り出す。
+ *     @option options :order_by (:key)
+ *       +:id+ を指定するとID順にレコードを取り出す。
+ *       +:key+ 指定するとキー順にレコードを取り出す。（デフォル
+ *       ト）
+ *   @macro database.each.options
+ *
+ * @overload each(options=nil)
+ *   @macro database.each.options
+ *   @option options :ignore_missing_object (false)
+ *     Specify +true+ to ignore missing object. Otherwise, an exception is
+ *     raised for missing object.
+ *
+ *   @since 2.0.5
  */
 static VALUE
 rb_grn_database_each (int argc, VALUE *argv, VALUE self)
@@ -359,8 +360,12 @@ rb_grn_database_each (int argc, VALUE *argv, VALUE self)
     grn_obj *database;
     grn_table_cursor *cursor;
     VALUE rb_cursor, rb_options, rb_order, rb_order_by;
+    VALUE rb_ignore_missing_object;
     int flags = 0;
     grn_id id;
+    VALUE exception;
+
+    RETURN_ENUMERATOR(self, argc, argv);
 
     rb_grn_database_deconstruct(SELF(self), &database, &context,
 				NULL, NULL, NULL, NULL);
@@ -370,6 +375,7 @@ rb_grn_database_each (int argc, VALUE *argv, VALUE self)
     rb_grn_scan_options(rb_options,
 			"order", &rb_order,
 			"order_by", &rb_order_by,
+			"ignore_missing_object", &rb_ignore_missing_object,
 			NULL);
 
     flags |= rb_grn_table_cursor_order_to_flag(rb_order);
@@ -386,8 +392,21 @@ rb_grn_database_each (int argc, VALUE *argv, VALUE self)
 	grn_obj *object;
 
 	object = grn_ctx_at(context, id);
-	if (object)
+	if (!object && RTEST(rb_ignore_missing_object)) {
+	    context->rc = GRN_SUCCESS;
+	    continue;
+	}
+
+	exception = rb_grn_context_to_exception(context, self);
+	if (!NIL_P(exception)) {
+	    rb_grn_object_close(rb_cursor);
+	    rb_iv_set(self, "cursor", Qnil);
+	    rb_exc_raise(exception);
+	}
+
+	if (object) {
 	    rb_yield(GRNOBJECT2RVAL(Qnil, context, object, GRN_FALSE));
+	}
     }
     rb_grn_object_close(rb_cursor);
     rb_iv_set(self, "cursor", Qnil);
@@ -421,25 +440,22 @@ rb_grn_database_unlock (VALUE self)
 }
 
 /*
- * Document-method: lock
- *
- * call-seq:
- *   database.lock(options={})
- *   database.lock(options={}) {...}
- *
  * _database_ をロックする。ロックに失敗した場合は
  * Groonga::ResourceDeadlockAvoided例外が発生する。
  *
- * ブロックを指定した場合はブロックを抜けたときにunlockする。
- *
- * 利用可能なオプションは以下の通り。
- * @param [::Hash] options The name and value
- *   pairs. Omitted names are initialized as the default value
- * @option options :timeout The timeout
- *
- *   ロックを獲得できなかった場合は _:timeout_ 秒間ロックの獲
- *   得を試みる。 _:timeout_ 秒以内にロックを獲得できなかった
- *   場合は例外が発生する。
+ * @overload lock(options={})
+ *   @param [::Hash] options 利用可能なオプションは以下の通り。
+ *   @option options :timeout
+ *     ロックを獲得できなかった場合は _:timeout_ 秒間ロックの獲
+ *     得を試みる。 _:timeout_ 秒以内にロックを獲得できなかった
+ *     場合は例外が発生する。
+ * @overload lock(options={})
+ *   @yield ブロックを指定した場合はブロックを抜けたときにunlockする。
+ *   @param [::Hash] options 利用可能なオプションは以下の通り。
+ *   @option options :timeout
+ *     ロックを獲得できなかった場合は _:timeout_秒間ロックの獲
+ *     得を試みる。 _:timeout_秒以内にロックを獲得できなかった
+ *     場合は例外が発生する。
  */
 static VALUE
 rb_grn_database_lock (int argc, VALUE *argv, VALUE self)
@@ -537,18 +553,14 @@ rb_grn_database_touch (VALUE self)
 }
 
 /*
- * Document-method: defrag
- *
- * call-seq:
- *   database.defrag(options={}) -> n_segments
- *
  * Defrags all variable size columns in the database.
- *
  * @return [Integer] the number of defraged segments
- * @option options [Integer] :threshold (0) the threshold to
- *   determine whether a segment is defraged. Available
- *   values are -4..22. -4 means all segments are defraged.
- *   22 means no segment is defraged.
+ * @overload defrag(options={})
+ *   @param [::Hash] options option for defrag
+ *   @option options [Integer] :threshold (0) the threshold to
+ *     determine whether a segment is defraged. Available
+ *     values are -4..22. -4 means all segments are defraged.
+ *     22 means no segment is defraged.
  * @since 1.2.6
  */
 static VALUE

data/ext/groonga/rb-grn-double-array-trie.c

@@ -43,91 +43,9 @@ VALUE rb_cGrnDoubleArrayTrie;
  */
 
 /*
- * call-seq:
- *   Groonga::DoubleArrayTrie.create(options={}) -> Groonga::DoubleArrayTrie
- *   Groonga::DoubleArrayTrie.create(options={}) {|table| ... }
- *
  * It creates a table that manages records by double array trie.
  * ブロックを指定すると、そのブロックに生成したテーブルが渡さ
  * れ、ブロックを抜けると自動的にテーブルが破棄される。
- *
- * _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::DoubleArrayTrieのどれか）を指定する。
- *
- *   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::DoubleArrayTrie.create
@@ -138,7 +56,7 @@ VALUE rb_cGrnDoubleArrayTrie;
  *   #名前付き永続テーブルを生成する。ただし、ファイル名は気に
  *   #しない。
  *   Groonga::DoubleArrayTrie.create(:name => "Bookmarks",
- *                                :persistent => true)
+ *                                   :persistent => true)
  *
  *   #それぞれのレコードに512バイトの値を格納できる無名一時テー
  *   #ブルを生成する。
@@ -167,9 +85,127 @@ VALUE rb_cGrnDoubleArrayTrie;
  *   bookmarks = Groonga::DoubleArrayTrie.create(:name => "Bookmarks")
  *   bookmarks.define_column("comment", "Text")
  *   terms = Groonga::DoubleArrayTrie.create(:name => "Terms",
- *                                        :default_tokenizer => "TokenBigram")
+ *                                           :default_tokenizer => "TokenBigram")
  *   terms.define_index_column("content", bookmarks,
  *                             :source => "Bookmarks.comment")
+ *
+ * @overload create(options={})
+ *   @return [Groonga::DoubleArrayTrie]
+ *   @param [::Hash] options 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::DoubleArrayTrieのどれか）を指定する。
+ *     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 [::Hash] options 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::DoubleArrayTrieのどれか）を指定する。
+ *     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_double_array_trie_s_create (int argc, VALUE *argv, VALUE klass)
@@ -251,43 +287,13 @@ rb_grn_double_array_trie_s_create (int argc, VALUE *argv, VALUE klass)
 }
 
 /*
- * call-seq:
- *   double_array_trie.search(key, options=nil) -> Groonga::Hash
- *
  * _key_ にマッチするレコードのIDがキーに入っている
  * Groonga::Hashを返す。マッチするレコードがない場合は空の
  * Groonga::Hashが返る。
- *
  * _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|
@@ -297,6 +303,30 @@ rb_grn_double_array_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)
+ *   @return [Groonga::Hash]
+ *   @param key [String] レコードにマッチさせる値
+ *   @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+]
+ *       ?????
+ *
  */
 static VALUE
 rb_grn_double_array_trie_search (int argc, VALUE *argv, VALUE self)
@@ -441,59 +471,71 @@ rb_grn_double_array_trie_open_grn_prefix_cursor (int argc, VALUE *argv,
     return cursor;
 }
 
-
 /*
- * call-seq:
- *   table.open_prefix_cursor(prefix, options={}) -> Groonga::DoubleArrayTrieCursor
- *   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::DoubleArrayTrieCursor]
+ *   @param [String] prefix 前方一致させる値
+ *   @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 [String] prefix 前方一致させる値
+ *   @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_double_array_trie_open_prefix_cursor (int argc, VALUE *argv, VALUE self)