rroonga 2.0.4 → 2.0.5

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

@@ -65,23 +65,20 @@ rb_grn_plugin_alloc (VALUE klass)
 }
 
 /*
- * call-seq:
- *   Groonga::Plugin.register(name, options=nil)
- *   Groonga::Plugin.register({:path => path, :context => nil})
- *
  * 既存のプラグインをデータベースに登録する。
  *
- * _name_ を指定した場合はその名前のプラグインを登録する。
- *
- * _path_ を指定した場合はそのパスのプラグインを登録する。
- *
- * _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
+ * @overload register(name, options=nil)
+ *   _name_ で指定した名前のプラグインを登録する。
+ *   @param [String] name 登録するプラグインの名前
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :context (Groonga::Context.default)
+ *     データベースを結びつけるコンテキスト。
+ * @overload register({:path => path, :context => nil})
+ *   @param hash [::Hash] _:path_ と _:context_ を指定したハッシュを指定する。
+ *   _:path_ で指定したパスのプラグインを登録する。
  *
- *   データベースを結びつけるコンテキスト。
+ *   _:context_ については _name_ を設定した時と同様。
  */
 static VALUE
 rb_grn_plugin_s_register (int argc, VALUE *argv, VALUE klass)

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

@@ -55,43 +55,29 @@ rb_grn_snippet_deconstruct (RbGrnSnippet *rb_grn_snippet,
 }
 
 /*
- * call-seq:
- *   Groonga::Snippet.new(options={})
+ * スニペットを作成する。
  *
- * スニペットを作成する。 _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を指定する。
- *
- * @option options :normalize The normalize
- *
- *   キーワード文字列・スニペット元の文字列を正規化するかど
- *   うか。省略した場合は +false+ で正規化しない。
- *
- * @option options :skip_leading_spaces (false) The skip_leading_spaces
- *
- *   先頭の空白を無視するかどうか。省略した場合は で無
- *   視しない。
- *
- * @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エスケープしない。
- *
- * @option options :default_open_tag ("") The default_open_tag
- *   デフォルトの開始タグ。省略した場合は""(空文字列)
- *
- * @option options :default_close_tag ("") The default_close_tag
- *   デフォルトの終了タグ。省略した場合は""(空文字列)
+ * @overload new(options={})
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :context (Groonga::Context.default)
+ *     スキーマ作成時に使用するGroonga::Contextを指定する。
+ *   @option options :normalize
+ *     キーワード文字列・スニペット元の文字列を正規化するかどうか。
+ *     省略した場合は +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エスケープしない。
+ *   @option options :default_open_tag ("")
+ *     デフォルトの開始タグ。省略した場合は""(空文字列)
+ *   @option options :default_close_tag ("")
+ *     デフォルトの終了タグ。省略した場合は""(空文字列)
  */
 static VALUE
 rb_grn_snippet_initialize (int argc, VALUE *argv, VALUE self)
@@ -165,22 +151,18 @@ rb_grn_snippet_initialize (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   snippet.add_keyword(keyword, options={})
- *
- * _keyword_ を追加する。 _options_ に指定可能な値は
- * 以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :open_tag (default_open_tag) The open_tag
+ * _keyword_ を追加する。
  *
- *   開始タグ。省略した場合はGroonga::Snippet.newで指定し
- *   た+:default_open_tag+。
- *
- * @option options :close_tag (:default_close_tag) The close_tag
- *
- *   終了タグ。省略した場合はGroonga::Snippet.newで指定し
- *   た+:default_close_tag+。
+ * @overload add_keyword(keyword, options={})
+ *   @param [String] keyword 追加するキーワード
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :open_tag (default_open_tag)
+ *     開始タグ。省略した場合はGroonga::Snippet.newで指定した
+ *     +:default_open_tag+ 。
+ *   @option options :close_tag (:default_close_tag)
+ *     終了タグ。省略した場合はGroonga::Snippet.newで指定した
+ *     +:default_close_tag+ 。
  */
 static VALUE
 rb_grn_snippet_add_keyword (int argc, VALUE *argv, VALUE self)
@@ -225,10 +207,11 @@ rb_grn_snippet_add_keyword (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   snippet.execute(string) -> スニペットの配列
- *
  * _string_ を走査し、スニペットを作成する。
+ *
+ * @overload execute(string)
+ *   @param [String] string 走査する文字列
+ * @return [::Array] 作成されたスニペットの配列
  */
 static VALUE
 rb_grn_snippet_execute (VALUE self, VALUE rb_string)

data/ext/groonga/rb-grn-table-cursor-key-support.c

@@ -31,10 +31,10 @@ VALUE rb_mGrnTableCursorKeySupport;
  */
 
 /*
- * call-seq:
- *   cursor.key -> 主キー
- *
  * カレントレコードの主キーを返す。
+ *
+ * @overload key
+ * @return [::Object] カレントレコードの主キー
  */
 static VALUE
 rb_grn_table_cursor_get_key (VALUE self)

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

@@ -125,10 +125,10 @@ rb_grn_table_cursor_order_by_to_flag (unsigned char table_type,
 }
 
 /*
- * call-seq:
- *   cursor.value -> 値
- *
  * カレントレコードの値を返す。
+ *
+ * @overload value
+ * @return [String] カレントレコードの値
  */
 static VALUE
 rb_grn_table_cursor_get_value (VALUE self)
@@ -151,10 +151,10 @@ rb_grn_table_cursor_get_value (VALUE self)
 }
 
 /*
- * call-seq:
- *   cursor.value = 値
- *
  * カレントレコードの値を設定する。既存の値は上書きされる。
+ *
+ * @overload value=(value)
+ *   @param [String] value カレントレコードに設定する値
  */
 static VALUE
 rb_grn_table_cursor_set_value (VALUE self, VALUE value)
@@ -241,6 +241,8 @@ rb_grn_table_cursor_each (VALUE self)
     grn_ctx *context;
     grn_table_cursor *cursor;
 
+    RETURN_ENUMERATOR(self, 0, NULL);
+
     rb_grn_table_cursor_deconstruct(SELF(self), &cursor, &context,
 				    NULL, NULL, NULL, NULL);
 

data/ext/groonga/rb-grn-table-key-support.c

@@ -300,14 +300,12 @@ rb_grn_table_key_support_delete (VALUE self, VALUE rb_id_or_key)
 }
 
 /*
- * Document-method: []
- *
- * call-seq:
- *   table[key] -> Groonga::Record
- *
  * _table_ の _key_ に対応するGroonga::Recordを返す。
  *
  * 0.9.0から値ではなくGroonga::Recordを返すようになった。
+ *
+ * @overload [](key)
+ * @return [Groonga::Record]
  */
 static VALUE
 rb_grn_table_key_support_array_reference (VALUE self, VALUE rb_key)
