Skip to content

Commit f56f572

Browse files
author
Ralph Desir
committed
Merge pull request #29 from Mav7/master
fixed documentation for mrb_obj_new
2 parents 1fd1b06 + 9f1c2c2 commit f56f572

File tree

1 file changed

+17
-82
lines changed

1 file changed

+17
-82
lines changed

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

Lines changed: 17 additions & 82 deletions
Original file line numberDiff line numberDiff line change
@@ -354,9 +354,7 @@ <h2>
354354

355355

356356

357-
<span class="summary_desc"><div class='inline'>
358-
<p>Initialize a new object instace of c class.</p>
359-
</div></span>
357+
<span class="summary_desc"><div class='inline'></div></span>
360358

361359
</li>
362360

@@ -3684,20 +3682,23 @@ <h3 class="signature " id="mrb_obj_new-function">
36843682

36853683
<p>Initialize a new object instace of c class.</p>
36863684

3687-
<pre class="code ruby"><code class="ruby"><span style="background-color:hsla(300,100%,50%,0.06)"><span style="color:#404">/</span><span style="color:#404">/</span></span> <span style="color:#606">Example</span>:
3685+
<pre class="code ruby"><code class="ruby"><span style="color:#777"># Ruby style</span>
3686+
<span style="color:#080;font-weight:bold">class</span> <span style="color:#B06;font-weight:bold">ExampleClass</span>
3687+
<span style="color:#080;font-weight:bold">end</span>
3688+
3689+
p <span style="color:#036;font-weight:bold">ExampleClass</span> <span style="color:#777"># =&gt; #&lt;ExampleClass:0x9958588&gt;</span>
3690+
<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
36883691
<span style="color:#777">#include &lt;stdio.h&gt;</span>
36893692
<span style="color:#777">#include &lt;mruby.h&gt;</span>
36903693

36913694
void
36923695
mrb_example_gem_init(mrb_state* mrb) {
36933696
struct <span style="color:#036;font-weight:bold">RClass</span> *example_class;
3694-
3695-
mrb_value *argv[<span style="color:#00D">1</span>];
36963697
mrb_value obj;
36973698

3698-
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);* argv[<span style="color:#00D">0</span>] = example_class;
3699-
obj = mrb_obj_new(mrb, mrb-&gt;object_class, <span style="color:#00D">1</span>, argv); <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:#036;font-weight:bold">ExampleClass</span>
3700-
mrb_funcall(mrb, obj, <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">puts</span><span style="color:#710">&quot;</span></span>, <span style="color:#00D">1</span>, example_class);
3699+
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); <span style="color:#777"># =&gt; class ExampleClass; end</span>
3700+
obj = mrb_obj_new(mrb, example_class, <span style="color:#00D">0</span>, <span style="color:#036;font-weight:bold">NULL</span>); <span style="color:#777"># =&gt; ExampleClass.new</span>
3701+
mrb_p(mrb, obj); <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:#036;font-weight:bold">Kernel</span><span style="color:#777">#p</span>
37013702
}</code></pre>
37023703

37033704

@@ -3805,84 +3806,18 @@ <h3 class="signature " id="mrb_class_new_instance-function">
38053806
<div class="docstring">
38063807
<div class="discussion">
38073808

3808-
<p>Initialize a new object instace of c class.</p>
3809-
3810-
<pre class="code ruby"><code class="ruby"><span style="background-color:hsla(300,100%,50%,0.06)"><span style="color:#404">/</span><span style="color:#404">/</span></span> <span style="color:#606">Example</span>:
3811-
<span style="color:#777">#include &lt;stdio.h&gt;</span>
3812-
<span style="color:#777">#include &lt;mruby.h&gt;</span>
3813-
3814-
void
3815-
mrb_example_gem_init(mrb_state* mrb) {
3816-
struct <span style="color:#036;font-weight:bold">RClass</span> *example_class;
3817-
3818-
mrb_value *argv[<span style="color:#00D">1</span>];
3819-
mrb_value obj;
3820-
mrb_value obj_inst;
3821-
3822-
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);*
3823-
argv[<span style="color:#00D">0</span>] = example_class;
3824-
obj = mrb_obj_new(mrb, mrb-&gt;object_class, <span style="color:#00D">1</span>, argv);
3825-
obj_inst = mrb_class_new_instance(mrb, <span style="color:#00D">0</span>, argv, example_class); <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:#777">#&lt;ExampleClass:0x89734f8&gt;</span>
3826-
mrb_funcall(mrb, obj, <span style="background-color:hsla(0,100%,50%,0.05)"><span style="color:#710">&quot;</span><span style="color:#D20">puts</span><span style="color:#710">&quot;</span></span>, <span style="color:#00D">1</span>, obj_inst);
3827-
}</code></pre>
3828-
38293809

38303810
</div>
38313811
</div>
38323812
<div class="tags">
3833-
<p class="tag_title">Parameters:</p>
3834-
<ul class="param">
38353813

3836-
<li>
3837-
3838-
<span class='name'>mrb</span>
3839-
3840-
3841-
<span class='type'></span>
3842-
3843-
3844-
3845-
&mdash;
3846-
<div class='inline'>
3847-
<p>The current mruby state.</p>
3848-
</div>
3849-
3850-
</li>
3851-
3852-
<li>
3853-
3854-
<span class='name'>argc</span>
3855-
3856-
3857-
<span class='type'></span>
3858-
3859-
3860-
3861-
&mdash;
3862-
<div class='inline'>
3863-
<p>Number of arguments in argv</p>
3864-
</div>
3865-
3866-
</li>
3867-
3868-
<li>
3869-
3870-
<span class='name'>c</span>
3871-
3872-
3873-
<span class='type'></span>
3874-
3875-
3876-
3877-
&mdash;
3878-
<div class='inline'>
3879-
<p>Reference to the class of the new object.</p>
3880-
</div>
3881-
3882-
</li>
3883-
3884-
</ul>
38853814

3815+
<p class="tag_title">See Also:</p>
3816+
<ul class="see">
3817+
3818+
<li><span class='object_link'><a href="#mrb_obj_new-function" title="mrb_obj_new (function)">mrb_obj_new</a></span></li>
3819+
3820+
</ul>
38863821

38873822
</div>
38883823
</div>
@@ -5477,7 +5412,7 @@ <h3 class="signature " id="mrb_format-function">
54775412
</div>
54785413

54795414
<div id="footer">
5480-
Generated on Thu Oct 15 19:31:44 2015 by
5415+
Generated on Sat Oct 17 02:56:22 2015 by
54815416
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
54825417
0.8.7.6 in <a href="https://github.com/sagmor/yard-mruby">mruby mode</a> 0.2.0 (ruby-2.2.3).
54835418
</div>

0 commit comments

Comments
 (0)