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

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

@@ -249,50 +249,34 @@ rb_grn_logger_initialize (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   Groonga::Logger.register(options={})
-       {|level, time, title, message, location| ...}
+ * groongaがログを出力する度に呼び出されるブロックを登録する。
  *
- * groongaがログを出力する度に呼び出されるブロックを登録す
- * る。
- *
- * ブロックに渡されてくる引数は _level_ ,  _time_ ,  _title_ ,
- * _message_ ,  _location_ の5つで、 _level_ はSymbol、それ以外は
- * 全て文字列で渡される。その4つについては _options_ で +false+
- * を指定することでブロックに渡さないようにすることができ、
- * その場合は空文字列が実際には渡される。
- *
- * _options_ に指定可能な値は以下の通り。
- * @param options [::Hash] The name and value
- *   pairs. Omitted names are initialized as the default value.
- * @option options :level (:notice) The log level
- *
- *   ログのレベルを +:none+ ,  +:emergency+ ,  +:alert+ ,
- *   +:critical+ , +:error+ , +:warning+ , +:notice+ , +:info+ ,
- *   +:debug+ ,  +:dump+ のいずれかで指定する。それより重要度が
- *   低いログはブロックに渡されなくなる。デフォルトでは
- *   +:notice+ 。
- *
- * @option options :time
- *
- *   ログが出力された時間をブロックに渡したいなら +true+ を指
- *   定する。デフォルトでは渡す。
- *
- * @option options :title The title
- *
- *   ログのタイトルをブロックに渡したいなら +true+ を指定す
- *   る。デフォルトでは渡す。(FIXME: groongaで実装されてい
- *   ない?)
- *
- * @option options :message The message
- *   ログのメッセージをブロックに渡したいなら +true+ を指定す
- *   る。デフォルトでは渡す。
- *
- * @option options :location The location
- *
- *   ログの発生元のプロセスIDとgroongaのソースコードのファイ
- *   ル名、行番号、関数名をブロックに渡したいなら +true+ を指
- *   定する。デフォルトでは渡す。
+ * @overload register(options={})
+ *   @yield [level, time, title, message, location]
+ *     _level_ はSymbol、それ以外は全て文字列で渡される。 _level_ 以外
+ *     の4つについては _options_ で +false+ を指定することでブロックに
+ *     渡さないようにすることができ、その場合は空文字列が実際には渡される。
+ *   @param options [::Hash] The name and value
+ *     pairs. Omitted names are initialized as the default value.
+ *   @option options :level (:notice)
+ *     ログのレベルを +:none+ ,  +:emergency+ ,  +:alert+ ,
+ *     +:critical+ , +:error+ , +:warning+ , +:notice+ , +:info+ ,
+ *     +:debug+ ,  +:dump+ のいずれかで指定する。それより重要度が
+ *     低いログはブロックに渡されなくなる。デフォルトでは +:notice+ 。
+ *   @option options :time
+ *     ログが出力された時間をブロックに渡したいなら +true+ を指
+ *     定する。デフォルトでは渡す。
+ *   @option options :title
+ *     ログのタイトルをブロックに渡したいなら +true+ を指定す
+ *     る。デフォルトでは渡す。
+ *     (FIXME: groongaで実装されていない?)
+ *   @option options :message
+ *     ログのメッセージをブロックに渡したいなら +true+ を指定す
+ *     る。デフォルトでは渡す。
+ *   @option options :location
+ *     ログの発生元のプロセスIDとgroongaのソースコードのファイ
+ *     ル名、行番号、関数名をブロックに渡したいなら +true+ を指
+ *     定する。デフォルトでは渡す。
  */
 static VALUE
 rb_grn_logger_s_register (int argc, VALUE *argv, VALUE klass)
@@ -353,14 +337,13 @@ rb_grn_logger_s_reopen_with_related_object (VALUE klass, VALUE related_object)
 }
 
 /*
- * call-seq:
- *   Groonga::Logger.reopen
- *
  * groongaのデフォルトロガーがログを出力するファイルを再オー
  * プンする。ログファイルのバックアップ時などに使用する。
  *
- * Groonga::Logger.registerで独自のロガーを設定している場合
+ * {Groonga::Logger.register} で独自のロガーを設定している場合
  * は例外が発生する。
+ *
+ * @overload reopen
  */
 static VALUE
 rb_grn_logger_s_reopen (VALUE klass)