@@ -352,15 +350,14 @@ set_value (VALUE args, SetValueData *data)
 }
 
 /*
- * Document-method: []=
- *
- * call-seq:
- *   table[key] = {:column_name => value, ...}
- *
  * _table_ の _key_ に対応するカラム _column_name_ の値を設定する。
  * _key_ に対応するレコードがない場合は新しく作成される。
  *
  * 0.9.0から値ではなくカラムの値を設定するようになった。
+ *
+ * @overload []=(key, values)
+ *   @param [::Hash] values
+ *     keyに対応させるカラムの値。{ :column_name => value, ... }の形で設定する。
  */
 static VALUE
 rb_grn_table_key_support_array_set (VALUE self, VALUE rb_key, VALUE rb_values)
@@ -393,12 +390,11 @@ rb_grn_table_key_support_array_set (VALUE self, VALUE rb_key, VALUE rb_values)
 }
 
 /*
- * call-seq:
- *   table.set_column_value(key, name, value)
- *   table.set_column_value(id, name, value, :id => true)
- *
  * _table_ の _key_ に対応するカラム _name_ の値を設定する。
  * _key_ に対応するレコードがない場合は新しく作成される。
+ *
+ * @overload set_column_value(key, name, value)
+ * @overload set_column_value(id, name, value, {:id=>true})
  */
 static VALUE
 rb_grn_table_key_support_set_column_value (int argc, VALUE *argv, VALUE self)
@@ -433,13 +429,12 @@ rb_grn_table_key_support_set_column_value (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   table.column_value(key, name)
- *   table.column_value(id, name, :id => true)
- *
  * _table_ の _key_ に対応するカラム _name_ の値を設定する。
  *
  * TODO: _key_ に対応するレコードがない場合は例外？
+ *
+ * @overload column_value(key, name)
+ * @overload column_value(id, name, :id=>true)
  */
 static VALUE
 rb_grn_table_key_support_get_column_value (int argc, VALUE *argv, VALUE self)
@@ -492,11 +487,11 @@ rb_grn_table_key_support_get_value_by_key (VALUE self, VALUE rb_key)
 }
 
 /*
- * call-seq:
- *   table.value(id, :id => true) -> 値
- *   table.value(key) -> 値
- *
  * _table_ の _id_ または _key_ に対応する値を返す。
+ *
+ * @overload value(id, :id=>true)
+ * @overload value(key)
+ * @return _id_ もしくは _key_ に対応する値
  */
 static VALUE
 rb_grn_table_key_support_get_value (int argc, VALUE *argv, VALUE self)
@@ -562,12 +557,11 @@ rb_grn_table_key_support_set_value_by_key (VALUE self,
 }
 
 /*
- * call-seq:
- *   table.set_value(id, value, :id => true)
- *   table.set_value(key, value)
- *
  * _table_ の _id_ または _key_ に対応する値を _value_ に設定する。
  * 既存の値は上書きされる。
+ *
+ * @overload set_value(id, value, :id=>true)
+ * @overload set_value(key, value)
  */
 static VALUE
 rb_grn_table_key_support_set_value (int argc, VALUE *argv, VALUE self)
