rroonga 2.0.5 → 2.0.6

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

@@ -23,9 +23,9 @@ VALUE rb_cGrnPatriciaTrieCursor;
 /*
  * Document-class: Groonga::PatriciaTrieCursor < Groonga::TableCursor
  *
- * Groonga::PatriciaTrieに登録されているレコードを順番に取り
+ * {Groonga::PatriciaTrie} に登録されているレコードを順番に取り
  * 出すためのオブジェクト。利用できるメソッドは
- * Groonga::TableCursorとGroonga::TableCursor::KeySupportを
+ * {Groonga::TableCursor} と {Groonga::TableCursor::KeySupport} を
  * 参照。
  */
 

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

@@ -62,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")
@@ -84,120 +84,67 @@ VALUE rb_cGrnPatriciaTrie;
  *
  * @overload create(options={})
  *   @return [Groonga::PatriciaTrie]
- *   @param options [::Hash] The name and value
- *     pairs. Omitted names are initialized as the default value.
- *   @option options [Groonga::Context] :context (Groonga::Context.default)
- *     テーブルが利用するGroonga::Context。
- *   @option options :name
- *     テーブルの名前。名前をつけると、Groonga::Context#[]に名
- *     前を指定してテーブルを取得することができる。省略すると
- *     無名テーブルになり、テーブルIDでのみ取得できる。
- *   @option options :path
- *     テーブルを保存するパス。パスを指定すると永続テーブルとな
- *     り、プロセス終了後もレコードは保持される。次回起動時に
- *     Groonga::Context#[]で保存されたレコードを利用する
- *     ことができる。省略すると一時テーブルになり、プロセスが終
- *     了するとレコードは破棄される。
- *   @option options :persistent
- *     +true+ を指定すると永続テーブルとなる。 +path+ を省略した
- *     場合は自動的にパスが付加される。 +:context+ で指定した
- *     Groonga::Contextに結びついているデータベースが一時デー
- *     タベースの場合は例外が発生する。
- *   @option options :key_normalize
- *     +true+ を指定するとキーを正規化する。
- *   @option options :key_with_sis
- *     +true+ を指定するとキーの文字列の全suffixが自動的に登
- *     録される。
- *   @option options :key_type
- *     キーの種類を示すオブジェクトを指定する。キーの種類には型
- *     名（"Int32"や"ShortText"など）またはGroonga::Typeまたは
- *     テーブル（Groonga::Array、Groonga::Hash、
- *     Groonga::PatriciaTrieのどれか）を指定する。
- *
- *     Groonga::Typeを指定した場合は、その型が示す範囲の値をキー
- *     として使用する。ただし、キーの最大サイズは4096バイトで
- *     あるため、Groonga::Type::TEXTやGroonga::Type::LONG_TEXT
- *     は使用できない。
- *
- *     テーブルを指定した場合はレコードIDをキーとして使用する。
- *     指定したテーブルのGroonga::Recordをキーとして使用するこ
- *     ともでき、その場合は自動的にGroonga::Recordからレコード
- *     IDを取得する。
- *
- *     省略した場合はShortText型をキーとして使用する。この場合、
- *     4096バイトまで使用可能である。
- *   @option options :value_type
- *     値の型を指定する。省略すると値のための領域を確保しない。
- *     値を保存したい場合は必ず指定すること。
- *
- *     参考: Groonga::Type.new
- *   @option options :default_tokenizer
- *     Groonga::IndexColumnで使用するトークナイザを指定する。
- *     デフォルトでは何も設定されていないので、テーブルに
- *     Groonga::IndexColumnを定義する場合は
- *     <tt>"TokenBigram"</tt>などを指定する必要がある。
- *   @option options :sub_records
- *     +true+ を指定すると#groupでグループ化したときに、
- *     Groonga::Record#n_sub_recordsでグループに含まれるレコー
- *     ドの件数を取得できる。
+ *   @!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]
- *   @param options [::Hash] The name and value
- *     pairs. Omitted names are initialized as the default value.
- *   @option options [Groonga::Context] :context (Groonga::Context.default)
- *     テーブルが利用するGroonga::Context。
- *   @option options :name
- *     テーブルの名前。名前をつけると、Groonga::Context#[]に名
- *     前を指定してテーブルを取得することができる。省略すると
- *     無名テーブルになり、テーブルIDでのみ取得できる。
- *   @option options :path
- *     テーブルを保存するパス。パスを指定すると永続テーブルとな
- *     り、プロセス終了後もレコードは保持される。次回起動時に
- *     Groonga::Context#[]で保存されたレコードを利用する
- *     ことができる。省略すると一時テーブルになり、プロセスが終
- *     了するとレコードは破棄される。
- *   @option options :persistent
- *     +true+ を指定すると永続テーブルとなる。 +path+ を省略した
- *     場合は自動的にパスが付加される。 +:context+ で指定した
- *     Groonga::Contextに結びついているデータベースが一時デー
- *     タベースの場合は例外が発生する。
- *   @option options :key_normalize
- *     +true+ を指定するとキーを正規化する。
- *   @option options :key_with_sis
- *     +true+ を指定するとキーの文字列の全suffixが自動的に登
- *     録される。
- *   @option options :key_type
- *     キーの種類を示すオブジェクトを指定する。キーの種類には型
- *     名（"Int32"や"ShortText"など）またはGroonga::Typeまたは
- *     テーブル（Groonga::Array、Groonga::Hash、
- *     Groonga::PatriciaTrieのどれか）を指定する。
- *
- *     Groonga::Typeを指定した場合は、その型が示す範囲の値をキー
- *     として使用する。ただし、キーの最大サイズは4096バイトで
- *     あるため、Groonga::Type::TEXTやGroonga::Type::LONG_TEXT
- *     は使用できない。
- *
- *     テーブルを指定した場合はレコードIDをキーとして使用する。
- *     指定したテーブルのGroonga::Recordをキーとして使用するこ
- *     ともでき、その場合は自動的にGroonga::Recordからレコード
- *     IDを取得する。
- *
- *     省略した場合はShortText型をキーとして使用する。この場合、
- *     4096バイトまで使用可能である。
- *   @option options :value_type
- *     値の型を指定する。省略すると値のための領域を確保しない。
- *     値を保存したい場合は必ず指定すること。
- *
- *     参考: Groonga::Type.new
- *   @option options :default_tokenizer
- *     Groonga::IndexColumnで使用するトークナイザを指定する。
- *     デフォルトでは何も設定されていないので、テーブルに
- *     Groonga::IndexColumnを定義する場合は
- *     <tt>"TokenBigram"</tt>などを指定する必要がある。
- *   @option options :sub_records
- *     +true+ を指定すると#groupでグループ化したときに、
- *     Groonga::Record#n_sub_recordsでグループに含まれるレコー
- *     ドの件数を取得できる。
+ *   @!macro patricia_trie.create.options
  */
 static VALUE
 rb_grn_patricia_trie_s_create (int argc, VALUE *argv, VALUE klass)
