rroonga 2.0.4-x86-mingw32 → 2.0.7-x86-mingw32

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

@@ -19,7 +19,7 @@
 
 #include "rb-grn.h"
 
-grn_rc grn_obj_cast(grn_ctx *ctx, grn_obj *src, grn_obj *dest, int addp);
+grn_rc grn_obj_cast(grn_ctx *ctx, grn_obj *src, grn_obj *dest, grn_bool addp);
 
 #define SELF(object) ((RbGrnTableKeySupport *)DATA_PTR(object))
 
@@ -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
@@ -143,12 +62,12 @@ VALUE rb_cGrnPatriciaTrie;
  *   #（キーの種類を表すオブジェクトは文字列で指定。）
  *   Groonga::PatriciaTrie.create(:key_type => "ShortText")
  *
- *   #キーとして<tt>Bookmarks</tt>テーブルのレコードを使用す
+ *   #キーとしてBookmarksテーブルのレコードを使用す
  *   #る無名一時テーブルを生成する。
  *   bookmarks = Groonga::PatriciaTrie.create(:name => "Bookmarks")
  *   Groonga::PatriciaTrie.create(:key_type => bookmarks)
  *
- *   #キーとして<tt>Bookmarks</tt>テーブルのレコードを使用す
+ *   #キーとしてBookmarksテーブルのレコードを使用す
  *   #る無名一時テーブルを生成する。
  *   #（テーブルは文字列で指定。）
  *   Groonga::PatriciaTrie.create(:name => "Bookmarks")
@@ -162,6 +81,70 @@ VALUE rb_cGrnPatriciaTrie;
  *                                        :default_tokenizer => "TokenBigram")
  *   terms.define_index_column("content", bookmarks,
  *                             :source => "Bookmarks.comment")
+ *
+ * @overload create(options={})
+ *   @return [Groonga::PatriciaTrie]
+ *   @!macro [new] patricia_trie.create.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
+ *       テーブルの名前。名前をつけると、 {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} を定義する場合は
+ *       @"TokenBigram"@ などを指定する必要がある。
+ *     @option options :sub_records
+ *       +true+ を指定すると {#group} でグループ化したときに、
+ *       {Groonga::Record#n_sub_records} でグループに含まれるレコー
+ *       ドの件数を取得できる。
+ *   @!macro patricia_trie.create.options
+ * @overload create(options={})
+ *   @yield [table]
+ *   @!macro patricia_trie.create.options
  */
 static VALUE
 rb_grn_patricia_trie_s_create (int argc, VALUE *argv, VALUE klass)
@@ -243,43 +226,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 +243,29 @@ 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)
@@ -339,29 +316,14 @@ rb_grn_patricia_trie_search (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   patricia_trie.scan(string) -> Array
- *   patricia_trie.scan(string) {|record, word, start, length| ... }
- *
  * _string_ を走査し、 _patricia_trie_ 内に格納されているキーに
  * マッチした部分文字列の情報をブロックに渡す。複数のキーが
  * マッチする場合は最長一致するキーを優先する。
  *
- * [_record_]
- *   マッチしたキーのGroonga::Record。
- *
- * [_word_]
- *   マッチした部分文字列。
- *
- * [_start_]
- *   _string_ 内での _word_ の出現位置。（バイト単位）
- *
- * [_length_]
- *   _word_ の長さ。（バイト単位）
- *
  * ブロックを指定しない場合は、マッチした部分文字列の情報を
  * まとめて配列として返す。
  *
+ * @example
  *   words = Groonga::PatriciaTrie.create(:key_type => "ShortText",
  *                                        :key_normalize => true)
  *   words.add("リンク")
@@ -382,6 +344,15 @@ rb_grn_patricia_trie_search (int argc, VALUE *argv, VALUE self)
  *     # -> [[muteki, "muTEki", 0, 6],
  *     #     [adventure_of_link, "リンクの冒険", 7, 18],
  *     #     [gaxtu, "ガッ", 42, 6]]
+ *
+ * @overload scan(string)
+ *   @return [Array]
+ * @overload scan(string)
+ *   @yield [record, word, start, length]
+ *   @yieldparam record マッチしたキーの {Groonga::Record} 。
+ *   @yieldparam word マッチした部分文字列。
+ *   @yieldparam start _string_ 内での _word_ の出現位置。（バイト単位）
+ *   @yieldparam length _word_ の長さ。（バイト単位）
  */
 static VALUE
 rb_grn_patricia_trie_scan (VALUE self, VALUE rb_string)
@@ -445,13 +416,12 @@ rb_grn_patricia_trie_scan (VALUE self, VALUE rb_string)
 }
 
 /*
- * call-seq:
- *   patricia_trie.prefix_search(prefix) -> Groonga::Hash
- *
  * キーが _prefix_ に前方一致するレコードのIDがキーに入っている
- * Groonga::Hashを返す。マッチするレコードがない場合は空の
- * Groonga::Hashが返る。
+ * {Groonga::Hash} を返す。マッチするレコードがない場合は空の
+ * {Groonga::Hash} が返る。
  *
+ * @overload prefix_search(prefix)
+ *   @return [Groonga::Hash]
  */
 static VALUE
 rb_grn_patricia_trie_prefix_search (VALUE self, VALUE rb_prefix)
@@ -483,11 +453,10 @@ rb_grn_patricia_trie_prefix_search (VALUE self, VALUE rb_prefix)
 }
 
 /*
- * call-seq:
- *   table.register_key_with_sis? -> true/false
- *
  * キーを登録するときに文字列の全suffixも一緒に登録する場合
  * は +true+ 、登録しない場合は +false+ を返す。
+ *
+ * @overload register_key_with_sis?
  */
 static VALUE
 rb_grn_patricia_trie_register_key_with_sis_p (VALUE self)
