rroonga 2.0.5 → 2.0.6

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

@@ -30,15 +30,17 @@ static VALUE cGrnContext;
  * 複数のコンテキストを利用する必要はない。
  *
  * デフォルトで使用されるコンテキストは
- * Groonga::Context#defaultでアクセスできる。コンテキストを
- * 指定できる箇所でコンテキストの指定を省略したり +nil+ を指定
- * した場合はGroonga::Context.defaultが利用される。
+ * {Groonga::Context.default} でアクセスできる。コンテキ
+ * ストを指定できる箇所でコンテキストの指定を省略したり +nil+
+ * を指定した場合は {Groonga::Context.default} が利用さ
+ * れる。
  *
  * また、デフォルトのコンテキストは必要になると暗黙のうちに
  * 作成される。そのため、コンテキストを意識することは少ない。
  *
  * 暗黙のうちに作成されるコンテキストにオプションを指定する
- * 場合はGroonga::Context.default_options=を使用する。
+ * 場合は {Groonga::Context.default_options=} を使用
+ * する。
  */
 
 grn_ctx *
@@ -325,15 +327,15 @@ rb_grn_context_text_set (grn_ctx *context, grn_obj *bulk, VALUE rb_string)
 }
 
 /*
- * call-seq:
- *   Groonga::Context.default -> Groonga::Context
- *
  * デフォルトのコンテキストを返す。デフォルトのコンテキスト
  * が作成されていない場合は暗黙のうちに作成し、それを返す。
  *
  * 暗黙のうちにコンテキストを作成する場合は、
- * Groonga::Context.default_optionsに設定されているオプショ
- * ンを利用する。
+ * {Groonga::Context.default_options} に設定されているオプ
+ * ションを利用する。
+ *
+ * @overload default
+ *   @return [Groonga::Context]
  */
 static VALUE
 rb_grn_context_s_get_default (VALUE self)
@@ -355,13 +357,12 @@ rb_grn_context_get_default (void)
 }
 
 /*
- * call-seq:
- *   Groonga::Context.default=(context)
- *
  * デフォルトのコンテキストを設定する。 +nil+ を指定すると、
  * デフォルトのコンテキストをリセットする。リセットすると、次
- * 回Groonga::Context.defaultを呼び出したときに新しくコンテ
- * キストが作成される。
+ * 回 {Groonga::Context.default} を呼び出したときに新しくコ
+ * ンテキストが作成される。
+ *
+ * @overload default=(context)
  */
 static VALUE
 rb_grn_context_s_set_default (VALUE self, VALUE context)
@@ -371,11 +372,11 @@ rb_grn_context_s_set_default (VALUE self, VALUE context)
 }
 
 /*
- * call-seq:
- *   Groonga::Context.default_options -> Hash or nil
- *
  * コンテキストを作成する時に利用するデフォルトのオプション
  * を返す。
+ *
+ * @overload default_options
+ *   @return [::Hash or nil]
  */
 static VALUE
 rb_grn_context_s_get_default_options (VALUE self)
@@ -384,12 +385,11 @@ rb_grn_context_s_get_default_options (VALUE self)
 }
 
 /*
- * call-seq:
- *   Groonga::Context.default_options=(options)
- *
  * コンテキストを作成する時に利用するデフォルトのオプション
  * を設定する。利用可能なオプションは
- * Groonga::Context.newを参照。
+ * {Groonga::Context.new} を参照。
+ *
+ * @overload default_options=(options)
  */
 static VALUE
 rb_grn_context_s_set_default_options (VALUE self, VALUE options)
@@ -405,7 +405,7 @@ rb_grn_context_s_set_default_options (VALUE self, VALUE options)
  *     pairs. Omitted names are initialized as the default value.
  *   @option options [Groonga::Encoding] :encoding The encoding
  *     エンコーディングを指定する。エンコーディングの指定方法
