rroonga 2.0.4 → 2.0.5

data/ext/groonga/rb-grn-encoding-support.c

@@ -30,10 +30,9 @@ VALUE rb_mGrnEncodingSupport;
  */
 
 /*
- * call-seq:
- *   object.encoding -> エンコーディング
- *
  * オブジェクトのエンコーディングを返す。
+ * @overload encoding
+ * @return [Groonga::Encoding] オブジェクトのエンコーディング
  */
 static VALUE
 rb_grn_encoding_support_get_encoding (VALUE self)

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

@@ -183,13 +183,19 @@ rb_grn_encoding_to_ruby_encoding (grn_encoding encoding)
 
     return rb_encoding;
 }
+
+VALUE
+rb_grn_encoding_to_ruby_encoding_object (grn_encoding encoding)
+{
+    rb_encoding *rb_encoding = rb_grn_encoding_to_ruby_encoding(encoding);
+    return rb_enc_from_encoding(rb_encoding);
+}
 #endif
 
 /*
- * call-seq:
- *   Groonga::Encoding.default -> エンコーディング
- *
  * デフォルトのエンコーディングを返す。
+ * @overload default
+ * @return [Groonga::Encoding] デフォルトのエンコーディング
  */
 static VALUE
 rb_grn_encoding_s_get_default (VALUE self)
@@ -198,11 +204,10 @@ rb_grn_encoding_s_get_default (VALUE self)
 }
 
 /*
- * call-seq:
- *   Groonga::Encoding.default(encoding)
- *
- * デフォルトのエンコーディングを設定する。エンコーディング
- * の指定方法はGroonga::Encodingを参照。
+ * デフォルトのエンコーディングを設定する。
+ * @overload default=(encoding)
+ *   @param [Groonga::Encoding] encoding 指定するエンコーディング。
+ *     エンコーディングの指定方法はGroonga::Encodingを参照。
  */
 static VALUE
 rb_grn_encoding_s_set_default (VALUE self, VALUE rb_encoding)

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

@@ -605,7 +605,7 @@ rb_grn_init_exception (VALUE mGrn)
      * groongaレベルでは破棄されているが、Rubyレベルでは生き
      * ているオブジェクトにアクセスすると発生する。
      *
-     * @deprecated since 1.2.3. Use Groonga::Closed instead.
+     * @deprecated Use {Closed} instead since 1.2.3.
      */
     rb_define_const(mGrn, "ObjectClosed", rb_eGrnClosed);
 

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

