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

data/lib/groonga/schema.rb

@@ -21,7 +21,7 @@ module Groonga
 
   # groongaのスキーマ（データ構造）を管理するクラス。
   #
-  # Groonga::Schemaを使うことにより簡単にテーブルやカラムを
+  # {Groonga::Schema} を使うことにより簡単にテーブルやカラムを
   # 追加・削除することができる。
   #
   # !http://qwik.jp/senna/senna2.files/rect4605.png!
@@ -148,11 +148,12 @@ module Groonga
 
     class << self
 
-      # スキーマを定義する。ブロックにはGroonga::Schemaオブ
+      # スキーマを定義する。ブロックには {Groonga::Schema} オブ
       # ジェクトがわたるので、そのオブジェクトを利用してスキー
       # マを定義する。以下の省略形。
       #
       # <pre>
+      # !!!ruby
       # schema = Groonga::Scheme.new(options)
       # # ...
       # schema.define
@@ -162,20 +163,25 @@ module Groonga
       #   pairs. Omitted names are initialized as the default value.
       # @option options [Groonga::Context] :content (Groonga::Context.default) The context
       #
-      #   スキーマ定義時に使用するGroonga::Contextを指定する。
+      #   スキーマ定義時に使用する {Groonga::Context} を指定する。
       def define(options={})
         schema = new(options)
         yield(schema)
         schema.define
       end
 
-      # @example 名前が _name_ のテーブルを作成する。以下の省略形。
-      #  Groonga::Schema.define do |schema|
-      #    schema.create_table(name, options) do |table|
-      #      # ...
-      #    end
-      #  end
-      # ブロックにはGroonga::Schema::TableDefinitionオブジェ
+      # 名前が _name_ のテーブルを作成する。以下の省略形。
+      #
+      # <pre>
+      # !!!ruby
+      # Groonga::Schema.define do |schema|
+      #   schema.create_table(name, options) do |table|
+      #     # ...
+      #   end
+      # end
+      # </pre>
+      #
+      # ブロックには {Groonga::Schema::TableDefinition} オブジェ
       # クトがわたるので、そのオブジェクトを利用してテーブル
       # の詳細を定義する。
       #
@@ -195,7 +201,7 @@ module Groonga
       #     (:key_typeの項も参照)
       #   @option options [Groonga::Context] :context (Groonga::Context.default) The context
       #
-      #     スキーマ定義時に使用するGroonga::Contextを指定する。
+      #     スキーマ定義時に使用する {Groonga::Context} を指定する。
       #   @option options :path The path
       #
       #     テーブルを保存するパスを指定する。
@@ -210,8 +216,8 @@ module Groonga
       #     値を保存したい場合は必ず指定すること。
       #   @option options :sub_records The sub_records
       #
-      #     +true+ を指定するとGroonga::Table#groupで
-      #     グループ化したときに、Groonga::Record#n_sub_recordsでグループに
+      #     +true+ を指定すると {Groonga::Table#group} で
+      #     グループ化したときに、 {Groonga::Record#n_sub_records} でグループに
       #     含まれるレコードの件数を取得できる。
       #
       # @overload create_table(name, options= {:type => :hash}, &block)
@@ -229,7 +235,7 @@ module Groonga
       #     (:key_typeの項も参照)
       #   @option options [Groonga::Context] :context (Groonga::Context.default) The context
       #
-      #     スキーマ定義時に使用するGroonga::Contextを指定する。
+      #     スキーマ定義時に使用する {Groonga::Context} を指定する。
       #   @option options :path The path
       #
       #     テーブルを保存するパスを指定する。
@@ -244,29 +250,29 @@ module Groonga
       #     値を保存したい場合は必ず指定すること。
       #   @option options :sub_records The sub_records
       #
-      #     +true+ を指定するとGroonga::Table#groupで
-      #     グループ化したときに、Groonga::Record#n_sub_recordsでグループに
+      #     +true+ を指定すると {Groonga::Table#group} で
+      #     グループ化したときに、 {Groonga::Record#n_sub_records} でグループに
       #     含まれるレコードの件数を取得できる。
       #   @option options :key_type The key_type
       #
       #     キーの種類を示すオブジェクトを指定する。
-      #     キーの種類には型名（"Int32"や"ShortText"など）またはGroonga::Type
-      #     またはテーブル（Groonga::Array、Groonga::Hash、
-      #     Groonga::PatriciaTrie、Groonga::DoubleArrayTrieの
-      #     どれか）を指定する。Groonga::Typeを指定した場合は、その型が示す範囲の
+      #     キーの種類には型名（"Int32"や"ShortText"など）または {Groonga::Type}
+      #     またはテーブル（ {Groonga::Array} 、 {Groonga::Hash} 、
+      #     {Groonga::PatriciaTrie} 、 {Groonga::DoubleArrayTrie} の
+      #     どれか）を指定する。 {Groonga::Type} を指定した場合は、その型が示す範囲の
       #     値をキーとして使用する。ただし、キーの最大サイズは4096バイトで
