Update Rroonga document

ranguba · Nov 6, 2014 · b0ad2e2 · b0ad2e2
1 parent 0bab8d4
commit b0ad2e2
Show file tree

Hide file tree

Showing 201 changed files with 2,022 additions and 2,111 deletions.
diff --git a/rroonga/en/Groonga.html b/rroonga/en/Groonga.html
@@ -111,15 +111,15 @@
 
     <dt class="r1 last">Defined in:</dt>
     <dd class="r1 last">lib/groonga.rb<span class="defines">,<br />
-  lib/groonga/table.rb,<br /> lib/groonga/record.rb,<br /> lib/groonga/schema.rb,<br /> lib/groonga/dumper.rb,<br /> lib/groonga/logger.rb,<br /> lib/groonga/column.rb,<br /> lib/groonga/posting.rb,<br /> lib/groonga/context.rb,<br /> lib/groonga/database.rb,<br /> lib/groonga/geo-point.rb,<br /> lib/groonga/pagination.rb,<br /> lib/groonga/memory-pool.rb,<br /> lib/groonga/grntest-log.rb,<br /> lib/groonga/sub-records.rb,<br /> lib/groonga/index-column.rb,<br /> lib/groonga/query-logger.rb,<br /> lib/groonga/patricia-trie.rb,<br /> lib/groonga/expression-builder.rb,<br /> lib/groonga/database-inspector.rb,<br /> lib/groonga/statistic-measurer.rb,<br /> lib/groonga/expression-builder-19.rb,<br /> lib/groonga/context/command-executor.rb,<br /> ext/groonga/rb-groonga.c</span>
+  lib/groonga/table.rb,<br /> lib/groonga/record.rb,<br /> lib/groonga/dumper.rb,<br /> lib/groonga/logger.rb,<br /> lib/groonga/schema.rb,<br /> lib/groonga/column.rb,<br /> lib/groonga/posting.rb,<br /> lib/groonga/context.rb,<br /> lib/groonga/database.rb,<br /> lib/groonga/geo-point.rb,<br /> lib/groonga/pagination.rb,<br /> lib/groonga/memory-pool.rb,<br /> lib/groonga/grntest-log.rb,<br /> lib/groonga/sub-records.rb,<br /> lib/groonga/index-column.rb,<br /> lib/groonga/query-logger.rb,<br /> lib/groonga/patricia-trie.rb,<br /> lib/groonga/statistic-measurer.rb,<br /> lib/groonga/database-inspector.rb,<br /> lib/groonga/expression-builder.rb,<br /> lib/groonga/expression-builder-19.rb,<br /> lib/groonga/context/command-executor.rb,<br /> ext/groonga/rb-groonga.c</span>
 </dd>
 
 </dl>
 <div class="clear"></div>
 
 <h2>Overview</h2><div class="docstring">
   <div class="discussion">
-    <p>Copyright (C) 2011  Kouhei Sutou <a href="&#109;&#97;&#105;&#x6c;&#116;&#111;&#58;&#x6b;&#x6f;&#117;&#x40;&#99;&#108;&#101;&#x61;&#114;&#45;&#x63;&#111;&#x64;&#x65;&#46;&#x63;&#x6f;&#109;">&#107;&#111;&#x75;&#64;&#99;&#108;&#x65;&#97;&#114;&#45;&#x63;&#111;&#100;&#101;&#x2e;&#x63;&#x6f;&#x6d;</a></p>
+    <p>Copyright (C) 2011  Kouhei Sutou <a href="&#109;&#097;&#105;&#108;&#116;&#111;:&#107;&#111;&#117;&#064;&#099;&#108;&#101;&#097;&#114;&#045;&#099;&#111;&#100;&#101;&#046;&#099;&#111;&#109;">&#107;&#111;&#117;&#064;&#099;&#108;&#101;&#097;&#114;&#045;&#099;&#111;&#100;&#101;&#046;&#099;&#111;&#109;</a></p>
 
 <p>This library is free software; you can redistribute it and/or
 modify it under the terms of the GNU Lesser General Public
@@ -275,7 +275,7 @@ <h2>
 
 
 
