Skip to content

Commit

Permalink
iOS docs update
Browse files Browse the repository at this point in the history
  • Loading branch information
JOikarinen committed Jul 7, 2021
1 parent ce9e725 commit e7e698e
Show file tree
Hide file tree
Showing 60 changed files with 893 additions and 108 deletions.
35 changes: 33 additions & 2 deletions polar-sdk-ios/docs/Classes.html
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"> Docs</a> (89% documented)</p>
<p><a href="index.html"> Docs</a> (87% documented)</p>
<p class="header-right">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
Expand Down Expand Up @@ -62,6 +62,9 @@
<li class="nav-group-task">
<a href="Classes.html#/s:11PolarBleSdk21OperationNotSupportedC">OperationNotSupported</a>
</li>
<li class="nav-group-task">
<a href="Classes/PolarAdvDataUtility.html">PolarAdvDataUtility</a>
</li>
<li class="nav-group-task">
<a href="Classes/PolarBleApiDefaultImpl.html">PolarBleApiDefaultImpl</a>
</li>
Expand Down Expand Up @@ -197,6 +200,34 @@ <h1>Classes</h1>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:11PolarBleSdk0A14AdvDataUtilityC"></a>
<a name="//apple_ref/swift/Class/PolarAdvDataUtility" class="dashAnchor"></a>
<a class="token" href="#/s:11PolarBleSdk0A14AdvDataUtilityC">PolarAdvDataUtility</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>

<a href="Classes/PolarAdvDataUtility.html" class="slightly-smaller">See more</a>
</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">PolarAdvDataUtility</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
Expand Down Expand Up @@ -500,7 +531,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-06-23)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-07-07)</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
276 changes: 276 additions & 0 deletions polar-sdk-ios/docs/Classes/PolarAdvDataUtility.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,276 @@
<!DOCTYPE html>
<html lang="en">
<head>
<title>PolarAdvDataUtility Class Reference</title>
<link rel="stylesheet" type="text/css" href="../css/jazzy.css" />
<link rel="stylesheet" type="text/css" href="../css/highlight.css" />
<meta charset='utf-8'>
<script src="../js/jquery.min.js" defer></script>
<script src="../js/jazzy.js" defer></script>