@@ -279,8 +226,8 @@ rb_grn_patricia_trie_s_create (int argc, VALUE *argv, VALUE klass)
 }
 
 /*
- * _key_ にマッチするレコードのIDがキーに入っているGroonga::Hashを返す。
- * マッチするレコードがない場合は空のGroonga::Hashが返る。
+ * _key_ にマッチするレコードのIDがキーに入っている {Groonga::Hash} を返す。
+ * マッチするレコードがない場合は空の {Groonga::Hash} が返る。
  *
  * _options_ で +:result+ を指定することにより、そのテーブルにマッチした
  * レコードIDがキーのレコードを追加することができる。
@@ -306,20 +253,19 @@ rb_grn_patricia_trie_s_create (int argc, VALUE *argv, VALUE klass)
  *     マッチしたレコードをどのように扱うか。指定可能な値は以
  *     下の通り。
  *
- *     [Groonga::Operator::OR]
+ *     - Groonga::Operator::OR :=
  *       マッチしたレコードを追加。すでにレコードが追加され
- *       ている場合は何もしない。
- *     [Groonga::Operator::AND]
+ *       ている場合は何もしない。 =:
+ *     - Groonga::Operator::AND :=
  *       マッチしたレコードのスコアを増加。マッチしなかった
- *       レコードを削除。
- *     [Groonga::Operator::BUT]
- *       マッチしたレコードを削除。
- *     [Groonga::Operator::ADJUST]
- *       マッチしたレコードのスコアを増加。
- *
- *   [+:type+]
- *     ?????
- * @return [Groonga::Hash]
+ *       レコードを削除。 =:
+ *     - Groonga::Operator::BUT :=
+ *       マッチしたレコードを削除。 =:
+ *     - Groonga::Operator::ADJUST :=
+ *       マッチしたレコードのスコアを増加。 =:
+ *     - +:type+ :=
+ *       ????? =:
+ *   @return [Groonga::Hash]
  */
 static VALUE
 rb_grn_patricia_trie_search (int argc, VALUE *argv, VALUE self)
