Skip to content

Commit 6de1d3a

Browse files
authored
Merge pull request #146 from msgpack/gh-pages-update-20171207
API document update
2 parents b3cae6b + c8ff370 commit 6de1d3a

27 files changed

+619
-185
lines changed

.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -5,3 +5,5 @@ Gemfile*
55
*~
66
/msgpack-ruby
77
/vendor
8+
/.yardoc
9+
/doc

Array.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ <h2>
117117
<li class="public ">
118118
<span class="summary_signature">
119119

120-
<a href="#to_msgpack-instance_method" title="#to_msgpack (instance method)">- (String) <strong>to_msgpack</strong>(io = nil) </a>
120+
<a href="#to_msgpack-instance_method" title="#to_msgpack (instance method)">- (String) <strong>to_msgpack</strong>(packer = nil) </a>
121121

122122

123123

@@ -132,7 +132,7 @@ <h2>
132132

133133

134134
<span class="summary_desc"><div class='inline'>
135-
<p>Same as MessagePack.to_msgpack(self[, io]).</p>
135+
<p>Same as MessagePack.to_msgpack(self[, packer]).</p>
136136
</div></span>
137137

138138
</li>
@@ -150,7 +150,7 @@ <h2>Instance Method Details</h2>
150150
<div class="method_details first">
151151
<h3 class="signature first" id="to_msgpack-instance_method">
152152

153-
- (<tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>) <strong>to_msgpack</strong>(io = nil)
153+
- (<tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>) <strong>to_msgpack</strong>(packer = nil)
154154

155155

156156

@@ -159,7 +159,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
159159
</h3><div class="docstring">
160160
<div class="discussion">
161161

162-
<p>Same as MessagePack.to_msgpack(self[, io]).</p>
162+
<p>Same as MessagePack.to_msgpack(self[, packer]).</p>
163163

164164

165165
</div>
@@ -197,7 +197,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
197197
<td>
198198
<pre class="code"><span class="info file"># File 'doclib/msgpack/core_ext.rb', line 78</span>
199199