@@ -107,20 +107,17 @@ rb_grn_expression_initialize (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   expression.define_variable(options={}) -> Groonga::Variable
- *
  * _expression_ で使用可能な変数を作成する。
  *
- * _options_ に指定可能な値は以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :name (false)
- *
- *   変数の名前。省略した場合は名前を付けない。
- * @option options :domain
+ * @overload define_variable(options={})
+ *   @param [::Hash] options The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :name (false)
+ *     変数の名前。省略した場合は名前を付けない。
+ *   @option options :domain
+ *     テーブルを指定すると、そのテーブル用のレコードとして初期化する。
+ * @return [Groonga::Variable]
  *
- *   テーブルを指定すると、そのテーブル用のレコードとして初期化する。
  */
 static VALUE
 rb_grn_expression_define_variable (int argc, VALUE *argv, VALUE self)
@@ -160,12 +157,14 @@ rb_grn_expression_define_variable (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   expression.append_object(object,
- *                            operation=Groonga::Operator::PUSH,
- *                            n_arguments=1) -> self
- *
  * _object_ を追加し、 _n_arguments_ 個の引数を取る _operation_ を追加する。
+ *
+ * @overload append_object(object, operation=Groonga::Operator::PUSH, n_arguments=1)
+ *   @param [Object] object 追加するオブジェクト
+ *   @param [Groonga::Operator::XXX] operation 追加する _operation_
+ *   @param [Integer] n_arguments _operation_ の取る引数
+ * @return [Self] self
+ *
  */
 static VALUE
 rb_grn_expression_append_object (int argc, VALUE *argv, VALUE self)
@@ -196,12 +195,13 @@ rb_grn_expression_append_object (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   expression.append_constant(constant,
- *                              operation=Groonga::Operator::PUSH,
- *                              n_arguments=1) -> self
- *
  * _constant_ を追加し、 _n_arguments_ 個の引数を取る _operation_ を追加する。
+ *
+ * @overload append_constant(constant, operation=Groonga::Operator::PUSH, n_arguments=1)
+ *   @param [Object] constant 追加する _constant_
+ *   @param [Groonga::Operator::XXX] operation 追加する _operation_
+ *   @param [Integer] n_arguments _operation_ の取る引数
+ * @return [Self] self
  */
 static VALUE
 rb_grn_expression_append_constant (int argc, VALUE *argv, VALUE self)
@@ -261,87 +261,71 @@ rb_grn_expression_append_operation (VALUE self, VALUE rb_operation,
 }
 
 /*
- * call-seq:
- *   expression.parse(query, options={})
- *
  * 文字列 _query_ をパースする。
- *
- * _options_ に指定可能な値は以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :default_column The default_column
- *
- *   "column_name:hoge"ではなく"hoge"のようにcolumn_nameが指
- *   定されない条件の検索対象となるカラムを指定する。
- * @option options :default_operator (Groonga::Operator::AND)
- *
- *   The default_operator
- *   "+"や"OR"で繋がれず、ただ列挙された複数の条件があった時、
- *   _expression_ 全体として各レコードをヒットとみなすかの論理
- *   条件を指定する。省略した場合はGroonga::Operator::AND。
- *   [Groonga::Operator::OR]
- *     レコードはいずれかの条件にマッチすればいい。
- *   [Groonga::Operator::AND]
- *     レコードは全ての条件にマッチしなければならない。
- *   [Groonga::Operator::BUT]
- *     最初の条件にレコードはマッチし、残りの条件にレコードは
- *     マッチしてはならない。
- * @option options :default_mode (Groonga::Operator::MATCH) The default_mode
- *
- *   検索時のモードを指定する。省略した場合は
- *   Groonga::Operator::MATCH。（FIXME: モードによってどう
- *   いう動作になるかを書く。）
- *
- * @option options :syntax (:query) The syntax
- *
- *   _query_ の構文を指定する。指定可能な値は以下の通り。省略
- *   した場合は +:query+ 。
- *
- *   [+nil+]
- *     +:query+と同様。
- *   [+:query+]
- *     「文字列1 OR 文字列2」で「"文字列1"あるいは"文字列2"
- *     にマッチという検索エンジンで利用できるような構文を使
- *     う。
+ * @overload parse(query, options={})
+ *   @param [String] query パースする文字列
+ *   @param [::Hash] options The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :default_column
+ *     "column_name:hoge"ではなく"hoge"のようにcolumn_nameが指
+ *     定されない条件の検索対象となるカラムを指定する。
+ *   @option options :default_operator (Groonga::Operator::AND)
+ *     "+"や"OR"で繋がれず、ただ列挙された複数の条件があった時、
+ *     _expression_ 全体として各レコードをヒットとみなすかの論理
+ *     条件を指定する。省略した場合はGroonga::Operator::AND。
+ *
+ *     - Groonga::Operator::OR :=
+ *       レコードはいずれかの条件にマッチすればいい。 =:
+ *     - Groonga::Operator::AND :=
+ *       レコードは全ての条件にマッチしなければならない。 =:
+ *     - Groonga::Operator::BUT :=
+ *       最初の条件にレコードはマッチし、残りの条件にレコードは
+ *       マッチしてはならない。 =:
+ *
+ *   @option options :default_mode (Groonga::Operator::MATCH)
+ *     検索時のモードを指定する。省略した場合はGroonga::Operator::MATCH。
+ *     （FIXME: モードによってどういう動作になるかを書く。）
+ *   @option options :syntax (:query)
+ *     _query_ の構文を指定する。指定可能な値は以下の通り。省略
+ *     した場合は +:query+ 。
+ *
+ *     - +:query+ :=
+ *       「文字列1 OR 文字列2」で「"文字列1"あるいは"文字列2"
+ *       にマッチという検索エンジンで利用できるような構文を使
+ *       う。
+ *       参考: grn式のquery形式（link:text/expression_rdoc.html） =:
+ *     - +nil+ :=
+ *       +:query+と同様 =:
+ *     - +:script+ :=
+ *       「[カラム名] == [値]」というようにECMAScript風の構文を使う。
+ *       参考: grn式のscript形式（link:text/expression_rdoc.html） =:
+ *   @option options :allow_pragma
+ *     _query_ の構文に query を用いているとき（ +:syntax+
+ *     オプション参照）、「*E-1」というようにクエリの先頭で
+ *     pragmaを利用できるようにする。script構文を用いている
+ *     ときはこのオプションを利用できない。
+ *
+ *     デフォルトではプラグマを利用できる。
  *
  *     参考: grn式のquery形式（link:text/expression_rdoc.html）
- *   [+:script+]
- *     「[カラム名] == [値]」というようにECMAScript風の構文
- *     を使う。
+ *   @option options :allow_column
+ *     _query_ の構文にqueryを用いているとき（ +:syntax+ オプショ
+ *     ン参照）、「カラム名:値」というようにカラム名を指定した
+ *     条件式を利用できるようにする。script構文を用いていると
+ *     きはこのオプションを利用できない。
  *
- *     参考: grn式のscript形式（link:text/expression_rdoc.html）
+ *     デフォルトではカラム名を指定した条件式を利用できる。
  *
- * @option options :allow_pragma The allow_pragma
- *   _query_ の構文に query を用いているとき（ +:syntax+
- *   オプション参照）、「*E-1」というようにクエリの先頭で
- *   pragmaを利用できるようにする。script構文を用いている
- *   ときはこのオプションを利用できない。
- *
- *   デフォルトではプラグマを利用できる。
- *
- *   参考: grn式のquery形式（link:text/expression_rdoc.html）
- *
- * @option options :allow_column The allow_column
- *
- *   _query_ の構文にqueryを用いているとき（+:syntax+オプショ
- *   ン参照）、「カラム名:値」というようにカラム名を指定した
- *   条件式を利用できるようにする。script構文を用いていると
- *   きはこのオプションを利用できない。
- *
- *   デフォルトではカラム名を指定した条件式を利用できる。
- *
- *   参考: grn式のquery形式（link:text/expression_rdoc.html）
- *
- * @option options :allow_update The allow_update
- *
- *   _query_の構文にscriptを用いているとき（ +:syntax+ オプショ
- *   ン参照）、「カラム名 = 値」というように更新操作を利用で
- *   きるようにする。query構文を用いているときはこのオプショ
- *   ンを利用できない。
+ *     参考: grn式のquery形式（link:text/expression_rdoc.html）
+ *   @option options :allow_update
+ *     _query_ の構文にscriptを用いているとき（ +:syntax+ オプショ
+ *     ン参照）、「カラム名 = 値」というように更新操作を利用で
+ *     きるようにする。query構文を用いているときはこのオプショ
+ *     ンを利用できない。
  *
- *   デフォルトでは更新操作を利用できる。
+ *     デフォルトでは更新操作を利用できる。
  *
- *   参考: grn式のscript形式（link:text/expression_rdoc.html）
+ *     参考: grn式のscript形式（link:text/expression_rdoc.html）
  */
 static VALUE
 rb_grn_expression_parse (int argc, VALUE *argv, VALUE self)
@@ -578,20 +562,17 @@ rb_grn_expression_inspect (VALUE self)
 }
 
 /*
- * call-seq:
- *   expression.snippet(tags, options) -> Groonga::Snippet
- *
- * _expression_ からGroonga::Snippetを生成する。 _tags_ には
+ * _expression_ から {Groonga::Snippet} を生成する。 _tags_ には
  * キーワードの前後に挿入するタグの配列を以下のような形式で指定
  * する。
  *
  * <pre>
  * !!!ruby
- * [
- *  ["キーワード前に挿入する文字列1", "キーワード後に挿入する文字列1"],
- *  ["キーワード前に挿入する文字列2", "キーワード後に挿入する文字列2"],
- *  # ...,
- * ]
+ *   [
+ *    ["キーワード前に挿入する文字列1", "キーワード後に挿入する文字列1"],
+ *    ["キーワード前に挿入する文字列2", "キーワード後に挿入する文字列2"],
+ *    # ...,
+ *   ]
  * </pre>
  *
  * もし、1つのスニペットの中に _tags_ で指定したタグより多くの
@@ -600,37 +581,33 @@ rb_grn_expression_inspect (VALUE self)
  *
  * <pre>
  * !!!ruby
- * expression.parse("Ruby groonga 検索")
- * tags = [["<tag1>", "</tag1>"], ["<tag2>", "</tag2>"]]
- * snippet = expression.snippet(tags)
- * p snippet.execute("Rubyでgroonga使って全文検索、高速検索。")
- *    # => ["<tag1>Ruby</tag1>で<tag2>groonga</tag2>"
- *    # =>  "使って全文<tag1>検索</tag1>、高速<tag2>検索</tag2>。"]
+ *   expression.parse("Ruby groonga 検索")
+ *   tags = [["<tag1>", "</tag1>"], ["<tag2>", "</tag2>"]]
+ *   snippet = expression.snippet(tags)
+ *   p snippet.execute("Rubyでgroonga使って全文検索、高速検索。")
+ *      # => ["<tag1>Ruby</tag1>で<tag2>groonga</tag2>"
+ *      # =>  "使って全文<tag1>検索</tag1>、高速<tag2>検索</tag2>。"]
  * </pre>
  *
- * _options_ に指定可能な値は以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :normalize (false) The normalize
- *
- *   キーワード文字列・スニペット元の文字列を正規化するかど
- *   うか。省略した場合は +false+ で正規化しない。
- *
- * @option options :skip_leading_spaces (false) The skip_leading_spaces
- *
- *   先頭の空白を無視するかどうか。省略した場合は +false+ で無
- *   視しない。
- *
- * @option options :width (100) The width
- *
- *   スニペット文字列の長さ。省略した場合は100文字。
- * @option options :max_results (3) The max_results
- *
- *   生成するスニペットの最大数。省略した場合は3。
- * @option options :html_escape (false) The html_escape
- *
- *   スニペット内の +<+, +>+, +&+, +"+ をHTMLエスケープするか
- *   どうか。省略した場合は +false+ で、HTMLエスケープしない。
+ * @overload snippet(tags, options)
+ *   @param tags [Array<string>] キーワードの前後に挿入するタグの配列
+ *     （詳細は上記を参照）
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :normalize (false)
+ *     キーワード文字列・スニペット元の文字列を正規化するかど
+ *     うか。省略した場合は +false+ で正規化しない。
+ *   @option options :skip_leading_spaces (false)
+ *     先頭の空白を無視するかどうか。省略した場合は +false+ で無
+ *     視しない。
+ *   @option options :width (100)
+ *     スニペット文字列の長さ。省略した場合は100文字。
+ *   @option options :max_results (3)
+ *     生成するスニペットの最大数。省略した場合は3。
+ *   @option options :html_escape (false)
+ *     スニペット内の +<+, +>+, +&+, +"+ をHTMLエスケープするか
+ *     どうか。省略した場合は +false+ で、HTMLエスケープしない。
+ * @return [Groonga::Snippet]
  */
 static VALUE
 rb_grn_expression_snippet (int argc, VALUE *argv, VALUE self)

data/ext/groonga/rb-grn-fix-size-column.c

@@ -56,10 +56,11 @@ rb_grn_fix_size_column_array_reference (VALUE self, VALUE rb_id)
 }
 
 /*
- * call-seq:
- *   column[id] = value
- *
  * _column_ の _id_ に対応する値を設定する。
+ *
+ * @overload []=(id, value)
+ *   @param [Integer] id 設定する値に対応する _column_ の _id_
+ *   @param [Groonga::Object] value 設定する値
  */
 static VALUE
 rb_grn_fix_size_column_array_set (VALUE self, VALUE rb_id, VALUE rb_value)
@@ -77,7 +78,7 @@ rb_grn_fix_size_column_array_set (VALUE self, VALUE rb_id, VALUE rb_value)
 			      &value, &range_id, &range);
 
     id = NUM2UINT(rb_id);
