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

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

@@ -1,6 +1,7 @@
 /* -*- coding: utf-8; c-file-style: "ruby" -*- */
 /*
   Copyright (C) 2011  Haruka Yoshihara <yoshihara@clear-code.com>
+  Copyright (C) 2012  Kouhei Sutou <kou@clear-code.com>
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Lesser General Public
@@ -21,7 +22,8 @@
 VALUE rb_cGrnPosting;
 
 VALUE
-rb_grn_posting_new (grn_posting *posting, grn_id term_id)
+rb_grn_posting_new (grn_posting *posting, grn_id term_id,
+		    VALUE rb_table, VALUE rb_lexicon)
 {
     VALUE parameters;
 
@@ -40,6 +42,9 @@ rb_grn_posting_new (grn_posting *posting, grn_id term_id)
 
 #undef SET_PARAMETER
 
+    rb_hash_aset(parameters, ID2SYM(rb_intern("table")), rb_table);
+    rb_hash_aset(parameters, ID2SYM(rb_intern("lexicon")), rb_lexicon);
+
     return rb_funcall(rb_cGrnPosting, rb_intern("new"), 1,
 		      parameters);
 }

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

@@ -55,43 +55,29 @@ rb_grn_snippet_deconstruct (RbGrnSnippet *rb_grn_snippet,
 }
 
 /*
- * call-seq:
- *   Groonga::Snippet.new(options={})
+ * スニペットを作成する。
  *
- * スニペットを作成する。 _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
- *
- *   スキーマ作成時に使用するGroonga::Contextを指定する。
- *
- * @option options :normalize The normalize
- *
- *   キーワード文字列・スニペット元の文字列を正規化するかど
- *   うか。省略した場合は +false+ で正規化しない。
- *
- * @option options :skip_leading_spaces (false) The skip_leading_spaces
- *
- *   先頭の空白を無視するかどうか。省略した場合は で無
- *   視しない。
- *
- * @option options :width (100) The width
- *
- *   スニペット文字列の長さ。省略した場合は100文字。
- *
- * @option options :max_results (3) The max_results
- *   生成するスニペットの最大数。省略した場合は3。
- *
- * @option options :html_escape (false) The html_escape
- *   スニペット内の+<+, +>+, +&+, +"+をHTMLエスケープするか
- *   どうか。省略した場合は+false+で、HTMLエスケープしない。
- *
- * @option options :default_open_tag ("") The default_open_tag
- *   デフォルトの開始タグ。省略した場合は""(空文字列)
- *
- * @option options :default_close_tag ("") The default_close_tag
- *   デフォルトの終了タグ。省略した場合は""(空文字列)
+ * @overload new(options={})
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :context (Groonga::Context.default)
+ *     スキーマ作成時に使用するGroonga::Contextを指定する。
+ *   @option options :normalize
+ *     キーワード文字列・スニペット元の文字列を正規化するかどうか。
+ *     省略した場合は +false+ で正規化しない。
+ *   @option options :skip_leading_spaces (false)
+ *     先頭の空白を無視するかどうか。省略した場合は +false+ で無視しない。
+ *   @option options :width (100)
+ *     スニペット文字列の長さ。省略した場合は100文字。
+ *   @option options :max_results (3)
+ *     生成するスニペットの最大数。省略した場合は3。
+ *   @option options :html_escape (false)
+ *     スニペット内の +<+ , +>+ , +&+ , +"+ をHTMLエスケープするかどうか。
+ *     省略した場合は +false+ で、HTMLエスケープしない。
+ *   @option options :default_open_tag ("")
+ *     デフォルトの開始タグ。省略した場合は""(空文字列)
+ *   @option options :default_close_tag ("")
+ *     デフォルトの終了タグ。省略した場合は""(空文字列)
  */
 static VALUE
 rb_grn_snippet_initialize (int argc, VALUE *argv, VALUE self)