-    <span class="summary_desc"><div class='inline'><p>call-seq:   Groonga[name] -> Groonga::Object or nil   Groonga[id]   -> Groonga::Object or nil.</p>
+    <span class="summary_desc"><div class='inline'><p>call-seq:   Groonga[name] -&gt; Groonga::Object or nil   Groonga[id]   -&gt; Groonga::Object or nil.</p>
 </div></span>
 
 </li>
@@ -298,7 +298,7 @@ <h2>
 
 
 
-    <span class="summary_desc"><div class='inline'><p>BINDINGS_VERSIONを"."で結合して"メジャーバージョン.マ イナーバージョン.マイクロバージョン"という形式の文 字列にしたもの。.</p>
+    <span class="summary_desc"><div class='inline'><p>BINDINGS_VERSIONを”.”で結合して”メジャーバージョン.マ イナーバージョン.マイクロバージョン”という形式の文 字列にしたもの。.</p>
 </div></span>
 
 </li>
@@ -321,7 +321,7 @@ <h2>
 
 
 
-    <span class="summary_desc"><div class='inline'><p>BUILD_VERSIONを"."で結合して"メジャーバージョン.マ イナーバージョン.マイクロバージョン"という形式の 文字列にしたもの。.</p>
+    <span class="summary_desc"><div class='inline'><p>BUILD_VERSIONを”.”で結合して”メジャーバージョン.マ イナーバージョン.マイクロバージョン”という形式の 文字列にしたもの。.</p>
 </div></span>
 
 </li>
@@ -417,8 +417,8 @@ <h3 class="signature first" id="[]-class_method">
 </h3><div class="docstring">
   <div class="discussion">
     <p>call-seq:
-  Groonga[name] -> Groonga::Object or nil
-  Groonga[id]   -> Groonga::Object or nil</p>
+  Groonga[name] -&gt; Groonga::Object or nil
+  Groonga[id]   -&gt; Groonga::Object or nil</p>
 
 <p>便利メソッド。Groonga::Context.default[name]と同じ。</p>
 
@@ -460,8 +460,8 @@ <h3 class="signature " id="bindings_version-class_method">
 
 </h3><div class="docstring">
   <div class="discussion">
-    <p>BINDINGS_VERSIONを"."で結合して<tt>"メジャーバージョン.マ
-イナーバージョン.マイクロバージョン"</tt>という形式の文
+    <p>BINDINGS_VERSIONを”.”で結合して<tt>“メジャーバージョン.マ
+イナーバージョン.マイクロバージョン”</tt>という形式の文
 字列にしたもの。</p>
 
 
@@ -502,8 +502,8 @@ <h3 class="signature " id="build_version-class_method">
 
 </h3><div class="docstring">
   <div class="discussion">
-    <p>BUILD_VERSIONを"."で結合して<tt>"メジャーバージョン.マ
-イナーバージョン.マイクロバージョン"</tt>という形式の
+    <p>BUILD_VERSIONを”.”で結合して<tt>“メジャーバージョン.マ
+イナーバージョン.マイクロバージョン”</tt>という形式の
 文字列にしたもの。</p>
 
 
@@ -547,7 +547,7 @@ <h3 class="signature " id="lock_timeout-class_method">
     <p>Returns the current lock timeout.</p>
 
 <p>See
-<a href="http://groonga.org/docs/reference/api/global_configurations.html">http://groonga.org/docs/reference/api/global_configurations.html</a>
+http://groonga.org/docs/reference/api/global_configurations.html
 about lock timeout.</p>
 
 

diff --git a/rroonga/en/Groonga/Array.html b/rroonga/en/Groonga/Array.html
@@ -834,8 +834,8 @@ <h3 class="signature first" id="add-instance_method">
 
 <p><em>values</em> にはレコードのカラムに設定する値を指定する。省略
 した場合または +nil+ を指定した場合はカラムは設定しない。カ
-ラムの値は @=> 値1, :カラム名2 => 値2,
-...@ と指定する。</p>
+ラムの値は @=&gt; 値1, :カラム名2 =&gt; 値2,
+…@ と指定する。</p>
 
 
   </div>
@@ -964,14 +964,14 @@ <h3 class="signature " id="pull-instance_method">
 record, the pulled record may be uncompleted. It should be handled
 by your application.</p>
 
-<p>If you passes @:block? => true@ option, the pull operation blocks
+<p>If you passes @:block? =&gt; true@ option, the pull operation blocks
 until a pushed record is pushed. It is the default behavior.</p>
 
