Navigation Menu

Skip to content

Commit

Permalink
Update Rroonga documents
Browse files Browse the repository at this point in the history
  • Loading branch information
@kou
kou committed Oct 7, 2015
1 parent 015aa29 commit 766ccf0
Show file tree
Hide file tree
Showing 197 changed files with 2,117 additions and 1,743 deletions.
2 changes: 1 addition & 1 deletion rroonga/en/Groonga.html
View file
Expand Up @@ -111,7 +111,7 @@

<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/logger.rb,<br /> lib/groonga/schema.rb,<br /> lib/groonga/record.rb,<br /> lib/groonga/column.rb,<br /> lib/groonga/dumper.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/statistic-measurer.rb,<br /> lib/groonga/database-inspector.rb,<br /> lib/groonga/expression-builder-19.rb,<br /> lib/groonga/context/command-executor.rb,<br /> ext/groonga/rb-groonga.c</span>
</dd>

</dl>
Expand Down
146 changes: 146 additions & 0 deletions rroonga/en/Groonga/Context.html
View file
Expand Up @@ -627,6 +627,29 @@ <h2>
<span class="summary_desc"><div class='inline'><p><em>path</em> にある既存のデータベースを開く。ブロックを指定した場 合はブロックに開いたデータベースを渡し、ブロックを抜けると きに閉じる。.</p>
</div></span>

</li>


<li class="public ">
<span class="summary_signature">

<a href="#opened%3F-instance_method" title="#opened? (instance method)">- (Boolean) <strong>opened?</strong>(id) </a>



</span>









<span class="summary_desc"><div class='inline'><p>Checks whether object with the ID is opened or not.</p>
</div></span>

</li>


Expand Down Expand Up @@ -2857,6 +2880,129 @@ <h3 class="signature " id="open_database-instance_method">
</td>
</tr>
</table>
</div>

<div class="method_details ">
<h3 class="signature " id="opened?-instance_method">

- (<tt>Boolean</tt>) <strong>opened?</strong>(id)





</h3><div class="docstring">
<div class="discussion">
<p>Checks whether object with the ID is opened or not.</p>


</div>
</div>
<div class="tags">

<div class="docstring">
<div class="discussion">
<p>Returns <code>true</code> if object with the <code>id</code> is opened,
<code>false</code> otherwise.</p>


</div>
</div>
<div class="tags">
<p class="tag_title">Parameters:</p>
<ul class="param">

<li>

<span class='name'>id</span>


<span class='type'>(<tt>Integer</tt>)</span>



&mdash;
<div class='inline'><p>The ID to be checked</p>
</div>

</li>

</ul>

<p class="tag_title">Returns:</p>
<ul class="return">

<li>


<span class='type'>(<tt>Boolean</tt>)</span>



&mdash;
<div class='inline'><p><code>true</code> if object with the <code>id</code> is opened,
<code>false</code> otherwise.</p>
</div>

</li>

</ul>

</div>

<p class="tag_title">Returns:</p>
<ul class="return">

<li>


<span class='type'>(<tt>Boolean</tt>)</span>



</li>

</ul>

</div><table class="source_code">
<tr>
<td>
<pre class="lines">


954
955
956
957
958
959
960
961
962
963
964
965
966</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'ext/groonga/rb-grn-context.c', line 954</span>

static VALUE
rb_grn_context_is_opened (VALUE self, VALUE rb_id)
{
grn_ctx *context;
grn_id id;
grn_bool is_opened;

context = SELF(self);
id = NUM2UINT(rb_id);
is_opened = grn_ctx_is_opened(context, id);

return CBOOL2RVAL(is_opened);
}</pre>
</td>
</tr>
</table>
</div>

<div class="method_details ">
Expand Down
14 changes: 12 additions & 2 deletions rroonga/en/Groonga/DoubleArrayTrieCursor.html
View file
Expand Up @@ -124,7 +124,7 @@