@@ -165,22 +151,18 @@ rb_grn_snippet_initialize (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   snippet.add_keyword(keyword, options={})
- *
- * _keyword_ を追加する。 _options_ に指定可能な値は
- * 以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :open_tag (default_open_tag) The open_tag
+ * _keyword_ を追加する。
  *
- *   開始タグ。省略した場合はGroonga::Snippet.newで指定し
- *   た+:default_open_tag+。
- *
- * @option options :close_tag (:default_close_tag) The close_tag
- *
- *   終了タグ。省略した場合はGroonga::Snippet.newで指定し
- *   た+:default_close_tag+。
+ * @overload add_keyword(keyword, options={})
+ *   @param [String] keyword 追加するキーワード
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :open_tag (default_open_tag)
+ *     開始タグ。省略した場合はGroonga::Snippet.newで指定した
+ *     +:default_open_tag+ 。
+ *   @option options :close_tag (:default_close_tag)
+ *     終了タグ。省略した場合はGroonga::Snippet.newで指定した
+ *     +:default_close_tag+ 。
  */
 static VALUE
 rb_grn_snippet_add_keyword (int argc, VALUE *argv, VALUE self)
@@ -225,10 +207,11 @@ rb_grn_snippet_add_keyword (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   snippet.execute(string) -> スニペットの配列
- *
  * _string_ を走査し、スニペットを作成する。
+ *
+ * @overload execute(string)
+ *   @param [String] string 走査する文字列
+ * @return [::Array] 作成されたスニペットの配列
  */
 static VALUE
 rb_grn_snippet_execute (VALUE self, VALUE rb_string)

data/ext/groonga/rb-grn-table-cursor-key-support.c

@@ -31,10 +31,10 @@ VALUE rb_mGrnTableCursorKeySupport;
  */
 
 /*
- * call-seq:
- *   cursor.key -> 主キー
- *
  * カレントレコードの主キーを返す。
+ *
+ * @overload key
+ * @return [::Object] カレントレコードの主キー
  */
 static VALUE
 rb_grn_table_cursor_get_key (VALUE self)

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

@@ -26,7 +26,7 @@ VALUE rb_cGrnTableCursor;
  * Document-class: Groonga::TableCursor
  *
  * テーブルに登録されているレコードを順番に取り出すための
- * オブジェクト。Groonga::Table#open_cursorで生成できる。
+ * オブジェクト。 {Groonga::Table#open_cursor} で生成できる。
  */
 
 grn_table_cursor *
@@ -125,10 +125,10 @@ rb_grn_table_cursor_order_by_to_flag (unsigned char table_type,
 }
 
 /*
- * call-seq:
- *   cursor.value -> 値
- *
  * カレントレコードの値を返す。
+ *
+ * @overload value
+ *   @return [String] カレントレコードの値
  */
 static VALUE
 rb_grn_table_cursor_get_value (VALUE self)
@@ -151,10 +151,10 @@ rb_grn_table_cursor_get_value (VALUE self)
 }
 
 /*
- * call-seq:
- *   cursor.value = 値
- *
  * カレントレコードの値を設定する。既存の値は上書きされる。
+ *
+ * @overload value=(value)
+ *   @param [String] value カレントレコードに設定する値
  */
 static VALUE
 rb_grn_table_cursor_set_value (VALUE self, VALUE value)
@@ -178,10 +178,9 @@ rb_grn_table_cursor_set_value (VALUE self, VALUE value)
 }
 
 /*
- * call-seq:
- *   table_cursor.delete
- *
  * カレントレコードを削除する。
+ *
+ * @overload delete
  */
 static VALUE
 rb_grn_table_cursor_delete (VALUE self)
@@ -202,10 +201,10 @@ rb_grn_table_cursor_delete (VALUE self)
 }
 
 /*
- * call-seq:
- *   table_cursor.next -> Groonga::Record
- *
  * カレントレコードを一件進めてそのレコードを返す。
+ *
+ * @overload next
+ *   @return [Groonga::Record]
  */
 static VALUE
 rb_grn_table_cursor_next (VALUE self)
