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

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

@@ -30,104 +30,23 @@ VALUE rb_cGrnDoubleArrayTrie;
  * trie. It can change key without ID change. This feature
  * is supported by only Groonga::DoubleArrayTrie. But it
  * requires large spaces rather than other tables. It is
- * used by Groonga::Database for key management
+ * used by {Groonga::Database} for key management
  * internally. It's reasonable choice because number of
- * tables and columns in Groonga::Database (number of their
+ * tables and columns in {Groonga::Database} (number of their
  * names equals to number of keys to be managed by
  * Groonga::DoubleArrayTrie) will be less than number of
  * records of user defined tables.
  *
  * Groonga::DoubleArrayTrie supports exact match search,
  * predictive search and common prefix search like
- * Groonga::PatriciaTrie. It also supports cursor API.
+ * {Groonga::PatriciaTrie} . It also supports cursor API.
  */
 
 /*
- * call-seq:
- *   Groonga::DoubleArrayTrie.create(options={}) -> Groonga::DoubleArrayTrie
- *   Groonga::DoubleArrayTrie.create(options={}) {|table| ... }
- *
  * It creates a table that manages records by double array trie.
  * ブロックを指定すると、そのブロックに生成したテーブルが渡さ
  * れ、ブロックを抜けると自動的にテーブルが破棄される。
  *
- * _options_ に指定可能な値は以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options [Groonga::Context] :context (Groonga::Context.default)
- *
- *   テーブルが利用するGroonga::Context。
- *
- * @option options :name The table name
- *
- *   テーブルの名前。名前をつけると、Groonga::Context#[]に名
- *   前を指定してテーブルを取得することができる。省略すると
- *   無名テーブルになり、テーブルIDでのみ取得できる。
- *
- * @option options :path The path
- *
- *   テーブルを保存するパス。パスを指定すると永続テーブルとな
- *   り、プロセス終了後もレコードは保持される。次回起動時に
- *   Groonga::Context#[]で保存されたレコードを利用する
- *   ことができる。省略すると一時テーブルになり、プロセスが終
- *   了するとレコードは破棄される。
- *
- * @option options :persistent The persistent
- *
- *   +true+ を指定すると永続テーブルとなる。 +path+ を省略した
- *   場合は自動的にパスが付加される。 +:context+ で指定した
- *   Groonga::Contextに結びついているデータベースが一時デー
- *   タベースの場合は例外が発生する。
- *
- * @option options :key_normalize The key_normalize
- *
- *   +true+ を指定するとキーを正規化する。
- *
- * @option options :key_with_sis The key_with_sis
- *
- *   +true+ を指定するとキーの文字列の全suffixが自動的に登
- *   録される。
- *
- * @option options :key_type The key_type
- *
- *   キーの種類を示すオブジェクトを指定する。キーの種類には型
- *   名（"Int32"や"ShortText"など）またはGroonga::Typeまたは
- *   テーブル（Groonga::Array、Groonga::Hash、
- *   Groonga::DoubleArrayTrieのどれか）を指定する。
- *
- *   Groonga::Typeを指定した場合は、その型が示す範囲の値をキー
- *   として使用する。ただし、キーの最大サイズは4096バイトで
- *   あるため、Groonga::Type::TEXTやGroonga::Type::LONG_TEXT
- *   は使用できない。
- *
- *   テーブルを指定した場合はレコードIDをキーとして使用する。
- *   指定したテーブルのGroonga::Recordをキーとして使用するこ
- *   ともでき、その場合は自動的にGroonga::Recordからレコード
- *   IDを取得する。
- *
- *   省略した場合はShortText型をキーとして使用する。この場合、
- *   4096バイトまで使用可能である。
- *
- * @option options :value_type The value_type
- *
- *   値の型を指定する。省略すると値のための領域を確保しない。
- *   値を保存したい場合は必ず指定すること。
- *
- *   参考: Groonga::Type.new
- *
- * @option options :default_tokenizer The default_tokenizer
- *
- *   Groonga::IndexColumnで使用するトークナイザを指定する。
- *   デフォルトでは何も設定されていないので、テーブルに
- *   Groonga::IndexColumnを定義する場合は
- *   <tt>"TokenBigram"</tt>などを指定する必要がある。
- *
- * @option options :sub_records The sub_records
- *
- *   +true+ を指定すると#groupでグループ化したときに、
- *   Groonga::Record#n_sub_recordsでグループに含まれるレコー
- *   ドの件数を取得できる。
- *
  * @example
  *   #無名一時テーブルを生成する。
  *   Groonga::DoubleArrayTrie.create
@@ -138,7 +57,7 @@ VALUE rb_cGrnDoubleArrayTrie;
  *   #名前付き永続テーブルを生成する。ただし、ファイル名は気に
  *   #しない。
  *   Groonga::DoubleArrayTrie.create(:name => "Bookmarks",
- *                                :persistent => true)
+ *                                   :persistent => true)
  *
  *   #それぞれのレコードに512バイトの値を格納できる無名一時テー
  *   #ブルを生成する。
@@ -151,12 +70,12 @@ VALUE rb_cGrnDoubleArrayTrie;
  *   #（キーの種類を表すオブジェクトは文字列で指定。）
  *   Groonga::DoubleArrayTrie.create(:key_type => "ShortText")
  *
- *   #キーとして<tt>Bookmarks</tt>テーブルのレコードを使用す
+ *   #キーとしてBookmarksテーブルのレコードを使用す
  *   #る無名一時テーブルを生成する。
  *   bookmarks = Groonga::DoubleArrayTrie.create(:name => "Bookmarks")
  *   Groonga::DoubleArrayTrie.create(:key_type => bookmarks)
  *
- *   #キーとして<tt>Bookmarks</tt>テーブルのレコードを使用す
+ *   #キーとしてBookmarksテーブルのレコードを使用す
  *   #る無名一時テーブルを生成する。
  *   #（テーブルは文字列で指定。）
  *   Groonga::DoubleArrayTrie.create(:name => "Bookmarks")
@@ -167,9 +86,73 @@ VALUE rb_cGrnDoubleArrayTrie;
  *   bookmarks = Groonga::DoubleArrayTrie.create(:name => "Bookmarks")
  *   bookmarks.define_column("comment", "Text")
  *   terms = Groonga::DoubleArrayTrie.create(:name => "Terms",
- *                                        :default_tokenizer => "TokenBigram")
+ *                                           :default_tokenizer => "TokenBigram")
  *   terms.define_index_column("content", bookmarks,
  *                             :source => "Bookmarks.comment")
+ *
+ * @overload create(options={})
+ *   @return [Groonga::DoubleArrayTrie]
+ *   @!macro [new] double-array-trie.create.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)
+ *       テーブルが利用する {Groonga::Context} 。
+ *     @option options :name
+ *       テーブルの名前。名前をつけると、 {Groonga::Context#[]} に名
+ *       前を指定してテーブルを取得することができる。省略すると
+ *       無名テーブルになり、テーブルIDでのみ取得できる。
+ *     @option options :path
+ *       テーブルを保存するパス。パスを指定すると永続テーブルとな
+ *       り、プロセス終了後もレコードは保持される。次回起動時に
+ *       {Groonga::Context#[]} で保存されたレコードを利用する
+ *       ことができる。省略すると一時テーブルになり、プロセスが終
+ *       了するとレコードは破棄される。
+ *     @option options :persistent
+ *       +true+ を指定すると永続テーブルとなる。 +path+ を省略した
+ *       場合は自動的にパスが付加される。 +:context+ で指定した
+ *       {Groonga::Context} に結びついているデータベースが一時デー
+ *       タベースの場合は例外が発生する。
+ *     @option options :key_normalize
+ *       +true+ を指定するとキーを正規化する。
+ *     @option options :key_with_sis
+ *       +true+ を指定するとキーの文字列の全suffixが自動的に登
+ *       録される。
+ *     @option options :key_type
+ *       キーの種類を示すオブジェクトを指定する。キーの種類には型
+ *       名（"Int32"や"ShortText"など）または {Groonga::Type} または
+ *       テーブル（ {Groonga::Array} 、{Groonga::Hash} 、
+ *       {Groonga::DoubleArrayTrie} のどれか）を指定する。
+ *       {Groonga::Type} を指定した場合は、その型が示す範囲の値をキー
+ *       として使用する。ただし、キーの最大サイズは4096バイトで
+ *       あるため、 {Groonga::Type::TEXT} や {Groonga::Type::LONG_TEXT}
+ *       は使用できない。
+ *
+ *       テーブルを指定した場合はレコードIDをキーとして使用する。
+ *       指定したテーブルの {Groonga::Record} をキーとして使用するこ
+ *       ともでき、その場合は自動的に {Groonga::Record} からレコード
+ *       IDを取得する。
+ *
+ *       省略した場合はShortText型をキーとして使用する。この場合、
+ *       4096バイトまで使用可能である。
+ *     @option options :value_type
+ *       値の型を指定する。省略すると値のための領域を確保しない。
+ *       値を保存したい場合は必ず指定すること。
+ *
+ *       参考: {Groonga::Type.new}
+ *
+ *     @option options :default_tokenizer
+ *       {Groonga::IndexColumn} で使用するトークナイザを指定する。
+ *       デフォルトでは何も設定されていないので、テーブルに
+ *       {Groonga::IndexColumn} を定義する場合は
+ *       @"TokenBigram"@ などを指定する必要がある。
+ *     @option options :sub_records
+ *       +true+ を指定すると {#group} でグループ化したときに、
+ *       {Groonga::Record#n_sub_records} でグループに含まれるレコー
+ *       ドの件数を取得できる。
+ *   @!macro double-array-trie.create.options
+ * @overload create(options={})
+ *   @yield [table]
+ *   @!macro double-array-trie.create.options
  */
 static VALUE
 rb_grn_double_array_trie_s_create (int argc, VALUE *argv, VALUE klass)
@@ -251,43 +234,14 @@ rb_grn_double_array_trie_s_create (int argc, VALUE *argv, VALUE klass)
 }
 
 /*
- * call-seq:
- *   double_array_trie.search(key, options=nil) -> Groonga::Hash
- *
  * _key_ にマッチするレコードのIDがキーに入っている
- * Groonga::Hashを返す。マッチするレコードがない場合は空の
- * Groonga::Hashが返る。
- *
+ * {Groonga::Hash} を返す。マッチするレコードがない場合は空の
+ * {fGroonga::Hash} が返る。
  * _options_ で +:result+ を指定することにより、そのテーブルにマッ
  * チしたレコードIDがキーのレコードを追加することができる。
  * +:result+ にテーブルを指定した場合は、そのテーブルが返る。
  *
- * _options_ に指定可能な値は以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :result The result
- *
- *   結果を格納するテーブル。
- * @option options :operator (Groonga::Operator::OR)
- *
- *   マッチしたレコードをどのように扱うか。指定可能な値は以
- *   下の通り。
- *
- *   [Groonga::Operator::OR]
- *     マッチしたレコードを追加。すでにレコードが追加され
- *     ている場合は何もしない。
- *   [Groonga::Operator::AND]
- *     マッチしたレコードのスコアを増加。マッチしなかった
- *     レコードを削除。
- *   [Groonga::Operator::BUT]
- *     マッチしたレコードを削除。
- *   [Groonga::Operator::ADJUST]
- *     マッチしたレコードのスコアを増加。
- *
- * [+:type+]
- *   ?????
- *
- * 複数のキーで検索し、結果を1つのテーブルに集める。
+ * @example 複数のキーで検索し、結果を1つのテーブルに集める。
  *   result = nil
  *   keys = ["morita", "gunyara-kun", "yu"]
  *   keys.each do |key|
@@ -297,6 +251,31 @@ rb_grn_double_array_trie_s_create (int argc, VALUE *argv, VALUE klass)
  *     user = record.key
  *     p user.key # -> "morita"または"gunyara-kun"または"yu"
  *   end
+ *
+ * @overload search(key, options=nil)
+ *   @return [Groonga::Hash]
+ *   @param key [String] レコードにマッチさせる値
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :result The result
+ *     結果を格納するテーブル。
+ *   @option options :operator (Groonga::Operator::OR)
+ *     マッチしたレコードをどのように扱うか。指定可能な値は以
+ *     下の通り。
+ *
+ *     - Groonga::Operator::OR :=
+ *       マッチしたレコードを追加。すでにレコードが追加され
+ *       ている場合は何もしない。 =:
+ *     - Groonga::Operator::AND :=
+ *       マッチしたレコードのスコアを増加。マッチしなかった
+ *       レコードを削除。 =:
+ *     - Groonga::Operator::BUT :=
+ *       マッチしたレコードを削除。 =:
+ *     - Groonga::Operator::ADJUST :=
+ *       マッチしたレコードのスコアを増加。 =:
+ *     - +:type+ :=
+ *       ????? =:
+ *
  */
 static VALUE
 rb_grn_double_array_trie_search (int argc, VALUE *argv, VALUE self)
