rroonga 1.2.9 → 1.3.0

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

@@ -1,4 +1,4 @@
-/* -*- c-file-style: "ruby" -*- */
+/* -*- coding: utf-8; c-file-style: "ruby" -*- */
 /*
   Copyright (C) 2009  Kouhei Sutou <kou@clear-code.com>
 

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

@@ -1,4 +1,4 @@
-/* -*- c-file-style: "ruby" -*- */
+/* -*- coding: utf-8; c-file-style: "ruby" -*- */
 /*
   Copyright (C) 2009  Kouhei Sutou <kou@clear-code.com>
 

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

@@ -1,4 +1,4 @@
-/* -*- c-file-style: "ruby" -*- */
+/* -*- coding: utf-8; c-file-style: "ruby" -*- */
 /*
   Copyright (C) 2009-2010  Kouhei Sutou <kou@clear-code.com>
 

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

@@ -1,4 +1,4 @@
-/* -*- c-file-style: "ruby" -*- */
+/* -*- coding: utf-8; c-file-style: "ruby" -*- */
 /*
   Copyright (C) 2009  Kouhei Sutou <kou@clear-code.com>
 

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

@@ -1,4 +1,4 @@
-/* -*- c-file-style: "ruby" -*- */
+/* -*- coding: utf-8; c-file-style: "ruby" -*- */
 /*
   Copyright (C) 2009-2010  Kouhei Sutou <kou@clear-code.com>
 
@@ -107,14 +107,16 @@ rb_grn_expression_initialize (int argc, VALUE *argv, VALUE self)
  * call-seq:
  *   expression.define_variable(options={}) -> Groonga::Variable
  *
- * _expression_で使用可能な変数を作成する。
+ * _expression_ で使用可能な変数を作成する。
  *
- * _options_に指定可能な値は以下の通り。
+ * _options_ に指定可能な値は以下の通り。
+ * @param options [::Hash] The name and value
+ *   pairs. Omitted names are initialized as the default value.
+ * @option options :name (false)
  *
- * [+:name+]
  *   変数の名前。省略した場合は名前を付けない。
+ * @option options :domain
  *
- * [+:domain+]
  *   テーブルを指定すると、そのテーブル用のレコードとして初期化する。
  */
 static VALUE
@@ -160,7 +162,7 @@ rb_grn_expression_define_variable (int argc, VALUE *argv, VALUE self)
  *                            operation=Groonga::Operator::PUSH,
  *                            n_arguments=1) -> self
  *
- * _object_を追加し、_n_arguments_個の引数を取る_operation_を追加する。
+ * _object_ を追加し、 _n_arguments_ 個の引数を取る _operation_ を追加する。
  */
 static VALUE
 rb_grn_expression_append_object (int argc, VALUE *argv, VALUE self)
@@ -196,7 +198,7 @@ rb_grn_expression_append_object (int argc, VALUE *argv, VALUE self)
  *                              operation=Groonga::Operator::PUSH,
  *                              n_arguments=1) -> self
  *
- * _constant_を追加し、_n_arguments_個の引数を取る_operation_を追加する。
+ * _constant_ を追加し、 _n_arguments_ 個の引数を取る _operation_ を追加する。
  */
 static VALUE
 rb_grn_expression_append_constant (int argc, VALUE *argv, VALUE self)
@@ -233,7 +235,7 @@ rb_grn_expression_append_constant (int argc, VALUE *argv, VALUE self)
  * call-seq:
  *   expression.append_operation(operation, n_arguments)
  *