<dt class="r2">Includes:</dt>
<dd class="r2">TableCursorKeySupport</dd>
<dd class="r2"><span class='object_link'><a href="TableCursor/KeySupport.html" title="Groonga::TableCursor::KeySupport (module)">TableCursor::KeySupport</a></span></dd>



Expand Down Expand Up @@ -165,9 +165,19 @@ <h2>Overview</h2><div class="docstring">




<h2>Method Summary</h2>

<h3 class="inherited">Methods included from <span class='object_link'><a href="TableCursor/KeySupport.html" title="Groonga::TableCursor::KeySupport (module)">TableCursor::KeySupport</a></span></h3>
<p class="inherited"><span class='object_link'><a href="TableCursor/KeySupport.html#key-instance_method" title="Groonga::TableCursor::KeySupport#key (method)">#key</a></span></p>









<h3 class="inherited">Methods inherited from <span class='object_link'><a href="TableCursor.html" title="Groonga::TableCursor (class)">TableCursor</a></span></h3>
<p class="inherited"><span class='object_link'><a href="TableCursor.html#close-instance_method" title="Groonga::TableCursor#close (method)">#close</a></span>, <span class='object_link'><a href="TableCursor.html#closed%3F-instance_method" title="Groonga::TableCursor#closed? (method)">#closed?</a></span>, <span class='object_link'><a href="TableCursor.html#delete-instance_method" title="Groonga::TableCursor#delete (method)">#delete</a></span>, <span class='object_link'><a href="TableCursor.html#each-instance_method" title="Groonga::TableCursor#each (method)">#each</a></span>, <span class='object_link'><a href="TableCursor.html#next-instance_method" title="Groonga::TableCursor#next (method)">#next</a></span>, <span class='object_link'><a href="TableCursor.html#value-instance_method" title="Groonga::TableCursor#value (method)">#value</a></span>, <span class='object_link'><a href="TableCursor.html#value%3D-instance_method" title="Groonga::TableCursor#value= (method)">#value=</a></span></p>

Expand Down
2 changes: 1 addition & 1 deletion rroonga/en/Groonga/LZOError.html
View file
Expand Up @@ -21,7 +21,7 @@
<script type="text/javascript" charset="utf-8">
hasFrames = window.top.frames.main ? true : false;
relpath = '../';
framesUrl = "../frames.html#!Groonga/LZOError.html";
framesUrl = "../frames.html#!" + escape(window.location.href);
</script>


Expand Down
64 changes: 32 additions & 32 deletions rroonga/en/Groonga/PatriciaTrie.html
View file
Expand Up @@ -1045,6 +1045,8 @@ <h3 class="signature first" id="create-class_method">
<pre class="lines">


162
163
164
165
166
Expand Down Expand Up @@ -1131,12 +1133,10 @@ <h3 class="signature first" id="create-class_method">
247
248
249
250
251
252</pre>
250</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'ext/groonga/rb-grn-patricia-trie.c', line 164</span>
<pre class="code"><span class="info file"># File 'ext/groonga/rb-grn-patricia-trie.c', line 162</span>

static VALUE
rb_grn_patricia_trie_s_create (int argc, VALUE *argv, VALUE klass)
Expand Down Expand Up @@ -1528,6 +1528,8 @@ <h3 class="signature first" id="open_near_cursor-instance_method">
<pre class="lines">


841
842
843
844
845
Expand All @@ -1541,12 +1543,10 @@ <h3 class="signature first" id="open_near_cursor-instance_method">
853
854
855
856
857
858</pre>
856</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'ext/groonga/rb-grn-patricia-trie.c', line 843</span>
<pre class="code"><span class="info file"># File 'ext/groonga/rb-grn-patricia-trie.c', line 841</span>

static VALUE
rb_grn_patricia_trie_open_near_cursor (int argc, VALUE *argv, VALUE self)
Expand Down Expand Up @@ -1945,6 +1945,8 @@ <h3 class="signature " id="open_prefix_cursor-instance_method">
<pre class="lines">