@@ -441,59 +420,71 @@ rb_grn_double_array_trie_open_grn_prefix_cursor (int argc, VALUE *argv,
     return cursor;
 }
 
-
 /*
- * call-seq:
- *   table.open_prefix_cursor(prefix, options={}) -> Groonga::DoubleArrayTrieCursor
- *   table.open_prefix_cursor(prefix, options={}) {|cursor| ... }
- *
  * _prefix_ に前方一致検索をするカーソルを生成して返す。ブロッ
  * クを指定すると、そのブロックに生成したカーソルが渡され、ブ
  * ロックを抜けると自動的にカーソルが破棄される。
  *
- * _options_ に指定可能な値は以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :key_bytes The key_bytes
- *
- *  _prefix_ のサイズ（byte）
- *
- * @option options :key_bits The key_bits
- *
- *  _prefix_ のサイズ（bit）
- *
- * @option options :offset The offset
- *
- *   該当する範囲のレコードのうち、(0ベースで) _:offset_ 番目
- *   からレコードを取り出す。
- *
- * @option options :limit The limit
- *
- *   該当する範囲のレコードのうち、 _:limit_ 件のみを取り出す。
- *   省略された場合または-1が指定された場合は、全件が指定され
- *   たものとみなす。
- *
- * @option options :order The order
- *
- *   +:asc+ または +:ascending+ を指定すると昇順にレコードを取
- *   り出す。
- *   +:desc+ または +:descending+ を指定すると降順にレコードを
- *   取り出す。
- *
- * @option options :order_by (:id) The order_by
- *
- *   +:id+ を指定するとID順にレコードを取り出す。（デフォルト）
- *   +:key+指定するとキー順にレコードを取り出す。
- *
- * @option options :greater_than The greater_than
- *
- *   +true+ を指定すると _prefix_ で指定した値に一致した [ +key+ ] を
- *   範囲に含まない。
- *
- * @option options :less_than The less_than
- *
- *   +true+ を指定すると _prefix_ で指定した値に一致した [ +key+ ] を
- *   範囲に含まない。
+ * @overload open_prefix_cursor(prefix, options={})
+ *   @return [Groonga::DoubleArrayTrieCursor]
+ *   @param [String] prefix 前方一致させる値
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :key_bytes
+ *    _prefix_ のサイズ（byte）
+ *   @option options :key_bits
+ *    _prefix_ のサイズ（bit）
+ *   @option options :offset
+ *     該当する範囲のレコードのうち、(0ベースで) _:offset_ 番目
+ *     からレコードを取り出す。
+ *   @option options :limit
+ *     該当する範囲のレコードのうち、 _:limit_ 件のみを取り出す。
+ *     省略された場合または-1が指定された場合は、全件が指定され
+ *     たものとみなす。
+ *   @option options :order
+ *     +:asc+ または +:ascending+ を指定すると昇順にレコードを取
+ *     り出す。
+ *     +:desc+ または +:descending+ を指定すると降順にレコードを
+ *     取り出す。
+ *   @option options :order_by (:id)
+ *     +:id+ を指定するとID順にレコードを取り出す。（デフォルト）
+ *     +:key+指定するとキー順にレコードを取り出す。
+ *   @option options :greater_than
+ *     +true+ を指定すると _prefix_ で指定した値に一致した [ +key+ ] を
+ *     範囲に含まない。
+ *   @option options :less_than
+ *     +true+ を指定すると _prefix_ で指定した値に一致した [ +key+ ] を
+ *     範囲に含まない。
+ * @overload open_prefix_cursor(prefix, options={})
+ *   @yield [cursor]
+ *   @param [String] prefix 前方一致させる値
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :key_bytes
+ *    _prefix_ のサイズ（byte）
+ *   @option options :key_bits
+ *    _prefix_ のサイズ（bit）
+ *   @option options :offset
+ *     該当する範囲のレコードのうち、(0ベースで) _:offset_ 番目
+ *     からレコードを取り出す。
+ *   @option options :limit
+ *     該当する範囲のレコードのうち、 _:limit_ 件のみを取り出す。
+ *     省略された場合または-1が指定された場合は、全件が指定され
+ *     たものとみなす。
+ *   @option options :order
+ *     +:asc+ または +:ascending+ を指定すると昇順にレコードを取
+ *     り出す。
+ *     +:desc+ または +:descending+ を指定すると降順にレコードを
+ *     取り出す。
+ *   @option options :order_by (:id)
+ *     +:id+ を指定するとID順にレコードを取り出す。（デフォルト）
+ *     +:key+指定するとキー順にレコードを取り出す。
+ *   @option options :greater_than
+ *     +true+ を指定すると _prefix_ で指定した値に一致した [ +key+ ] を
+ *     範囲に含まない。
+ *   @option options :less_than
+ *     +true+ を指定すると _prefix_ で指定した値に一致した [ +key+ ] を
+ *     範囲に含まない。
  */
 static VALUE
 rb_grn_double_array_trie_open_prefix_cursor (int argc, VALUE *argv, VALUE self)

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

