Skip to content

Commit 1659856

Browse files
matzmatz
committed
Merge pull request #33 from Mav7/master
Added documentation for mrb_obj_dup, and mrb_obj_respond_to
2 parents cd2bb7a + d732259 commit 1659856

File tree

1 file changed

+194
-5
lines changed

1 file changed

+194
-5
lines changed

‎docs/api/headers/mruby.h.html‎

Lines changed: 194 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -427,7 +427,7 @@ <h2>
427427

428428

429429
<span class="summary_desc"><div class='inline'>
430-
<p>Creates a new module, Module.</p>
430+
<p>Returns an mrb_bool.</p>
431431
</div></span>
432432

433433
</li>
@@ -538,7 +538,9 @@ <h2>
538538

539539

540540

541-
<span class="summary_desc"><div class='inline'></div></span>
541+
<span class="summary_desc"><div class='inline'>
542+
<p>Duplicate an object.</p>
543+
</div></span>
542544

543545
</li>
544546

@@ -572,7 +574,9 @@ <h2>
572574

573575

574576

575-
<span class="summary_desc"><div class='inline'></div></span>
577+
<span class="summary_desc"><div class='inline'>
578+
<p>Returns true if obj responds to the given method.</p>
579+
</div></span>
576580

577581
</li>
578582

@@ -4027,7 +4031,8 @@ <h3 class="signature " id="mrb_class_defined-function">
40274031
<div class="docstring">
40284032
<div class="discussion">
40294033

4030-
<p>Creates a new module, Module.</p>
4034+
<p>Returns an mrb_bool. True if class was defined, and false if the class was
4035+
not defined.</p>
40314036

40324037
<p>Example:</p>
40334038

@@ -4461,7 +4466,77 @@ <h3 class="signature " id="mrb_obj_dup-function">
44614466

44624467

44634468
</h3>
4469+
<div class="docstring">
4470+
<div class="discussion">
4471+
4472+
<p>Duplicate an object.</p>
44644473

4474+
<p>Equivalent to:</p>
4475+
4476+
<pre class="code ruby"><code class="ruby"><span style="color:#036;font-weight:bold">Object</span><span style="color:#777">#dup</span>
4477+
</code></pre>
4478+
4479+
4480+
</div>
4481+
</div>
4482+
<div class="tags">
4483+
<p class="tag_title">Parameters:</p>
4484+
<ul class="param">
4485+
4486+
<li>
4487+
4488+
<span class='name'>mrb</span>
4489+
4490+
4491+
<span class='type'></span>
4492+
4493+
4494+
4495+
&mdash;
4496+
<div class='inline'>
4497+
<p>The current mruby state.</p>
4498+
</div>
4499+
4500+
</li>
4501+
4502+
<li>
4503+
4504+
<span class='name'>obj</span>
4505+
4506+
4507+
<span class='type'></span>
4508+
4509+
4510+
4511+
&mdash;
4512+
<div class='inline'>
4513+
<p>Object to be duplicate.</p>
4514+
</div>
4515+
4516+
</li>
4517+
4518+
</ul>
4519+
4520+
<p class="tag_title">Returns:</p>
4521+
<ul class="return">
4522+
4523+
<li>
4524+
4525+
4526+
<span class='type'></span>
4527+
4528+
4529+
4530+
4531+
<div class='inline'>
4532+
<p>The newly duplicated object.</p>
4533+
</div>
4534+
4535+
</li>
4536+
4537+
</ul>
4538+
4539+
</div>
44654540
</div>
44664541

44674542

@@ -4481,7 +4556,121 @@ <h3 class="signature " id="mrb_obj_respond_to-function">
44814556

44824557