628
629
630
631
632
Expand All @@ -1958,12 +1960,10 @@ <h3 class="signature " id="open_prefix_cursor-instance_method">
640
641
642
643
644
645</pre>
643</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'ext/groonga/rb-grn-patricia-trie.c', line 630</span>
<pre class="code"><span class="info file"># File 'ext/groonga/rb-grn-patricia-trie.c', line 628</span>

static VALUE
rb_grn_patricia_trie_open_prefix_cursor (int argc, VALUE *argv, VALUE self)
Expand Down Expand Up @@ -2299,6 +2299,8 @@ <h3 class="signature " id="open_rk_cursor-instance_method">
<pre class="lines">


740
741
742
743
744
Expand All @@ -2312,12 +2314,10 @@ <h3 class="signature " id="open_rk_cursor-instance_method">
752
753
754
755
756
757</pre>
755</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'ext/groonga/rb-grn-patricia-trie.c', line 742</span>
<pre class="code"><span class="info file"># File 'ext/groonga/rb-grn-patricia-trie.c', line 740</span>

static VALUE
rb_grn_patricia_trie_open_rk_cursor (int argc, VALUE *argv, VALUE self)
Expand Down Expand Up @@ -2392,6 +2392,8 @@ <h3 class="signature " id="prefix_search-instance_method">
<pre class="lines">


452
453
454
455
456
Expand All @@ -2417,12 +2419,10 @@ <h3 class="signature " id="prefix_search-instance_method">
476
477
478
479
480
481</pre>
479</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'ext/groonga/rb-grn-patricia-trie.c', line 454</span>
<pre class="code"><span class="info file"># File 'ext/groonga/rb-grn-patricia-trie.c', line 452</span>

static VALUE
rb_grn_patricia_trie_prefix_search (VALUE self, VALUE rb_prefix)
Expand Down Expand Up @@ -2498,6 +2498,8 @@ <h3 class="signature " id="register_key_with_sis?-instance_method">
<pre class="lines">


487
488
489
490
491
Expand All @@ -2506,12 +2508,10 @@ <h3 class="signature " id="register_key_with_sis?-instance_method">
494
495
496
497
498
499</pre>
497</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'ext/groonga/rb-grn-patricia-trie.c', line 489</span>
<pre class="code"><span class="info file"># File 'ext/groonga/rb-grn-patricia-trie.c', line 487</span>

static VALUE
rb_grn_patricia_trie_register_key_with_sis_p (VALUE self)
Expand Down Expand Up @@ -2717,6 +2717,8 @@ <h3 class="signature " id="scan-instance_method">
<pre class="lines">


383
384
385
386
387
Expand Down Expand Up @@ -2774,12 +2776,10 @@ <h3 class="signature " id="scan-instance_method">
439
440
441
442
443
444</pre>
442</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'ext/groonga/rb-grn-patricia-trie.c', line 385</span>
<pre class="code"><span class="info file"># File 'ext/groonga/rb-grn-patricia-trie.c', line 383</span>

static VALUE
rb_grn_patricia_trie_scan (VALUE self, VALUE rb_string)
Expand Down Expand Up @@ -2996,6 +2996,8 @@ <h3 class="signature " id="search-instance_method">
<pre class="lines">


294
295
296
297
298
Expand Down Expand Up @@ -3042,12 +3044,10 @@ <h3 class="signature " id="search-instance_method">
339
340
341
342
343
344</pre>
342</pre>
</td>
<td>
<pre class="code"><span class="info file"># File 'ext/groonga/rb-grn-patricia-trie.c', line 296</span>
<pre class="code"><span class="info file"># File 'ext/groonga/rb-grn-patricia-trie.c', line 294</span>

static VALUE
rb_grn_patricia_trie_search (int argc, VALUE *argv, VALUE self)
Expand Down

0 comments on commit 766ccf0

Please sign in to comment.