Skip to content

Commit d827436

Browse files
committed
📝 phpdoc
1 parent 638afcf commit d827436

File tree

2 files changed

+51
-7
lines changed

2 files changed

+51
-7
lines changed

docs/class-LINE.LINEBot.Event.BeaconDetectionEvent.html

Lines changed: 37 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -180,7 +180,7 @@ <h1>Class BeaconDetectionEvent</h1>
180180
<b>Namespace:</b> <a href="namespace-LINE.html">LINE</a>\<a href="namespace-LINE.LINEBot.html">LINEBot</a>\<a href="namespace-LINE.LINEBot.Event.html">Event</a><br>
181181
<b>Package:</b> LINE\LINEBot\Event<br>
182182

183-
<b>Located at</b> <a href="source-class-LINE.LINEBot.Event.BeaconDetectionEvent.html#21-57" title="Go to source code">LINEBot/Event/BeaconDetectionEvent.php</a>
183+
<b>Located at</b> <a href="source-class-LINE.LINEBot.Event.BeaconDetectionEvent.html#21-67" title="Go to source code">LINEBot/Event/BeaconDetectionEvent.php</a>
184184
<br>
185185
</div>
186186

@@ -264,7 +264,7 @@ <h4>Returns</h4>
264264
<td class="attributes"><code>
265265
public
266266

267-
String
267+
string
268268

269269
</code>
270270
</td>
@@ -284,7 +284,41 @@ <h4>Returns</h4>
284284

285285
<h4>Returns</h4>
286286
<div class="list">
287-
String
287+
string
288+
</div>
289+
290+
291+
292+
293+
</div>
294+
</div></td>
295+
</tr>
296+
<tr data-order="getDeviceMessage" id="_getDeviceMessage">
297+
298+
<td class="attributes"><code>
299+
public
300+
301+
string
302+
303+
</code>
304+
</td>
305+
306+
<td class="name"><div>
307+
<a class="anchor" href="#_getDeviceMessage">#</a>
308+
<code><a href="source-class-LINE.LINEBot.Event.BeaconDetectionEvent.html#58-66" title="Go to source code">getDeviceMessage</a>( )</code>
309+
310+
<div class="description short">
311+
<p>Returns device message of the beacon.</p>
312+
</div>
313+
314+
<div class="description detailed hidden">
315+
<p>Returns device message of the beacon.</p>
316+
317+
318+
319+
<h4>Returns</h4>
320+
<div class="list">
321+
string<br>a binary string containing data
288322
</div>
289323

290324

docs/source-class-LINE.LINEBot.Event.BeaconDetectionEvent.html

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -199,7 +199,7 @@ <h3>Exceptions</h3>
199199
</ul>
200200
</div>
201201