@@ -396,11 +379,10 @@ rb_grn_logger_s_set_path (VALUE klass, VALUE rb_path,
 #endif
 
 /*
- * call-seq:
- *   Groonga::Logger.log_path # => path
+ * groongaのデフォルトロガーがログを出力するファイルのパスを返す。
  *
- * groongaのデフォルトロガーがログを出力するファイルの
- * パスを返す。
+ * @overload log_path
+ *   @return [String]
  */
 static VALUE
 rb_grn_logger_s_get_log_path (VALUE klass)
@@ -418,14 +400,13 @@ rb_grn_logger_s_get_log_path (VALUE klass)
 }
 
 /*
- * call-seq:
- *   Groonga::Logger.log_path= path
- *
  * groongaのデフォルトロガーがログを出力するファイルのパスを
  * 指定する。
  *
- * Groonga::Logger.registerで独自のロガーを設定している場合、
+ * {Groonga::Logger.register} で独自のロガーを設定している場合、
  * 設定している独自ロガーは無効になる。
+ *
+ * @overload log_path=(path)
  */
 static VALUE
 rb_grn_logger_s_set_log_path (VALUE klass, VALUE path)
@@ -439,11 +420,10 @@ rb_grn_logger_s_set_log_path (VALUE klass, VALUE path)
 }
 
 /*
- * call-seq:
- *   Groonga::Logger.query_log_path # => path
+ * groongaのデフォルトロガーがクエリログを出力するファイルのパスを返す。
  *
- * groongaのデフォルトロガーがクエリログを出力するファイルの
- * パスを返す。
+ * @overload query_log_path
+ *   @return [String]
  */
 static VALUE
 rb_grn_logger_s_get_query_log_path (VALUE klass)
@@ -461,14 +441,13 @@ rb_grn_logger_s_get_query_log_path (VALUE klass)
 }
 
 /*
- * call-seq:
- *   Groonga::Logger.query_log_path= path
- *
  * groongaのデフォルトロガーがクエリログを出力するファイルの
  * パスを指定する。
  *
- * Groonga::Logger.registerで独自のロガーを設定している場合、
+ * {Groonga::Logger.register} で独自のロガーを設定している場合、
  * 設定している独自ロガーは無効になる。
+ *
+ * @overload query_log_path=(path)
  */
 static VALUE
 rb_grn_logger_s_set_query_log_path (VALUE klass, VALUE path)

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

@@ -20,7 +20,7 @@
  * Document-class: Groonga::Object
  *
  * rroongaが提供するクラスのベースとなるクラス。
- * Groonga::ContextとGroonga::Logger以外はGroonga::Objectを継
+ * {Groonga::Context} と {Groonga::Logger} 以外はGroonga::Objectを継
  * 承している。
  */
 
@@ -49,6 +49,7 @@ rb_grn_object_from_ruby_object (VALUE object, grn_ctx **context)
 	    grn_object = rb_grn_context_get_backward_compatibility(*context,
 								   name,
 								   name_size);
+	    rb_grn_context_check(*context, object);
 	    if (!grn_object)
 		rb_raise(rb_eArgError,
 			 "unregistered groonga object: name: <%s>",
@@ -56,6 +57,7 @@ rb_grn_object_from_ruby_object (VALUE object, grn_ctx **context)
 	    return grn_object;
 	} else if (RVAL2CBOOL(rb_obj_is_kind_of(object, rb_cInteger))) {
 	    grn_object = grn_ctx_at(*context, NUM2UINT(object));
+	    rb_grn_context_check(*context, object);
 	    if (!grn_object)
 		rb_raise(rb_eArgError,
 			 "unregistered groonga object: ID: <%s>",
@@ -557,13 +559,10 @@ rb_grn_object_deconstruct (RbGrnObject *rb_grn_object,
 }
 
 /*
- * Document-method: close
- *
- * call-seq:
- *   object.close
- *
  * _object_ が使用しているリソースを開放する。これ以降 _object_ を
  * 使うことはできない。
+ *
+ * @overload close
  */
 VALUE
 rb_grn_object_close (VALUE self)
@@ -584,12 +583,9 @@ rb_grn_object_close (VALUE self)
 }
 
 /*
- * Document-method: unlink
- *
- * call-seq:
- *   object.unlink
- *
  * _object_ のリファレンスカウンタを1減少する。
+ *
+ * @overload unlink
  */
 VALUE
 rb_grn_object_unlink (VALUE self)
@@ -612,13 +608,10 @@ rb_grn_object_unlink (VALUE self)
 }
 
 /*
- * Document-method: closed?
- *
- * call-seq:
- *   object.closed? -> true/false
- *
- * _object_ が開放済みの場合は+true+を返し、そうでない場合は
+ * _object_ が開放済みの場合は +true+ を返し、そうでない場合は
  * +false+ を返す。
+ *
+ * @overload closed?
  */
 VALUE
 rb_grn_object_closed_p (VALUE self)