@@ -26,47 +26,47 @@
  *
  * エンコーディングの指定方法は以下の通り。
  *
- * [+nil+]
- *   コンテキストと関連付けられているオブジェクトの場合（多
+ * - +nil+ :=
+ *     コンテキストと関連付けられているオブジェクトの場合（多
  *   くの場合）はコンテキストのエンコーディングを使用。
  *
  *   それ以外のオブジェクトの場合（コンテキスト自身など）は
  *   groongaのビルド時に指定したエンコーディング
- *   （Groonga::Encoding::DEFAULT）を使用
+ *   （ {Groonga::Encoding::DEFAULT} ）を使用 =:
  *
- * [+:default+]
- *   groongaのビルド時に指定したエンコーディングを使用。
- *   Groonga::Encoding::DEFAULT
+ * - +:default+ :=
+ *     groongaのビルド時に指定したエンコーディングを使用。
+ *   {Groonga::Encoding::DEFAULT} =:
  *
- * [+:none+]
- *   エンコーディングを指定しない。Groonga::Encoding::NONE
+ * - +:none+ :=
+ *     エンコーディングを指定しない。{Groonga::Encoding::NONE} =:
  *
- * [+:euc_jp+]
- *   EUC-JPを使用。Groonga::Encoding::EUC_JP
+ * - +:euc_jp+ :=
+ *     EUC-JPを使用。{Groonga::Encoding::EUC_JP} =:
  *