- *     はGroonga::Encodingを参照。
+ *     は {Groonga::Encoding} を参照。
  */
 static VALUE
 rb_grn_context_initialize (int argc, VALUE *argv, VALUE self)
@@ -454,11 +454,10 @@ rb_grn_context_initialize (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * call-seq:
- *   context.close
- *
  * Closes the _context_. Closed _context_ can't be used
  * anymore.
+ *
+ * @overload close
  */
 static VALUE
 rb_grn_context_close (VALUE self)
@@ -479,10 +478,9 @@ rb_grn_context_close (VALUE self)
 }
 
 /*
- * call-seq:
- *   context.closed?
- *
  * Returns whether the _context_ is closed by #close or not.
+ *
+ * @overload closed?
  */
 static VALUE
 rb_grn_context_closed_p (VALUE self)
@@ -495,10 +493,10 @@ rb_grn_context_closed_p (VALUE self)
 }
 
 /*
- * call-seq:
- *   context.inspect -> String
- *
  * コンテキストの中身を人に見やすい文字列で返す。
+ *
+ * @overload inspect
+ *   @return [String]
  */
 static VALUE
 rb_grn_context_inspect (VALUE self)
@@ -535,10 +533,10 @@ rb_grn_context_inspect (VALUE self)
 }
 
 /*
- * call-seq:
- *   context.encoding -> Groonga::Encoding
- *
  * コンテキストが使うエンコーディングを返す。
+ *
+ * @overload encoding
+ *   @return [Groonga::Encoding]
  */
 static VALUE
 rb_grn_context_get_encoding (VALUE self)
@@ -547,11 +545,10 @@ rb_grn_context_get_encoding (VALUE self)
 }
 
 /*
- * call-seq:
- *   context.encoding=(encoding)
- *
  * コンテキストが使うエンコーディングを設定する。エンコーディ
- * ングの指定のしかたはGroonga::Encodingを参照。
+ * ングの指定のしかたは {Groonga::Encoding} を参照。
+ *
+ * @overload encoding=(encoding)
  */
 static VALUE
 rb_grn_context_set_encoding (VALUE self, VALUE rb_encoding)
@@ -589,13 +586,14 @@ rb_grn_context_get_ruby_encoding (VALUE self)
 }
 
 /*
- * call-seq:
- *   context.match_escalation_threshold -> Integer
- *
  * このコンテキストを使って検索したときに検索の挙動をエスカレー
- * ションする閾値を返します。エスカレーションの詳細はgroonga
- * の検索の仕様に関するドキュメントを参照してください。
- * http://groonga.org/docs/spec/search.html#spec-search
+ * ションする閾値を返します。
+ * エスカレーションの詳細は
+ * "groongaの検索の仕様に関するドキュメント":http://groonga.org/docs/spec/search.html#match-escalation-threshold
+ * を参照してください。
+ *
+ * @overload match_escalation_threshold
+ *   @return [Integer]
  */
 static VALUE
 rb_grn_context_get_match_escalation_threshold (VALUE self)
@@ -604,13 +602,13 @@ rb_grn_context_get_match_escalation_threshold (VALUE self)
 }
 
 /*
- * call-seq:
- *   context.match_escalation_threshold=(match_escalation_threshold)
- *
  * このコンテキストを使って検索したときに検索の挙動をエスカレー
- * ションする閾値を設定します。エスカレーションの詳細はgroonga
- * の検索の仕様に関するドキュメントを参照してください。
- * http://groonga.org/docs/spec/search.html#spec-search
+ * ションする閾値を設定します。
+ * エスカレーションの詳細は
+ * "groongaの検索の仕様に関するドキュメント":http://groonga.org/docs/spec/search.html#match-escalation-threshold
+ * を参照してください。
+ *
+ * @overload match_escalation_threshold=(match_escalation_threshold)
  */
 static VALUE
 rb_grn_context_set_match_escalation_threshold (VALUE self, VALUE threshold)