@@ -828,12 +821,26 @@ rb_grn_object_inspect_content_flags_with_label (VALUE inspected,
       case GRN_COLUMN_FIX_SIZE:
       case GRN_COLUMN_VAR_SIZE:
       case GRN_TYPE:
-	if (flags & GRN_OBJ_KEY_UINT)
-	    rb_ary_push(inspected_flags, rb_str_new2("KEY_UINT"));
-	if (flags & GRN_OBJ_KEY_INT)
-	    rb_ary_push(inspected_flags, rb_str_new2("KEY_INT"));
-	if (flags & GRN_OBJ_KEY_FLOAT)
-	    rb_ary_push(inspected_flags, rb_str_new2("KEY_FLOAT"));
+	if (flags & GRN_OBJ_KEY_VAR_SIZE) {
+	    rb_ary_push(inspected_flags, rb_str_new2("KEY_VAR_SIZE"));
+	} else {
+	    switch (flags & GRN_OBJ_KEY_MASK) {
+	      case GRN_OBJ_KEY_UINT:
+		rb_ary_push(inspected_flags, rb_str_new2("KEY_UINT"));
+		break;
+	      case GRN_OBJ_KEY_INT:
+		rb_ary_push(inspected_flags, rb_str_new2("KEY_INT"));
+		break;
+	      case GRN_OBJ_KEY_FLOAT:
+		rb_ary_push(inspected_flags, rb_str_new2("KEY_FLOAT"));
+		break;
+	      case GRN_OBJ_KEY_GEO_POINT:
+		rb_ary_push(inspected_flags, rb_str_new2("KEY_GEO_POINT"));
+		break;
+	      default:
+		break;
+	    }
+	}
 	break;
       default:
 	break;
@@ -962,12 +969,10 @@ rb_grn_object_inspect_footer (VALUE self, VALUE inspected)
 }
 
 /*
- * Document-method: inspect
- *
- * call-seq:
- *   object.inspect -> 詳細情報
- *
  * _object_ の詳細を示した文字列を返す。デバッグ用。
+ *
+ * @overload inspect
+ *   @return [詳細情報]
  */
 static VALUE
 rb_grn_object_inspect (VALUE self)
@@ -983,13 +988,11 @@ rb_grn_object_inspect (VALUE self)
 }
 
 /*
- * Document-method: id
- *
- * call-seq:
- *   object.id -> ID/nil
+ * _object_ のIDを返す。
+ * _object_ が {#closed?} なときやIDがない場合は +nil+ を返す。
  *
- * _object_ のIDを返す。 _object_ が#closed?なときやIDがない場合
- * は +nil+ を返す。
+ * @overload id
+ *   @return [ID or nil]
  */
 VALUE
 rb_grn_object_get_id (VALUE self)
@@ -1009,13 +1012,11 @@ rb_grn_object_get_id (VALUE self)
 }
 
 /*
- * Document-method: path
- *
- * call-seq:
- *   object.path -> ファイルパス/nil
- *
  * _object_ に対応するファイルパスを返す。一時 _object_
  * なら +nil+ を返す。
+ *
+ * @overload path
+ *   @return [ファイルパス or nil]
  */
 static VALUE
 rb_grn_object_get_path (VALUE self)
@@ -1036,13 +1037,10 @@ rb_grn_object_get_path (VALUE self)
 }
 
 /*
- * Document-method: temporary?
- *
- * call-seq:
- *   object.temporary? -> true/false
- *
  * _object_ が一時オブジェクトなら +true+ 、永続オブジェクトな
  * ら +false+ を返す。
+ *
+ * @overload temporary?
  */
 static VALUE
 rb_grn_object_temporary_p (VALUE self)
@@ -1057,13 +1055,10 @@ rb_grn_object_temporary_p (VALUE self)
 }
 
 /*
- * Document-method: persistent?
- *
- * call-seq:
- *   object.persistent? -> true/false
- *
  * _object_ が永続オブジェクトなら +true+ 、一時オブジェクトな
  * ら +false+ を返す。
+ *
+ * @overload persistent?
  */
 static VALUE
 rb_grn_object_persistent_p (VALUE self)
@@ -1078,14 +1073,12 @@ rb_grn_object_persistent_p (VALUE self)
 }
 
 /*
- * Document-method: domain
+ * _object_ の属している {Groonga::Object} を返す。例えば、
+ * {Groonga::Column} は {Groonga::Table} を返す。属している
+ * {Groonga::Object} がない場合は +nil+ を返す。
  *
- * call-seq:
- *   object.domain -> Groonga::Object/nil
- *
- * _object_ の属しているGroonga::Objectを返す。例えば、
- * Groonga::ColumnはGroonga::Tableを返す。属している
- * Groonga::Objectがない場合は +nil+ を返す。
+ * @overload domain
+ *   @return [Groonga::Object or nil]
  */
 static VALUE
 rb_grn_object_get_domain (VALUE self)