@@ -623,9 +617,6 @@ rb_grn_table_key_support_get_default_tokenizer (VALUE self)
 }
 
 /*
- * call-seq:
- *   table.default_tokenizer = トークナイザ
- *
  * Groonga::IndexColumnで使用するトークナイザを設定する。
  *
  * @example
@@ -643,6 +634,8 @@ rb_grn_table_key_support_get_default_tokenizer (VALUE self)
  *
  *   # MeCabを使用
  *   table.default_tokenizer = "TokenMecab"
+ *
+ * @overload default_tokenizer=(tokenizer)
  */
 static VALUE
 rb_grn_table_key_support_set_default_tokenizer (VALUE self, VALUE rb_tokenizer)

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

@@ -224,36 +224,31 @@ rb_grn_table_inspect (VALUE self)
 }
 
 /*
- * call-seq:
- *   table.define_column(name, value_type, options={}) ->
- *     Groonga::FixSizeColumnかGroonga::VariableSizeColumn
- *
  * テーブルに名前が _name_ で型が _value_type_ のカラムを定義
  * し、新しく定義されたカラムを返す。
  *
- * _options_ に指定可能な値は以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :path The path
- *   カラムを保存するパス。
- *
- * @option options :persistent (永続カラム) The persistent
- *   +true+ を指定すると永続カラムとなる。省略した場合は永
- *   続カラムとなる。 +:path+ を省略した場合は自動的にパスが
- *   付加される。
- *
- * @option options :type (:scalar) The type
- *   カラムの値の格納方法について指定する。省略した場合は、
- *   +:scalar+ になる。
- *
- *   [+:scalar+] スカラ値(単独の値)を格納する。
- *   [+:vector+] 値の配列を格納する。
- *
- * @param options :compress The compress
- *   値の圧縮方法を指定する。省略した場合は、圧縮しない。
- *
- *   [+:zlib+] 値をzlib圧縮して格納する。
- *   [+:lzo+] 値をlzo圧縮して格納する。
+ * @overload define_column(name, value_type, options={})
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :path
+ *     カラムを保存するパス。
+ *   @option options :persistent (永続カラム)
+ *     +true+ を指定すると永続カラムとなる。省略した場合は永
+ *     続カラムとなる。 +:path+ を省略した場合は自動的にパスが
+ *     付加される。
+ *   @option options :type (:scalar)
+ *     カラムの値の格納方法について指定する。省略した場合は、
+ *     +:scalar+ になる。
+ *
+ *     [+:scalar+] スカラ値(単独の値)を格納する。
+ *     [+:vector+] 値の配列を格納する。
+ *   @option options :compress
+ *     値の圧縮方法を指定する。省略した場合は、圧縮しない。
+ *
+ *     [+:zlib+] 値をzlib圧縮して格納する。
+ *     [+:lzo+] 値をlzo圧縮して格納する。
+ *
+ * @return [Groonga::FixSizeColumn or Groonga::VariableSizeColumn]
  */
 static VALUE
 rb_grn_table_define_column (int argc, VALUE *argv, VALUE self)
@@ -364,37 +359,30 @@ n_gram_tokenizer_p(grn_ctx *context, grn_obj *tokenizer)
 }
 
 /*
- * call-seq:
- *   table.define_index_column(name, value_type, options={}) -> Groonga::IndexColumn
- *
  * テーブルに名前が _name_ で型が _value_type_ のインデックスカ
  * ラムを定義し、新しく定義されたカラムを返す。
  *
- * _options_ に指定可能な値は以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :path The path
- *   カラムを保存するパス。
- *
- * @option options :persistent (永続カラム) The persistent
- *   +true+ を指定すると永続カラムとなる。省略した場合は永
- *   続カラムとなる。 +:path+ を省略した場合は自動的にパスが
- *   付加される。
- *
- * @option options :with_section The with_section
- *   転置索引にsection(段落情報)を合わせて格納する。
- *
- * @option options :with_weight  The with_weight
- *   転置索引にweight情報を合わせて格納する。
- *
- * @option options :with_position The with_position
- *   転置索引に出現位置情報を合わせて格納する。
- *
- * @option options :source The source
- *  インデックス対象となるカラムを指定する。 +:sources+ との併用はできない。
- *
- * @option options :sources The sources
- *  インデックス対象となる複数のカラムを指定する。 +:source+ との併用はできない。
+ * @overload define_index_column(name, value_type, options={})
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :path
+ *     カラムを保存するパス。
+ *   @option options :persistent (永続カラム)
+ *     +true+ を指定すると永続カラムとなる。省略した場合は永
+ *     続カラムとなる。 +:path+ を省略した場合は自動的にパスが
+ *     付加される。
+ *   @option options :with_section
+ *     転置索引にsection(段落情報)を合わせて格納する。
+ *   @option options :with_weight
+ *     転置索引にweight情報を合わせて格納する。
+ *   @option options :with_position
+ *     転置索引に出現位置情報を合わせて格納する。
+ *   @option options :source
+ *    インデックス対象となるカラムを指定する。 +:sources+ との併用はできない。
+ *   @option options :sources
+ *    インデックス対象となる複数のカラムを指定する。 +:source+ との併用はできない。
+ *
+ * @return [Groonga::IndexColumn]
  */
 static VALUE
 rb_grn_table_define_index_column (int argc, VALUE *argv, VALUE self)