-<p>If you passes @:block? => false@ option, the pull operation returns
-immediately, the given block isn't called and returns nil when no
+<p>If you passes @:block? =&gt; false@ option, the pull operation returns
+immediately, the given block isn’t called and returns nil when no
 record exist in the array.</p>
 
-<p>Note that your signal handlers can't be ran while a pull
+<p>Note that your signal handlers can’t be ran while a pull
 operation. You need to use <span class='object_link'><a href="#unblock-instance_method" title="Groonga::Array#unblock (method)">#unblock</a></span> from
 another process to unblock the pull operation. If you call
 <span class='object_link'><a href="#unblock-instance_method" title="Groonga::Array#unblock (method)">#unblock</a></span>, signal handler can be ran.</p>
@@ -1001,7 +1001,7 @@ <h3 class="signature " id="pull-instance_method">
 </span><span class='kw'>end</span></code></pre>
 
 
-        <p class="example_title"><div class='inline'><p>Signal handler isn't called</p>
+        <p class="example_title"><div class='inline'><p>Signal handler isn’t called</p>
 </div></p>
 
       <pre class="example code"><code><span class='id identifier rubyid_queue'>queue</span> <span class='op'>=</span> <span class='const'>Groonga</span><span class='op'>::</span><span class='const'>Array</span><span class='period'>.</span><span class='id identifier rubyid_open'>open</span><span class='lparen'>(</span><span class='symbol'>:name</span> <span class='op'>=&gt;</span> <span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>CrawlURLQueue</span><span class='tstring_end'>&quot;</span></span><span class='rparen'>)</span>

diff --git a/rroonga/en/Groonga/Column.html b/rroonga/en/Groonga/Column.html
@@ -143,16 +143,15 @@ <h2>Overview</h2><div class="docstring">
 <p>カラムには大きく分けて3種類ある。</p>
 
 <ul>
-<li><span class='object_link'><a href="FixSizeColumn.html" title="Groonga::FixSizeColumn (class)">FixSizeColumn</a></span> :=
+  <li><span class='object_link'><a href="FixSizeColumn.html" title="Groonga::FixSizeColumn (class)">FixSizeColumn</a></span> :=
 固定長のデータを格納するカラム。 =:</li>
-<li><span class='object_link'><a href="VariableSizeColumn.html" title="Groonga::VariableSizeColumn (class)">VariableSizeColumn</a></span> :=
+  <li><span class='object_link'><a href="VariableSizeColumn.html" title="Groonga::VariableSizeColumn (class)">VariableSizeColumn</a></span> :=
 可変長のデータを格納するカラム。 =:</li>
-<li><span class='object_link'><a href="IndexColumn.html" title="Groonga::IndexColumn (class)">IndexColumn</a></span> :=
+  <li><span class='object_link'><a href="IndexColumn.html" title="Groonga::IndexColumn (class)">IndexColumn</a></span> :=
 転置インデックスを格納するカラム。全文検索や参照元レコー
 ドの検索を行う場合はこのカラムを使用する。 =:</li>
 </ul>
 
-
 <p>固定長データ用カラム・可変長データ用カラムは1つのデータだ
 けを格納するか複数のデータを格納するかを選ぶことができる。
 1つのデータの場合はスカラ値、複数のデータの場合はスカラー
@@ -616,7 +615,7 @@ <h3 class="signature first" id="clear_lock-instance_method">
 
           </span>
 
-            &mdash; <div class='inline'><p><em>:id</em>で指定したレコードのロックを強制的に解除する。
+            &mdash; <div class='inline'><p>_:id_で指定したレコードのロックを強制的に解除する。
 （注: groonga側が未実装のため、現在は無視される。実装さ
 れるのではないかと思っているが、実装されないかもしれな
 い。）</p>
@@ -1183,7 +1182,7 @@ <h3 class="signature " id="lock-instance_method">
 
           </span>
 
-            &mdash; <div class='inline'><p><em>:id</em>で指定したレコードをロックする。（注: groonga側が
+            &mdash; <div class='inline'><p>_:id_で指定したレコードをロックする。（注: groonga側が
 未実装のため、現在は無視される）</p>
 </div>
 
@@ -1256,7 +1255,7 @@ <h3 class="signature " id="lock-instance_method">
 
           </span>
 