- * [<tt>"euc-jp"</tt>]
- *   +:euc_jp+と同じ。
+ * - @"euc-jp"@ :=
+ *     +:euc_jp+と同じ。 =:
  *
- * [+:utf8+]
- *   UTF-8を使用。Groonga::Encoding::UTF8
+ * - +:utf8+ :=
+ *     UTF-8を使用。{Groonga::Encoding::UTF8} =:
  *
- * [<tt>"utf-8"</tt>]
- *   +:utf8+と同じ。
+ * - @"utf-8"@ :=
+ *     +:utf8+と同じ。 =:
  *
- * [+:sjis+]
- *   Shift_JISを使用。Groonga::Encoding::SJIS
+ * - +:sjis+ :=
+ *     Shift_JISを使用。{Groonga::Encoding::SJIS} =:
  *
- * [+:shift_jis+]
- *   +:sjis+と同じ。
+ * - +:shift_jis+ :=
+ *     +:sjis+と同じ。 =:
  *
- * [<tt>"shift-jis"</tt>]
- *   +:sjis+と同じ。
+ * - @"shift-jis"@ :=
+ *     +:sjis+と同じ。 =:
  *
- * [+:latin1+]
- *   Latin-1を使用。Groonga::Encoding::LATIN1
+ * - +:latin1+ :=
+ *     Latin-1を使用。{Groonga::Encoding::LATIN1} =:
  *
- * [+:koi8r+]
- *   KOI8-Rを使用。Groonga::Encoding::KOI8R
+ * - +:koi8r+ :=
+ *     KOI8-Rを使用。{Groonga::Encoding::KOI8R} =:
  */
 
 static VALUE mGrnEncoding;
@@ -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);