@@ -619,6 +607,7 @@ rb_grn_table_get_columns (int argc, VALUE *argv, VALUE self)
     VALUE rb_name, rb_columns;
     char *name = NULL;
     unsigned name_size = 0;
+    VALUE exception;
 
     rb_grn_table_deconstruct(SELF(self), &table, &context,
 			     NULL, NULL,
@@ -655,6 +644,13 @@ rb_grn_table_get_columns (int argc, VALUE *argv, VALUE self)
 	grn_table_cursor_get_key(context, cursor, &key);
 	column_id = key;
 	column = grn_ctx_at(context, *column_id);
+	exception = rb_grn_context_to_exception(context, self);
+	if (!NIL_P(exception)) {
+	    grn_table_cursor_close(context, cursor);
+	    grn_obj_unlink(context, columns);
+	    rb_exc_raise(exception);
+	}
+
 	rb_column = GRNOBJECT2RVAL(Qnil, context, column, GRN_FALSE);
 	rb_ary_push(rb_columns, rb_column);
     }
@@ -762,54 +758,74 @@ rb_grn_table_open_grn_cursor (int argc, VALUE *argv, VALUE self,
 }
 
 /*
- * call-seq:
- *   table.open_cursor(options={}) -> Groonga::TableCursor
- *   table.open_cursor(options={}) {|cursor| }
- *
  * カーソルを生成して返す。ブロックを指定すると、そのブロッ
  * クに生成したカーソルが渡され、ブロックを抜けると自動的に
  * カーソルが破棄される。
  *
- * _options_に指定可能な値は以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :min The min
- *  キーの下限
- *
- * @option  options :max The max
- *  キーの上限
- *
- * @option options :offset The offset
- *   該当する範囲のレコードのうち、(0ベースで) _:offset_ 番目
- *   からレコードを取り出す。
- *
- * @option options :limit The limit
- *   該当する範囲のレコードのうち、 _:limit_ 件のみを取り出す。
- *   省略された場合または-1が指定された場合は、全件が指定され
- *   たものとみなす。
- *
- * @option options :order (asc) The order
- *   +:asc+ または +:ascending+ を指定すると昇順にレコードを取
- *   り出す。（デフォルト）
- *
- *   +:desc+ または +:descending+ を指定すると降順にレコードを
- *   取り出す。
- *
- * @option options :order_by The order_by
- *   +:id+ を指定するとID順にレコードを取り出す。（Arrayと
- *   Hashのデフォルト）
- *
- *   +:key+ 指定するとキー順にレコードを取り出す。ただし、
- *   Groonga::PatriciaTrieにしか使えない。（PatriciaTrieのデ
- *   フォルト）
- *
- * @option options :greater_than The greater_than
- *   +true+ を指定すると +:min+ で指定した値に一致した [ +key+ ] を
- *   範囲に含まない。
- *
- * @option options :less_than The less_than
- *   +true+ を指定すると +:max+ で指定した値に一致した [ +key+ ] を
- *   範囲に含まない。
+ * @overload open_cursor(options={})
+ *   @return [Groonga::TableCursor]
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :min
+ *    キーの下限
+ *   @option options :max
+ *    キーの上限
+ *   @option options :offset
+ *     該当する範囲のレコードのうち、(0ベースで) _:offset_ 番目
+ *     からレコードを取り出す。
+ *   @option options :limit
+ *     該当する範囲のレコードのうち、 _:limit_ 件のみを取り出す。
+ *     省略された場合または-1が指定された場合は、全件が指定され
+ *     たものとみなす。
+ *   @option options :order (asc)
+ *     +:asc+ または +:ascending+ を指定すると昇順にレコードを取
+ *     り出す。（デフォルト）
+ *     +:desc+ または +:descending+ を指定すると降順にレコードを
+ *     取り出す。
+ *   @option options :order_by
+ *     +:id+ を指定するとID順にレコードを取り出す。（Arrayと
+ *     Hashのデフォルト）
+ *     +:key+ 指定するとキー順にレコードを取り出す。ただし、
+ *     Groonga::PatriciaTrieにしか使えない。（PatriciaTrieのデ
+ *     フォルト）
+ *   @option options :greater_than The greater_than
+ *     +true+ を指定すると +:min+ で指定した値に一致した [ +key+ ] を
+ *     範囲に含まない。
+ *   @option options :less_than
+ *     +true+ を指定すると +:max+ で指定した値に一致した [ +key+ ] を
+ *     範囲に含まない。
+ * @overload open_cursor(options={})
+ *   @yield [cursor]
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :min
+ *    キーの下限
+ *   @option options :max
+ *    キーの上限
+ *   @option options :offset
+ *     該当する範囲のレコードのうち、(0ベースで) _:offset_ 番目
+ *     からレコードを取り出す。
+ *   @option options :limit
+ *     該当する範囲のレコードのうち、 _:limit_ 件のみを取り出す。
+ *     省略された場合または-1が指定された場合は、全件が指定され
+ *     たものとみなす。
+ *   @option options :order (asc)
+ *     +:asc+ または +:ascending+ を指定すると昇順にレコードを取
+ *     り出す。（デフォルト）
+ *     +:desc+ または +:descending+ を指定すると降順にレコードを
+ *     取り出す。
+ *   @option options :order_by
+ *     +:id+ を指定するとID順にレコードを取り出す。（Arrayと
+ *     Hashのデフォルト）
+ *     +:key+ 指定するとキー順にレコードを取り出す。ただし、
+ *     Groonga::PatriciaTrieにしか使えない。（PatriciaTrieのデ
+ *     フォルト）
+ *   @option options :greater_than The greater_than
+ *     +true+ を指定すると +:min+ で指定した値に一致した [ +key+ ] を
+ *     範囲に含まない。
+ *   @option options :less_than
+ *     +true+ を指定すると +:max+ で指定した値に一致した [ +key+ ] を
+ *     範囲に含まない。
  */
 static VALUE
 rb_grn_table_open_cursor (int argc, VALUE *argv, VALUE self)