-    RVAL2GRNBULK_WITH_TYPE(rb_value, context, value, range_id, range);
+    RVAL2GRNVALUE(rb_value, context, value, range_id, range);
 
     rc = grn_obj_set_value(context, column, id, value, GRN_OBJ_SET);
     rb_grn_context_check(context, self);

data/ext/groonga/rb-grn-geo-point.c

@@ -0,0 +1,55 @@
+/* -*- coding: utf-8; c-file-style: "ruby" -*- */
+/*
+  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
+  License version 2.1 as published by the Free Software Foundation.
+
+  This library is distributed in the hope that it will be useful,
+  but WITHOUT ANY WARRANTY; without even the implied warranty of
+  MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
+  Lesser General Public License for more details.
+
+  You should have received a copy of the GNU Lesser General Public
+  License along with this library; if not, write to the Free Software
+  Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA  02111-1307  USA
+*/
+
+#include "rb-grn.h"
+
+VALUE rb_cGrnTokyoGeoPoint;
+VALUE rb_cGrnWGS84GeoPoint;
+
+VALUE
+rb_grn_tokyo_geo_point_new (int latitude, int longitude)
+{
+    return rb_grn_tokyo_geo_point_new_raw(INT2NUM(latitude), INT2NUM(longitude));
+}
+
+VALUE
+rb_grn_wgs84_geo_point_new (int latitude, int longitude)
+{
+    return rb_grn_wgs84_geo_point_new_raw(INT2NUM(latitude), INT2NUM(longitude));
+}
+
+VALUE
+rb_grn_tokyo_geo_point_new_raw (VALUE latitude, VALUE longitude)
+{
+    return rb_funcall(rb_cGrnTokyoGeoPoint, rb_intern("new"), 2,
+		      latitude, longitude);
+}
+
+VALUE
+rb_grn_wgs84_geo_point_new_raw (VALUE latitude, VALUE longitude)
+{
+    return rb_funcall(rb_cGrnWGS84GeoPoint, rb_intern("new"), 2,
+		      latitude, longitude);
+}
+
+void
+rb_grn_init_geo_point (VALUE mGrn)
+{
+    rb_cGrnTokyoGeoPoint = rb_const_get(mGrn, rb_intern("TokyoGeoPoint"));
+    rb_cGrnWGS84GeoPoint = rb_const_get(mGrn, rb_intern("WGS84GeoPoint"));
+}

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