<script src="../js/lunr.min.js" defer></script>
<script src="../js/typeahead.jquery.js" defer></script>
<script src="../js/jazzy.search.js" defer></script>
</head>
<body>
<a name="//apple_ref/swift/Class/PolarAdvDataUtility" class="dashAnchor"></a>
<a title="PolarAdvDataUtility Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (87% documented)</p>
<p class="header-right">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
</form>
</p>
</div>
</header>
<div class="content-wrapper">
<p id="breadcrumbs">
<a href="../index.html"> Reference</a>
<img id="carat" src="../img/carat.png" />
PolarAdvDataUtility Class Reference
</p>
</div>
<div class="content-wrapper">
<nav class="sidebar">
<ul class="nav-groups">
<li class="nav-group-name">
<a href="../Classes.html">Classes</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Classes.html#/s:11PolarBleSdk20DateTimeFormatFailedC">DateTimeFormatFailed</a>
</li>
<li class="nav-group-task">
<a href="../Classes.html#/s:11PolarBleSdk18DeviceNotConnectedC">DeviceNotConnected</a>
</li>
<li class="nav-group-task">
<a href="../Classes.html#/s:11PolarBleSdk14DeviceNotFoundC">DeviceNotFound</a>
</li>
<li class="nav-group-task">
<a href="../Classes.html#/s:11PolarBleSdk15InvalidArgumentC">InvalidArgument</a>
</li>
<li class="nav-group-task">
<a href="../Classes.html#/s:11PolarBleSdk19MessageDecodeFailedC">MessageDecodeFailed</a>
</li>
<li class="nav-group-task">
<a href="../Classes.html#/s:11PolarBleSdk19MessageEncodeFailedC">MessageEncodeFailed</a>
</li>
<li class="nav-group-task">
<a href="../Classes.html#/s:11PolarBleSdk22NotificationNotEnabledC">NotificationNotEnabled</a>
</li>
<li class="nav-group-task">
<a href="../Classes.html#/s:11PolarBleSdk21OperationNotSupportedC">OperationNotSupported</a>
</li>
<li class="nav-group-task">
<a href="../Classes/PolarAdvDataUtility.html">PolarAdvDataUtility</a>
</li>
<li class="nav-group-task">
<a href="../Classes/PolarBleApiDefaultImpl.html">PolarBleApiDefaultImpl</a>
</li>
<li class="nav-group-task">
<a href="../Classes.html#/s:11PolarBleSdk15ServiceNotFoundC">ServiceNotFound</a>
</li>
<li class="nav-group-task">
<a href="../Classes.html#/s:11PolarBleSdk22UnableToStartStreamingC">UnableToStartStreaming</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Enums.html">Enumerations</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Enums/DeviceStreamingFeature.html">DeviceStreamingFeature</a>
</li>
<li class="nav-group-task">
<a href="../Enums/Features.html">Features</a>
</li>
<li class="nav-group-task">
<a href="../Enums/OhrDataType.html">OhrDataType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/RecordingInterval.html">RecordingInterval</a>
</li>
<li class="nav-group-task">
<a href="../Enums/SampleType.html">SampleType</a>
</li>
<li class="nav-group-task">
<a href="../Enums/UndefinedError.html">UndefinedError</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Extensions.html">Extensions</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Extensions/PrimitiveSequence.html">PrimitiveSequence</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Protocols.html">Protocols</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Protocols/PolarBleApi.html">PolarBleApi</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/PolarBleApiCCCWriteObserver.html">PolarBleApiCCCWriteObserver</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/PolarBleApiDeviceFeaturesObserver.html">PolarBleApiDeviceFeaturesObserver</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/PolarBleApiDeviceHrObserver.html">PolarBleApiDeviceHrObserver</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/PolarBleApiDeviceInfoObserver.html">PolarBleApiDeviceInfoObserver</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/PolarBleApiLogger.html">PolarBleApiLogger</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/PolarBleApiObserver.html">PolarBleApiObserver</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/PolarBleApiPowerStateObserver.html">PolarBleApiPowerStateObserver</a>
</li>
<li class="nav-group-task">
<a href="../Protocols/PolarBleApiSdkModeFeatureObserver.html">PolarBleApiSdkModeFeatureObserver</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Structs.html">Structures</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Structs/PolarSensorSetting.html">PolarSensorSetting</a>
</li>
<li class="nav-group-task">
<a href="../Structs/PolarSensorSetting/SettingType.html">– SettingType</a>
</li>
</ul>
</li>
<li class="nav-group-name">
<a href="../Typealiases.html">Type Aliases</a>
<ul class="nav-group-tasks">
<li class="nav-group-task">
<a href="../Typealiases.html#/s:11PolarBleSdk0A7AccDataa">PolarAccData</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:11PolarBleSdk0A10DeviceInfoa">PolarDeviceInfo</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:11PolarBleSdk0A7EcgDataa">PolarEcgData</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:11PolarBleSdk0A12ExerciseDataa">PolarExerciseData</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:11PolarBleSdk0A13ExerciseEntrya">PolarExerciseEntry</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:11PolarBleSdk0A8GyroDataa">PolarGyroData</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:11PolarBleSdk0A15HrBroadcastDataa">PolarHrBroadcastData</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:11PolarBleSdk0A16MagnetometerDataa">PolarMagnetometerData</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:11PolarBleSdk0A7OhrDataa">PolarOhrData</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:11PolarBleSdk0A7PpiDataa">PolarPpiData</a>
</li>
<li class="nav-group-task">
<a href="../Typealiases.html#/s:11PolarBleSdk0A15RecordingStatusa">PolarRecordingStatus</a>
</li>
</ul>
</li>
</ul>
</nav>
<article class="main-content">
<section>
<section class="section">
<h1>PolarAdvDataUtility</h1>
<div class="declaration">
<div class="language">

<pre class="highlight swift"><code><span class="kd">open</span> <span class="kd">class</span> <span class="kt">PolarAdvDataUtility</span></code></pre>

</div>
</div>
<p>Undocumented</p>

