Skip to content

Commit

Permalink
Update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@zihejia
zihejia committed Feb 19, 2022
1 parent 0f1f2e9 commit b1ff3fd
Show file tree
Hide file tree
Showing 57 changed files with 128 additions and 128 deletions.
4 changes: 2 additions & 2 deletions docs/Classes.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Classes Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
<p><a href="index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="search.json">
Expand Down Expand Up @@ -253,7 +253,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Classes/Group.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Group Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
<p><a href="../index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -491,7 +491,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
24 changes: 12 additions & 12 deletions docs/Classes/Mixpanel.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Mixpanel Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
<p><a href="../index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -144,9 +144,9 @@ <h1>Mixpanel</h1>
<li class="item">
<div>
<code>
<a name="/s:8MixpanelAAC10initialize5token13flushInterval12instanceName23optOutTrackingByDefault20trackAutomaticEvents19useUniqueDistinctId15superPropertiesAA0A8InstanceCSS_SdSSS2bSgSbSDySSAA0A4Type_pGSgtFZ"></a>
<a name="/s:8MixpanelAAC10initialize5token13flushInterval12instanceName23optOutTrackingByDefault20trackAutomaticEvents19useUniqueDistinctId15superPropertiesAA0A8InstanceCSS_SdSSSgS2bSgSbSDySSAA0A4Type_pGSgtFZ"></a>
<a name="//apple_ref/swift/Method/initialize(token:flushInterval:instanceName:optOutTrackingByDefault:trackAutomaticEvents:useUniqueDistinctId:superProperties:)" class="dashAnchor"></a>
<a class="token" href="#/s:8MixpanelAAC10initialize5token13flushInterval12instanceName23optOutTrackingByDefault20trackAutomaticEvents19useUniqueDistinctId15superPropertiesAA0A8InstanceCSS_SdSSS2bSgSbSDySSAA0A4Type_pGSgtFZ">initialize(token:<wbr>flushInterval:<wbr>instanceName:<wbr>optOutTrackingByDefault:<wbr>trackAutomaticEvents:<wbr>useUniqueDistinctId:<wbr>superProperties:<wbr>)</a>
<a class="token" href="#/s:8MixpanelAAC10initialize5token13flushInterval12instanceName23optOutTrackingByDefault20trackAutomaticEvents19useUniqueDistinctId15superPropertiesAA0A8InstanceCSS_SdSSSgS2bSgSbSDySSAA0A4Type_pGSgtFZ">initialize(token:<wbr>flushInterval:<wbr>instanceName:<wbr>optOutTrackingByDefault:<wbr>trackAutomaticEvents:<wbr>useUniqueDistinctId:<wbr>superProperties:<wbr>)</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -174,7 +174,7 @@ <h4>Declaration</h4>
<pre class="highlight swift"><code><span class="kd">@discardableResult</span>
<span class="kd">open</span> <span class="kd">class</span> <span class="kd">func</span> <span class="nf">initialize</span><span class="p">(</span><span class="n">token</span> <span class="nv">apiToken</span><span class="p">:</span> <span class="kt">String</span><span class="p">,</span>
<span class="nv">flushInterval</span><span class="p">:</span> <span class="kt">Double</span> <span class="o">=</span> <span class="mi">60</span><span class="p">,</span>
<span class="nv">instanceName</span><span class="p">:</span> <span class="kt">String</span> <span class="o">=</span> <span class="kt">UUID</span><span class="p">()</span><span class="o">.</span><span class="n">uuidString</span><span class="p">,</span>
<span class="nv">instanceName</span><span class="p">:</span> <span class="kt">String</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
<span class="nv">optOutTrackingByDefault</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">,</span>
<span class="nv">trackAutomaticEvents</span><span class="p">:</span> <span class="kt">Bool</span><span class="p">?</span> <span class="o">=</span> <span class="kc">nil</span><span class="p">,</span>
<span class="nv">useUniqueDistinctId</span><span class="p">:</span> <span class="kt">Bool</span> <span class="o">=</span> <span class="kc">false</span><span class="p">,</span>
Expand Down Expand Up @@ -218,7 +218,7 @@ <h4>Parameters</h4>
</td>
<td>
<div>
<p>Optional. The name you want to call this instance</p>
<p>Optional. The name you want to call this instance, must be unique 1:1 for each instance&rsquo;s project token. Defaults to project token.</p>
</div>
</td>
</tr>
Expand Down Expand Up @@ -249,24 +249,24 @@ <h4>Parameters</h4>
<tr>
<td>
<code>
<em>superProperties</em>
<em>useUniqueDistinctId</em>
</code>
</td>
<td>
<div>
<p>Optional. Super properties dictionary to register during initialization</p>
<p>Optional. whether or not to use the unique device identifier as the distinct_id</p>
</div>
</td>
</tr>
<tr>
<td>
<code>
<em>useUniqueDistinctId</em>
<em>superProperties</em>
</code>
</td>
<td>
<div>
<p>Optional. whether or not to use the unique device identifier as the distinct_id</p>
<p>Optional. Super properties dictionary to register during initialization</p>
</div>
</td>
</tr>
Expand All @@ -285,8 +285,8 @@ <h4>Return Value</h4>
<div>
<code>
<a name="/"></a>
<a name="//apple_ref/swift/Method/initialize(token:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:)" class="dashAnchor"></a>
<a class="token" href="#/">initialize(token:<wbr>flushInterval:<wbr>instanceName:<wbr>optOutTrackingByDefault:<wbr>useUniqueDistinctId:<wbr>)</a>
<a name="//apple_ref/swift/Method/initialize(token:flushInterval:instanceName:optOutTrackingByDefault:useUniqueDistinctId:superProperties:)" class="dashAnchor"></a>
<a class="token" href="#/">initialize(token:<wbr>flushInterval:<wbr>instanceName:<wbr>optOutTrackingByDefault:<wbr>useUniqueDistinctId:<wbr>superProperties:<wbr>)</a>
</code>
</div>
<div class="height-container">
Expand Down Expand Up @@ -490,7 +490,7 @@ <h4>Parameters</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Classes/MixpanelInstance.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="MixpanelInstance Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
<p><a href="../index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -1969,7 +1969,7 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Classes/People.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="People Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
<p><a href="../index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -785,7 +785,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Extensions.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Extensions Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
<p><a href="index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="search.json">
Expand Down Expand Up @@ -544,7 +544,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Extensions/Array.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Array Extension Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
<p><a href="../index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -199,7 +199,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Extensions/Bool.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Bool Extension Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
<p><a href="../index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -200,7 +200,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Extensions/Date.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Date Extension Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
<p><a href="../index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -200,7 +200,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Extensions/Dictionary.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Dictionary Extension Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
<p><a href="../index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -199,7 +199,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
4 changes: 2 additions & 2 deletions docs/Extensions/Double.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Double Extension Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html">Mixpanel 3.1.4 Docs</a> (84% documented)</p>
<p><a href="../index.html">Mixpanel 3.1.5 Docs</a> (84% documented)</p>
<p class="header-right"><a href="https://github.com/mixpanel/mixpanel-swift"><img src="../img/gh.png"/>View on GitHub</a></p>
<p class="header-right">
<form role="search" action="../search.json">
Expand Down Expand Up @@ -200,7 +200,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-10)</p>
<p>&copy; 2022 <a class="link" href="http://mixpanel.com" target="_blank" rel="external">Mixpanel</a>. All rights reserved. (Last updated: 2022-02-18)</p>
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.13.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
</section>
</article>
Expand Down
Loading

0 comments on commit b1ff3fd

Please sign in to comment.