-      #     あるため、Groonga::Type::TEXTやGroonga::Type::LONG_TEXTは使用できない
+      #     あるため、 {Groonga::Type::TEXT} や {Groonga::Type::LONG_TEXT} は使用できない
       #     。テーブルを指定した場合はレコードIDをキーとして使用する。
-      #     指定したテーブルのGroonga::Recordをキーとして使用することもでき、
-      #     その場合は自動的にGroonga::RecordからレコードIDを取得する。
+      #     指定したテーブルの {Groonga::Record} をキーとして使用することもでき、
+      #     その場合は自動的に {Groonga::Record} からレコードIDを取得する。
       #     省略した場合は文字列をキーとして使用する。
       #     この場合、4096バイトまで使用可能である。
       #   @option options :default_tokenizer The default_tokenizer
       #
-      #     Groonga::IndexColumnで
+      #     {Groonga::IndexColumn} で
       #     使用するトークナイザを指定する。デフォルトでは
       #     何も設定されていないので、テーブルに
-      #     Groonga::IndexColumnを定義する場合は<tt>"TokenBigram"</tt>
+      #     {Groonga::IndexColumn} を定義する場合は @"TokenBigram"@
       #     などを指定する必要がある。
       #   @option options :key_normalize The key_normalize
       #
@@ -287,7 +293,7 @@ module Groonga
       #     (:key_typeの項も参照)
       #   @option options [Groonga::Context] :context (Groonga::Context.default) The context
       #
-      #     スキーマ定義時に使用するGroonga::Contextを指定する。
+      #     スキーマ定義時に使用する {Groonga::Context} を指定する。
       #   @option options :path The path
       #
       #     テーブルを保存するパスを指定する。
@@ -302,8 +308,8 @@ module Groonga
       #     値を保存したい場合は必ず指定すること。
       #   @option options :sub_records The sub_records
       #
-      #     +true+ を指定するとGroonga::Table#groupで
-      #     グループ化したときに、Groonga::Record#n_sub_recordsでグループに
+      #     +true+ を指定すると {Groonga::Table#group} で
+      #     グループ化したときに、 {Groonga::Record#n_sub_records} でグループに
       #     含まれるレコードの件数を取得できる。
       #   @option options :key_normalize The key_normalize
       #
@@ -322,7 +328,7 @@ module Groonga
       #   pairs. Omitted names are initialized as the default value.
       # @option options :context (Groonga::Context.default)
       #
-      #   スキーマ定義時に使用するGroonga::Contextを指定する。
+      #   スキーマ定義時に使用する {Groonga::Context} を指定する。
       def remove_table(name, options={})
         define do |schema|
           schema.remove_table(name, options)
@@ -332,6 +338,7 @@ module Groonga
       # 名前が _name_ のテーブルを変更する。以下の省略形。
       #
       # <pre>
+      # !!!ruby
       # Groonga::Schema.define do |schema|
       #   schema.change_table(name, options) do |table|
       #     # ...
@@ -339,7 +346,7 @@ module Groonga
       # end
       # </pre>
       #
-      # ブロックにはGroonga::Schema::TableDefinitionオブジェ
+      # ブロックには {Groonga::Schema::TableDefinition} オブジェ
       # クトがわたるので、そのオブジェクトを利用してテーブル
       # の詳細を定義する。
       #
@@ -347,7 +354,7 @@ module Groonga
       #   pairs. Omitted names are initialized as the default value.
       # @option options :context (Groonga::Context.default) The context
       #
-      #   スキーマ定義時に使用するGroonga::Contextを指定する。
+      #   スキーマ定義時に使用する {Groonga::Context} を指定する。
       def change_table(name, options={}, &block)
         define do |schema|
           schema.change_table(name, options, &block)
@@ -359,6 +366,7 @@ module Groonga
       # This is a syntax sugar of the following code:
       #
       # <pre>
+      # !!!ruby
       # Groonga::Schema.define do |schema|
       #   schema.rename_table(current_name, new_name, options)
       # end
@@ -372,13 +380,14 @@ module Groonga
       # 名前が_name_のビューを作成する。以下の省略形。
       #
       # <pre>
+      # !!!ruby
       # Groonga::Schema.define do |schema|
       #   schema.create_view(name, options) do |view|
       #     # ...
       #   end
       # end
       # </pre>
-      # ブロックにはGroonga::Schema::ViewDefinitionオブジェ
+      # ブロックには {Groonga::Schema::ViewDefinition} オブジェ
       # クトがわたるので、そのオブジェクトを利用してビュー
       # の詳細を定義する。
       #
@@ -390,7 +399,7 @@ module Groonga
       #   存在していても、強制的にビューを作成する。
       # @option options :context (Groonga::Context.default) The context
       #
-      #   スキーマ定義時に使用するGroonga::Contextを指定する。
+      #   スキーマ定義時に使用する {Groonga::Context} を指定する。
       # @option options :path The path
       #
       #   ビューを保存するパスを指定する。