-            &mdash; <div class='inline'><p><em>:id</em>で指定したレコードをロックする。（注: groonga側が
+            &mdash; <div class='inline'><p>_:id_で指定したレコードをロックする。（注: groonga側が
 未実装のため、現在は無視される）</p>
 </div>
 
@@ -1439,7 +1438,7 @@ <h3 class="signature " id="locked?-instance_method">
 
           </span>
 
-            &mdash; <div class='inline'><p><em>:id</em>で指定したレコードがロックされていれば +true+ を返す。
+            &mdash; <div class='inline'><p>_:id_で指定したレコードがロックされていれば +true+ を返す。
 （注: groonga側が未実装のため、現在は無視される。実装さ
 れるのではないかと思っているが、実装されないかもしれな
 い。）</p>
@@ -1914,15 +1913,15 @@ <h3 class="signature " id="select-instance_method">
 
 <p>bc. !!!ruby
   results = description_column.select do |column|
-    column =~ "groonga"
+    column =~ “groonga”
   end
-  snippet = results.expression.snippet([["<em>", "</em>"]])
+  snippet = results.expression.snippet([[“<em>”, “</em>”]])
   results.each do |record|
-    puts "#record[&#39;name&#39;]の説明文の中で「groonga」が含まれる部分"
-    snippet.execute(record["description"]).each do |snippet|
-      puts "---"
-      puts "#snippet..."
-      puts "---"
+    puts “#record[‘name’]の説明文の中で「groonga」が含まれる部分”
+    snippet.execute(record[“description”]).each do |snippet|
+      puts “—”
+      puts “#snippet…”
+      puts “—”
     end
   end</p>
 
@@ -1935,7 +1934,6 @@ <h3 class="signature " id="select-instance_method">
 </code></pre>
 
 
-
   </div>
 </div>
 <div class="tags">
@@ -1995,18 +1993,17 @@ <h3 class="signature " id="select-instance_method">
 下の通り。</p>
 
 <ul>
-<li>Groonga::Operator::OR :=
+  <li>Groonga::Operator::OR :=
 マッチしたレコードを追加。すでにレコードが追加され
 ている場合は何もしない。 =:</li>
-<li>Groonga::Operator::AND :=
+  <li>Groonga::Operator::AND :=
 マッチしたレコードのスコアを増加。マッチしなかった
 レコードを削除。 =:</li>
-<li>Groonga::Operator::AND_NOT :=
+  <li>Groonga::Operator::AND_NOT :=
 マッチしたレコードを削除。 =:</li>
-<li>Groonga::Operator::ADJUST :=
+  <li>Groonga::Operator::ADJUST :=
 マッチしたレコードのスコアを増加。 =:</li>
 </ul>
-
 </div>
 
         </li>
@@ -2133,11 +2130,11 @@ <h3 class="signature " id="select-instance_method">
         <div class='inline'><p>検索条件を指定するのに、 <em>record</em> に対して次のメソッドを使って検索条
 件を指定できます。</p>
 
-<p>@==@ 、 @=~@ 、 @&lt;@ 、 @&lt;=@ 、 @>@ 、 @>=@ 、 @+@ 、 @-@ 、
+<p>@==@ 、 @=~@ 、 @&lt;@ 、 @&lt;=@ 、 @&gt;@ 、 @&gt;=@ 、 @+@ 、 @-@ 、
 @*@ 、 @/@ 、 @%@ 、
-@match(query, :syntax => :query/:script, &amp;block)@
+@match(query, :syntax =&gt; :query/:script, &amp;block)@
 （ <em>query</em> に指定した
-"grn_expr":<a href="http://groonga.org/ja/docs/reference/grn_expr.html">http://groonga.org/ja/docs/reference/grn_expr.html</a>
+“grn_expr”:http://groonga.org/ja/docs/reference/grn_expr.html
 とのマッチ）、
 @similar_search(text)@ （ <em>text</em> との類似文書探索）、
 @term_extract(text)@ （ <em>text</em> 内から <em>record</em> の単語を抽出）</p>
@@ -2179,28 +2176,26 @@ <h3 class="signature " id="select-instance_method">
 指定する。演算子は以下の通り。</p>
 
 <ul>