202-
<pre class="numbers"><code><span class="l"><a href="#1"> 1: </a></span><span class="l"><a href="#2"> 2: </a></span><span class="l"><a href="#3"> 3: </a></span></span><span class="l"><a href="#4"> 4: </a></span></span><span class="l"><a href="#5"> 5: </a></span></span><span class="l"><a href="#6"> 6: </a></span></span><span class="l"><a href="#7"> 7: </a></span></span><span class="l"><a href="#8"> 8: </a></span></span><span class="l"><a href="#9"> 9: </a></span></span><span class="l"><a href="#10">10: </a></span></span><span class="l"><a href="#11">11: </a></span></span><span class="l"><a href="#12">12: </a></span></span><span class="l"><a href="#13">13: </a></span></span><span class="l"><a href="#14">14: </a></span></span><span class="l"><a href="#15">15: </a></span></span><span class="l"><a href="#16">16: </a></span></span><span class="l"><a href="#17">17: </a></span><span class="l"><a href="#18">18: </a></span><span class="l"><a href="#19">19: </a></span><span class="l"><a href="#20">20: </a></span><span class="l"><a href="#21">21: </a></span></span><span class="l"><a href="#22">22: </a></span></span><span class="l"><a href="#23">23: </a></span></span><span class="l"><a href="#24">24: </a></span></span><span class="l"><a href="#25">25: </a></span><span class="l"><a href="#26">26: </a></span><span class="l"><a href="#27">27: </a></span><span class="l"><a href="#28">28: </a></span></span><span class="l"><a href="#29">29: </a></span></span><span class="l"><a href="#30">30: </a></span></span><span class="l"><a href="#31">31: </a></span></span><span class="l"><a href="#32">32: </a></span><span class="l"><a href="#33">33: </a></span><span class="l"><a href="#34">34: </a></span><span class="l"><a href="#35">35: </a></span><span class="l"><a href="#36">36: </a></span><span class="l"><a href="#37">37: </a></span><span class="l"><a href="#38">38: </a></span></span><span class="l"><a href="#39">39: </a></span></span><span class="l"><a href="#40">40: </a></span></span><span class="l"><a href="#41">41: </a></span></span><span class="l"><a href="#42">42: </a></span><span class="l"><a href="#43">43: </a></span><span class="l"><a href="#44">44: </a></span><span class="l"><a href="#45">45: </a></span><span class="l"><a href="#46">46: </a></span><span class="l"><a href="#47">47: </a></span><span class="l"><a href="#48">48: </a></span></span><span class="l"><a href="#49">49: </a></span></span><span class="l"><a href="#50">50: </a></span></span><span class="l"><a href="#51">51: </a></span></span><span class="l"><a href="#52">52: </a></span><span class="l"><a href="#53">53: </a></span><span class="l"><a href="#54">54: </a></span><span class="l"><a href="#55">55: </a></span><span class="l"><a href="#56">56: </a></span><span class="l"><a href="#57">57: </a></span><span class="l"><a href="#58">58: </a></span></code></pre>
202+
<pre class="numbers"><code><span class="l"><a href="#1"> 1: </a></span><span class="l"><a href="#2"> 2: </a></span><span class="l"><a href="#3"> 3: </a></span></span><span class="l"><a href="#4"> 4: </a></span></span><span class="l"><a href="#5"> 5: </a></span></span><span class="l"><a href="#6"> 6: </a></span></span><span class="l"><a href="#7"> 7: </a></span></span><span class="l"><a href="#8"> 8: </a></span></span><span class="l"><a href="#9"> 9: </a></span></span><span class="l"><a href="#10">10: </a></span></span><span class="l"><a href="#11">11: </a></span></span><span class="l"><a href="#12">12: </a></span></span><span class="l"><a href="#13">13: </a></span></span><span class="l"><a href="#14">14: </a></span></span><span class="l"><a href="#15">15: </a></span></span><span class="l"><a href="#16">16: </a></span></span><span class="l"><a href="#17">17: </a></span><span class="l"><a href="#18">18: </a></span><span class="l"><a href="#19">19: </a></span><span class="l"><a href="#20">20: </a></span><span class="l"><a href="#21">21: </a></span></span><span class="l"><a href="#22">22: </a></span></span><span class="l"><a href="#23">23: </a></span></span><span class="l"><a href="#24">24: </a></span></span><span class="l"><a href="#25">25: </a></span><span class="l"><a href="#26">26: </a></span><span class="l"><a href="#27">27: </a></span><span class="l"><a href="#28">28: </a></span></span><span class="l"><a href="#29">29: </a></span></span><span class="l"><a href="#30">30: </a></span></span><span class="l"><a href="#31">31: </a></span></span><span class="l"><a href="#32">32: </a></span><span class="l"><a href="#33">33: </a></span><span class="l"><a href="#34">34: </a></span><span class="l"><a href="#35">35: </a></span><span class="l"><a href="#36">36: </a></span><span class="l"><a href="#37">37: </a></span><span class="l"><a href="#38">38: </a></span></span><span class="l"><a href="#39">39: </a></span></span><span class="l"><a href="#40">40: </a></span></span><span class="l"><a href="#41">41: </a></span></span><span class="l"><a href="#42">42: </a></span><span class="l"><a href="#43">43: </a></span><span class="l"><a href="#44">44: </a></span><span class="l"><a href="#45">45: </a></span><span class="l"><a href="#46">46: </a></span><span class="l"><a href="#47">47: </a></span><span class="l"><a href="#48">48: </a></span></span><span class="l"><a href="#49">49: </a></span></span><span class="l"><a href="#50">50: </a></span></span><span class="l"><a href="#51">51: </a></span></span><span class="l"><a href="#52">52: </a></span><span class="l"><a href="#53">53: </a></span><span class="l"><a href="#54">54: </a></span><span class="l"><a href="#55">55: </a></span><span class="l"><a href="#56">56: </a></span><span class="l"><a href="#57">57: </a></span><span class="l"><a href="#58">58: </a></span></span><span class="l"><a href="#59">59: </a></span></span><span class="l"><a href="#60">60: </a></span></span><span class="l"><a href="#61">61: </a></span></span><span class="l"><a href="#62">62: </a></span><span class="l"><a href="#63">63: </a></span><span class="l"><a href="#64">64: </a></span><span class="l"><a href="#65">65: </a></span><span class="l"><a href="#66">66: </a></span><span class="l"><a href="#67">67: </a></span><span class="l"><a href="#68">68: </a></span></code></pre>
203203
<pre class="code"><code><span id="1" class="l"><span class="xlang">&lt;?php</span>
204204
</span><span id="2" class="l">
205205
</span><span id="3" class="l"><span class="php-comment">/**
@@ -250,14 +250,24 @@ <h3>Exceptions</h3>
250250
</span><span id="48" class="l"> <span class="php-comment">/**
251251
</span></span><span id="49" class="l"><span class="php-comment"> * Returns type of beacon event.
252252
</span></span><span id="50" class="l"><span class="php-comment"> *
253-
</span></span><span id="51" class="l"><span class="php-comment"> * @return String
253+
</span></span><span id="51" class="l"><span class="php-comment"> * @return string
254254
</span></span><span id="52" class="l"><span class="php-comment"> */</span>
255255
</span><span id="53" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getBeaconEventType()
256256
</span><span id="54" class="l"> {
257257
</span><span id="55" class="l"> <span class="php-keyword1">return</span> <span class="php-var">$this</span>-&gt;event[<span class="php-quote">'beacon'</span>][<span class="php-quote">'type'</span>];
258258
</span><span id="56" class="l"> }
259-
</span><span id="57" class="l">}
260-
</span><span id="58" class="l"></span></code></pre>
259+
</span><span id="57" class="l">
260+
</span><span id="58" class="l"> <span class="php-comment">/**
261+
</span></span><span id="59" class="l"><span class="php-comment"> * Returns device message of the beacon.
262+
</span></span><span id="60" class="l"><span class="php-comment"> *
263+
</span></span><span id="61" class="l"><span class="php-comment"> * @return string a binary string containing data
264+
</span></span><span id="62" class="l"><span class="php-comment"> */</span>
265+
</span><span id="63" class="l"> <span class="php-keyword1">public</span> <span class="php-keyword1">function</span> getDeviceMessage()
266+
</span><span id="64" class="l"> {
267+
</span><span id="65" class="l"> <span class="php-keyword1">return</span> <span class="php-keyword2">pack</span>(<span class="php-quote">'H*'</span>, <span class="php-var">$this</span>-&gt;event[<span class="php-quote">'beacon'</span>][<span class="php-quote">'dm'</span>]);
268+
</span><span id="66" class="l"> }
269+
</span><span id="67" class="l">}
270+
</span><span id="68" class="l"></span></code></pre>
261271

262272
<div id="footer">
263273
line-bot-sdk-php API documentation generated by <a href="http://apigen.org">ApiGen</a>

0 commit comments

Comments
 (0)