@@ -853,10 +869,10 @@ rb_grn_table_get_records (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   table.size -> レコード数
- *
  * テーブルに登録されているレコード数を返す。
+ *
+ * @overload size
+ * @return [Integer] レコード数
  */
 static VALUE
 rb_grn_table_get_size (VALUE self)
@@ -937,6 +953,8 @@ rb_grn_table_each (int argc, VALUE *argv, VALUE self)
     VALUE rb_cursor;
     grn_id id;
 
+    RETURN_ENUMERATOR(self, argc, argv);
+
     cursor = rb_grn_table_open_grn_cursor(argc, argv, self, &context);
     rb_cursor = GRNTABLECURSOR2RVAL(Qnil, context, cursor);
     rb_table = SELF(self);
@@ -977,10 +995,7 @@ rb_grn_table_delete (VALUE self, VALUE rb_id)
 }
 
 /*
- * call-seq:
- *   table.sort(keys, options={}) -> Groonga::Recordの配列
- *
- * テーブルに登録されているレコードを_keys_で指定されたルー
+ * テーブルに登録されているレコードを _keys_ で指定されたルー
  * ルに従ってソートしたレコードの配列を返す。
  *
  * _order_ には +:asc+ ,  +:ascending+ , +:desc+ , +:descending+ の
@@ -1022,16 +1037,17 @@ rb_grn_table_delete (VALUE self, VALUE rb_id)
  * </pre>
  * =:
  *
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :offset The offset
- *   ソートされたレコードのうち、(0ベースで) _:offset_ 番目
- *   からレコードを取り出す。
- *
- * @option options :limit The limit
- *   ソートされたレコードのうち、 _:limit_ 件のみを取り出す。
- *   省略された場合または-1が指定された場合は、全件が指定され
- *   たものとみなす。
+ * @overload sort(keys, options={})
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :offset
+ *     ソートされたレコードのうち、(0ベースで) _:offset_ 番目
+ *     からレコードを取り出す。
+ *   @option options :limit
+ *     ソートされたレコードのうち、 _:limit_ 件のみを取り出す。
+ *     省略された場合または-1が指定された場合は、全件が指定され
+ *     たものとみなす。
+ * @return [::Array<Groonga::Record>]
  */
 static VALUE
 rb_grn_table_sort (int argc, VALUE *argv, VALUE self)