-<li>なし := [カラム値] == [値]</li>
-<li>@!@ := [カラム値] != [値]</li>
-<li>@&lt;@ := [カラム値] &lt; [値]</li>
-<li>@>@ := [カラム値] > [値]</li>
-<li>@&lt;=@ := [カラム値] &lt;= [値]</li>
-<li>@>=@ := [カラム値] >= [値]</li>
-<li>@@@ := [カラム値]が[値]を含んでいるかどうか</li>
+  <li>なし := [カラム値] == [値]</li>
+  <li>@!@ := [カラム値] != [値]</li>
+  <li>@&lt;@ := [カラム値] &lt; [値]</li>
+  <li>@&gt;@ := [カラム値] &gt; [値]</li>
+  <li>@&lt;=@ := [カラム値] &lt;= [値]</li>
+  <li>@&gt;=@ := [カラム値] &gt;= [値]</li>
+  <li>@@@ := [カラム値]が[値]を含んでいるかどうか</li>
 </ul>
 
-
 <p>例:</p>
 
 <ul>
-<li>@"groonga"@ := <em>column</em> カラムの値が @"groonga"@ のレコードにマッチ</li>
-<li>@"name:daijiro"@ :=
-<em>column</em> カラムが属しているテーブルの @"name"@ カラムの値が
-@"daijiro"@ のレコードにマッチ  =:</li>
-<li>@"description:@@@groonga"@ :=
-<em>column</em> カラムが属しているテーブルの @"description"@ カラムが
-@"groonga"@ を含んでいるレコードにマッチ =:</li>
+  <li>@”groonga”@ := <em>column</em> カラムの値が @”groonga”@ のレコードにマッチ</li>
+  <li>@”name:daijiro”@ :=
+<em>column</em> カラムが属しているテーブルの @”name”@ カラムの値が
+@”daijiro”@ のレコードにマッチ  =:</li>
+  <li>@”description:@@@groonga”@ :=
+<em>column</em> カラムが属しているテーブルの @”description”@ カラムが
+@”groonga”@ を含んでいるレコードにマッチ =:</li>
 </ul>
-
 </div>
 
     </li>
@@ -2245,18 +2240,17 @@ <h3 class="signature " id="select-instance_method">
 下の通り。</p>
 
 <ul>
-<li>Groonga::Operator::OR :=
+  <li>Groonga::Operator::OR :=
 マッチしたレコードを追加。すでにレコードが追加され
 ている場合は何もしない。 =:</li>
-<li>Groonga::Operator::AND :=
+  <li>Groonga::Operator::AND :=
 マッチしたレコードのスコアを増加。マッチしなかった
 レコードを削除。 =:</li>
-<li>Groonga::Operator::AND_NOT :=
+  <li>Groonga::Operator::AND_NOT :=
 マッチしたレコードを削除。 =:</li>
-<li>Groonga::Operator::ADJUST :=
+  <li>Groonga::Operator::ADJUST :=
 マッチしたレコードのスコアを増加。 =:</li>
 </ul>
-
 </div>
 
         </li>
@@ -2441,18 +2435,17 @@ <h3 class="signature " id="select-instance_method">
 下の通り。</p>
 
 <ul>
-<li>Groonga::Operator::OR :=
+  <li>Groonga::Operator::OR :=
 マッチしたレコードを追加。すでにレコードが追加され
 ている場合は何もしない。 =:</li>
-<li>Groonga::Operator::AND :=
+  <li>Groonga::Operator::AND :=
 マッチしたレコードのスコアを増加。マッチしなかった
 レコードを削除。 =:</li>
-<li>Groonga::Operator::AND_NOT :=
+  <li>Groonga::Operator::AND_NOT :=
 マッチしたレコードを削除。 =:</li>
-<li>Groonga::Operator::ADJUST :=
+  <li>Groonga::Operator::ADJUST :=
 マッチしたレコードのスコアを増加。 =:</li>
 </ul>
-
 </div>
 
         </li>
@@ -3137,7 +3130,7 @@ <h3 class="signature " id="with_weight?-instance_method">
 
         &mdash;
         <div class='inline'><p>@true@ if the column is vector and created with
-@:with_weight => true@ flag, @false@ otherwise.</p>
+@:with_weight =&gt; true@ flag, @false@ otherwise.</p>
 </div>
 
     </li>