@@ -370,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("リンク")
@@ -413,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)
@@ -476,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)
@@ -514,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)
@@ -635,62 +573,38 @@ rb_grn_patricia_trie_open_grn_prefix_cursor (int argc, VALUE *argv, VALUE self,
  *
  * @overload open_prefix_cursor(prefix, options={})
  *   @return [Groonga::PatriciaTrieCursor]
- *   @param options [::Hash] The name and value
- *     pairs. Omitted names are initialized as the default value.
- *   @option options :key_bytes
- *    _prefix_ のサイズ（byte）
- *   @option options :key_bits
- *    _prefix_ のサイズ（bit）
- *   @option options :offset
- *     該当する範囲のレコードのうち、(0ベースで) _:offset_ 番目
- *     からレコードを取り出す。
- *   @option options :limit
- *     該当する範囲のレコードのうち、 _:limit_ 件のみを取り出す。
- *     省略された場合または-1が指定された場合は、全件が指定され
- *     たものとみなす。
- *   @option options :order
- *     +:asc+ または +:ascending+ を指定すると昇順にレコードを取
- *     り出す。
- *     +:desc+ または +:descending+ を指定すると降順にレコードを
- *     取り出す。
- *   @option options :order_by (:id)
- *     +:id+ を指定するとID順にレコードを取り出す。（デフォルト）
- *     +:key+指定するとキー順にレコードを取り出す。
- *   @option options :greater_than
- *     +true+ を指定すると _prefix_ で指定した値に一致した [ +key+ ] を
- *     範囲に含まない。
- *   @option options :less_than
- *     +true+ を指定すると _prefix_ で指定した値に一致した [ +key+ ] を
- *     範囲に含まない。
+ *   @!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]
- *   @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
  */
 static VALUE
 rb_grn_patricia_trie_open_prefix_cursor (int argc, VALUE *argv, VALUE self)
@@ -780,44 +694,29 @@ rb_grn_patricia_trie_open_grn_rk_cursor (int argc, VALUE *argv, VALUE self,
  *
  * @overload open_rk_cursor(key, options={})
  *   @return [Groonga::PatriciaTrieCursor]
- *   @param options [::Hash]
- *     pairs. Omitted names are initialized as the default value.
- *   @option options :key_bytes
- *    _key_のサイズ（byte）
- *   @option options :key_bits
- *    _key_のサイズ（bit）（現在は未サポート）
- *   @option options :offset
- *     該当する範囲のレコードのうち、(0ベースで)_:offset_番目から
- *     レコードを取り出す。
- *   @option options :limit
- *     該当する範囲のレコードのうち、 _:limit_ 件のみを取り出す。
- *     省略された場合または-1が指定された場合は、全件が指定されたものとみなす。
- *   @option options :greater_than
- *     +true+ を指定すると _key_ で指定した値に一致した [ +key+ ] を
- *     範囲に含まない。
- *   @option options :less_than
- *     +true+ を指定すると _key_ で指定した値に一致した [ +key+ ] を
- *     範囲に含まない。
+ *   @!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]
- *   @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
  */
 static VALUE
 rb_grn_patricia_trie_open_rk_cursor (int argc, VALUE *argv, VALUE self)
@@ -905,42 +804,28 @@ rb_grn_patricia_trie_open_grn_near_cursor (int argc, VALUE *argv, VALUE self,
  *
  * @overload open_near_cursor(key, options={})
  *   @return [Groonga::PatriciaTrieCursor]
- *   @param options [::Hash] The name and value
- *     pairs. Omitted names are initialized as the default value.
- *   @option options :size
- *     _size_ バイト以降のデータが同じキーのレコードに限定する。
- *   @option options :offset
- *     該当する範囲のレコードのうち、(0ベースで)_:offset_番目
- *     からレコードを取り出す。
- *   @option options :limit
- *     該当する範囲のレコードのうち、_:limit_件のみを取り出す。
- *     省略された場合または-1が指定された場合は、全件が指定され
- *     たものとみなす。
- *   @option options :greater_than
- *     +true+ を指定すると _key_ で指定した値に一致した [ +key+ ] を
- *     範囲に含まない。
- *   @option options :less_than
- *     +true+ を指定すると _key_ で指定した値に一致した [ +key+ ] を
- *     範囲に含まない。
+ *   @!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]
- *   @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
  */
 static VALUE
 rb_grn_patricia_trie_open_near_cursor (int argc, VALUE *argv, VALUE self)