@@ -1550,30 +1566,32 @@ rb_grn_table_unlock_ensure (VALUE self)
 }
 
 /*
- * Document-method: lock
- *
- * call-seq:
- *   table.lock(options={})
- *   table.lock(options={}) {}
- *
  * _table_ をロックする。ロックに失敗した場合は
  * Groonga::ResourceDeadlockAvoided例外が発生する。
  *
  * ブロックを指定した場合はブロックを抜けたときにunlockする。
  *
- * 利用可能なオプションは以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :timeout The timeout
- *
- *   ロックを獲得できなかった場合は _:timeout_ 秒間ロックの獲
- *   得を試みる。 _:timeout_ 秒以内にロックを獲得できなかった
- *   場合は例外が発生する。
- *
- * @option options :id The id
- *
- *   _:id_ で指定したレコードをロックする。（注: groonga側が
- *   未実装のため、現在は無視される）
+ * @overload lock(options={})
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :timeout
+ *     ロックを獲得できなかった場合は _:timeout_ 秒間ロックの獲
+ *     得を試みる。 _:timeout_ 秒以内にロックを獲得できなかった
+ *     場合は例外が発生する。
+ *   @option options :id
+ *     _:id_ で指定したレコードをロックする。（注: groonga側が
+ *     未実装のため、現在は無視される）
+ * @overload lock(options={})
+ *   @yield ブロックを抜けたときにunlockする。
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :timeout
+ *     ロックを獲得できなかった場合は _:timeout_ 秒間ロックの獲
+ *     得を試みる。 _:timeout_ 秒以内にロックを獲得できなかった
+ *     場合は例外が発生する。
+ *   @option options :id
+ *     _:id_ で指定したレコードをロックする。（注: groonga側が
+ *     未実装のため、現在は無視される）
  */
 static VALUE
 rb_grn_table_lock (int argc, VALUE *argv, VALUE self)