@@ -624,11 +622,10 @@ rb_grn_context_set_match_escalation_threshold (VALUE self, VALUE threshold)
 }
 
 /*
- * call-seq:
- *   context.support_zlib?
- *
  * groongaがZlibサポート付きでビルドされていれば +true+ 、そう
  * でなければ +false+ を返す。
+ *
+ * @overload support_zlib?
  */
 static VALUE
 rb_grn_context_support_zlib_p (VALUE self)
@@ -647,11 +644,10 @@ rb_grn_context_support_zlib_p (VALUE self)
 }
 
 /*
- * call-seq:
- *   context.support_lzo?
- *
  * groongaがLZOサポート付きでビルドされていれば +true+ 、そう
  * でなければ +false+ を返す。
+ *
+ * @overload support_lzo?
  */
 static VALUE
 rb_grn_context_support_lzo_p (VALUE self)
@@ -670,10 +666,10 @@ rb_grn_context_support_lzo_p (VALUE self)
 }
 
 /*
- * call-seq:
- *   context.database -> Groonga::Database
- *
  * コンテキストが使うデータベースを返す。
+ *
+ * @overload database
+ *   @return [Groonga::Database]
  */
 static VALUE
 rb_grn_context_get_database (VALUE self)
@@ -855,10 +851,6 @@ rb_grn_context_get_backward_compatibility (grn_ctx *context,
 
 
 /*
- * call-seq:
- *   context[name] -> Groonga::Object or nil
- *   context[id]   -> Groonga::Object or nil
- *
  * コンテキスト管理下にあるオブジェクトを返す。
  *
  * _name_ として文字列を指定した場合はオブジェクト名でオブジェ
@@ -866,6 +858,11 @@ rb_grn_context_get_backward_compatibility (grn_ctx *context,
  *
  * _id_ として数値を指定した場合はオブジェクトIDでオブジェク
  * トを検索する。
+ *
+ * @overload [](name)
+ *   @return [Groonga::Object or nil]
+ * @overload [](id)
+ *   @return [Groonga::Object or nil]
  */
 static VALUE
 rb_grn_context_array_reference (VALUE self, VALUE name_or_id)

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

@@ -135,13 +135,10 @@ rb_grn_database_finalizer (grn_ctx *context,
 }
 
 /*
- * Document-method: close
- *
- * call-seq:
- *   database.close
- *
  * _database_ が使用しているリソースを開放する。これ以降 _database_ を
  * 使うことはできない。
+ *
+ * @overload close
  */
 static VALUE
 rb_grn_database_close (VALUE self)
@@ -166,8 +163,16 @@ reset_floating_objects (VALUE rb_context)
 /*
  * 新しくデータベースを作成する。
  * _options_ にはハッシュでオプションを指定する。
- * @return [Groonga::Database] 作成されたデータベース
+ *
+ * @example
+ *   # 一時データベースを作成:
+ *   Groonga::Database.create
+ *
+ *   # 永続データベースを作成:
+ *   Groonga::Database.create(:path => "/tmp/db.groonga")
+ *
  * @overload create(options=nil)
+ *   @return [Groonga::Database] 作成されたデータベースを返す。
  *   @param option [::Hash] options The name and value
  *     pairs. Omitted names are initialized as the default value.
  *   @option options :path
@@ -175,14 +180,7 @@ reset_floating_objects (VALUE rb_context)
  *     となる。
  *   @option options :context (Groonga::Context.default)
  *     データベースを結びつけるコンテキスト。省略すると
- *     Groonga::Context.defaultを利用する。
- *
- * @example
- *   # 一時データベースを作成:
- *   Groonga::Database.create
- *
- *   # 永続データベースを作成:
- *   Groonga::Database.create(:path => "/tmp/db.groonga")
+ *     {Groonga::Context.default} を利用する。
  */
 static VALUE
 rb_grn_database_s_create (int argc, VALUE *argv, VALUE klass)
@@ -234,19 +232,20 @@ rb_grn_database_s_create (int argc, VALUE *argv, VALUE klass)
  * 既存のデータベースを開く。ブロックを指定した場合はブロッ
  * クに開いたデータベースを渡し、ブロックを抜けるときに閉じ
  * る。
+ *
  * @overload new(path, options=nil)
  *   @param options [::Hash] The name and value
  *     pairs. Omitted names are initialized as the default value.
  *   @option options :context (Groonga::Context.default)
  *     データベースを結びつけるコンテキスト。省略すると
- *     Groonga::Context.defaultを利用する。
+ *     {Groonga::Context.default} を利用する。
  *   @return [Groonga::Database]
  * @overload new(path, options=nil)
  *   @param options [::Hash] The name and value
  *     pairs. Omitted names are initialized as the default value.
  *   @option options :context (Groonga::Context.default)
  *     データベースを結びつけるコンテキスト。省略すると
- *     Groonga::Context.defaultを利用する。
+ *     {Groonga::Context.default} を利用する。
  *   @yield [database]
  *   @yieldparam [Groonga::Database] database 開いたデータベース
  */
@@ -286,6 +285,7 @@ rb_grn_database_initialize (int argc, VALUE *argv, VALUE self)
  * 既存のデータベースを開く。ブロックを指定した場合はブロッ
  * クに開いたデータベースを渡し、ブロックを抜けるときに閉じ
  * る。 _options_ にはハッシュでオプションを指定する。
+ *
  * @overload open(path, options=nil)
  *   @return [Groonga::Database]
  *   @param options [::Hash] The name and value
@@ -315,6 +315,7 @@ rb_grn_database_s_open (int argc, VALUE *argv, VALUE klass)
 
 /*
  * データベース内のオブジェクトを順番にブロックに渡す。
+ *
  * @example すべてのオブジェクトの名前を表示する:
  *   database.each do |object|
  *     p object.name
@@ -415,12 +416,9 @@ rb_grn_database_each (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * Document-method: unlock
- *
- * call-seq:
- *   database.unlock
- *
  * _database_ のロックを解除する。
+ *
+ * @overload unlock
  */
 static VALUE
 rb_grn_database_unlock (VALUE self)
@@ -441,7 +439,7 @@ rb_grn_database_unlock (VALUE self)
 
 /*
  * _database_ をロックする。ロックに失敗した場合は
- * Groonga::ResourceDeadlockAvoided例外が発生する。
+ * {Groonga::ResourceDeadlockAvoided} 例外が発生する。
  *
  * @overload lock(options={})
  *   @param [::Hash] options 利用可能なオプションは以下の通り。
@@ -490,12 +488,9 @@ rb_grn_database_lock (int argc, VALUE *argv, VALUE self)
 }
 
 /*
- * Document-method: clear_lock
- *
- * call-seq:
- *   database.clear_lock
- *
  * _database_ のロックを強制的に解除する。
+ *
+ * @overload clear_lock
  */
 static VALUE
 rb_grn_database_clear_lock (VALUE self)
@@ -512,12 +507,9 @@ rb_grn_database_clear_lock (VALUE self)
 }
 
 /*
- * Document-method: locked?
- *
- * call-seq:
- *   database.locked?
- *
  * _database_ がロックされていれば +true+ を返す。
+ *
+ * @overload locked?
  */
 static VALUE
 rb_grn_database_is_locked (VALUE self)