@@ -598,57 +567,44 @@ 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]
+ *   @!macro [new] patricia-trie.open_prefix_cursor.options
+ *     @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+ ] を
+ *       範囲に含まない。
+ *   @!macro patricia-trie.open_prefix_cursor.options
+ * @overload open_prefix_cursor(prefix, options={})
+ *   @yield [cursor]
+ *   @!macro patricia-trie.open_prefix_cursor.options
  */
 static VALUE
 rb_grn_patricia_trie_open_prefix_cursor (int argc, VALUE *argv, VALUE self)
@@ -729,10 +685,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 +692,31 @@ 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]
+ *   @!macro [new] patricia-trie.open_rk_cursor.options
+ *     @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+ ] を
+ *       範囲に含まない。
+ *   @!macro patricia-trie.open_rk_cursor.options
+ * @overload open_rk_cursor(key, options={})
+ *   @yield [cursor]
+ *   @!macro patricia-trie.open_rk_cursor.options
  */
 static VALUE
 rb_grn_patricia_trie_open_rk_cursor (int argc, VALUE *argv, VALUE self)
@@ -820,10 +766,11 @@ 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);
+	grn_obj_cast(*context, key_p, &casted_key, GRN_FALSE);
 	grn_obj_unlink(*context, key_p);
 	key_p = &casted_key;
     }
@@ -851,41 +798,34 @@ 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]
+ *   @!macro [new] patricia-trie.open_near_cursor.options
+ *     @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+ ] を
+ *       範囲に含まない。
+ *   @!macro patricia-trie.open_near_cursor.options
+ * @overload open_near_cursor(key, options={})
+ *   @yield [cursor]
+ *   @!macro patricia-trie.open_near_cursor.options
  */
 static VALUE
 rb_grn_patricia_trie_open_near_cursor (int argc, VALUE *argv, VALUE self)

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_ を指定した場合はそのパスのプラグインを登録する。
+ * @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_ で指定したパスのプラグインを登録する。
  *
- * _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
- *
- *   データベースを結びつけるコンテキスト。
+ *   _:context_ については _name_ を設定した時と同様。
  */
 static VALUE
 rb_grn_plugin_s_register (int argc, VALUE *argv, VALUE klass)
@@ -124,13 +121,11 @@ rb_grn_plugin_s_register (int argc, VALUE *argv, VALUE klass)
     return Qnil;
 }
 
-/**
- * call-seq:
- *   Groonga::Plugin.system_plugins_dir
- *
+/*
  * Returns the system plugins directory.
  *
- * @return The system plugins directory.
+ * @overload system_plugins_dir
+ *   @return [String]
  */
 static VALUE
 rb_grn_plugin_s_system_plugins_dir (VALUE klass)
@@ -138,13 +133,11 @@ rb_grn_plugin_s_system_plugins_dir (VALUE klass)
     return rb_str_new2(grn_plugin_get_system_plugins_dir());
 }
 
-/**
- * call-seq:
- *   Groonga::Plugin.suffix
- *
+/*
  * Returns the plugin file suffix. (e.g. ".so", ".dll" and so on.)
  *
- * @return The plugin file suffix.
+ * @overload suffix
+ *   @return [String]
  */
 static VALUE
 rb_grn_plugin_s_suffix (VALUE klass)