@@ -411,16 +420,17 @@ module Groonga
       # @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を指定する。
+      #   スキーマ定義時に使用する {Groonga::Context} を指定する。
       def remove_view(name, options={})
         define do |schema|
           schema.remove_view(name, options)
         end
       end
 
-      # 名前が_name_のビューを変更する。以下の省略形。
+      # 名前が _name_ のビューを変更する。以下の省略形。
       #
       # <pre>
+      # !!!ruby
       # Groonga::Schema.define do |schema|
       #   schema.change_view(name, options) do |view|
       #     # ...
@@ -428,7 +438,7 @@ module Groonga
       # end
       # </pre>
       #
-      # ブロックにはGroonga::Schema::ViewDefinitionオブジェ
+      # ブロックには {Groonga::Schema::ViewDefinition} オブジェ
       # クトがわたるので、そのオブジェクトを利用してテーブル
       # の詳細を定義する。
       #
@@ -436,7 +446,7 @@ module Groonga
       #   pairs. Omitted names are initialized as the default value.
       # @option options :context (Groonga::Context.default) The context
       #
-      #   スキーマ定義時に使用するGroonga::Contextを指定する。
+      #   スキーマ定義時に使用する {Groonga::Context} を指定する。
       def change_view(name, options={}, &block)
         define do |schema|
           schema.change_view(name, options, &block)
@@ -446,6 +456,7 @@ module Groonga
       # 以下と同様:
       #
       # <pre>
+      # !!!ruby
       # Groonga::Schema.change_table(table_name) do |table|
       #   table.remove_column(column_name)
       # end
@@ -459,6 +470,7 @@ module Groonga
       # This is a syntax sugar of the following:
       #
       # <pre>
+      # !!!ruby
       # Groonga::Schema.define do |schema|
       #   schema.rename_column(table_name,
       #                        current_column_name, new_column_name)
@@ -473,12 +485,13 @@ module Groonga
       # スキーマの内容を文字列をRubyスクリプト形式またはgrn式
       # 形式で返す。デフォルトはRubyスクリプト形式である。
       # Rubyスクリプト形式で返された値は
-      # Groonga::Schema.restoreすることによりスキーマ内に組み
+      # {Groonga::Schema.restore} することによりスキーマ内に組み
       # 込むことができる。
       #
       # dump.rb:
       #
       # <pre>
+      # !!!ruby
       # File.open("/tmp/groonga-schema.rb", "w") do |schema|
       #   dumped_text = Groonga::Schema.dump
       # end
@@ -487,6 +500,7 @@ module Groonga
       # restore.rb:
       #
       # <pre>
+      # !!!ruby
       # dumped_text = Groonga::Schema.dump
       # Groonga::Database.create(:path => "/tmp/new-db.grn")
       # Groonga::Schema.restore(dumped_text)
@@ -498,6 +512,7 @@ module Groonga
       # dump.rb:
       #
       # <pre>
+      # !!!ruby
       # File.open("/tmp/groonga-schema.grn", "w") do |schema|
       #   dumped_text = Groonga::Schema.dump(:syntax => :command)
       # end
@@ -512,7 +527,7 @@ module Groonga
       #   pairs. Omitted names are initialized as the default value.
       # @option options :context (Groonga::Context.default) The context
       #
-      #   スキーマ定義時に使用するGroonga::Contextを指定する。
+      #   スキーマ定義時に使用する {Groonga::Context} を指定する。
       # @option options :syntax The syntax
       #
       #   スキーマの文字列の形式を指定する。指定可能な値は以下の通り。
@@ -526,13 +541,14 @@ module Groonga
         schema.dump
       end
 
-      # Groonga::Schema.dumpで文字列化したスキーマを組み込む。
+      # {Groonga::Schema.dump} で文字列化したスキーマを組み込む。
       def restore(dumped_text, options={})
         define(options) do |schema|
           schema.restore(dumped_text)
 	end
       end
 