@@ -30,81 +30,10 @@ VALUE rb_cGrnHash;
  */
 
 /*
- * call-seq:
- *   Groonga::Hash.create(options={})                -> Groonga::Hash
- *   Groonga::Hash.create(options={}) {|table| ... }
- *
  * 各レコードをキーで管理するテーブルを生成する。ブロックを指
  * 定すると、そのブロックに生成したテーブルが渡され、ブロック
  * を抜けると自動的にテーブルが破棄される。
  *
- * _options_ に指定可能な値は以下の通り。
- * @param [::Hash] options The name and value
- *   pairs. Omitted names are initialized as the default value
- * @option options [Groonga::Context] :context (Groonga::Context.default) The context
- *
- *   テーブルが利用するGroonga::Context。省略すると
- *   Groonga::Context.defaultを用いる。
- * @option options [Groonga::Context#[]] :name The name
- *
- *   テーブルの名前。名前をつけると、Groonga::Context#[]に名
- *   前を指定してテーブルを取得することができる。省略すると
- *   無名テーブルになり、テーブルIDでのみ取得できる。
- *
- * @option options [Groonga::Context#[]] :path The path
- *
- *   テーブルを保存するパス。パスを指定すると永続テーブルとな
- *   り、プロセス終了後もレコードは保持される。次回起動時に
- *   Groonga::Context#[]で保存されたレコードを利用することが
- *   できる。省略すると一時テーブルになり、プロセスが終了する
- *   とレコードは破棄される。
- *
- * @option options :persistent The persistent
- *   +true+ を指定すると永続テーブルとなる。 +path+ を省略した
- *   場合は自動的にパスが付加される。 +:context+ で指定した
- *   Groonga::Contextに結びついているデータベースが一時デー
- *   タベースの場合は例外が発生する。
- *
- * @option options :key_normalize The normalize
- *   +true+ を指定するとキーを正規化する。
- *
- * @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 [Groonga::IndexColumn] :default_tokenizer The default_tokenizer
- *   Groonga::IndexColumnで使用するトークナイザを指定する。
- *   デフォルトでは何も設定されていないので、テーブルに
- *   Groonga::IndexColumnを定義する場合は
- *   <tt>"TokenBigram"</tt>などを指定する必要がある。
- *
- * @option options [Groonga::Record#n_sub_records] :sub_records The sub_records
- *   +true+ を指定すると#groupでグループ化したときに、
- *   Groonga::Record#n_sub_recordsでグループに含まれるレコー
- *   ドの件数を取得できる。
- *
  * @example
  *   #無名一時テーブルを生成する。
  *   Groonga::Hash.create
@@ -144,6 +73,119 @@ VALUE rb_cGrnHash;
  *                                :default_tokenizer => "TokenBigram")
  *   terms.define_index_column("content", bookmarks,
  *                             :source => "Bookmarks.comment")
+ *
+ * @overload create(options={})
+ *   @return [Groonga::Hash]
+ *   @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。省略すると
+ *     Groonga::Context.defaultを用いる。
+ *   @option options [Groonga::Context#[]] :name
+ *     テーブルの名前。名前をつけると、Groonga::Context#[]に名
+ *     前を指定してテーブルを取得することができる。省略すると
+ *     無名テーブルになり、テーブルIDでのみ取得できる。
+ *   @option options [Groonga::Context#[]] :path
+ *     テーブルを保存するパス。パスを指定すると永続テーブルとな
+ *     り、プロセス終了後もレコードは保持される。次回起動時に
+ *     Groonga::Context#[]で保存されたレコードを利用することが
+ *     できる。省略すると一時テーブルになり、プロセスが終了する
+ *     とレコードは破棄される。
+ *   @option options :persistent
+ *     +true+ を指定すると永続テーブルとなる。 +path+ を省略した
+ *     場合は自動的にパスが付加される。 +:context+ で指定した
+ *     Groonga::Contextに結びついているデータベースが一時デー
+ *     タベースの場合は例外が発生する。
+ *   @option options :key_normalize
+ *     +true+ を指定するとキーを正規化する。
+ *   @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 [Groonga::IndexColumn] :default_tokenizer
+ *     Groonga::IndexColumnで使用するトークナイザを指定する。
+ *     デフォルトでは何も設定されていないので、テーブルに
+ *     Groonga::IndexColumnを定義する場合は
+ *     <tt>"TokenBigram"</tt>などを指定する必要がある。
+ *   @option options [Groonga::Record#n_sub_records] :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。省略すると
+ *     Groonga::Context.defaultを用いる。
+ *   @option options [Groonga::Context#[]] :name
+ *     テーブルの名前。名前をつけると、Groonga::Context#[]に名
+ *     前を指定してテーブルを取得することができる。省略すると
+ *     無名テーブルになり、テーブルIDでのみ取得できる。
+ *   @option options [Groonga::Context#[]] :path
+ *     テーブルを保存するパス。パスを指定すると永続テーブルとな
+ *     り、プロセス終了後もレコードは保持される。次回起動時に
+ *     Groonga::Context#[]で保存されたレコードを利用することが
+ *     できる。省略すると一時テーブルになり、プロセスが終了する
+ *     とレコードは破棄される。
+ *   @option options :persistent
+ *     +true+ を指定すると永続テーブルとなる。 +path+ を省略した
+ *     場合は自動的にパスが付加される。 +:context+ で指定した
+ *     Groonga::Contextに結びついているデータベースが一時デー
+ *     タベースの場合は例外が発生する。
+ *   @option options :key_normalize
+ *     +true+ を指定するとキーを正規化する。
+ *   @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 [Groonga::IndexColumn] :default_tokenizer
+ *     Groonga::IndexColumnで使用するトークナイザを指定する。
+ *     デフォルトでは何も設定されていないので、テーブルに
+ *     Groonga::IndexColumnを定義する場合は
+ *     <tt>"TokenBigram"</tt>などを指定する必要がある。
+ *   @option options [Groonga::Record#n_sub_records] :sub_records
+ *     +true+ を指定すると#groupでグループ化したときに、
+ *     Groonga::Record#n_sub_recordsでグループに含まれるレコー
+ *     ドの件数を取得できる。
  */
 static VALUE
 rb_grn_hash_s_create (int argc, VALUE *argv, VALUE klass)
