rroonga 2.0.5 → 2.0.6

data/ext/groonga/rb-grn-index-column.c

@@ -97,7 +97,7 @@ rb_grn_index_column_deconstruct (RbGrnIndexColumn *rb_grn_index_column,
 
 /*
  * IDが _id_ であるレコードを高速に全文検索するため転置索引を作
- * 成する。多くの場合、Groonga::Table#define_index_columnで
+ * 成する。多くの場合、 {Groonga::Table#define_index_column} で
  * +:source+ オプションを指定することにより、自動的に全文検索
  * 用の索引は更新されるので、明示的にこのメソッドを使うこと
  * は少ない。
@@ -147,15 +147,15 @@ rb_grn_index_column_deconstruct (RbGrnIndexColumn *rb_grn_index_column,
  *   @option options :section
  *     段落番号を指定する。省略した場合は1を指定したとみなされ
  *     る。
- *     Groonga::Table#define_index_columnで
- *     <tt>{:with_section => true}</tt>を指定していなければい
+ *     {Groonga::Table#define_index_column} で
+ *     @{:with_section => true}@ を指定していなければい
  *     けない。
  *   @option options :old_value
  *     以前の値を指定する。省略した場合は現在の値が用いられる。
  *     通常は指定する必要はない。
  *   @option options :value
  *     新しい値を指定する。 _value_ を指定した場合と _options_ で
- *     <tt>{:value => value}</tt>を指定した場合は同じ動作とな
+ *     @{:value => value}@ を指定した場合は同じ動作とな
  *     る。
  */
 static VALUE
@@ -220,11 +220,10 @@ rb_grn_index_column_array_set (VALUE self, VALUE rb_id, VALUE rb_value)
 }
 
 /*
- * インデックス対象となっているカラムの配列を返す。
+ * インデックス対象となっている {Groonga::Column} の配列を返す。
  *
  * @overload sources
- * @return [::Array<Groonga::Column>] インデックス対象となっている
- *   {Groonga::Column}の配列
+ *   @return [::Array<Groonga::Column>]
  */
 static VALUE
 rb_grn_index_column_get_sources (VALUE self)
@@ -399,7 +398,7 @@ rb_grn_index_column_set_source (VALUE self, VALUE rb_source)
 
 /*
  * _object_ から _query_ に対応するオブジェクトを検索し、見つかっ
- * たオブジェクトのIDがキーになっているGroonga::Hashを返す。
+ * たオブジェクトのIDがキーになっている {Groonga::Hash} を返す。
  *
  * @overload search(query, options={})
  *   @param [::Hash] options The name and value
@@ -408,9 +407,9 @@ rb_grn_index_column_set_source (VALUE self, VALUE rb_source)
  *     結果を格納するGroonga::Hash。指定しない場合は新しく
  *     Groonga::Hashを生成し、それに結果を格納して返す。
  *   @option options :operator
- *     以下のどれかの値を指定する。 +nil+ , <tt>"or"</tt>, <tt>"||"</tt>,
- *     <tt>"and"</tt>, <tt>"+"</tt>, <tt>"&&"</tt>, <tt>"but"</tt>,
- *     <tt>"not"</tt>, <tt>"-"</tt>, <tt>"adjust"</tt>, <tt>">"</tt>。
+ *     以下のどれかの値を指定する。 +nil+ , @"or"@ , @"||"@ ,
+ *     @"and"@ , @"+"@ , @"&&"@ , @"but"@ ,
+ *     @"not"@ , @"-"@ , @"adjust"@ , @">"@ 。
  *     それぞれ以下のようになる。（FIXME: 「以下」）
  *   @option options :exact
  *     +true+ を指定すると完全一致で検索する
@@ -426,9 +425,7 @@ rb_grn_index_column_set_source (VALUE self, VALUE rb_source)
  *   @option options :near
  *     +true+ を指定すると _query_ に指定した複数の語が近傍に含ま
  *     れるレコードを検索する
- *   [...]
- *     ...
- * @return [Groonga::Hash]
+ *   @return [Groonga::Hash]
  */
 static VALUE
 rb_grn_index_column_search (int argc, VALUE *argv, VALUE self)
