Skip to content

Commit 9da2919

Browse files
sgr-ksmtsgr-ksmt
committed
updte document.
1 parent 18b2050 commit 9da2919

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

41 files changed

+1443
-462
lines changed

‎docs/Classes/ConfigArrayBridge.html‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
Lobster 3.0.0 Docs
24+
Lobster 3.1.0 Docs
2525
</a>
26-
(92% documented)
26+
(91% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">
@@ -62,7 +62,7 @@
6262
<a class="nav-group-name-link" href="../Config%20Key.html">Config Key</a>
6363
<ul class="nav-group-tasks">
6464
<li class="nav-group-task">
65-
<a class="nav-group-task-link" href="../Classes/ConfigKey.html">ConfigKey</a>
65+
<a class="nav-group-task-link" href="../Config%20Key.html#/s:7Lobster9ConfigKeyC">ConfigKey</a>
6666
</li>
6767
<li class="nav-group-task">
6868
<a class="nav-group-task-link" href="../Config%20Key.html#/s:7Lobster10ConfigKeysC">ConfigKeys</a>
@@ -178,6 +178,17 @@
178178
</li>
179179
</ul>
180180
</li>
181+
<li class="nav-group-name">
182+
<a class="nav-group-name-link" href="../Other%20Classes.html">Other Classes</a>
183+
<ul class="nav-group-tasks">
184+
<li class="nav-group-task">
185+
<a class="nav-group-task-link" href="../Other%20Classes.html#/s:7Lobster16CodableConfigKeyC">CodableConfigKey</a>
186+
</li>
187+
<li class="nav-group-task">
188+
<a class="nav-group-task-link" href="../Other%20Classes.html#/s:7Lobster18DecodableConfigKeyC">DecodableConfigKey</a>
189+
</li>
190+
</ul>
191+
</li>
181192
</ul>
182193
</nav>
183194
<article class="main-content">

‎docs/Classes/ConfigBoolBridge.html‎

Lines changed: 14 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
Lobster 3.0.0 Docs
24+
Lobster 3.1.0 Docs
2525
</a>
26-
(92% documented)
26+
(91% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">
@@ -62,7 +62,7 @@
6262
<a class="nav-group-name-link" href="../Config%20Key.html">Config Key</a>
6363
<ul class="nav-group-tasks">
6464
<li class="nav-group-task">
65-
<a class="nav-group-task-link" href="../Classes/ConfigKey.html">ConfigKey</a>
65+
<a class="nav-group-task-link" href="../Config%20Key.html#/s:7Lobster9ConfigKeyC">ConfigKey</a>
6666
</li>
6767
<li class="nav-group-task">
6868
<a class="nav-group-task-link" href="../Config%20Key.html#/s:7Lobster10ConfigKeysC">ConfigKeys</a>
@@ -178,6 +178,17 @@
178178
</li>
179179
</ul>
180180
</li>
181+
<li class="nav-group-name">
182+
<a class="nav-group-name-link" href="../Other%20Classes.html">Other Classes</a>
183+
<ul class="nav-group-tasks">
184+
<li class="nav-group-task">
185+
<a class="nav-group-task-link" href="../Other%20Classes.html#/s:7Lobster16CodableConfigKeyC">CodableConfigKey</a>
186+
</li>
187+
<li class="nav-group-task">
188+
<a class="nav-group-task-link" href="../Other%20Classes.html#/s:7Lobster18DecodableConfigKeyC">DecodableConfigKey</a>
189+
</li>
190+
</ul>
191+
</li>
181192
</ul>
182193
</nav>
183194
<article class="main-content">

‎docs/Classes/ConfigBridge.html‎

Lines changed: 122 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -21,9 +21,9 @@
2121
<header class="header">
2222
<p class="header-col header-col--primary">
2323
<a class="header-link" href="../index.html">
24-
Lobster 3.0.0 Docs
24+
Lobster 3.1.0 Docs
2525
</a>
26-
(92% documented)
26+
(91% documented)
2727
</p>
2828

2929
<p class="header-col--secondary">
@@ -62,7 +62,7 @@
6262
<a class="nav-group-name-link" href="../Config%20Key.html">Config Key</a>
6363
<ul class="nav-group-tasks">
6464
<li class="nav-group-task">
65-
<a class="nav-group-task-link" href="../Classes/ConfigKey.html">ConfigKey</a>
65+
<a class="nav-group-task-link" href="../Config%20Key.html#/s:7Lobster9ConfigKeyC">ConfigKey</a>
6666
</li>
6767
<li class="nav-group-task">
6868
<a class="nav-group-task-link" href="../Config%20Key.html#/s:7Lobster10ConfigKeysC">ConfigKeys</a>
@@ -178,6 +178,17 @@
178178
</li>
179179
</ul>
180180
</li>
181+
<li class="nav-group-name">
182+
<a class="nav-group-name-link" href="../Other%20Classes.html">Other Classes</a>
183+
<ul class="nav-group-tasks">
184+
<li class="nav-group-task">
185+
<a class="nav-group-task-link" href="../Other%20Classes.html#/s:7Lobster16CodableConfigKeyC">CodableConfigKey</a>
186+
</li>
187+
<li class="nav-group-task">
188+
<a class="nav-group-task-link" href="../Other%20Classes.html#/s:7Lobster18DecodableConfigKeyC">DecodableConfigKey</a>
189+
</li>
190+
</ul>
191+
</li>
181192
</ul>
182193
</nav>
183194
<article class="main-content">
@@ -361,6 +372,114 @@ <h4>Return Value</h4>
361372
</section>
362373
</div>
363374
</li>
375+
<li class="item">
376+
<div>
377+
<code>
378+
<a name="/s:7Lobster12ConfigBridgeC4save3key5value13defaultsStore7encoderySS_xSgAA08DefaultsH0C10Foundation11JSONEncoderCtF"></a>
379+
<a name="//apple_ref/swift/Method/save(key:value:defaultsStore:encoder:)" class="dashAnchor"></a>
380+
<a class="token" href="#/s:7Lobster12ConfigBridgeC4save3key5value13defaultsStore7encoderySS_xSgAA08DefaultsH0C10Foundation11JSONEncoderCtF">save(key:<wbr>value:<wbr>defaultsStore:<wbr>encoder:<wbr>)</a>
381+
</code>
382+
</div>
383+
<div class="height-container">
384+
<div class="pointer-container"></div>
385+
<section class="section">
386+
<div class="pointer"></div>
387+
<div class="abstract">
388+
<p>Saves a value to DefaultsStore.</p>
389+
<div class="aside aside-note">
390+
<p class="aside-title">Note</p>
391+
If you create a bridge class by inheriting <code>ConfigBridge&lt;T&gt;</code>, You need to override this function absolutely.
392+
393+
</div>
394+
395+
</div>
396+
<div class="declaration">
397+
<h4>Declaration</h4>
398+
<div class="language">
399+
<p class="aside-title">Swift</p>
400+
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">save</span><span class="p">(</span><span class="nv">key</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">value</span><span class="p">:</span> <span class="kt">T</span><span class="p">?,</span> <span class="n">defaultsStore</span><span class="p">:</span> <span class="kt"><a href="../Classes/DefaultsStore.html">DefaultsStore</a></span><span class="p">,</span> <span class="nv">encoder</span><span class="p">:</span> <span class="kt">JSONEncoder</span><span class="p">)</span></code></pre>
401+
402+
</div>
403+
</div>
404+
</section>
405+
</div>
406+
</li>
407+
<li class="item">
408+
<div>
409+
<code>
410+
<a name="/s:7Lobster12ConfigBridgeC3get3key06remoteB07decoderxSgSS_So09FIRRemoteB0C10Foundation11JSONDecoderCtF"></a>
411+
<a name="//apple_ref/swift/Method/get(key:remoteConfig:decoder:)" class="dashAnchor"></a>
412+
<a class="token" href="#/s:7Lobster12ConfigBridgeC3get3key06remoteB07decoderxSgSS_So09FIRRemoteB0C10Foundation11JSONDecoderCtF">get(key:<wbr>remoteConfig:<wbr>decoder:<wbr>)</a>
413+
</code>
414+
</div>
415+
<div class="height-container">
416+
<div class="pointer-container"></div>
417+
<section class="section">
418+
<div class="pointer"></div>
419+
<div class="abstract">
420+
<p>Get a value from RemoteConfig</p>
421+
422+
<p>If a value matched a key doesn&rsquo;t exist in RemoteConfig , this function will return <code>nil</code></p>
423+
<div class="aside aside-note">
424+
<p class="aside-title">Note</p>
425+
<p>If you create a bridge class by inheriting <code>ConfigBridge&lt;T&gt;</code>, You need to override this function absolutely.</p>
426+
427+
</div>
428+
429+
</div>
430+
<div class="declaration">
431+
<h4>Declaration</h4>
432+
<div class="language">
433+
<p class="aside-title">Swift</p>
434+
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">get</span><span class="p">(</span><span class="nv">key</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="nv">remoteConfig</span><span class="p">:</span> <span class="kt">RemoteConfig</span><span class="p">,</span> <span class="nv">decoder</span><span class="p">:</span> <span class="kt">JSONDecoder</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">T</span><span class="p">?</span></code></pre>
435+
436+
</div>
437+
</div>
438+
<div>
439+
<h4>Return Value</h4>
440+
<p>A value of type of T?</p>
441+
</div>
442+
</section>
443+
</div>
444+
</li>
445+
<li class="item">
446+
<div>
447+
<code>
448+
<a name="/s:7Lobster12ConfigBridgeC3get3key13defaultsStore7decoderxSgSS_AA08DefaultsG0C10Foundation11JSONDecoderCtF"></a>
449+
<a name="//apple_ref/swift/Method/get(key:defaultsStore:decoder:)" class="dashAnchor"></a>
450+
<a class="token" href="#/s:7Lobster12ConfigBridgeC3get3key13defaultsStore7decoderxSgSS_AA08DefaultsG0C10Foundation11JSONDecoderCtF">get(key:<wbr>defaultsStore:<wbr>decoder:<wbr>)</a>
451+
</code>
452+
</div>
453+
<div class="height-container">
454+
<div class="pointer-container"></div>
455+
<section class="section">
456+
<div class="pointer"></div>
457+
<div class="abstract">
458+
<p>Get a value from DefaultsStore</p>
459+
460+
<p>If a value matched a key doesn&rsquo;t exist in DefaultsStore, this function will return <code>nil</code></p>
461+
<div class="aside aside-note">
462+
<p class="aside-title">Note</p>
463+
<p>If you create a bridge class by inheriting <code>ConfigBridge&lt;T&gt;</code>, You need to override this function absolutely.</p>
464+
465+
</div>
466+
467+
</div>
468+
<div class="declaration">
469+
<h4>Declaration</h4>
470+
<div class="language">
471+
<p class="aside-title">Swift</p>
472+
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">func</span> <span class="nf">get</span><span class="p">(</span><span class="nv">key</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span> <span class="n">defaultsStore</span><span class="p">:</span> <span class="kt"><a href="../Classes/DefaultsStore.html">DefaultsStore</a></span><span class="p">,</span> <span class="nv">decoder</span><span class="p">:</span> <span class="kt">JSONDecoder</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">T</span><span class="p">?</span></code></pre>
473+
474+
</div>
475+
</div>
476+
<div>
477+
<h4>Return Value</h4>
478+
<p>A value of type of T?</p>
479+
</div>
480+
</section>
481+
</div>
482+
</li>
364483
</ul>
365484
</div>
366485
</div>

0 commit comments

Comments
 (0)