@@ -229,10 +228,10 @@ rb_grn_table_cursor_next (VALUE self)
 }
 
 /*
- * call-seq:
- *   table_cursor.each {|record| ...}
- *
  * カーソルの範囲内にあるレコードを順番にブロックに渡す。
+ *
+ * @overload each
+ *   @yield [record]
  */
 static VALUE
 rb_grn_table_cursor_each (VALUE self)
@@ -241,6 +240,8 @@ rb_grn_table_cursor_each (VALUE self)
     grn_ctx *context;
     grn_table_cursor *cursor;
 
+    RETURN_ENUMERATOR(self, 0, NULL);
+
     rb_grn_table_cursor_deconstruct(SELF(self), &cursor, &context,
 				    NULL, NULL, NULL, NULL);
 
@@ -255,23 +256,17 @@ rb_grn_table_cursor_each (VALUE self)
 }
 
 /*
- * Document-method: close
- *
- * call-seq:
- *   cursor.close
- *
  * カーソルが使用しているリソースを開放する。これ以降カーソルを
  * 使うことはできない。
+ *
+ * @overload close
  */
 
 /*
- * Document-method: closed?
- *
- * call-seq:
- *   cursor.closed? -> true/false
- *
  * カーソルが開放済みの場合は +true+ を返し、そうでない場合は
  * +false+ を返す。
+ *
+ * @overload closed?
  */
 
 void

data/ext/groonga/rb-grn-table-key-support.c

@@ -25,8 +25,8 @@ VALUE rb_mGrnTableKeySupport;
 /*
  * Document-module: Groonga::Table::KeySupport
  *
- * 主キーを持つテーブルであるGroonga::Hashと
- * Groonga::PatriciaTrieに主キーの機能を提供するモジュール。
+ * 主キーを持つテーブルである {Groonga::Hash} と
+ * {Groonga::PatriciaTrie} に主キーの機能を提供するモジュール。
  */
 
 void
@@ -110,21 +110,21 @@ rb_grn_table_key_support_add_raw (VALUE self, VALUE rb_key, int *added)
 }
 
 /*
- * call-seq:
- *   table.add(key, values=nil) -> Groonga::Recordまたはnil
- *
  * 主キーが _key_ のレコード追加し、追加したレコードを返す。レ
  * コードの追加に失敗した場合は +nil+ を返す。
  *
  * すでに同じキーのレコードが存在する場合は追加せずに同じレ
  * コードを返す。追加されたかどうかは
- * +Groonga::Record#added?+ で調べることができる。 +true+ を返
+ * {Groonga::Record#added?} で調べることができる。 +true+ を返
  * したら追加されたということを示す。
  *
  * _values_ にはレコードのカラムに設定する値を指定する。省略
  * した場合または +nil+ を指定した場合はカラムは設定しない。カ
- * ラムの値は<tt>{:カラム名1 => 値1, :カラム名2 => 値2,
- * ...}</tt>と指定する。
+ * ラムの値は @{:カラム名1 => 値1, :カラム名2 => 値2,
+ * ...}@ と指定する。
+ *
+ * @overload add(key, values=nil)
+ *   @return [Groonga::Recordまたはnil]
  */
 static VALUE
 rb_grn_table_key_support_add (int argc, VALUE *argv, VALUE self)
@@ -168,14 +168,15 @@ rb_grn_table_key_support_get (VALUE self, VALUE rb_key)
 }
 
 /*
- * call-seq:
- *   table.id -> テーブルID
- *   table.id(key) -> レコードID
- *
  * _key_ を指定しない場合はテーブルのIDを返す。
  *
  * _key_ を指定した場合はテーブルの _key_ に対応するレコードの
  * IDを返す。
+ *
+ * @overload id
+ *   @return [テーブルID]
+ * @overload id(key)
+ *   @return [レコードID]
  */
 static VALUE
 rb_grn_table_key_support_get_id (int argc, VALUE *argv, VALUE self)