+      # @private
       NORMALIZE_TYPE_TABLE = {
         "short_text" => "ShortText",
         "string" => "ShortText",
@@ -616,7 +632,7 @@ module Groonga
     # @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を指定する。
+    #   スキーマ定義時に使用する {Groonga::Context} を指定する。
     def initialize(options={})
       @options = (options || {}).dup
       @options[:context] ||= Groonga::Context.default
@@ -630,9 +646,9 @@ module Groonga
       end
     end
 
-    # Groonga::Schema#dumpで返されたスキーマの内容を読み込む。
+    # {Groonga::Schema#dump} で返されたスキーマの内容を読み込む。
     #
-    # 読み込まれた内容は#defineを呼び出すまでは実行されない
+    # 読み込まれた内容は {#define} を呼び出すまでは実行されない
     # ことに注意すること。
     def restore(dumped_text)
       instance_eval(dumped_text)
@@ -642,7 +658,7 @@ module Groonga
     alias_method :load, :restore
 
     # スキーマの内容を文字列で返す。返された値は
-    # Groonga::Schema#restoreすることによりスキーマ内に組み込むことができる。
+    # {Groonga::Schema#restore} することによりスキーマ内に組み込むことができる。
     def dump
       dumper = SchemaDumper.new(:context => @options[:context],
                                 :syntax => @options[:syntax] || :ruby)
@@ -651,7 +667,7 @@ module Groonga
 
     # 名前が _name_ のテーブルを作成する。
     #
-    # テーブルの作成は#defineを呼び出すまでは実行されないこ
+    # テーブルの作成は {#define} を呼び出すまでは実行されないこ
     # とに注意すること。
     # @overload create_table(name, options= {:type => :array})
     #   :typeにデフォルトの:arrayを使用した場合
@@ -668,10 +684,10 @@ module Groonga
     #     +:double_array_trie+ のいずれかを指定する。
     #   @option options [Groonga::Context] :context The context.
     #
-    #     スキーマ定義時に使用するGroonga::Contextを指定する。
-    #     省略した場合はGroonga::Schema.newで指定した
-    #     Groonga::Contextを使用する。Groonga::Schema.newで指
-    #     定していない場合はGroonga::Context.defaultを使用する。
+    #     スキーマ定義時に使用する {Groonga::Context} を指定する。
+    #     省略した場合は {Groonga::Schema.new} で指定した
+    #     {Groonga::Context} を使用する。 {Groonga::Schema.new} で指
+    #     定していない場合は {Groonga::Context.default} を使用する。
     #   @option options :path The path
     #
     #     テーブルを保存するパスを指定する。パスを指定すると
@@ -685,11 +701,11 @@ module Groonga
     #
     #     値の型を指定する。省略すると値のための領域を確保しない。
     #     値を保存したい場合は必ず指定すること。
-    #     参考: Groonga::Type.new
+    #     参考: {Groonga::Type.new}
     #   @option options :sub_records The sub_records
     #
-    #     +true+ を指定するとGroonga::Table#groupでグループ化
-    #     したときに、Groonga::Record#n_sub_recordsでグループに
+    #     +true+ を指定すると {Groonga::Table#group} でグループ化
+    #     したときに、 {Groonga::Record#n_sub_records} でグループに
     #     含まれるレコードの件数を取得できる。
     #
     # @overload create_table(name, options= {:type => :hash})
@@ -707,10 +723,10 @@ module Groonga
     #     +:double_array_trie+ のいずれかを指定する。
     #   @option options [Groonga::Context] :context The context
     #
-    #     スキーマ定義時に使用するGroonga::Contextを指定する。
-    #     省略した場合はGroonga::Schema.newで指定した
-    #     Groonga::Contextを使用する。Groonga::Schema.newで指
-    #     定していない場合はGroonga::Context.defaultを使用する。
+    #     スキーマ定義時に使用する {Groonga::Context} を指定する。
+    #     省略した場合は {Groonga::Schema.new} で指定した
+    #     {Groonga::Context} を使用する。 {Groonga::Schema.new} で指
+    #     定していない場合は {Groonga::Context.default} を使用する。
     #   @option options :path The path
     #
     #     テーブルを保存するパスを指定する。パスを指定すると
@@ -724,39 +740,39 @@ module Groonga
     #
     #     値の型を指定する。省略すると値のための領域を確保しない。
     #     値を保存したい場合は必ず指定すること。
-    #     参考: Groonga::Type.new
+    #     参考: {Groonga::Type.new}
     #   @option options :sub_records The sub_records
     #
-    #     +true+ を指定するとGroonga::Table#groupでグループ化
-    #     したときに、Groonga::Record#n_sub_recordsでグループに
+    #     +true+ を指定すると {Groonga::Table#group} でグループ化
+    #     したときに、 {Groonga::Record#n_sub_records} でグループに
     #     含まれるレコードの件数を取得できる。
     #   @option options :key_type The key_type
     #
     #     キーの種類を示すオブジェクトを指定する。
     #     キーの種類には型名（"Int32"や"ShortText"など）または
-    #     Groonga::Typeまたはテーブル（Groonga::Array、
-    #     Groonga::Hash、Groonga::PatriciaTrie、
-    #     Groonga::DoubleArrayTrieのどれか）を指定する。
+    #     {Groonga::Type} またはテーブル（ {Groonga::Array} 、
+    #     {Groonga::Hash} 、 {Groonga::PatriciaTrie} 、
+    #     {Groonga::DoubleArrayTrie} のどれか）を指定する。
     #
-    #     Groonga::Typeを指定した場合は、その型が示す範囲の
+    #     {Groonga::Type} を指定した場合は、その型が示す範囲の
     #     値をキーとして使用する。ただし、キーの最大サイズは
-    #     4096バイトであるため、Groonga::Type::TEXTや
-    #     Groonga::Type::LONG_TEXTは使用できない。
+    #     4096バイトであるため、 {Groonga::Type::TEXT} や
+    #     {Groonga::Type::LONG_TEXT} は使用できない。
     #
     #     テーブルを指定した場合はレコードIDをキーとして使用
-    #     する。指定したテーブルのGroonga::Recordをキーとし
+    #     する。指定したテーブルの {Groonga::Record} をキーとし
     #     て使用することもでき、その場合は自動的に
-    #     Groonga::RecordからレコードIDを取得する。
+    #     {Groonga::Record} からレコードIDを取得する。
     #
     #     省略した場合は文字列をキーとして使用する。この場合、
     #     4096バイトまで使用可能である。
     #
     #   @option options :default_tokenizer The default_tokenizer
     #
-    #     Groonga::IndexColumnで使用するトークナイザを指定する。
+    #     {Groonga::IndexColumn} で使用するトークナイザを指定する。
     #     デフォルトでは何も設定されていないので、テーブルに
-    #     Groonga::IndexColumnを定義する場合は
-    #     <tt>"TokenBigram"</tt>などを指定する必要がある。
+    #     {Groonga::IndexColumn} を定義する場合は
+    #     @"TokenBigram"@ などを指定する必要がある。
     #
     # @overload create_table(name, options= {:type => :double_array_trie})
     #   :typeに:double_array_trieを使用した場合
@@ -768,10 +784,10 @@ module Groonga
     #     存在していても、強制的にテーブルを作成する。
     #   @option options [Groonga::Context] :context The context
     #
-    #     スキーマ定義時に使用するGroonga::Contextを指定する。
-    #     省略した場合はGroonga::Schema.newで指定した
-    #     Groonga::Contextを使用する。Groonga::Schema.newで指
-    #     定していない場合はGroonga::Context.defaultを使用する。
+    #     スキーマ定義時に使用する {Groonga::Context} を指定する。
+    #     省略した場合は {Groonga::Schema.new} で指定した
+    #     {Groonga::Context} を使用する。 {Groonga::Schema.new} で指
+    #     定していない場合は {Groonga::Context.default} を使用する。
     #   @option options :path The path
     #
     #     テーブルを保存するパスを指定する。パスを指定すると
@@ -785,11 +801,11 @@ module Groonga
     #
     #     値の型を指定する。省略すると値のための領域を確保しない。
     #     値を保存したい場合は必ず指定すること。
-    #     参考: Groonga::Type.new
+    #     参考: {Groonga::Type.new}
     #   @option options :sub_records The sub_records
     #
-    #     +true+ を指定するとGroonga::Table#groupでグループ化
-    #     したときに、Groonga::Record#n_sub_recordsでグループに
+    #     +true+ を指定すると {Groonga::Table#group} でグループ化
+    #     したときに、 {Groonga::Record#n_sub_records} でグループに
     #     含まれるレコードの件数を取得できる。
     #   @option options :key_normalize The key_normalize
     #
@@ -798,28 +814,28 @@ module Groonga
     #
     #     キーの種類を示すオブジェクトを指定する。
     #     キーの種類には型名（"Int32"や"ShortText"など）または
-    #     Groonga::Typeまたはテーブル（Groonga::Array、
-    #     Groonga::Hash、Groonga::PatriciaTrie、
-    #     Groonga::DoubleArrayTrieのどれか）を指定する。
+    #     {Groonga::Type} またはテーブル（ {Groonga::Array} 、
+    #     {Groonga::Hash} 、 {Groonga::PatriciaTrie} 、
+    #     {Groonga::DoubleArrayTrie} のどれか）を指定する。
     #
-    #     Groonga::Typeを指定した場合は、その型が示す範囲の
+    #     {Groonga::Type} を指定した場合は、その型が示す範囲の
     #     値をキーとして使用する。ただし、キーの最大サイズは
-    #     4096バイトであるため、Groonga::Type::TEXTや
-    #     Groonga::Type::LONG_TEXTは使用できない。
+    #     4096バイトであるため、 {Groonga::Type::TEXT} や
+    #     {Groonga::Type::LONG_TEXT} は使用できない。
     #
     #     テーブルを指定した場合はレコードIDをキーとして使用
-    #     する。指定したテーブルのGroonga::Recordをキーとし
+    #     する。指定したテーブルの {Groonga::Record} をキーとし
     #     て使用することもでき、その場合は自動的に
-    #     Groonga::RecordからレコードIDを取得する。
+    #     {Groonga::Record} からレコードIDを取得する。
     #
     #     省略した場合は文字列をキーとして使用する。この場合、
     #     4096バイトまで使用可能である。
     #   @option options :default_tokenizer The default_tokenizer
     #
-    #     Groonga::IndexColumnで使用するトークナイザを指定する。
+    #     {Groonga::IndexColumn} で使用するトークナイザを指定する。
     #     デフォルトでは何も設定されていないので、テーブルに
-    #     Groonga::IndexColumnを定義する場合は
-    #     <tt>"TokenBigram"</tt>などを指定する必要がある。
+    #     {Groonga::IndexColumn} を定義する場合は
+    #     @"TokenBigram"@ などを指定する必要がある。
     def create_table(name, options={})
       definition = TableDefinition.new(name, @options.merge(options || {}))
       yield(definition) if block_given?
@@ -828,14 +844,14 @@ module Groonga
 
     # 名前が _name_ のテーブルを削除する。
     #
-    # テーブルの削除は#defineを呼び出すまでは実行されないこ
+    # テーブルの削除は# {define} を呼び出すまでは実行されないこ
     # とに注意すること。
     #
     # @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を指定する。
+    #   スキーマ定義時に使用する {Groonga::Context} を指定する。
     def remove_table(name, options={})
       definition = TableRemoveDefinition.new(name, @options.merge(options || {}))
       @definitions << definition
@@ -843,14 +859,14 @@ module Groonga
 
     # 名前が _name_ のテーブルを変更する。
     #
-    # テーブルの変更は #define を呼び出すまでは実行されないこ
+    # テーブルの変更は {#define} を呼び出すまでは実行されないこ
     # とに注意すること。
     #
     # @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を指定する。
+    #   スキーマ定義時に使用する {Groonga::Context} を指定する。
     def change_table(name, options={})
       options = @options.merge(options || {}).merge(:change => true)
       definition = TableDefinition.new(name, options)
@@ -866,7 +882,7 @@ module Groonga
     # @param options [::Hash] The name and value
     #   pairs. Omitted names are initialized as the default value.
     # @option options :context (Groonga::Context.default)
-    #   The Groonga::Context to be used in renaming.
+    #   The {Groonga::Context} to be used in renaming.
     def rename_table(current_name, new_name, options={})
       options = @options.merge(options || {})
       definition = TableRenameDefinition.new(current_name, new_name, options)
@@ -875,7 +891,7 @@ module Groonga
 
     # 名前が _name_ のビューを作成する。
     #
-    # ビューの作成は #define を呼び出すまでは実行されないこ
+    # ビューの作成は {#define} を呼び出すまでは実行されないこ
     # とに注意すること。
     #
     # @param options [::Hash] The name and value
@@ -886,9 +902,9 @@ module Groonga
     #   ビューが存在していても、強制的にビューを作成する。
     # @option options [Groonga::Context] :context (Groonga::Schema.new) The context
     #
-    #   スキーマ定義時に使用するGroonga::Contextを指定する。
-    #   Groonga::Schema.newで指定していない場合は
-    #   Groonga::Context.defaultを使用する。
+    #   スキーマ定義時に使用する {Groonga::Context} を指定する。
+    #   {Groonga::Schema.new} で指定していない場合は
+    #   {Groonga::Context.default} を使用する。
     # @option options :path The path
     #
     #   テーブルを保存するパスを指定する。パスを指定すると
@@ -905,7 +921,7 @@ module Groonga
 
     # 名前が _name_ のビューを削除する。
     #
-    # ビューの削除は #define を呼び出すまでは実行されないことに
+    # ビューの削除は {#define} を呼び出すまでは実行されないことに
     # 注意すること。
     #
     # @param options [::Hash] The name and value
@@ -913,7 +929,7 @@ module Groonga
     # @option options [Groonga::Context] :context (Groonga::Context.default)
     #   The context
     #
-    #   スキーマ定義時に使用するGroonga::Contextを指定する。
+    #   スキーマ定義時に使用する {Groonga::Context} を指定する。
     def remove_view(name, options={})
       definition = ViewRemoveDefinition.new(name, @options.merge(options || {}))
       @definitions << definition
@@ -921,14 +937,14 @@ module Groonga
 
     # 名前が _name_ のビューを変更する。
     #
-    # ビューの変更は #define を呼び出すまでは実行されないこ
+    # ビューの変更は {#define} を呼び出すまでは実行されないこ
     # とに注意すること。
     #
     # @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を指定する。
+    #   スキーマ定義時に使用する {Groonga::Context} を指定する。
     def change_view(name, options={})
       options = @options.merge(options || {}).merge(:change => true)
       definition = ViewDefinition.new(name, options)
@@ -939,6 +955,7 @@ module Groonga
     # 以下と同様:
     #
     # <pre>
+    # !!!ruby
     # schema.change_table(table_name) do |table|
     #   table.remove_column(column_name)
     # end
@@ -952,6 +969,7 @@ module Groonga
     # It is a syntax sugar of the following:
     #
     # <pre>
+    # !!!ruby
     # schema.change_table(table_name) do |table|
     #   table.rename_column(current_column_name, new_column_name)
     # end
@@ -991,8 +1009,8 @@ module Groonga
       end
     end
 
-    # スキーマ定義時にGroonga::Schema.create_tableや
-    # Groonga::Schema#create_tableからブロックに渡されてくる
+    # スキーマ定義時に {Groonga::Schema.create_table} や
+    # {Groonga::Schema#create_table} からブロックに渡されてくる
     # オブジェクト
     class TableDefinition
       include Path
@@ -1039,31 +1057,29 @@ module Groonga
       #
       # @param options [::Hash] The name and value
       #   pairs. Omitted names are initialized as the default value.
-      # @option options :force The force
+      # @option options :force
       #
       #   +true+ を指定すると既存の同名のカラムが
       #   存在していても、強制的に新しいカラムを作成する。
-      # @option options :path The path
+      # @option options :path
       #
       #   カラムを保存するパス。
-      # @option options :persistent The persistent
+      # @option options :persistent
       #
-      #   +true+ を指定すると永続カラムとなる。+:path+ を省略
+      #   +true+ を指定すると永続カラムとなる。 +:path+ を省略
       #   した場合は自動的にパスが付加される。
-      # @option options :type (:scalar) The type
+      # @option options :type (:scalar)
       #
       #   カラムの値の格納方法について指定する。
-      #   <b>:scalar</b>
-      #     スカラ値(単独の値)を格納する。
-      #   <b>:vector</b>
-      #     値の配列を格納する。
-      # @option options :compress The compress
+      #
+      #   - :scalar := スカラ値(単独の値)を格納する。
+      #   - :vector := 値の配列を格納する。
+      # @option options :compress
       #
       #   値の圧縮方法を指定する。省略した場合は、圧縮しない。
-      #   <b>:zlib</b>
-      #     値をzlib圧縮して格納する。
-      #   <b>:lzo</b>
-      #     値をlzo圧縮して格納する。
+      #
+      #   - :zlib := 値をzlib圧縮して格納する。
+      #   - :lzo := 値をlzo圧縮して格納する。
       def column(name, type, options={})
         definition = self[name, ColumnDefinition]
         if definition.nil?
@@ -1112,43 +1128,40 @@ module Groonga
       # きます。
       #
       # _target_column_full_name_ で指定するときはテーブル名
-      # とカラム名を"."でつなげます。例えば、「Users」テーブ
-      # ルの「name」カラムのインデックスカラムを指定する場合
-      # はこうなります。
-      #
-      #   table.index("Users.name")
-      #
-      # @param options [::Hash] The name and value
-      #   pairs. Omitted names are initialized as the default value.
-      # @option options :name The name
-      #
-      #   インデックスカラムのカラム名を任意に指定する。
-      # @option options :force The force
-      #
-      #   +true+ を指定すると既存の同名のカラムが
-      #   存在していても、強制的に新しいカラムを作成する。
-      # @option options :path The path
-      #
-      #   カラムを保存するパス。
-      # @option options :persistent The persistent
-      #
-      #   +true+ を指定すると永続カラムとなる。
-      #   +:path+ を省略した場合は自動的にパスが付加される。
-      # @option options :with_section The with_section
+      # とカラム名を"."でつなげます。
       #
-      #   +true+ を指定すると転置索引にsection(段落情報)を
-      #   合わせて格納する。未指定または +nil+ を指定した場合、
-      #   複数のカラムを指定すると自動的に有効になる。
-      # @option options :with_weight The with_weight
+      # 例えば、「Users」テーブルの「name」カラムのインデックスカラムを
+      # 指定する場合はこうなります。
       #
-      #   +true+ を指定すると転置索引にweight情報を合わせて
-      #   格納する。
-      # @option options :with_position
+      # @example
+      #   table.index("Users.name")
       #
-      #   +true+ を指定すると転置索引に出現位置情報を合わせて
-      #   格納する。未指定または +nil+ を指定した場合、テーブル
-      #   がN-gram系のトークナイザーを利用している場合は
-      #   自動的に有効になる。
+      # @param [Array] args
+      #   インデックスカラム作成時に指定できるオプション。
+      #   ハッシュを使って次の要素を指定することができる。
+      #
+      #   - :name :=
+      #     インデックスカラムのカラム名を任意に指定する。 =:
+      #   - :force :=
+      #     +true+ を指定すると既存の同名のカラムが
+      #     存在していても、強制的に新しいカラムを作成する。 =:
+      #   - :path :=
+      #     カラムを保存するパス。 =:
+      #   - :persistent :=
+      #     +true+ を指定すると永続カラムとなる。
+      #     +:path+ を省略した場合は自動的にパスが付加される。 =:
+      #   - :with_section :=
+      #     +true+ を指定すると転置索引にsection(段落情報)を
+      #     合わせて格納する。未指定または +nil+ を指定した場合、
+      #     複数のカラムを指定すると自動的に有効になる。 =:
+      #   - :with_weight :=
+      #     +true+ を指定すると転置索引にweight情報を合わせて
+      #     格納する。 =:
+      #   - :with_position :=
+      #     +true+ を指定すると転置索引に出現位置情報を合わせて
+      #     格納する。未指定または +nil+ を指定した場合、テーブル
+      #     がN-gram系のトークナイザーを利用している場合は
+      #     自動的に有効になる。 =:
       def index(target_table_or_target_column_full_name, *args)
         key, target_table, target_columns, options =
           parse_index_argument(target_table_or_target_column_full_name, *args)
@@ -1169,16 +1182,16 @@ module Groonga
       # クスカラムを削除します。
       #
       # _target_column_full_name_ で指定するときはテーブル名
-      # とカラム名を"."でつなげます。例えば、「Users」テーブ
-      # ルの「name」カラムのインデックスカラムを削除する場合
-      # はこうなります。
+      # とカラム名を"."でつなげます。
+      #
+      # 例えば、「Users」テーブルの「name」カラムのインデックスカラムを
+      # 削除する場合はこうなります。
       #
+      # @example
       #   table.remove_index("Users.name")
       #
-      # @param options [::Hash] The name and value
-      #   pairs. Omitted names are initialized as the default value.
-      # @option options :name The name
-      #   インデックスカラムのカラム名を任意に指定する。
+      # @param [::Hash] args { :name => target_column }と指定す
+      #   ることでインデックスカラムの任意のカラム名を指定することができる。
       def remove_index(target_table_or_target_column_full_name, *args)
         key, target_table, target_columns, options =
           parse_index_argument(target_table_or_target_column_full_name, *args)
@@ -1202,8 +1215,7 @@ module Groonga
       #
       # @param [String or Symbol] name the column name
       # @param [Hash] options ({}) the options
-      # @see Groonga::Schema::TableDefinition#column for
-      #    available @options@.
+      # @see #column #column for available options.
       def integer8(name, options={})
         column(name, "Int8", options)
       end
@@ -1213,8 +1225,7 @@ module Groonga
       #
       # @param [String or Symbol] name the column name
       # @param [Hash] options ({}) the options
-      # @see Groonga::Schema::TableDefinition#column for
-      #    available @options@.
+      # @see #column #column for available options.
       def integer16(name, options={})
         column(name, "Int16", options)
       end
@@ -1243,8 +1254,7 @@ module Groonga
       #
       # @param [String or Symbol] name the column name
       # @param [Hash] options ({}) the options
-      # @see Groonga::Schema::TableDefinition#column for
-      #    available @options@.
+      # @see #column #column for available options.
       def unsigned_integer8(name, options={})
         column(name, "UInt8", options)
       end
@@ -1254,8 +1264,7 @@ module Groonga
       #
       # @param [String or Symbol] name the column name
       # @param [Hash] options ({}) the options
-      # @see Groonga::Schema::TableDefinition#column for
-      #    available @options@.
+      # @see #column #column for available options.
       def unsigned_integer16(name, options={})
         column(name, "UInt16", options)
       end
@@ -1299,8 +1308,11 @@ module Groonga
       end
 
       # 以下と同様:
-      #   table.time("updated_at")
-      #   table.time("created_at")
+      # <pre>
+      # !!!ruby
+      # table.time("updated_at")
+      # table.time("created_at")
+      # </pre>
       def timestamps(options={})
         time("created_at", options)
         time("updated_at", options)
@@ -1356,24 +1368,12 @@ module Groonga
       end
       alias_method :bool, :boolean
 
-      # Defines a 8 bit signed integer column named @name@.
-      #
-      # @param [String or Symbol] name the column name
-      # @param [Hash] options ({}) the options
-      # @see Groonga::Schema::TableDefinition#column for
-      #    available @options@.
-      def integer8(name, options={})
-        column(name, "Int8", options)
-      end
-      alias_method :int8, :integer8
-
       # Defines a geo point in Tokyo geodetic system column
       # named @name@.
       #
       # @param [String or Symbol] name the column name
       # @param [Hash] options ({}) the options
-      # @see Groonga::Schema::TableDefinition#column for
-      #    available @options@.
+      # @see #column #column for available options.
       def tokyo_geo_point(name, options={})
         column(name, "TokyoGeoPoint", options)
       end
@@ -1383,8 +1383,7 @@ module Groonga
       #
       # @param [String or Symbol] name the column name
       # @param [Hash] options ({}) the options
-      # @see Groonga::Schema::TableDefinition#column for
-      #    available @options@.
+      # @see #column #column for available options.
       def wgs84_geo_point(name, options={})
         column(name, "WGS84GeoPoint", options)
       end
@@ -1649,8 +1648,8 @@ module Groonga
       end
     end
 
-    # スキーマ定義時にGroonga::Schema.create_viewや
-    # Groonga::Schema#create_viewからブロックに渡されてくる
+    # スキーマ定義時に {Groonga::Schema.create_view} や
+    # {Groonga::Schema#create_view} からブロックに渡されてくる
     # オブジェクト
     class ViewDefinition
       # ビューの名前
@@ -1688,7 +1687,7 @@ module Groonga
         view
       end
 
-      # 名前が_table_のテーブルをビューに追加する。
+      # 名前が _table_ のテーブルをビューに追加する。
       def add(table)
         table = table.to_s if table.is_a?(Symbol)
         @tables << table