44834558
</h3>
4559+
<div class="docstring">
4560+
<div class="discussion">
4561+
4562+
<p>Returns true if obj responds to the given method. If the method was defined
4563+
for that class it returns true, it returns false otherwise.</p>
4564+
4565+
<p>Example:</p>
4566+
4567+
<pre class="code ruby"><code class="ruby"><span style="color:#777"># Ruby style</span>
4568+
<span style="color:#080;font-weight:bold">class</span> <span style="color:#B06;font-weight:bold">ExampleClass</span>
4569+
<span style="color:#080;font-weight:bold">def</span> <span style="color:#06B;font-weight:bold">example_method</span>
4570+
<span style="color:#080;font-weight:bold">end</span>
4571+
<span style="color:#080;font-weight:bold">end</span>
4572+
4573+
<span style="color:#036;font-weight:bold">ExampleClass</span>.new.respond_to?(<span style="color:#A60">:example_method</span>) <span style="color:#777"># =&gt; true</span>
4574+
4575+
<span style="background-color:hsla(300,100%,50%,0.06)"><span style="color:#404">/</span><span style="color:#404">/</span></span> <span style="color:#036;font-weight:bold">C</span> style
4576+
void
4577+
mrb_example_gem_init(mrb_state* mrb) {
4578+
struct <span style="color:#036;font-weight:bold">RClass</span> *example_class;
4579+
mrb_sym mid;
4580+
mrb_bool obj_resp;
4581+
4582+
example_class = mrb_define_class(mrb, <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">ExampleClass</span><span style="color:#710">&quot;</span></span>, mrb-&gt;object_class);
4583+
mrb_define_method(mrb, example_class, <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">example_method</span><span style="color:#710">&quot;</span></span>, exampleMethod, MRB_ARGS_NONE());
4584+
mid = mrb_intern_str(mrb, mrb_str_new_cstr(mrb, <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">example_method</span><span style="color:#710">&quot;</span></span> ));
4585+
obj_resp = mrb_obj_respond_to(mrb, example_class, mid); <span style="background-color:hsla(300,100%,50%,0.06)"><span style="color:#404">/</span><span style="color:#404">/</span></span> =&gt; <span style="color:#00D">1</span>(<span style="color:#069">true</span> <span style="color:#080;font-weight:bold">in</span> <span style="color:#036;font-weight:bold">Ruby</span> world)
4586+
4587+
<span style="background-color:hsla(300,100%,50%,0.06)"><span style="color:#404">/</span><span style="color:#404">/</span></span> <span style="color:#036;font-weight:bold">If</span> mrb_obj_respond_to returns <span style="color:#00D">1</span> <span style="color:#080;font-weight:bold">then</span> puts <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">True</span><span style="color:#710">&quot;</span></span>
4588+
<span style="background-color:hsla(300,100%,50%,0.06)"><span style="color:#404">/</span><span style="color:#404">/</span></span> <span style="color:#036;font-weight:bold">If</span> mrb_obj_respond_to returns <span style="color:#00D">0</span> <span style="color:#080;font-weight:bold">then</span> puts <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">False</span><span style="color:#710">&quot;</span></span>
4589+
<span style="color:#080;font-weight:bold">if</span> (obj_resp == <span style="color:#00D">1</span>) {
4590+
puts(<span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">True</span><span style="color:#710">&quot;</span></span>);
4591+
}
4592+
<span style="color:#080;font-weight:bold">else</span> <span style="color:#080;font-weight:bold">if</span> (obj_resp == <span style="color:#00D">0</span>) {
4593+
puts(<span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">False</span><span style="color:#710">&quot;</span></span>);
4594+
}
4595+
}</code></pre>
44844596

4597+
4598+
</div>
4599+
</div>
4600+
<div class="tags">
4601+
<p class="tag_title">Parameters:</p>
4602+
<ul class="param">
4603+
4604+
<li>
4605+
4606+
<span class='name'>mrb</span>
4607+
4608+
4609+
<span class='type'></span>
4610+
4611+
4612+
4613+
&mdash;
4614+
<div class='inline'>
4615+
<p>The current mruby state.</p>
4616+
</div>
4617+
4618+
</li>
4619+
4620+
<li>
4621+
4622+
<span class='name'>c</span>
4623+
4624+
4625+
<span class='type'></span>
4626+
4627+
4628+
4629+
&mdash;
4630+
<div class='inline'>
4631+
<p>A reference to a class.</p>
4632+
</div>
4633+
4634+
</li>
4635+
4636+
<li>
4637+
4638+
<span class='name'>mid</span>
4639+
4640+
4641+
<span class='type'></span>
4642+
4643+
4644+
4645+
&mdash;
4646+
<div class='inline'>
4647+
<p>A symbol referencing a method id.</p>
4648+
</div>
4649+
4650+
</li>
4651+
4652+
</ul>
4653+
4654+
<p class="tag_title">Returns:</p>
4655+
<ul class="return">
4656+
4657+
<li>
4658+
4659+
4660+
<span class='type'></span>
4661+
4662+
4663+
4664+
4665+
<div class='inline'>
4666+
<p>mrb_bool A boolean value.</p>
4667+
</div>
4668+
4669+
</li>
4670+
4671+
</ul>
4672+
4673+
</div>
44854674
</div>
44864675

44874676

@@ -5954,7 +6143,7 @@ <h3 class="signature " id="mrb_format-function">
59546143
</div>
59556144

59566145
<div id="footer">
5957-
Generated on Mon Nov 9 12:13:06 2015 by
6146+
Generated on Sat Nov 14 23:38:25 2015 by
59586147
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
59596148
0.8.7.6 in <a href="https://github.com/sagmor/yard-mruby">mruby mode</a> 0.2.0 (ruby-2.2.3).
59606149
</div>

0 commit comments

Comments
 (0)