</section>
<section class="section task-group-section">
<div class="task-group">
<ul>
<li class="item">
<div>
<code>
<a name="/s:11PolarBleSdk0A14AdvDataUtilityC03geta13ModelNameFromd5LocalI003advkI0S2S_tFZ"></a>
<a name="//apple_ref/swift/Method/getPolarModelNameFromAdvLocalName(advLocalName:)" class="dashAnchor"></a>
<a class="token" href="#/s:11PolarBleSdk0A14AdvDataUtilityC03geta13ModelNameFromd5LocalI003advkI0S2S_tFZ">getPolarModelNameFromAdvLocalName(advLocalName:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">getPolarModelNameFromAdvLocalName</span><span class="p">(</span><span class="nv">advLocalName</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">String</span></code></pre>

</div>
</div>
</section>
</div>
</li>
<li class="item">
<div>
<code>
<a name="/s:11PolarBleSdk0A14AdvDataUtilityC02isA6Device12advLocalNameSbSS_tFZ"></a>
<a name="//apple_ref/swift/Method/isPolarDevice(advLocalName:)" class="dashAnchor"></a>
<a class="token" href="#/s:11PolarBleSdk0A14AdvDataUtilityC02isA6Device12advLocalNameSbSS_tFZ">isPolarDevice(advLocalName:<wbr>)</a>
</code>
</div>
<div class="height-container">
<div class="pointer-container"></div>
<section class="section">
<div class="pointer"></div>
<div class="abstract">
<p>Undocumented</p>

</div>
<div class="declaration">
<h4>Declaration</h4>
<div class="language">
<p class="aside-title">Swift</p>
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">static</span> <span class="kd">func</span> <span class="nf">isPolarDevice</span><span class="p">(</span><span class="nv">advLocalName</span><span class="p">:</span> <span class="kt">String</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kt">Bool</span></code></pre>

</div>
</div>
</section>
</div>
</li>
</ul>
</div>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-07-07)</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>
</div>
</body>
</div>
</html>
7 changes: 5 additions & 2 deletions polar-sdk-ios/docs/Classes/PolarBleApiDefaultImpl.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="PolarBleApiDefaultImpl Class Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="../index.html"> Docs</a> (89% documented)</p>
<p><a href="../index.html"> Docs</a> (87% documented)</p>
<p class="header-right">
<form role="search" action="../search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
Expand Down Expand Up @@ -62,6 +62,9 @@
<li class="nav-group-task">
<a href="../Classes.html#/s:11PolarBleSdk21OperationNotSupportedC">OperationNotSupported</a>
</li>
<li class="nav-group-task">
<a href="../Classes/PolarAdvDataUtility.html">PolarAdvDataUtility</a>
</li>
<li class="nav-group-task">
<a href="../Classes/PolarBleApiDefaultImpl.html">PolarBleApiDefaultImpl</a>
</li>
Expand Down Expand Up @@ -302,7 +305,7 @@ <h4>Return Value</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-06-23)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-07-07)</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
7 changes: 5 additions & 2 deletions polar-sdk-ios/docs/Enums.html
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
<a title="Enumerations Reference"></a>
<header>
<div class="content-wrapper">
<p><a href="index.html"> Docs</a> (89% documented)</p>
<p><a href="index.html"> Docs</a> (87% documented)</p>
<p class="header-right">
<form role="search" action="search.json">
<input type="text" placeholder="Search documentation" data-typeahead>
Expand Down Expand Up @@ -62,6 +62,9 @@
<li class="nav-group-task">
<a href="Classes.html#/s:11PolarBleSdk21OperationNotSupportedC">OperationNotSupported</a>
</li>
<li class="nav-group-task">
<a href="Classes/PolarAdvDataUtility.html">PolarAdvDataUtility</a>
</li>
<li class="nav-group-task">
<a href="Classes/PolarBleApiDefaultImpl.html">PolarBleApiDefaultImpl</a>
</li>
Expand Down Expand Up @@ -370,7 +373,7 @@ <h4>Declaration</h4>
</section>
</section>
<section id="footer">
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-06-23)</p>
<p>&copy; 2021 <a class="link" href="" target="_blank" rel="external"></a>. All rights reserved. (Last updated: 2021-07-07)</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 e7e698e

Please sign in to comment.