200-
<span class='kw'>def</span> <span class='id identifier rubyid_to_msgpack'>to_msgpack</span><span class='lparen'>(</span><span class='id identifier rubyid_io'>io</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
200+
<span class='kw'>def</span> <span class='id identifier rubyid_to_msgpack'>to_msgpack</span><span class='lparen'>(</span><span class='id identifier rubyid_packer'>packer</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
201201
<span class='kw'>end</span></pre>
202202
</td>
203203
</tr>
@@ -209,9 +209,9 @@ <h3 class="signature first" id="to_msgpack-instance_method">
209209
</div>
210210

211211
<div id="footer">
212-
Generated on Thu Oct 29 10:16:06 2015 by
212+
Generated on Thu Dec 7 11:57:39 2017 by
213213
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
214-
0.8.7.6 (ruby-2.2.2).
214+
0.8.7.6 (ruby-2.4.2).
215215
</div>
216216

217217
</body>

Bignum.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ <h2>
119119
<li class="public ">
120120
<span class="summary_signature">
121121

122-
<a href="#to_msgpack-instance_method" title="#to_msgpack (instance method)">- (String) <strong>to_msgpack</strong>(io = nil) </a>
122+
<a href="#to_msgpack-instance_method" title="#to_msgpack (instance method)">- (String) <strong>to_msgpack</strong>(packer = nil) </a>
123123

124124

125125

@@ -134,7 +134,7 @@ <h2>
134134

135135

136136
<span class="summary_desc"><div class='inline'>
137-
<p>Same as MessagePack.to_msgpack(self[, io]).</p>
137+
<p>Same as MessagePack.to_msgpack(self[, packer]).</p>
138138
</div></span>
139139

140140
</li>
@@ -153,7 +153,7 @@ <h2>Instance Method Details</h2>
153153
<div class="method_details first">
154154
<h3 class="signature first" id="to_msgpack-instance_method">
155155

156-
- (<tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>) <strong>to_msgpack</strong>(io = nil)
156+
- (<tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>) <strong>to_msgpack</strong>(packer = nil)
157157

158158

159159

@@ -162,7 +162,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
162162
</h3><div class="docstring">
163163
<div class="discussion">
164164

165-
<p>Same as MessagePack.to_msgpack(self[, io]).</p>
165+
<p>Same as MessagePack.to_msgpack(self[, packer]).</p>
166166

167167

168168
</div>
@@ -200,7 +200,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
200200
<td>
201201
<pre class="code"><span class="info file"># File 'doclib/msgpack/core_ext.rb', line 48</span>
202202

203-
<span class='kw'>def</span> <span class='id identifier rubyid_to_msgpack'>to_msgpack</span><span class='lparen'>(</span><span class='id identifier rubyid_io'>io</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
203+
<span class='kw'>def</span> <span class='id identifier rubyid_to_msgpack'>to_msgpack</span><span class='lparen'>(</span><span class='id identifier rubyid_packer'>packer</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
204204
<span class='kw'>end</span></pre>
205205
</td>
206206
</tr>
@@ -212,9 +212,9 @@ <h3 class="signature first" id="to_msgpack-instance_method">
212212
</div>
213213

214214
<div id="footer">
215-
Generated on Thu Oct 29 10:16:06 2015 by
215+
Generated on Thu Dec 7 11:57:39 2017 by
216216
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
217-
0.8.7.6 (ruby-2.2.2).
217+
0.8.7.6 (ruby-2.4.2).
218218
</div>
219219

220220
</body>

FalseClass.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ <h2>
117117
<li class="public ">
118118
<span class="summary_signature">
119119

120-
<a href="#to_msgpack-instance_method" title="#to_msgpack (instance method)">- (String) <strong>to_msgpack</strong>(io = nil) </a>
120+
<a href="#to_msgpack-instance_method" title="#to_msgpack (instance method)">- (String) <strong>to_msgpack</strong>(packer = nil) </a>
121121

122122

123123

@@ -132,7 +132,7 @@ <h2>
132132

133133

134134
<span class="summary_desc"><div class='inline'>
135-
<p>Same as MessagePack.to_msgpack(self[, io]).</p>
135+
<p>Same as MessagePack.to_msgpack(self[, packer]).</p>
136136
</div></span>
137137

138138
</li>
@@ -150,7 +150,7 @@ <h2>Instance Method Details</h2>
150150
<div class="method_details first">
151151
<h3 class="signature first" id="to_msgpack-instance_method">
152152

153-
- (<tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>) <strong>to_msgpack</strong>(io = nil)
153+
- (<tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>) <strong>to_msgpack</strong>(packer = nil)
154154

155155

156156

@@ -159,7 +159,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
159159
</h3><div class="docstring">
160160
<div class="discussion">
161161

162-
<p>Same as MessagePack.to_msgpack(self[, io]).</p>
162+
<p>Same as MessagePack.to_msgpack(self[, packer]).</p>
163163

164164

165165
</div>
@@ -197,7 +197,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
197197
<td>
198198
<pre class="code"><span class="info file"># File 'doclib/msgpack/core_ext.rb', line 28</span>
199199

200-
<span class='kw'>def</span> <span class='id identifier rubyid_to_msgpack'>to_msgpack</span><span class='lparen'>(</span><span class='id identifier rubyid_io'>io</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
200+
<span class='kw'>def</span> <span class='id identifier rubyid_to_msgpack'>to_msgpack</span><span class='lparen'>(</span><span class='id identifier rubyid_packer'>packer</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
201201
<span class='kw'>end</span></pre>
202202
</td>
203203
</tr>
@@ -209,9 +209,9 @@ <h3 class="signature first" id="to_msgpack-instance_method">
209209
</div>
210210

211211
<div id="footer">
212-
Generated on Thu Oct 29 10:16:06 2015 by
212+
Generated on Thu Dec 7 11:57:39 2017 by
213213
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
214-
0.8.7.6 (ruby-2.2.2).
214+
0.8.7.6 (ruby-2.4.2).
215215
</div>
216216

217217
</body>

Fixnum.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ <h2>
119119
<li class="public ">
120120
<span class="summary_signature">
121121

122-
<a href="#to_msgpack-instance_method" title="#to_msgpack (instance method)">- (String) <strong>to_msgpack</strong>(io = nil) </a>
122+
<a href="#to_msgpack-instance_method" title="#to_msgpack (instance method)">- (String) <strong>to_msgpack</strong>(packer = nil) </a>
123123

124124

125125

@@ -134,7 +134,7 @@ <h2>
134134

135135

136136
<span class="summary_desc"><div class='inline'>
137-
<p>Same as MessagePack.to_msgpack(self[, io]).</p>
137+
<p>Same as MessagePack.to_msgpack(self[, packer]).</p>
138138
</div></span>
139139

140140
</li>
@@ -153,7 +153,7 @@ <h2>Instance Method Details</h2>
153153
<div class="method_details first">
154154
<h3 class="signature first" id="to_msgpack-instance_method">
155155

156-
- (<tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>) <strong>to_msgpack</strong>(io = nil)
156+
- (<tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>) <strong>to_msgpack</strong>(packer = nil)
157157

158158

159159

@@ -162,7 +162,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
162162
</h3><div class="docstring">
163163
<div class="discussion">
164164

165-
<p>Same as MessagePack.to_msgpack(self[, io]).</p>
165+
<p>Same as MessagePack.to_msgpack(self[, packer]).</p>
166166

167167

168168
</div>
@@ -200,7 +200,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
200200
<td>
201201
<pre class="code"><span class="info file"># File 'doclib/msgpack/core_ext.rb', line 38</span>
202202

203-
<span class='kw'>def</span> <span class='id identifier rubyid_to_msgpack'>to_msgpack</span><span class='lparen'>(</span><span class='id identifier rubyid_io'>io</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
203+
<span class='kw'>def</span> <span class='id identifier rubyid_to_msgpack'>to_msgpack</span><span class='lparen'>(</span><span class='id identifier rubyid_packer'>packer</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
204204
<span class='kw'>end</span></pre>
205205
</td>
206206
</tr>
@@ -212,9 +212,9 @@ <h3 class="signature first" id="to_msgpack-instance_method">
212212
</div>
213213

214214
<div id="footer">
215-
Generated on Thu Oct 29 10:16:06 2015 by
215+
Generated on Thu Dec 7 11:57:39 2017 by
216216
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
217-
0.8.7.6 (ruby-2.2.2).
217+
0.8.7.6 (ruby-2.4.2).
218218
</div>
219219

220220
</body>

Float.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -119,7 +119,7 @@ <h2>
119119
<li class="public ">
120120
<span class="summary_signature">
121121

122-
<a href="#to_msgpack-instance_method" title="#to_msgpack (instance method)">- (String) <strong>to_msgpack</strong>(io = nil) </a>
122+
<a href="#to_msgpack-instance_method" title="#to_msgpack (instance method)">- (String) <strong>to_msgpack</strong>(packer = nil) </a>
123123

124124

125125

@@ -134,7 +134,7 @@ <h2>
134134

135135

136136
<span class="summary_desc"><div class='inline'>
137-
<p>Same as MessagePack.to_msgpack(self[, io]).</p>
137+
<p>Same as MessagePack.to_msgpack(self[, packer]).</p>
138138
</div></span>
139139

140140
</li>
@@ -153,7 +153,7 @@ <h2>Instance Method Details</h2>
153153
<div class="method_details first">
154154
<h3 class="signature first" id="to_msgpack-instance_method">
155155

156-
- (<tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>) <strong>to_msgpack</strong>(io = nil)
156+
- (<tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>) <strong>to_msgpack</strong>(packer = nil)
157157

158158

159159

@@ -162,7 +162,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
162162
</h3><div class="docstring">
163163
<div class="discussion">
164164

165-
<p>Same as MessagePack.to_msgpack(self[, io]).</p>
165+
<p>Same as MessagePack.to_msgpack(self[, packer]).</p>
166166

167167

168168
</div>
@@ -200,7 +200,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
200200
<td>
201201
<pre class="code"><span class="info file"># File 'doclib/msgpack/core_ext.rb', line 58</span>
202202

203-
<span class='kw'>def</span> <span class='id identifier rubyid_to_msgpack'>to_msgpack</span><span class='lparen'>(</span><span class='id identifier rubyid_io'>io</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
203+
<span class='kw'>def</span> <span class='id identifier rubyid_to_msgpack'>to_msgpack</span><span class='lparen'>(</span><span class='id identifier rubyid_packer'>packer</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
204204
<span class='kw'>end</span></pre>
205205
</td>
206206
</tr>
@@ -212,9 +212,9 @@ <h3 class="signature first" id="to_msgpack-instance_method">
212212
</div>
213213

214214
<div id="footer">
215-
Generated on Thu Oct 29 10:16:06 2015 by
215+
Generated on Thu Dec 7 11:57:39 2017 by
216216
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
217-
0.8.7.6 (ruby-2.2.2).
217+
0.8.7.6 (ruby-2.4.2).
218218
</div>
219219

220220
</body>

Hash.html

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,7 @@ <h2>
117117
<li class="public ">
118118
<span class="summary_signature">
119119

120-
<a href="#to_msgpack-instance_method" title="#to_msgpack (instance method)">- (String) <strong>to_msgpack</strong>(io = nil) </a>
120+
<a href="#to_msgpack-instance_method" title="#to_msgpack (instance method)">- (String) <strong>to_msgpack</strong>(packer = nil) </a>
121121

122122

123123

@@ -132,7 +132,7 @@ <h2>
132132

133133

134134
<span class="summary_desc"><div class='inline'>
135-
<p>Same as MessagePack.to_msgpack(self[, io]).</p>
135+
<p>Same as MessagePack.to_msgpack(self[, packer]).</p>
136136
</div></span>
137137

138138
</li>
@@ -150,7 +150,7 @@ <h2>Instance Method Details</h2>
150150
<div class="method_details first">
151151
<h3 class="signature first" id="to_msgpack-instance_method">
152152

153-
- (<tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>) <strong>to_msgpack</strong>(io = nil)
153+
- (<tt><span class='object_link'><a href="String.html" title="String (class)">String</a></span></tt>) <strong>to_msgpack</strong>(packer = nil)
154154

155155

156156

@@ -159,7 +159,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
159159
</h3><div class="docstring">
160160
<div class="discussion">
161161

162-
<p>Same as MessagePack.to_msgpack(self[, io]).</p>
162+
<p>Same as MessagePack.to_msgpack(self[, packer]).</p>
163163

164164

165165
</div>
@@ -197,7 +197,7 @@ <h3 class="signature first" id="to_msgpack-instance_method">
197197
<td>
198198
<pre class="code"><span class="info file"># File 'doclib/msgpack/core_ext.rb', line 88</span>
199199

200-
<span class='kw'>def</span> <span class='id identifier rubyid_to_msgpack'>to_msgpack</span><span class='lparen'>(</span><span class='id identifier rubyid_io'>io</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
200+
<span class='kw'>def</span> <span class='id identifier rubyid_to_msgpack'>to_msgpack</span><span class='lparen'>(</span><span class='id identifier rubyid_packer'>packer</span><span class='op'>=</span><span class='kw'>nil</span><span class='rparen'>)</span>
201201
<span class='kw'>end</span></pre>
202202
</td>
203203
</tr>
@@ -209,9 +209,9 @@ <h3 class="signature first" id="to_msgpack-instance_method">
209209
</div>
210210

211211
<div id="footer">
212-
Generated on Thu Oct 29 10:16:06 2015 by
212+
Generated on Thu Dec 7 11:57:39 2017 by
213213
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
214-
0.8.7.6 (ruby-2.2.2).
214+
0.8.7.6 (ruby-2.4.2).
215215
</div>
216216

217217
</body>

MessagePack.html

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -80,7 +80,7 @@
8080

8181
<dt class="r1 last">Defined in:</dt>
8282
<dd class="r1 last">lib/msgpack/version.rb<span class="defines">,<br />
83-
doclib/msgpack.rb,<br /> doclib/msgpack/error.rb,<br /> doclib/msgpack/packer.rb,<br /> doclib/msgpack/buffer.rb,<br /> doclib/msgpack/factory.rb,<br /> doclib/msgpack/unpacker.rb,<br /> doclib/msgpack/extension_value.rb</span>
83+
doclib/msgpack.rb,<br /> doclib/msgpack/error.rb,<br /> doclib/msgpack/buffer.rb,<br /> doclib/msgpack/packer.rb,<br /> doclib/msgpack/factory.rb,<br /> doclib/msgpack/unpacker.rb,<br /> doclib/msgpack/extension_value.rb</span>
8484
</dd>
8585

8686
</dl>
@@ -104,7 +104,7 @@ <h2>Constant Summary</h2>
104104
<dt id="VERSION-constant" class="">VERSION =
105105

106106
</dt>
107-
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>0.7.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
107+
<dd><pre class="code"><span class='tstring'><span class='tstring_beg'>&quot;</span><span class='tstring_content'>1.1.0</span><span class='tstring_end'>&quot;</span></span></pre></dd>
108108

109109
<dt id="DefaultFactory-constant" class="">DefaultFactory =
110110
<div class="docstring">
@@ -952,9 +952,9 @@ <h3 class="signature " id="unpack-class_method">
952952
</div>
953953

954954
<div id="footer">
955-
Generated on Thu Oct 29 10:16:06 2015 by
955+
Generated on Thu Dec 7 11:57:38 2017 by
956956
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
957-
0.8.7.6 (ruby-2.2.2).
957+
0.8.7.6 (ruby-2.4.2).
958958
</div>
959959

960960
</body>

MessagePack/Buffer.html

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1826,9 +1826,9 @@ <h3 class="signature " id="write_to-instance_method">
18261826
</div>
18271827

18281828
<div id="footer">
1829-
Generated on Thu Oct 29 10:16:06 2015 by
1829+
Generated on Thu Dec 7 11:57:38 2017 by
18301830
<a href="http://yardoc.org" title="Yay! A Ruby Documentation Tool" target="_parent">yard</a>
1831-
0.8.7.6 (ruby-2.2.2).
1831+
0.8.7.6 (ruby-2.4.2).
18321832
</div>
18331833

18341834
</body>

0 commit comments

Comments
 (0)