@@ -198,10 +199,10 @@ rb_grn_table_key_support_get_id (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   table.key(id) -> 主キー
- *
  * テーブルの _id_ に対応する主キーを返す。
+ *
+ * @overload key(id)
+ *   @return [主キー]
  */
 static VALUE
 rb_grn_table_key_support_get_key (VALUE self, VALUE rb_id)
@@ -234,10 +235,9 @@ rb_grn_table_key_support_get_key (VALUE self, VALUE rb_id)
 }
 
 /*
- * call-seq:
- *   table.has_key?(key) -> true/false
- *
  * テーブルに主キーが _key_ のレコードがあるならtrueを返す。
+ *
+ * @overload has_key?(key)
  */
 static VALUE
 rb_grn_table_key_support_has_key (VALUE self, VALUE rb_key)
@@ -283,11 +283,10 @@ rb_grn_table_key_support_delete_by_key (VALUE self, VALUE rb_key)
 }
 
 /*
- * call-seq:
- *   table.delete(id)
- *   table.delete(key)
- *
  * テーブルの _id_ または _key_ に対応するレコードを削除する。
+ *
+ * @overload delete(id)
+ * @overload delete(key)
  */
 static VALUE
 rb_grn_table_key_support_delete (VALUE self, VALUE rb_id_or_key)
@@ -300,14 +299,12 @@ rb_grn_table_key_support_delete (VALUE self, VALUE rb_id_or_key)
 }
 
 /*
- * Document-method: []
- *
- * call-seq:
- *   table[key] -> Groonga::Record
+ * _table_ の _key_ に対応する {Groonga::Record} を返す。
  *
- * _table_ の _key_ に対応するGroonga::Recordを返す。
+ * 0.9.0から値ではなく {Groonga::Record} を返すようになった。
  *
- * 0.9.0から値ではなくGroonga::Recordを返すようになった。
+ * @overload [](key)
+ * @return [Groonga::Record]
  */
 static VALUE
 rb_grn_table_key_support_array_reference (VALUE self, VALUE rb_key)
@@ -352,15 +349,14 @@ set_value (VALUE args, SetValueData *data)
 }
 
 /*
- * Document-method: []=
- *
- * call-seq:
- *   table[key] = {:column_name => value, ...}
- *
  * _table_ の _key_ に対応するカラム _column_name_ の値を設定する。
  * _key_ に対応するレコードがない場合は新しく作成される。
  *
  * 0.9.0から値ではなくカラムの値を設定するようになった。
+ *
+ * @overload []=(key, values)
+ *   @param [::Hash] values
+ *     keyに対応させるカラムの値。{ :column_name => value, ... }の形で設定する。
  */
 static VALUE
 rb_grn_table_key_support_array_set (VALUE self, VALUE rb_key, VALUE rb_values)
@@ -393,12 +389,11 @@ rb_grn_table_key_support_array_set (VALUE self, VALUE rb_key, VALUE rb_values)
 }
 
 /*
- * call-seq:
- *   table.set_column_value(key, name, value)
- *   table.set_column_value(id, name, value, :id => true)
- *
  * _table_ の _key_ に対応するカラム _name_ の値を設定する。
  * _key_ に対応するレコードがない場合は新しく作成される。
+ *
+ * @overload set_column_value(key, name, value)
+ * @overload set_column_value(id, name, value, {:id=>true})
  */
 static VALUE
 rb_grn_table_key_support_set_column_value (int argc, VALUE *argv, VALUE self)