@@ -532,12 +524,9 @@ rb_grn_database_is_locked (VALUE self)
 }
 
 /*
- * Document-method: touch
- *
- * call-seq:
- *   database.touch
- *
  * _database_ の最終更新時刻を現在時刻にする。
+ *
+ * @overload touch
  */
 static VALUE
 rb_grn_database_touch (VALUE self)
@@ -554,6 +543,7 @@ rb_grn_database_touch (VALUE self)
 
 /*
  * Defrags all variable size columns in the database.
+ *
  * @return [Integer] the number of defraged segments
  * @overload defrag(options={})
  *   @param [::Hash] options option for defrag

data/ext/groonga/rb-grn-double-array-trie-cursor.c

@@ -21,11 +21,11 @@
 VALUE rb_cGrnDoubleArrayTrieCursor;
 
 /*
- * Document-class: Groonga::DoubleArrayCursor < Groonga::TableCursor
+ * Document-class: Groonga::DoubleArrayTrieCursor < Groonga::TableCursor
  *
- * Groonga::DoubleArrayに登録されているレコードを順番に取り
+ * {Groonga::DoubleArrayTrie} に登録されているレコードを順番に取り
  * 出すためのオブジェクト。利用できるメソッドは
- * Groonga::TableCursorとGroonga::TableCursor::KeySupportを
+ * {Groonga::TableCursor} と {Groonga::TableCursor::KeySupport} を
  * 参照。
  */
 