@@ -485,12 +482,9 @@ rb_grn_index_column_search (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * Document-method: with_section?
- *
- * call-seq:
- *   column.with_section? -> true/false
- *
  * _column_ が段落情報も格納する場合は +true+ を返します。
+ *
+ * @overload with_section?
  */
 static VALUE
 rb_grn_index_column_with_section_p (VALUE self)
@@ -506,12 +500,9 @@ rb_grn_index_column_with_section_p (VALUE self)
 }
 
 /*
- * Document-method: with_weight?
- *
- * call-seq:
- *   column.with_weight? -> true/false
- *
  * _column_ がウェイト情報も格納する場合は +true+ を返します。
+ *
+ * @overload with_weight?
  */
 static VALUE
 rb_grn_index_column_with_weight_p (VALUE self)
@@ -527,12 +518,9 @@ rb_grn_index_column_with_weight_p (VALUE self)
 }
 
 /*
- * Document-method: with_position?
- *
- * call-seq:
- *   column.with_position? -> true/false
- *
  * _column_ が位置情報も格納する場合は +true+ を返します。
+ *
+ * @overload with_position?
  */
 static VALUE
 rb_grn_index_column_with_position_p (VALUE self)

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

@@ -337,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)
@@ -383,7 +382,7 @@ rb_grn_logger_s_set_path (VALUE klass, VALUE rb_path,
  * groongaのデフォルトロガーがログを出力するファイルのパスを返す。
  *
  * @overload log_path
- * @return [String] path ログを出力するファイルのパス
+ *   @return [String]
  */
 static VALUE
 rb_grn_logger_s_get_log_path (VALUE klass)
@@ -401,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)
@@ -425,7 +423,7 @@ rb_grn_logger_s_set_log_path (VALUE klass, VALUE path)
  * groongaのデフォルトロガーがクエリログを出力するファイルのパスを返す。
  *
  * @overload query_log_path
- * @return [String] path ログを出力するファイルのパス
+ *   @return [String]
  */
 static VALUE
 rb_grn_logger_s_get_query_log_path (VALUE klass)
@@ -443,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を継
  * 承している。
  */
 
@@ -559,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)
@@ -586,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)
@@ -614,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)
@@ -964,12 +955,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)
@@ -985,13 +974,11 @@ rb_grn_object_inspect (VALUE self)
 }
 
 /*
- * Document-method: id
+ * _object_ のIDを返す。
+ * _object_ が {#closed?} なときやIDがない場合は +nil+ を返す。
  *
- * call-seq:
- *   object.id -> ID/nil
- *
- * _object_ のIDを返す。 _object_ が#closed?なときやIDがない場合
- * は +nil+ を返す。
+ * @overload id
+ *   @return [ID or nil]
  */
 VALUE
 rb_grn_object_get_id (VALUE self)
@@ -1011,13 +998,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)
@@ -1038,13 +1023,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)
@@ -1059,13 +1041,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)
@@ -1080,14 +1059,12 @@ rb_grn_object_persistent_p (VALUE self)
 }
 
 /*
- * Document-method: domain
- *
- * call-seq:
- *   object.domain -> Groonga::Object/nil
+ * _object_ の属している {Groonga::Object} を返す。例えば、
+ * {Groonga::Column} は {Groonga::Table} を返す。属している
+ * {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)
@@ -1118,12 +1095,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)
@@ -1152,16 +1127,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)
@@ -1192,13 +1165,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)
@@ -1219,12 +1190,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)
@@ -1382,13 +1351,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)
@@ -1397,12 +1363,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)
@@ -1411,12 +1374,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)
@@ -1425,13 +1385,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)