rroonga 2.0.5 → 2.0.6

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;
@@ -207,7 +207,7 @@ rb_grn_encoding_s_get_default (VALUE self)
  * デフォルトのエンコーディングを設定する。
  * @overload default=(encoding)
  *   @param [Groonga::Encoding] encoding 指定するエンコーディング。
- *     エンコーディングの指定方法はGroonga::Encodingを参照。
+ *     エンコーディングの指定方法は {Groonga::Encoding} を参照。
  */
 static VALUE
 rb_grn_encoding_s_set_default (VALUE self, VALUE rb_encoding)

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

@@ -235,10 +235,9 @@ rb_grn_expression_append_constant (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   expression.append_operation(operation, n_arguments)
- *
  * _n_arguments_ 個の引数を取る _operation_ を追加する。
+ *
+ * @overload append_operation(operation, n_arguments)
  */
 static VALUE
 rb_grn_expression_append_operation (VALUE self, VALUE rb_operation,
@@ -293,12 +292,12 @@ rb_grn_expression_append_operation (VALUE self, VALUE rb_operation,
  *       「文字列1 OR 文字列2」で「"文字列1"あるいは"文字列2"
  *       にマッチという検索エンジンで利用できるような構文を使
  *       う。
- *       参考: grn式のquery形式（link:text/expression_rdoc.html） =:
+ *       参考: "Groongaのクエリ構文のドキュメント":http://groonga.org/ja/docs/reference/grn_expr/query_syntax.html =:
  *     - +nil+ :=
  *       +:query+と同様 =:
  *     - +:script+ :=
  *       「[カラム名] == [値]」というようにECMAScript風の構文を使う。
- *       参考: grn式のscript形式（link:text/expression_rdoc.html） =:
+ *       参考: "Groongaのscript構文のドキュメント":http://groonga.org/ja/docs/reference/grn_expr/script_syntax.html =:
  *   @option options :allow_pragma
  *     _query_ の構文に query を用いているとき（ +:syntax+
  *     オプション参照）、「*E-1」というようにクエリの先頭で
@@ -307,7 +306,7 @@ rb_grn_expression_append_operation (VALUE self, VALUE rb_operation,
  *
  *     デフォルトではプラグマを利用できる。
  *
- *     参考: grn式のquery形式（link:text/expression_rdoc.html）
+ *     参考: "Groongaのクエリ構文のドキュメント":http://groonga.org/ja/docs/reference/grn_expr/query_syntax.html
  *   @option options :allow_column
  *     _query_ の構文にqueryを用いているとき（ +:syntax+ オプショ
  *     ン参照）、「カラム名:値」というようにカラム名を指定した
@@ -316,7 +315,7 @@ rb_grn_expression_append_operation (VALUE self, VALUE rb_operation,
  *
  *     デフォルトではカラム名を指定した条件式を利用できる。
  *
- *     参考: grn式のquery形式（link:text/expression_rdoc.html）
+ *     参考: "Groongaのクエリ構文のドキュメント":http://groonga.org/ja/docs/reference/grn_expr/query_syntax.html
  *   @option options :allow_update
  *     _query_ の構文にscriptを用いているとき（ +:syntax+ オプショ
  *     ン参照）、「カラム名 = 値」というように更新操作を利用で
@@ -325,7 +324,7 @@ rb_grn_expression_append_operation (VALUE self, VALUE rb_operation,
  *
  *     デフォルトでは更新操作を利用できる。
  *
- *     参考: grn式のscript形式（link:text/expression_rdoc.html）
+ *     参考: "Groongaのクエリ構文のドキュメント":http://groonga.org/ja/docs/reference/grn_expr/query_syntax.html
  */
 static VALUE
 rb_grn_expression_parse (int argc, VALUE *argv, VALUE self)
@@ -341,7 +340,7 @@ rb_grn_expression_parse (int argc, VALUE *argv, VALUE self)
     grn_expr_flags flags = 0;
     VALUE options, rb_query, rb_default_column, rb_default_operator;
     VALUE rb_default_mode, rb_syntax;
-    VALUE rb_allow_pragma, rb_allow_column, rb_allow_update;
+    VALUE rb_allow_pragma, rb_allow_column, rb_allow_update, rb_allow_leading_not;
     VALUE exception = Qnil;
 
     rb_scan_args(argc, argv, "11", &rb_query, &options);
@@ -353,6 +352,7 @@ rb_grn_expression_parse (int argc, VALUE *argv, VALUE self)
 			"allow_pragma", &rb_allow_pragma,
 			"allow_column", &rb_allow_column,
 			"allow_update", &rb_allow_update,
+			"allow_leading_not", &rb_allow_leading_not,
                         NULL);
 
     query = StringValuePtr(rb_query);
@@ -417,6 +417,11 @@ rb_grn_expression_parse (int argc, VALUE *argv, VALUE self)
 	    flags |= GRN_EXPR_ALLOW_UPDATE;
     }
 
+    if (!NIL_P(rb_allow_leading_not)) {
+	if (RVAL2CBOOL(rb_allow_leading_not))
+	    flags |= GRN_EXPR_ALLOW_LEADING_NOT;
+    }
+
     rc = grn_expr_parse(context, expression, query, query_size,
 			default_column, default_mode, default_operator,
 			flags);
@@ -436,10 +441,10 @@ rb_grn_expression_parse (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   expression.execute -> 値
+ * _expression_ を実行し、実行した結果を返す。
  *
- * _expression_を実行し、実行した結果を返す。
+ * @overload execute
+ *   @return [値]
  */
 static VALUE
 rb_grn_expression_execute (VALUE self)
@@ -459,10 +464,9 @@ rb_grn_expression_execute (VALUE self)
 }
 
 /*
- * call-seq:
- *   expression.compile
+ * _expression_ をコンパイルする。
  *
- * _expression_をコンパイルする。
+ * @overload compile
  */
 static VALUE
 rb_grn_expression_compile (VALUE self)
@@ -483,13 +487,14 @@ rb_grn_expression_compile (VALUE self)
 }
 
 /*
- * call-seq:
- *   expression[name] -> 変数の値
- *   expression[offset] -> 変数の値
+ * _expression_ で使用可能な変数のうち、名前が _name_
+ * または _offset_ 番目に {Expression#append_object}
+ * された変数の値を返す。
  *
- * _expression_ で使用可能な変数のうち、名前が _name_ または
- * _offset_ 番目にExpression#append_objectされた変数の値を返
- * す。
+ * @overload [](name)
+ *   @return [変数の値]
+ * @overload [](offset)
+ *   @return [変数の値]
  */
 static VALUE
 rb_grn_expression_array_reference (VALUE self, VALUE rb_name_or_offset)
@@ -528,10 +533,10 @@ rb_grn_expression_array_reference (VALUE self, VALUE rb_name_or_offset)
 grn_rc grn_expr_inspect(grn_ctx *ctx, grn_obj *buf, grn_obj *expr);
 
 /*
- * call-seq:
- *   _expression_.inspect -> String
- *
  * _expression_ の中身を人に見やすい文字列で返す。
+ *
+ * @overload inspect
+ *   @return [String]
  */
 static VALUE
 rb_grn_expression_inspect (VALUE self)

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

@@ -29,10 +29,10 @@ VALUE rb_cGrnFixSizeColumn;
  */
 
 /*
- * call-seq:
- *   column[id] -> 値
- *
  * _column_ の _id_ に対応する値を返す。
+ *
+ * @overload column[id]
+ *   @return [値]
  */
 VALUE
 rb_grn_fix_size_column_array_reference (VALUE self, VALUE rb_id)
@@ -118,11 +118,10 @@ 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増加する。
+ *
+ * @overload increment!(id, delta=nil)
  */
 static VALUE
 rb_grn_fix_size_column_increment (int argc, VALUE *argv, VALUE self)
@@ -131,11 +130,10 @@ 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減少する。
+ *
+ * @overload decrement!(id, delta=nil)
  */
 static VALUE
 rb_grn_fix_size_column_decrement (int argc, VALUE *argv, VALUE self)

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

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

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

@@ -55,12 +55,12 @@ VALUE rb_cGrnHash;
  *   （キーの種類を表すオブジェクトは文字列で指定。）
  *   Groonga::Hash.create(:key_type => "ShortText")
  *
- *   #キーとして<tt>Bookmarks</tt>テーブルのレコードを使用す
+ *   #キーとしてBookmarksテーブルのレコードを使用す
  *   る無名一時テーブルを生成する。
  *   bookmarks = Groonga::Hash.create(:name => "Bookmarks")
  *   Groonga::Hash.create(:key_type => bookmarks)
  *
- *   #キーとして<tt>Bookmarks</tt>テーブルのレコードを使用す
+ *   #キーとしてBookmarksテーブルのレコードを使用す
  *   #る無名一時テーブルを生成する。（テーブルは文字列で指定。）
  *   Groonga::Hash.create(:name => "Bookmarks")
  *   Groonga::Hash.create(:key_type => "Bookmarks")
@@ -76,116 +76,65 @@ VALUE rb_cGrnHash;
  *
  * @overload create(options={})
  *   @return [Groonga::Hash]
- *   @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。省略すると
- *     Groonga::Context.defaultを用いる。
- *   @option options [Groonga::Context#[]] :name
- *     テーブルの名前。名前をつけると、Groonga::Context#[]に名
- *     前を指定してテーブルを取得することができる。省略すると
- *     無名テーブルになり、テーブルIDでのみ取得できる。
- *   @option options [Groonga::Context#[]] :path
- *     テーブルを保存するパス。パスを指定すると永続テーブルとな
- *     り、プロセス終了後もレコードは保持される。次回起動時に
- *     Groonga::Context#[]で保存されたレコードを利用することが
- *     できる。省略すると一時テーブルになり、プロセスが終了する
- *     とレコードは破棄される。
- *   @option options :persistent
- *     +true+ を指定すると永続テーブルとなる。 +path+ を省略した
- *     場合は自動的にパスが付加される。 +:context+ で指定した
- *     Groonga::Contextに結びついているデータベースが一時デー
- *     タベースの場合は例外が発生する。
- *   @option options :key_normalize
- *     +true+ を指定するとキーを正規化する。
- *   @option options :key_type
- *     キーの種類を示すオブジェクトを指定する。キーの種類には型
- *     名（"Int32"や"ShortText"など）またはGroonga::Typeまたは
- *     テーブル（Groonga::Array、Groonga::Hash、
- *     Groonga::PatriciaTrieのどれか）を指定する。
+ *   @!macro hash.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} 。省略すると
+ *       {Groonga::Context.default} を用いる。
+ *     @option options [Groonga::Context#[]] :name
+ *       テーブルの名前。名前をつけると、 {Groonga::Context#[]} に名
+ *       前を指定してテーブルを取得することができる。省略すると
+ *       無名テーブルになり、テーブルIDでのみ取得できる。
+ *     @option options [Groonga::Context#[]] :path
+ *       テーブルを保存するパス。パスを指定すると永続テーブルとな
+ *       り、プロセス終了後もレコードは保持される。次回起動時に
+ *       {Groonga::Context#[]} で保存されたレコードを利用することが
+ *       できる。省略すると一時テーブルになり、プロセスが終了する
+ *       とレコードは破棄される。
+ *     @option options :persistent
+ *       +true+ を指定すると永続テーブルとなる。 +path+ を省略した
+ *       場合は自動的にパスが付加される。 +:context+ で指定した
+ *       {Groonga::Context} に結びついているデータベースが一時デー
+ *       タベースの場合は例外が発生する。
+ *     @option options :key_normalize
+ *       +true+ を指定するとキーを正規化する。
+ *     @option options :key_type
+ *       キーの種類を示すオブジェクトを指定する。キーの種類には型
+ *       名（"Int32"や"ShortText"など）または {Groonga::Type} または
+ *       テーブル（ {Groonga::Array} 、 {Groonga::Hash} 、
+ *       {Groonga::PatriciaTrie} のどれか）を指定する。
  *
- *     Groonga::Typeを指定した場合は、その型が示す範囲の値をキー
- *     として使用する。ただし、キーの最大サイズは4096バイトで
- *     あるため、Groonga::Type::TEXTやGroonga::Type::LONG_TEXT
- *     は使用できない。
+ *       {Groonga::Type} を指定した場合は、その型が示す範囲の値をキー
+ *       として使用する。ただし、キーの最大サイズは4096バイトで
+ *       あるため、 {Groonga::Type::TEXT} や {Groonga::Type::LONG_TEXT}
+ *       は使用できない。
  *
- *     テーブルを指定した場合はレコードIDをキーとして使用する。
- *     指定したテーブルのGroonga::Recordをキーとして使用するこ
- *     ともでき、その場合は自動的にGroonga::Recordからレコード
- *     IDを取得する。
+ *       テーブルを指定した場合はレコードIDをキーとして使用する。
+ *       指定したテーブルの {Groonga::Record} をキーとして使用するこ
+ *       ともでき、その場合は自動的に {Groonga::Record} からレコード
+ *       IDを取得する。
  *
- *     省略した場合はShortText型をキーとして使用する。この場合、
- *     4096バイトまで使用可能である。
- *   @option options :value_type
- *     値の型を指定する。省略すると値のための領域を確保しない。
- *     値を保存したい場合は必ず指定すること。
+ *       省略した場合はShortText型をキーとして使用する。この場合、
+ *       4096バイトまで使用可能である。
+ *     @option options :value_type
+ *       値の型を指定する。省略すると値のための領域を確保しない。
+ *       値を保存したい場合は必ず指定すること。
  *
- *     参考: Groonga::Type.new
- *   @option options [Groonga::IndexColumn] :default_tokenizer
- *     Groonga::IndexColumnで使用するトークナイザを指定する。
- *     デフォルトでは何も設定されていないので、テーブルに
- *     Groonga::IndexColumnを定義する場合は
- *     <tt>"TokenBigram"</tt>などを指定する必要がある。
- *   @option options [Groonga::Record#n_sub_records] :sub_records
- *     +true+ を指定すると#groupでグループ化したときに、
- *     Groonga::Record#n_sub_recordsでグループに含まれるレコー
- *     ドの件数を取得できる。
+ *       参考: {Groonga::Type.new}
+ *     @option options [Groonga::IndexColumn] :default_tokenizer
+ *       {Groonga::IndexColumn} で使用するトークナイザを指定する。
+ *       デフォルトでは何も設定されていないので、テーブルに
+ *       {Groonga::IndexColumn} を定義する場合は
+ *       @"TokenBigram"@ などを指定する必要がある。
+ *     @option options [Groonga::Record#n_sub_records] :sub_records
+ *       +true+ を指定すると {#group} でグループ化したときに、
+ *       {Groonga::Record#n_sub_records} でグループに含まれるレコー
+ *       ドの件数を取得できる。
+ *   @!macro hash.create.options
  * @overload create(options={})
  *   @yield [table]
- *   @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。省略すると
- *     Groonga::Context.defaultを用いる。
- *   @option options [Groonga::Context#[]] :name
- *     テーブルの名前。名前をつけると、Groonga::Context#[]に名
- *     前を指定してテーブルを取得することができる。省略すると
- *     無名テーブルになり、テーブルIDでのみ取得できる。
- *   @option options [Groonga::Context#[]] :path
- *     テーブルを保存するパス。パスを指定すると永続テーブルとな
- *     り、プロセス終了後もレコードは保持される。次回起動時に
- *     Groonga::Context#[]で保存されたレコードを利用することが
- *     できる。省略すると一時テーブルになり、プロセスが終了する
- *     とレコードは破棄される。
- *   @option options :persistent
- *     +true+ を指定すると永続テーブルとなる。 +path+ を省略した
- *     場合は自動的にパスが付加される。 +:context+ で指定した
- *     Groonga::Contextに結びついているデータベースが一時デー
- *     タベースの場合は例外が発生する。
- *   @option options :key_normalize
- *     +true+ を指定するとキーを正規化する。
- *   @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 [Groonga::IndexColumn] :default_tokenizer
- *     Groonga::IndexColumnで使用するトークナイザを指定する。
- *     デフォルトでは何も設定されていないので、テーブルに
- *     Groonga::IndexColumnを定義する場合は
- *     <tt>"TokenBigram"</tt>などを指定する必要がある。
- *   @option options [Groonga::Record#n_sub_records] :sub_records
- *     +true+ を指定すると#groupでグループ化したときに、
- *     Groonga::Record#n_sub_recordsでグループに含まれるレコー
- *     ドの件数を取得できる。
+ *   @!macro hash.create.options
  */
 static VALUE
 rb_grn_hash_s_create (int argc, VALUE *argv, VALUE klass)
@@ -263,8 +212,8 @@ rb_grn_hash_s_create (int argc, VALUE *argv, VALUE klass)
 
 /*
  * _key_ にマッチするレコードのIDがキーに入っている
- * Groonga::Hashを返す。マッチするレコードがない場合は空の
- * Groonga::Hashが返る。
+ * {Groonga::Hash} を返す。マッチするレコードがない場合は空の
+ * {Groonga::Hash} が返る。
  *
  * _options_ で +:result+ を指定することにより、そのテーブルにマッ
  * チしたレコードIDがキーのレコードを追加することができる。