@@ -1116,12 +1109,10 @@ rb_grn_object_get_domain (VALUE self)
 }
 
 /*
- * Document-method: name
- *
- * call-seq:
- *   object.name -> 名前/nil
- *
  * _object_ の名前を返す。無名オブジェクトの場合は +nil+ を返す。
+ *
+ * @overload name
+ *   @return [名前 or nil]
  */
 static VALUE
 rb_grn_object_get_name (VALUE self)
@@ -1150,16 +1141,14 @@ rb_grn_object_get_name (VALUE self)
 }
 
 /*
- * Document-method: range
- *
- * call-seq:
- *   object.range -> Groonga::Object/nil
- *
- * _object_ の値がとりうる範囲を示したGroonga::Objectを返す。
- * 例えば、Groonga::Columnの場合は
- * Groonga::Table#define_columnで指定されたGroonga::Typeや
- * Groonga::Tableを返す。
+ * _object_ の値がとりうる範囲を示した {Groonga::Object} を返す。
+ * 例えば、 {Groonga::Column} の場合は
+ * {Groonga::Table#define_column} で指定された {Groonga::Type} や
+ * {Groonga::Table} を返す。
  * 範囲が指定されていないオブジェクトの場合は +nil+ を返す。
+ *
+ * @overload range
+ *   @return [Groonga::Object or nil]
  */
 static VALUE
 rb_grn_object_get_range (VALUE self)
@@ -1190,13 +1179,11 @@ rb_grn_object_get_range (VALUE self)
 }
 
 /*
- * Document-method: ==
- *
- * call-seq:
- *   object == other -> true/false
- *
  * _object_ と _other_ が同じgroongaのオブジェクトなら +true+ を返
  * し、そうでなければ +false+ を返す。
+ *
+ * @overload ==(other)
+ *   @return [Boolean]
  */
 static VALUE
 rb_grn_object_equal (VALUE self, VALUE other)
@@ -1217,12 +1204,10 @@ rb_grn_object_equal (VALUE self, VALUE other)
 }
 
 /*
- * Document-method: []
- *
- * call-seq:
- *   object[id] -> 値
- *
  * _object_ の _id_ に対応する値を返す。
+ *
+ * @overload [](id)
+ *   @return [値]
  */
 VALUE
 rb_grn_object_array_reference (VALUE self, VALUE rb_id)
@@ -1380,13 +1365,10 @@ rb_grn_object_set (VALUE self, VALUE rb_id, VALUE rb_value, int flags)
 }
 
 /*
- * Document-method: []=
- *
- * call-seq:
- *   object[id] = value
- *
  * _object_ の _id_ に対応する値を設定する。既存の値は上書きさ
  * れる。
+ *
+ * @overload []=(id, value)
  */
 static VALUE
 rb_grn_object_array_set (VALUE self, VALUE rb_id, VALUE rb_value)
@@ -1395,12 +1377,9 @@ rb_grn_object_array_set (VALUE self, VALUE rb_id, VALUE rb_value)
 }
 
 /*
- * Document-method: append
- *
- * call-seq:
- *   object.append(id, value)
- *
  * _object_ の _id_ に対応する値の最後に _value_ を追加する。
+ *
+ * @overload append(id, value)
  */
 static VALUE
 rb_grn_object_append_value (VALUE self, VALUE rb_id, VALUE rb_value)
@@ -1409,12 +1388,9 @@ rb_grn_object_append_value (VALUE self, VALUE rb_id, VALUE rb_value)
 }
 
 /*
- * Document-method: prepend
- *
- * call-seq:
- *   object.prepend(id, value)
- *
  * _object_ の _id_ に対応する値の最初に _value_ を追加する。
+ *
+ * @overload prepend(id, value)
  */
 static VALUE
 rb_grn_object_prepend_value (VALUE self, VALUE rb_id, VALUE rb_value)
@@ -1423,13 +1399,10 @@ rb_grn_object_prepend_value (VALUE self, VALUE rb_id, VALUE rb_value)
 }
 
 /*
- * Document-method: remove
- *
- * call-seq:
- *   object.remove
- *
  * _object_ をメモリから解放し、それが永続オブジェクトであっ
  * た場合は、該当するファイル一式を削除する。
+ *
+ * @overload remove
  */
 static VALUE
 rb_grn_object_remove (VALUE self)

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

@@ -54,7 +54,7 @@ void
 rb_grn_init_operator (VALUE mGrn)
 {
     rb_mGrnOperator = rb_define_module_under(mGrn, "Operator");
-    /* deprecated: backward compatibility. */
+    /* @deprecated backward compatibility. */
     rb_define_const(mGrn, "Operation", rb_mGrnOperator);
 
     rb_define_const(rb_mGrnOperator, "PUSH",

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} を
  * 参照。
  */