- * _n_arguments_個の引数を取る_operation_を追加する。
+ * _n_arguments_ 個の引数を取る _operation_ を追加する。
  */
 static VALUE
 rb_grn_expression_append_operation (VALUE self, VALUE rb_operation,
@@ -259,19 +261,21 @@ rb_grn_expression_append_operation (VALUE self, VALUE rb_operation,
  * call-seq:
  *   expression.parse(query, options={})
  *
- * 文字列_query_をパースする。
+ * 文字列 _query_ をパースする。
  *
- * _options_に指定可能な値は以下の通り。
+ * _options_ に指定可能な値は以下の通り。
+ * @param options [::Hash] The name and value
+ *   pairs. Omitted names are initialized as the default value.
+ * @option options :default_column The default_column
  *
- * [+:default_column+]
  *   "column_name:hoge"ではなく"hoge"のようにcolumn_nameが指
  *   定されない条件の検索対象となるカラムを指定する。
+ * @option options :default_operator (Groonga::Operator::AND)
  *
- * [+:default_operator+]
+ *   The default_operator
  *   "+"や"OR"で繋がれず、ただ列挙された複数の条件があった時、
- *   _expression_全体として各レコードをヒットとみなすかの論理
+ *   _expression_ 全体として各レコードをヒットとみなすかの論理
  *   条件を指定する。省略した場合はGroonga::Operator::AND。
- *
  *   [Groonga::Operator::OR]
  *     レコードはいずれかの条件にマッチすればいい。
  *   [Groonga::Operator::AND]
@@ -279,15 +283,16 @@ rb_grn_expression_append_operation (VALUE self, VALUE rb_operation,
  *   [Groonga::Operator::BUT]
  *     最初の条件にレコードはマッチし、残りの条件にレコードは
  *     マッチしてはならない。
+ * @option options :default_mode (Groonga::Operator::MATCH) The default_mode
  *
- * [+:default_mode+]
  *   検索時のモードを指定する。省略した場合は
  *   Groonga::Operator::MATCH。（FIXME: モードによってどう
  *   いう動作になるかを書く。）
  *
- * [+:syntax+]
- *   _query_の構文を指定する。指定可能な値は以下の通り。省略
- *   した場合は+:query+。
+ * @option options :syntax (:query) The syntax
+ *
+ *   _query_ の構文を指定する。指定可能な値は以下の通り。省略
+ *   した場合は +:query+ 。
  *
  *   [+nil+]
  *     +:query+と同様。
@@ -303,18 +308,19 @@ rb_grn_expression_append_operation (VALUE self, VALUE rb_operation,
  *
  *     参考: grn式のscript形式（link:text/expression_rdoc.html）
  *
- * [+:allow_pragma+]
- *   _query_の構文にqueryを用いているとき（+:syntax+オプショ
- *   ン参照）、「*E-1」というようにクエリの先頭でpragmaを利
- *   用できるようにする。script構文を用いているときはこのオ
- *   プションを利用できない。
+ * @option options :allow_pragma The allow_pragma
+ *   _query_ の構文に query を用いているとき（ +:syntax+
+ *   オプション参照）、「*E-1」というようにクエリの先頭で
+ *   pragmaを利用できるようにする。script構文を用いている
+ *   ときはこのオプションを利用できない。
  *
  *   デフォルトではプラグマを利用できる。
  *
  *   参考: grn式のquery形式（link:text/expression_rdoc.html）
  *
- * [+:allow_column+]
- *   _query_の構文にqueryを用いているとき（+:syntax+オプショ
+ * @option options :allow_column The allow_column
+ *
+ *   _query_ の構文にqueryを用いているとき（+:syntax+オプショ
  *   ン参照）、「カラム名:値」というようにカラム名を指定した
  *   条件式を利用できるようにする。script構文を用いていると
  *   きはこのオプションを利用できない。
@@ -323,8 +329,9 @@ rb_grn_expression_append_operation (VALUE self, VALUE rb_operation,
  *
  *   参考: grn式のquery形式（link:text/expression_rdoc.html）
  *
- * [+:allow_update+]
- *   _query_の構文にscriptを用いているとき（+:syntax+オプショ
+ * @option options :allow_update The allow_update
+ *
+ *   _query_の構文にscriptを用いているとき（ +:syntax+ オプショ
  *   ン参照）、「カラム名 = 値」というように更新操作を利用で
  *   きるようにする。query構文を用いているときはこのオプショ
  *   ンを利用できない。
@@ -493,8 +500,8 @@ rb_grn_expression_compile (VALUE self)
  *   expression[name] -> 変数の値
  *   expression[offset] -> 変数の値
  *
- * _expression_で使用可能な変数のうち、名前が_name_または
- * _offset_番目にExpression#append_objectされた変数の値を返
+ * _expression_ で使用可能な変数のうち、名前が _name_ または
+ * _offset_ 番目にExpression#append_objectされた変数の値を返
  * す。
  */
 static VALUE
@@ -537,7 +544,7 @@ grn_rc grn_expr_inspect(grn_ctx *ctx, grn_obj *buf, grn_obj *expr);
  * call-seq:
  *   _expression_.inspect -> String
  *
- * _expression_の中身を人に見やすい文字列で返す。
+ * _expression_ の中身を人に見やすい文字列で返す。
  */
 static VALUE
 rb_grn_expression_inspect (VALUE self)
@@ -571,46 +578,51 @@ rb_grn_expression_inspect (VALUE self)
  * call-seq:
  *   expression.snippet(tags, options) -> Groonga::Snippet
  *
- * _expression_からGroonga::Snippetを生成する。_tags_にはキー
- * ワードの前後に挿入するタグの配列を以下のような形式で指定
+ * _expression_ からGroonga::Snippetを生成する。 _tags_ には
+ * キーワードの前後に挿入するタグの配列を以下のような形式で指定
  * する。
- *
- *   [
+ * <pre>
+ *   ==[
  *    ["キーワード前に挿入する文字列1", "キーワード後に挿入する文字列1"],
  *    ["キーワード前に挿入する文字列2", "キーワード後に挿入する文字列2"],
  *    ...,
- *   ]
- *
- * もし、1つのスニペットの中に_tags_で指定したタグより多くの
+ *   ]==
+ * </pre>
+ * もし、1つのスニペットの中に _tags_ で指定したタグより多くの
  * キーワードが含まれている場合は、以下のように、また、先頭
  * のタグから順番に使われる。
- *
- *   expression.parse("Ruby groonga 検索")
+ * <pre>
+ *   ==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>。"]
+ *      => ["<tag1>Ruby</tag1>で<tag2>groonga</tag2>"
+ *      => "使って全文<tag1>検索</tag1>、高速<tag2>検索</tag2>。"]==
+ * </pre>
  *
- * _options_に指定可能な値は以下の通り。
+ * _options_ に指定可能な値は以下の通り。
+ * @param options [::Hash] The name and value
+ *   pairs. Omitted names are initialized as the default value.
+ * @option options :normalize (false) The normalize
  *
- * [+:normalize+]
  *   キーワード文字列・スニペット元の文字列を正規化するかど
- *   うか。省略した場合は+false+で正規化しない。
+ *   うか。省略した場合は +false+ で正規化しない。
  *
- * [+:skip_leading_spaces+]
- *   先頭の空白を無視するかどうか。省略した場合は+false+で無
+ * @option options :skip_leading_spaces (false) The skip_leading_spaces
+ *
+ *   先頭の空白を無視するかどうか。省略した場合は +false+ で無
  *   視しない。
  *
- * [+:width+]
+ * @option options :width (100) The width
+ *
  *   スニペット文字列の長さ。省略した場合は100文字。
+ * @option options :max_results (3) The max_results
  *
- * [+:max_results+]
  *   生成するスニペットの最大数。省略した場合は3。
+ * @option options :html_escape (false) The html_escape
  *
- * [+:html_escape+]
- *   スニペット内の+<+, +>+, +&+, +"+をHTMLエスケープするか
- *   どうか。省略した場合は+false+で、HTMLエスケープしない。
+ *   スニペット内の +<+, +>+, +&+, +"+ をHTMLエスケープするか
+ *   どうか。省略した場合は +false+ で、HTMLエスケープしない。
  */
 static VALUE
 rb_grn_expression_snippet (int argc, VALUE *argv, VALUE self)

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

@@ -1,4 +1,4 @@
-/* -*- c-file-style: "ruby" -*- */
+/* -*- coding: utf-8; c-file-style: "ruby" -*- */
 /*
   Copyright (C) 2009-2010  Kouhei Sutou <kou@clear-code.com>
 
@@ -32,7 +32,7 @@ VALUE rb_cGrnFixSizeColumn;
  * call-seq:
  *   column[id] -> 値
  *
- * _column_の_id_に対応する値を返す。
+ * _column_ の _id_ に対応する値を返す。
  */
 VALUE
 rb_grn_fix_size_column_array_reference (VALUE self, VALUE rb_id)
@@ -59,7 +59,7 @@ rb_grn_fix_size_column_array_reference (VALUE self, VALUE rb_id)
  * call-seq:
  *   column[id] = value
  *
- * _column_の_id_に対応する値を設定する。
+ * _column_ の _id_ に対応する値を設定する。
  */
 static VALUE
 rb_grn_fix_size_column_array_set (VALUE self, VALUE rb_id, VALUE rb_value)
@@ -120,8 +120,8 @@ rb_grn_fix_size_column_integer_set (int argc, VALUE *argv, VALUE self, int flags
  * call-seq:
  *   column.increment!(id, delta=nil)
  *
- * _column_の_id_に対応する値を_delta_だけ増加する。_delta_
- * が+nil+の場合は1増加する。
+ * _column_ の _id_ に対応する値を _delta_ だけ増加する。 _delta_
+ * が +nil+ の場合は1増加する。
  */
 static VALUE
 rb_grn_fix_size_column_increment (int argc, VALUE *argv, VALUE self)
@@ -133,8 +133,8 @@ rb_grn_fix_size_column_increment (int argc, VALUE *argv, VALUE self)
  * call-seq:
  *   column.decrement!(id, delta=nil)
  *
- * _column_の_id_に対応する値を_delta_だけ減少する。_delta_
- * が+nil+の場合は1減少する。
+ * _column_ の _id_ に対応する値を _delta_ だけ減少する。 _delta_
+ * が +nil+ の場合は1減少する。
  */
 static VALUE
 rb_grn_fix_size_column_decrement (int argc, VALUE *argv, VALUE self)

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

@@ -1,4 +1,4 @@
-/* -*- c-file-style: "ruby" -*- */
+/* -*- coding: utf-8; c-file-style: "ruby" -*- */
 /*
   Copyright (C) 2009  Kouhei Sutou <kou@clear-code.com>
 

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

@@ -1,4 +1,4 @@
-/* -*- c-file-style: "ruby" -*- */
+/* -*- coding: utf-8; c-file-style: "ruby" -*- */
 /*
   Copyright (C) 2009  Kouhei Sutou <kou@clear-code.com>
 
@@ -38,34 +38,37 @@ VALUE rb_cGrnHash;
  * 定すると、そのブロックに生成したテーブルが渡され、ブロック
  * を抜けると自動的にテーブルが破棄される。
  *
- * _options_に指定可能な値は以下の通り。
+ * _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
  *
- * [+:context+]
  *   テーブルが利用するGroonga::Context。省略すると
  *   Groonga::Context.defaultを用いる。
+ * @option options [Groonga::Context#[]] :name The name
  *
- * [+:name+]
  *   テーブルの名前。名前をつけると、Groonga::Context#[]に名
  *   前を指定してテーブルを取得することができる。省略すると
  *   無名テーブルになり、テーブルIDでのみ取得できる。
  *
- * [+:path+]
+ * @option options [Groonga::Context#[]] :path The path
+ *
  *   テーブルを保存するパス。パスを指定すると永続テーブルとな
  *   り、プロセス終了後もレコードは保持される。次回起動時に
  *   Groonga::Context#[]で保存されたレコードを利用することが
  *   できる。省略すると一時テーブルになり、プロセスが終了する
  *   とレコードは破棄される。
  *
- * [+:persistent+]
- *   +true+を指定すると永続テーブルとなる。+path+を省略した
- *   場合は自動的にパスが付加される。+:context+で指定した
+ * @option options :persistent The persistent
+ *   +true+ を指定すると永続テーブルとなる。 +path+ を省略した
+ *   場合は自動的にパスが付加される。 +:context+ で指定した
  *   Groonga::Contextに結びついているデータベースが一時デー
  *   タベースの場合は例外が発生する。
  *
- * [+:key_normalize+]
- *   +true+を指定するとキーを正規化する。
+ * @option options :key_normalize The normalize
+ *   +true+ を指定するとキーを正規化する。
  *
- * [+:key_type+]
+ * @option options :key_type The key_type
  *   キーの種類を示すオブジェクトを指定する。キーの種類には型
  *   名（"Int32"や"ShortText"など）またはGroonga::Typeまたは
  *   テーブル（Groonga::Array、Groonga::Hash、
@@ -84,60 +87,57 @@ VALUE rb_cGrnHash;
  *   省略した場合はShortText型をキーとして使用する。この場合、
  *   4096バイトまで使用可能である。
  *
- * [+:value_type+]
+ * @option options :value_type The value_type
+ *
  *   値の型を指定する。省略すると値のための領域を確保しない。
  *   値を保存したい場合は必ず指定すること。
  *
  *   参考: Groonga::Type.new
  *
- * [+:default_tokenizer+]
+ * @option options [Groonga::IndexColumn] :default_tokenizer The default_tokenizer
  *   Groonga::IndexColumnで使用するトークナイザを指定する。
  *   デフォルトでは何も設定されていないので、テーブルに
  *   Groonga::IndexColumnを定義する場合は
  *   <tt>"TokenBigram"</tt>などを指定する必要がある。
  *
- * [+:sub_records+]
- *   +true+を指定すると#groupでグループ化したときに、
+ * @option options [Groonga::Record#n_sub_records] :sub_records The sub_records
+ *   +true+ を指定すると#groupでグループ化したときに、
  *   Groonga::Record#n_sub_recordsでグループに含まれるレコー
  *   ドの件数を取得できる。
  *
- * 使用例:
- *
- * 無名一時テーブルを生成する。
+ * @example
+ *   #無名一時テーブルを生成する。
  *   Groonga::Hash.create
  *
- * 無名永続テーブルを生成する。
+ *   #無名永続テーブルを生成する。
  *   Groonga::Hash.create(:path => "/tmp/hash.grn")
  *
- * 名前付き永続テーブルを生成する。ただし、ファイル名は気に
- * しない。
+ *   #名前付き永続テーブルを生成する。ただし、ファイル名は気にしない。
  *   Groonga::Hash.create(:name => "Bookmarks",
  *                        :persistent => true)
  *
- * それぞれのレコードに512バイトの値を格納できる無名一時テー
- * ブルを生成する。
+ *   #それぞれのレコードに512バイトの値を格納できる無名一時テーブルを生成する。
  *   Groonga::Hash.create(:value => 512)
  *
- * キーとして文字列を使用する無名一時テーブルを生成する。
+ *   #キーとして文字列を使用する無名一時テーブルを生成する。
  *   Groonga::Hash.create(:key_type => Groonga::Type::SHORT_TEXT)
  *
- * キーとして文字列を使用する無名一時テーブルを生成する。
- * （キーの種類を表すオブジェクトは文字列で指定。）
+ *   #キーとして文字列を使用する無名一時テーブルを生成する。
+ *   （キーの種類を表すオブジェクトは文字列で指定。）
  *   Groonga::Hash.create(:key_type => "ShortText")
  *
- * キーとして<tt>Bookmarks</tt>テーブルのレコードを使用す
- * る無名一時テーブルを生成する。
+ *   #キーとして<tt>Bookmarks</tt>テーブルのレコードを使用す
+ *   る無名一時テーブルを生成する。
  *   bookmarks = Groonga::Hash.create(:name => "Bookmarks")
  *   Groonga::Hash.create(:key_type => bookmarks)
  *
- * キーとして<tt>Bookmarks</tt>テーブルのレコードを使用す
- * る無名一時テーブルを生成する。
- * （テーブルは文字列で指定。）
+ *   #キーとして<tt>Bookmarks</tt>テーブルのレコードを使用す
+ *   #る無名一時テーブルを生成する。（テーブルは文字列で指定。）
  *   Groonga::Hash.create(:name => "Bookmarks")
  *   Groonga::Hash.create(:key_type => "Bookmarks")
  *
- * 全文検索用のトークンをバイグラムで切り出す無名一時テーブ
- * ルを生成する。
+ *   #全文検索用のトークンをバイグラムで切り出す無名一時テーブ
+ *   #ルを生成する。
  *   bookmarks = Groonga::Hash.create(:name => "Bookmarks")
  *   bookmarks.define_column("comment", "Text")
  *   terms = Groonga::Hash.create(:name => "Terms",
@@ -223,20 +223,23 @@ rb_grn_hash_s_create (int argc, VALUE *argv, VALUE klass)
  * call-seq:
  *   hash.search(key, options=nil) -> Groonga::Hash
  *
- * _key_にマッチするレコードのIDがキーに入っている
+ * _key_ にマッチするレコードのIDがキーに入っている
  * Groonga::Hashを返す。マッチするレコードがない場合は空の
  * Groonga::Hashが返る。
  *
- * _options_で+:result+を指定することにより、そのテーブルにマッ
+ * _options_ で +:result+ を指定することにより、そのテーブルにマッ
  * チしたレコードIDがキーのレコードを追加することができる。
- * +:result+にテーブルを指定した場合は、そのテーブルが返る。
+ * +:result+ にテーブルを指定した場合は、そのテーブルが返る。
+ *
+ * _options_ に指定可能な値は以下の通り。
+ * @param [::Hash] options The name and value
+ *   pairs. Omitted names are initialized as the default value
  *
- * _options_に指定可能な値は以下の通り。
+ * @option options :result The result
  *
- * [+:result+]
  *   結果を格納するテーブル。
  *
- * 複数のキーで検索し、結果を1つのテーブルに集める。
+ * @example 複数のキーで検索し、結果を1つのテーブルに集める。
  *   result = nil
  *   keys = ["morita", "gunyara-kun", "yu"]
  *   keys.each do |key|