data/ext/groonga/rb-grn-double-array-trie.c

@@ -30,22 +30,23 @@ VALUE rb_cGrnDoubleArrayTrie;
  * trie. It can change key without ID change. This feature
  * is supported by only Groonga::DoubleArrayTrie. But it
  * requires large spaces rather than other tables. It is
- * used by Groonga::Database for key management
+ * used by {Groonga::Database} for key management
  * internally. It's reasonable choice because number of
- * tables and columns in Groonga::Database (number of their
+ * tables and columns in {Groonga::Database} (number of their
  * names equals to number of keys to be managed by
  * Groonga::DoubleArrayTrie) will be less than number of
  * records of user defined tables.
  *
  * Groonga::DoubleArrayTrie supports exact match search,
  * predictive search and common prefix search like
- * Groonga::PatriciaTrie. It also supports cursor API.
+ * {Groonga::PatriciaTrie} . It also supports cursor API.
  */
 
 /*
  * It creates a table that manages records by double array trie.
  * ブロックを指定すると、そのブロックに生成したテーブルが渡さ
  * れ、ブロックを抜けると自動的にテーブルが破棄される。
+ *
  * @example
  *   #無名一時テーブルを生成する。
  *   Groonga::DoubleArrayTrie.create
@@ -69,12 +70,12 @@ VALUE rb_cGrnDoubleArrayTrie;
  *   #（キーの種類を表すオブジェクトは文字列で指定。）
  *   Groonga::DoubleArrayTrie.create(:key_type => "ShortText")
  *
- *   #キーとして<tt>Bookmarks</tt>テーブルのレコードを使用す
+ *   #キーとしてBookmarksテーブルのレコードを使用す
  *   #る無名一時テーブルを生成する。
  *   bookmarks = Groonga::DoubleArrayTrie.create(:name => "Bookmarks")
  *   Groonga::DoubleArrayTrie.create(:key_type => bookmarks)
  *
- *   #キーとして<tt>Bookmarks</tt>テーブルのレコードを使用す
+ *   #キーとしてBookmarksテーブルのレコードを使用す
  *   #る無名一時テーブルを生成する。
  *   #（テーブルは文字列で指定。）
  *   Groonga::DoubleArrayTrie.create(:name => "Bookmarks")
@@ -91,121 +92,67 @@ VALUE rb_cGrnDoubleArrayTrie;
  *
  * @overload create(options={})
  *   @return [Groonga::DoubleArrayTrie]
- *   @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。
- *   @option options :name
- *     テーブルの名前。名前をつけると、Groonga::Context#[]に名
- *     前を指定してテーブルを取得することができる。省略すると
- *     無名テーブルになり、テーブルIDでのみ取得できる。
- *   @option options :path
- *     テーブルを保存するパス。パスを指定すると永続テーブルとな
- *     り、プロセス終了後もレコードは保持される。次回起動時に
- *     Groonga::Context#[]で保存されたレコードを利用する
- *     ことができる。省略すると一時テーブルになり、プロセスが終
- *     了するとレコードは破棄される。
- *   @option options :persistent
- *     +true+ を指定すると永続テーブルとなる。 +path+ を省略した
- *     場合は自動的にパスが付加される。 +:context+ で指定した
- *     Groonga::Contextに結びついているデータベースが一時デー
- *     タベースの場合は例外が発生する。
- *   @option options :key_normalize
- *     +true+ を指定するとキーを正規化する。
- *   @option options :key_with_sis
- *     +true+ を指定するとキーの文字列の全suffixが自動的に登
- *     録される。
- *   @option options :key_type
- *     キーの種類を示すオブジェクトを指定する。キーの種類には型
- *     名（"Int32"や"ShortText"など）またはGroonga::Typeまたは
- *     テーブル（Groonga::Array、Groonga::Hash、
- *     Groonga::DoubleArrayTrieのどれか）を指定する。
- *     Groonga::Typeを指定した場合は、その型が示す範囲の値をキー
- *     として使用する。ただし、キーの最大サイズは4096バイトで
- *     あるため、Groonga::Type::TEXTやGroonga::Type::LONG_TEXT
- *     は使用できない。
+ *   @!macro [new] double-array-trie.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} 。
+ *     @option options :name
+ *       テーブルの名前。名前をつけると、 {Groonga::Context#[]} に名
+ *       前を指定してテーブルを取得することができる。省略すると
+ *       無名テーブルになり、テーブルIDでのみ取得できる。
+ *     @option options :path
+ *       テーブルを保存するパス。パスを指定すると永続テーブルとな
+ *       り、プロセス終了後もレコードは保持される。次回起動時に
+ *       {Groonga::Context#[]} で保存されたレコードを利用する
+ *       ことができる。省略すると一時テーブルになり、プロセスが終
+ *       了するとレコードは破棄される。
+ *     @option options :persistent
+ *       +true+ を指定すると永続テーブルとなる。 +path+ を省略した
+ *       場合は自動的にパスが付加される。 +:context+ で指定した
+ *       {Groonga::Context} に結びついているデータベースが一時デー
+ *       タベースの場合は例外が発生する。
+ *     @option options :key_normalize
+ *       +true+ を指定するとキーを正規化する。
+ *     @option options :key_with_sis
+ *       +true+ を指定するとキーの文字列の全suffixが自動的に登
+ *       録される。
+ *     @option options :key_type
+ *       キーの種類を示すオブジェクトを指定する。キーの種類には型
+ *       名（"Int32"や"ShortText"など）または {Groonga::Type} または
+ *       テーブル（ {Groonga::Array} 、{Groonga::Hash} 、
+ *       {Groonga::DoubleArrayTrie} のどれか）を指定する。
+ *       {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
+ *       参考: {Groonga::Type.new}
  *
- *   @option options :default_tokenizer
- *     Groonga::IndexColumnで使用するトークナイザを指定する。
- *     デフォルトでは何も設定されていないので、テーブルに
- *     Groonga::IndexColumnを定義する場合は
- *     <tt>"TokenBigram"</tt>などを指定する必要がある。
- *   @option options :sub_records
- *     +true+ を指定すると#groupでグループ化したときに、
- *     Groonga::Record#n_sub_recordsでグループに含まれるレコー
- *     ドの件数を取得できる。
+ *     @option options :default_tokenizer
+ *       {Groonga::IndexColumn} で使用するトークナイザを指定する。
+ *       デフォルトでは何も設定されていないので、テーブルに
+ *       {Groonga::IndexColumn} を定義する場合は
+ *       @"TokenBigram"@ などを指定する必要がある。
+ *     @option options :sub_records
+ *       +true+ を指定すると {#group} でグループ化したときに、
+ *       {Groonga::Record#n_sub_records} でグループに含まれるレコー
+ *       ドの件数を取得できる。
+ *   @!macro double-array-trie.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。
- *   @option options :name
- *     テーブルの名前。名前をつけると、Groonga::Context#[]に名
- *     前を指定してテーブルを取得することができる。省略すると
- *     無名テーブルになり、テーブルIDでのみ取得できる。
- *   @option options :path
- *     テーブルを保存するパス。パスを指定すると永続テーブルとな
- *     り、プロセス終了後もレコードは保持される。次回起動時に
- *     Groonga::Context#[]で保存されたレコードを利用する
- *     ことができる。省略すると一時テーブルになり、プロセスが終
- *     了するとレコードは破棄される。
- *   @option options :persistent
- *     +true+ を指定すると永続テーブルとなる。 +path+ を省略した
- *     場合は自動的にパスが付加される。 +:context+ で指定した
- *     Groonga::Contextに結びついているデータベースが一時デー
- *     タベースの場合は例外が発生する。
- *   @option options :key_normalize
- *     +true+ を指定するとキーを正規化する。
- *   @option options :key_with_sis
- *     +true+ を指定するとキーの文字列の全suffixが自動的に登
- *     録される。
- *   @option options :key_type
- *     キーの種類を示すオブジェクトを指定する。キーの種類には型
- *     名（"Int32"や"ShortText"など）またはGroonga::Typeまたは
- *     テーブル（Groonga::Array、Groonga::Hash、
- *     Groonga::DoubleArrayTrieのどれか）を指定する。
- *     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 :default_tokenizer
- *     Groonga::IndexColumnで使用するトークナイザを指定する。
- *     デフォルトでは何も設定されていないので、テーブルに
- *     Groonga::IndexColumnを定義する場合は
- *     <tt>"TokenBigram"</tt>などを指定する必要がある。
- *   @option options :sub_records
- *     +true+ を指定すると#groupでグループ化したときに、
- *     Groonga::Record#n_sub_recordsでグループに含まれるレコー
- *     ドの件数を取得できる。
- *
+ *   @!macro double-array-trie.create.options
  */
 static VALUE
 rb_grn_double_array_trie_s_create (int argc, VALUE *argv, VALUE klass)
@@ -288,11 +235,12 @@ rb_grn_double_array_trie_s_create (int argc, VALUE *argv, VALUE klass)
 
 /*
  * _key_ にマッチするレコードのIDがキーに入っている
- * Groonga::Hashを返す。マッチするレコードがない場合は空の
- * Groonga::Hashが返る。
+ * {Groonga::Hash} を返す。マッチするレコードがない場合は空の
+ * {fGroonga::Hash} が返る。
  * _options_ で +:result+ を指定することにより、そのテーブルにマッ
  * チしたレコードIDがキーのレコードを追加することができる。
  * +:result+ にテーブルを指定した場合は、そのテーブルが返る。
+ *
  * @example 複数のキーで検索し、結果を1つのテーブルに集める。
  *   result = nil
  *   keys = ["morita", "gunyara-kun", "yu"]
@@ -314,18 +262,19 @@ rb_grn_double_array_trie_s_create (int argc, VALUE *argv, VALUE klass)
  *   @option options :operator (Groonga::Operator::OR)
  *     マッチしたレコードをどのように扱うか。指定可能な値は以
  *     下の通り。
- *     [Groonga::Operator::OR]
+ *
+ *     - Groonga::Operator::OR :=
  *       マッチしたレコードを追加。すでにレコードが追加され
- *       ている場合は何もしない。
- *     [Groonga::Operator::AND]
+ *       ている場合は何もしない。 =:
+ *     - Groonga::Operator::AND :=
  *       マッチしたレコードのスコアを増加。マッチしなかった
- *       レコードを削除。
- *     [Groonga::Operator::BUT]
- *       マッチしたレコードを削除。
- *     [Groonga::Operator::ADJUST]
- *       マッチしたレコードのスコアを増加。
- *     [+:type+]
- *       ?????
+ *       レコードを削除。 =:
+ *     - Groonga::Operator::BUT :=
+ *       マッチしたレコードを削除。 =:
+ *     - Groonga::Operator::ADJUST :=
+ *       マッチしたレコードのスコアを増加。 =:
+ *     - +:type+ :=
+ *       ????? =:
  *
  */
 static VALUE