@@ -433,13 +428,12 @@ rb_grn_table_key_support_set_column_value (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   table.column_value(key, name)
- *   table.column_value(id, name, :id => true)
- *
  * _table_ の _key_ に対応するカラム _name_ の値を設定する。
  *
  * TODO: _key_ に対応するレコードがない場合は例外？
+ *
+ * @overload column_value(key, name)
+ * @overload column_value(id, name, :id=>true)
  */
 static VALUE
 rb_grn_table_key_support_get_column_value (int argc, VALUE *argv, VALUE self)
@@ -492,11 +486,11 @@ rb_grn_table_key_support_get_value_by_key (VALUE self, VALUE rb_key)
 }
 
 /*
- * call-seq:
- *   table.value(id, :id => true) -> 値
- *   table.value(key) -> 値
- *
  * _table_ の _id_ または _key_ に対応する値を返す。
+ *
+ * @overload value(id, :id=>true)
+ * @overload value(key)
+ * @return _id_ もしくは _key_ に対応する値
  */
 static VALUE
 rb_grn_table_key_support_get_value (int argc, VALUE *argv, VALUE self)
@@ -562,12 +556,11 @@ rb_grn_table_key_support_set_value_by_key (VALUE self,
 }
 
 /*
- * call-seq:
- *   table.set_value(id, value, :id => true)
- *   table.set_value(key, value)
- *
  * _table_ の _id_ または _key_ に対応する値を _value_ に設定する。
  * 既存の値は上書きされる。
+ *
+ * @overload set_value(id, value, :id=>true)
+ * @overload set_value(key, value)
  */
 static VALUE
 rb_grn_table_key_support_set_value (int argc, VALUE *argv, VALUE self)
@@ -598,10 +591,10 @@ rb_grn_table_key_support_set_value (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   table.default_tokenizer -> nilまたはGroonga::Procedure
+ * {Groonga::IndexColumn} で使用するトークナイザを返す。
  *
- * Groonga::IndexColumnで使用するトークナイザを返す。
+ * @overload default_tokenizer
+ *   @return [nilまたはGroonga::Procedure]
  */
 static VALUE
 rb_grn_table_key_support_get_default_tokenizer (VALUE self)
@@ -623,10 +616,7 @@ rb_grn_table_key_support_get_default_tokenizer (VALUE self)
 }
 
 /*
- * call-seq:
- *   table.default_tokenizer = トークナイザ
- *
- * Groonga::IndexColumnで使用するトークナイザを設定する。
+ * {Groonga::IndexColumn} で使用するトークナイザを設定する。
  *
  * @example
  *   # 2-gramを使用。
@@ -643,6 +633,8 @@ rb_grn_table_key_support_get_default_tokenizer (VALUE self)
  *
  *   # MeCabを使用
  *   table.default_tokenizer = "TokenMecab"
+ *
+ * @overload default_tokenizer=(tokenizer)
  */
 static VALUE
 rb_grn_table_key_support_set_default_tokenizer (VALUE self, VALUE rb_tokenizer)
@@ -667,11 +659,10 @@ rb_grn_table_key_support_set_default_tokenizer (VALUE self, VALUE rb_tokenizer)
 }
 
 /*
- * call-seq:
- *   table.normalize_key? -> true/false
- *
  * キーを正規化する場合は +true+ 、正規化しない場合は +false+ を返
  * す。
+ *
+ * @overload normalize_key?
  */
 static VALUE
 rb_grn_table_key_normalize_key_p (VALUE self)
@@ -686,11 +677,10 @@ rb_grn_table_key_normalize_key_p (VALUE self)
 }
 
 /*
- * call-seq:
- *   table.support_key? -> true/false
- *
  * テーブルでキーを使えるなら +true+ 、使えないなら +false+ を返
- * す。キーを使えないテーブルはGroonga::Arrayだけ。
+ * す。キーを使えないテーブルは {Groonga::Array} だけ。
+ *
+ * @overload support_key?
  */
 static VALUE
 rb_grn_table_key_support_support_key_p (VALUE self)