@@ -220,9 +262,6 @@ rb_grn_hash_s_create (int argc, VALUE *argv, VALUE klass)
 }
 
 /*
- * call-seq:
- *   hash.search(key, options=nil) -> Groonga::Hash
- *
  * _key_ にマッチするレコードのIDがキーに入っている
  * Groonga::Hashを返す。マッチするレコードがない場合は空の
  * Groonga::Hashが返る。
@@ -231,14 +270,6 @@ rb_grn_hash_s_create (int argc, VALUE *argv, VALUE klass)
  * チしたレコードIDがキーのレコードを追加することができる。
  * +:result+ にテーブルを指定した場合は、そのテーブルが返る。
  *
- * _options_ に指定可能な値は以下の通り。
- * @param [::Hash] options The name and value
- *   pairs. Omitted names are initialized as the default value
- *
- * @option options :result The result
- *
- *   結果を格納するテーブル。
- *
  * @example 複数のキーで検索し、結果を1つのテーブルに集める。
  *   result = nil
  *   keys = ["morita", "gunyara-kun", "yu"]
@@ -249,6 +280,13 @@ rb_grn_hash_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 [::Hash] options The name and value
+ *     pairs. Omitted names are initialized as the default value
+ *   @option options :result
+ *     結果を格納するテーブル。
+ * @return [Groonga::Hash]
  */
 static VALUE
 rb_grn_hash_search (int argc, VALUE *argv, VALUE self)