@@ -1615,22 +1633,16 @@ rb_grn_table_lock (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * Document-method: clear_lock
- *
- * call-seq:
- *   table.clear_lock(options={})
- *
  * _table_ のロックを強制的に解除する。
  *
- * 利用可能なオプションは以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :id The id
- *
- *   _:id_ で指定したレコードのロックを強制的に解除する。
- *   （注: groonga側が未実装のため、現在は無視される。実装さ
- *   れるのではないかと思っているが、実装されないかもしれな
- *   い。）
+ * @overload clear_lock(options={})
+ *   @param [::Hash] options The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :id
+ *     _:id_ で指定したレコードのロックを強制的に解除する。
+ *     （注: groonga側が未実装のため、現在は無視される。実装さ
+ *     れるのではないかと思っているが、実装されないかもしれな
+ *     い。）
  */
 static VALUE
 rb_grn_table_clear_lock (int argc, VALUE *argv, VALUE self)
@@ -1660,22 +1672,16 @@ rb_grn_table_clear_lock (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * Document-method: locked?
- *
- * call-seq:
- *   table.locked?(options={})
- *
  * _table_ がロックされていれば +true+ を返す。
  *
- * 利用可能なオプションは以下の通り。
- * @param options [options] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :id The id
- *
- *   _:id_ で指定したレコードがロックされていれば +true+ を返す。
- *   （注: groonga側が未実装のため、現在は無視される。実装さ
- *   れるのではないかと思っているが、実装されないかもしれな
- *   い。）
+ * @overload locked?(options={})
+ *   @param [options] options The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :id
+ *     _:id_ で指定したレコードがロックされていれば +true+ を返す。
+ *     （注: groonga側が未実装のため、現在は無視される。実装さ
+ *     れるのではないかと思っているが、実装されないかもしれな
+ *     い。）
  */
 static VALUE
 rb_grn_table_is_locked (int argc, VALUE *argv, VALUE self)
@@ -1703,11 +1709,6 @@ rb_grn_table_is_locked (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   table.select(options) {|record| ...} -> Groonga::Hash
- *   table.select(query, options) -> Groonga::Hash
- *   table.select(expression, options) -> Groonga::Hash
- *
  * _table_ からブロックまたは文字列で指定した条件にマッチする
  * レコードを返す。返されたテーブルには +expression+ という特
  * 異メソッドがあり、指定した条件を表している
@@ -1741,108 +1742,185 @@ rb_grn_table_is_locked (int argc, VALUE *argv, VALUE self)
  * ---
  * </pre>
  *
- * _query_ には「[カラム名]:[演算子][値]」という書式で条件を
- * 指定する。演算子は以下の通り。
- *
- * - なし := [カラム値] == [値]
- * - @!@ := [カラム値] != [値]
- * - @<@ := [カラム値] < [値]
- * - @>@ := [カラム値] > [値]
- * - @<=@ := [カラム値] <= [値]
- * - @>=@ := [カラム値] >= [値]
- * - @@@ := [カラム値]が[値]を含んでいるかどうか
- *
- * 例:
- *
- * <pre>
- * !!!ruby
- * "name:daijiro" # "name"カラムの値が"daijiro"のレコードにマッチ
- * "description:@groonga" # "description"カラムが
- *                        # "groonga"を含んでいるレコードにマッチ
- * </pre>
- *
- * _expression_ には既に作成済みのGroonga::Expressionを渡す
- *
- * ブロックで条件を指定する場合は
- * Groonga::RecordExpressionBuilderを参照。
- *
- * Ruby1.9以降では、ブロックで条件を指定する際に
- * Groonga::ColumnExpressionBuilderの他に"!="も使用可能。
- *
- * 例:
- *
- * <pre>
- * !!!ruby
- * comments = Groonga::Array.create(:name => "Comments")
- * comments.define_column("content", "Text")
- * comments.add(:content => "Hello Good-bye!")
- * comments.add(:content => "Hello World")
- * comments.add(:content => "test")
- * result = comments.select do |record|
- *   record.content != "test"
- * end
- * p result.collect {|record| record.content}
- *   # => ["Hello Good-bye!", "Hello World"]
- * </pre>
- *
- * _options_ に指定可能な値は以下の通り。
- * @param options [::Hash] 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 :operator (Groonga::Operator::OR) The operator
- *
- *   マッチしたレコードをどのように扱うか。指定可能な値は以
- *   下の通り。省略した場合はGroonga::Operator::OR。
- *
- *   [Groonga::Operator::OR] マッチしたレコードを追加。すで
- *                           にレコードが追加されている場合
- *                           は何もしない。
- *   [Groonga::Operator::AND] マッチしたレコードのスコアを増
- *                            加。マッチしなかったレコード
- *                            を削除。
- *   [Groonga::Operator::BUT] マッチしたレコードを削除。
- *   [Groonga::Operator::ADJUST] マッチしたレコードのスコア
- *                               を増加。
- *
- * @option options :result The result
- *
- *   検索結果を格納するテーブル。マッチしたレコードが追加さ
- *   れていく。省略した場合は新しくテーブルを作成して返す。
- *
- * @option options :name The name
- *
- *   条件の名前。省略した場合は名前を付けない。
- *
- * @option options :syntax The syntax
- *
- *   _query_ の構文。省略した場合は +:query+ 。
- *
- *   参考: Groonga::Expression#parse.
- *
- * @option options :allow_pragma The allow_pragma
- *
- *   query構文時にプラグマを利用するかどうか。省略した場合は
- *   利用する。
- *
- *   参考: Groonga::Expression#parse.
- *
- * @option options :allow_column The allow_column
- *
- *   query構文時にカラム指定を利用するかどうか。省略した場合
- *   は利用する。
- *
- *   参考: Groonga::Expression#parse.
- *
- * @option options :allow_update The allow_update
- *
- *   script構文時に更新操作を利用するかどうか。省略した場合
- *   は利用する。
- *
- *   参考: Groonga::Expression#parse.
+ * @overload select(options)
+ *   @yield [record] ブロックで条件を指定する場合は
+ *     Groonga::RecordExpressionBuilderを参照。
+ *
+ *     Ruby1.9以降では、ブロックで条件を指定する際に
+ *     Groonga::ColumnExpressionBuilderの他に"!="も使用可能。
+ *
+ *     例:
+ *
+ *     <pre>
+ *     !!!ruby
+ *     comments = Groonga::Array.create(:name => "Comments")
+ *     comments.define_column("content", "Text")
+ *     comments.add(:content => "Hello Good-bye!")
+ *     comments.add(:content => "Hello World")
+ *     comments.add(:content => "test")
+ *     result = comments.select do |record|
+ *       record.content != "test"
+ *     end
+ *     p result.collect {|record| record.content}
+ *       # => ["Hello Good-bye!", "Hello World"]
+ *     </pre>
+ *
+ *   @param options [::Hash] 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 :operator (Groonga::Operator::OR)
+ *     マッチしたレコードをどのように扱うか。指定可能な値は以
+ *     下の通り。省略した場合はGroonga::Operator::OR。
+ *
+ *     [Groonga::Operator::OR] マッチしたレコードを追加。すで
+ *                             にレコードが追加されている場合
+ *                             は何もしない。
+ *     [Groonga::Operator::AND] マッチしたレコードのスコアを増
+ *                              加。マッチしなかったレコード
+ *                              を削除。
+ *     [Groonga::Operator::BUT] マッチしたレコードを削除。
+ *     [Groonga::Operator::ADJUST] マッチしたレコードのスコア
+ *                                 を増加。
+ *
+ *   @option options :result
+ *     検索結果を格納するテーブル。マッチしたレコードが追加さ
+ *     れていく。省略した場合は新しくテーブルを作成して返す。
+ *   @option options :name
+ *     条件の名前。省略した場合は名前を付けない。
+ *   @option options :syntax
+ *     _query_ の構文。省略した場合は +:query+ 。
+ *
+ *     参考: Groonga::Expression#parse.
+ *   @option options :allow_pragma
+ *     query構文時にプラグマを利用するかどうか。省略した場合は
+ *     利用する。
+ *
+ *     参考: Groonga::Expression#parse.
+ *   @option options :allow_column
+ *     query構文時にカラム指定を利用するかどうか。省略した場合
+ *     は利用する。
+ *
+ *     参考: Groonga::Expression#parse.
+ *   @option options :allow_update
+ *     script構文時に更新操作を利用するかどうか。省略した場合
+ *     は利用する。
+ *
+ *     参考: Groonga::Expression#parse.
+ *
+ * @overload select(query, options)
+ *   _query_ には「[カラム名]:[演算子][値]」という書式で条件を
+ *   指定する。演算子は以下の通り。
+ *
+ *   - なし := [カラム値] == [値]
+ *   - @!@ := [カラム値] != [値]
+ *   - @<@ := [カラム値] < [値]
+ *   - @>@ := [カラム値] > [値]
+ *   - @<=@ := [カラム値] <= [値]
+ *   - @>=@ := [カラム値] >= [値]
+ *   - @@@ := [カラム値]が[値]を含んでいるかどうか
+ *
+ *   例:
+ *
+ *   <pre>
+ *   !!!ruby
+ *   "name:daijiro" # "name"カラムの値が"daijiro"のレコードにマッチ
+ *   "description:@groonga" # "description"カラムが
+ *                          # "groonga"を含んでいるレコードにマッチ
+ *   </pre>
+ *
+ *   @param options [::Hash] 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 :operator (Groonga::Operator::OR)
+ *     マッチしたレコードをどのように扱うか。指定可能な値は以
+ *     下の通り。省略した場合はGroonga::Operator::OR。
+ *
+ *     [Groonga::Operator::OR] マッチしたレコードを追加。すで
+ *                             にレコードが追加されている場合
+ *                             は何もしない。
+ *     [Groonga::Operator::AND] マッチしたレコードのスコアを増
+ *                              加。マッチしなかったレコード
+ *                              を削除。
+ *     [Groonga::Operator::BUT] マッチしたレコードを削除。
+ *     [Groonga::Operator::ADJUST] マッチしたレコードのスコア
+ *                                 を増加。
+ *
+ *   @option options :result
+ *     検索結果を格納するテーブル。マッチしたレコードが追加さ
+ *     れていく。省略した場合は新しくテーブルを作成して返す。
+ *   @option options :name
+ *     条件の名前。省略した場合は名前を付けない。
+ *   @option options :syntax
+ *     _query_ の構文。省略した場合は +:query+ 。
+ *
+ *     参考: Groonga::Expression#parse.
+ *   @option options :allow_pragma
+ *     query構文時にプラグマを利用するかどうか。省略した場合は
+ *     利用する。
+ *
+ *     参考: Groonga::Expression#parse.
+ *   @option options :allow_column
+ *     query構文時にカラム指定を利用するかどうか。省略した場合
+ *     は利用する。
+ *
+ *     参考: Groonga::Expression#parse.
+ *   @option options :allow_update
+ *     script構文時に更新操作を利用するかどうか。省略した場合
+ *     は利用する。
+ *
+ *     参考: Groonga::Expression#parse.
+ *
+ * @overload select(expression, options)
+ *   _expression_ には既に作成済みのGroonga::Expressionを渡す
+ *
+ *   @param options [::Hash] 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 :operator (Groonga::Operator::OR)
+ *     マッチしたレコードをどのように扱うか。指定可能な値は以
+ *     下の通り。省略した場合はGroonga::Operator::OR。
+ *
+ *     [Groonga::Operator::OR] マッチしたレコードを追加。すで
+ *                             にレコードが追加されている場合
+ *                             は何もしない。
+ *     [Groonga::Operator::AND] マッチしたレコードのスコアを増
+ *                              加。マッチしなかったレコード
+ *                              を削除。
+ *     [Groonga::Operator::BUT] マッチしたレコードを削除。
+ *     [Groonga::Operator::ADJUST] マッチしたレコードのスコア
+ *                                 を増加。
+ *
+ *   @option options :result
+ *     検索結果を格納するテーブル。マッチしたレコードが追加さ
+ *     れていく。省略した場合は新しくテーブルを作成して返す。
+ *   @option options :name
+ *     条件の名前。省略した場合は名前を付けない。
+ *   @option options :syntax
+ *     _query_ の構文。省略した場合は +:query+ 。
+ *
+ *     参考: Groonga::Expression#parse.
+ *   @option options :allow_pragma
+ *     query構文時にプラグマを利用するかどうか。省略した場合は
+ *     利用する。
+ *
+ *     参考: Groonga::Expression#parse.
+ *   @option options :allow_column
+ *     query構文時にカラム指定を利用するかどうか。省略した場合
+ *     は利用する。
+ *
+ *     参考: Groonga::Expression#parse.
+ *   @option options :allow_update
+ *     script構文時に更新操作を利用するかどうか。省略した場合
+ *     は利用する。
+ *
+ *     参考: Groonga::Expression#parse.
+ * @return [Groonga::Hash]
  */
 static VALUE
 rb_grn_table_select (int argc, VALUE *argv, VALUE self)
@@ -2065,18 +2143,16 @@ rb_grn_table_exist_p (VALUE self, VALUE id)
 }
 
 /*
- * Document-method: defrag
- *
- * call-seq:
- *   table.defrag(options={}) -> n_segments
- *
  * Defrags all variable size columns in the table.
  *
+ * @overload defrag(options={})
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @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.
  * @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.
  * @since 1.3.0
  */
 static VALUE