Skip to content

Commit 5f93c2c

Browse files
author
christophhagen
committed
Update documentation to version 1.3
1 parent acfe723 commit 5f93c2c

File tree

131 files changed

+7005
-6079
lines changed

Some content is hidden

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

131 files changed

+7005
-6079
lines changed

‎Documentation/Classes.html

+45-47
Large diffs are not rendered by default.

‎Documentation/Classes/ReceiverChain.html

+51-47
Large diffs are not rendered by default.

‎Documentation/Classes/SenderKeyRecord.html

+71-60
Large diffs are not rendered by default.

‎Documentation/Classes/SenderKeyState.html

+61-57
Large diffs are not rendered by default.

‎Documentation/Classes/SessionRecord.html

+53-49
Large diffs are not rendered by default.

‎Documentation/Classes/SessionState.html

+103-99
Large diffs are not rendered by default.

‎Documentation/Classes/SignalError.html

+61-64
Large diffs are not rendered by default.

‎Documentation/Enums.html

+29-31
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
<!DOCTYPE html>
22
<html lang="en">
33
<head>
4-
<title>Enums Reference</title>
4+
<title>Enumerations Reference</title>
55
<link rel="stylesheet" type="text/css" href="css/jazzy.css" />
66
<link rel="stylesheet" type="text/css" href="css/highlight.css" />
77
<meta charset='utf-8'>
@@ -10,7 +10,8 @@
1010

1111
</head>
1212
<body>
13-
<a title="Enums Reference"></a>
13+
<a name="//apple_ref/swift/Section/Enumerations" class="dashAnchor"></a>
14+
<a title="Enumerations Reference"></a>
1415
<header>
1516
<div class="content-wrapper">
1617
<p><a href="index.html">SignalProtocol Docs</a> (100% documented)</p>
@@ -21,7 +22,7 @@
2122
<p id="breadcrumbs">
2223
<a href="index.html">SignalProtocol Reference</a>
2324
<img id="carat" src="img/carat.png" />
24-
Enums Reference
25+
Enumerations Reference
2526
</p>
2627
</div>
2728
<div class="content-wrapper">
@@ -51,7 +52,7 @@
5152
</ul>
5253
</li>
5354
<li class="nav-group-name">
54-
<a href="Enums.html">Enums</a>
55+
<a href="Enums.html">Enumerations</a>
5556
<ul class="nav-group-tasks">
5657
<li class="nav-group-task">
5758
<a href="Enums/CipherTextType.html">CipherTextType</a>
@@ -68,16 +69,19 @@
6869
<a href="Functions.html">Functions</a>
6970
<ul class="nav-group-tasks">
7071
<li class="nav-group-task">
71-
<a href="Functions.html#/s:14SignalProtocol14getFingerprint33_4D265CAC7D325782566EF400BD6F4359LL10Foundation4DataVAF8identity_SS16stableIdentifierSi10iterationstKF">getFingerprint(identity:stableIdentifier:iterations:)</a>
72+
<a href="Functions.html#/s:14SignalProtocol14getFingerprint33_4D265CAC7D325782566EF400BD6F4359LL8identity16stableIdentifier10iterations10Foundation4DataVAI_SSSitKF">getFingerprint(identity:stableIdentifier:iterations:)</a>
7273
</li>
7374
<li class="nav-group-task">
74-
<a href="Functions.html#/s:14SignalProtocol13getLogicalKey33_4D265CAC7D325782566EF400BD6F4359LL10Foundation4DataVSayAA06PublicE0VG3for_tF">getLogicalKey(for:)</a>
75+
<a href="Functions.html#/s:14SignalProtocol13getLogicalKey33_4D265CAC7D325782566EF400BD6F4359LL3for10Foundation4DataVSayAA06PublicE0VG_tF">getLogicalKey(for:)</a>
7576
</li>
7677
</ul>
7778
</li>
7879
<li class="nav-group-name">
7980
<a href="Protocols.html">Protocols</a>
8081
<ul class="nav-group-tasks">
82+
<li class="nav-group-task">
83+
<a href="Protocols/GroupKeyStore.html">GroupKeyStore</a>
84+
</li>
8185
<li class="nav-group-task">
8286
<a href="Protocols/IdentityKeyStore.html">IdentityKeyStore</a>
8387
</li>
@@ -102,7 +106,7 @@
102106
</ul>
103107
</li>
104108
<li class="nav-group-name">
105-
<a href="Structs.html">Structs</a>
109+
<a href="Structs.html">Structures</a>
106110
<ul class="nav-group-tasks">
107111
<li class="nav-group-task">
108112
<a href="Structs/CipherTextMessage.html">CipherTextMessage</a>
@@ -191,9 +195,6 @@
191195
<li class="nav-group-task">
192196
<a href="Structs/SessionSignedPreKeyPublic.html">SessionSignedPreKeyPublic</a>
193197
</li>
194-
<li class="nav-group-task">
195-
<a href="Structs/SignalAddress.html">SignalAddress</a>
196-
</li>
197198
<li class="nav-group-task">
198199
<a href="Structs/SignalCommonCrypto.html">SignalCommonCrypto</a>
199200
</li>
@@ -203,16 +204,13 @@
203204
<li class="nav-group-task">
204205
<a href="Structs/SignalMessage.html">SignalMessage</a>
205206
</li>
206-
<li class="nav-group-task">
207-
<a href="Structs/SignalSenderKeyName.html">SignalSenderKeyName</a>
208-
</li>
209207
<li class="nav-group-task">
210208
<a href="Structs/SymmetricParameters.html">SymmetricParameters</a>
211209
</li>
212210
</ul>
213211
</li>
214212
<li class="nav-group-name">
215-
<a href="Typealiases.html">Typealiases</a>
213+
<a href="Typealiases.html">Type Aliases</a>
216214
<ul class="nav-group-tasks">
217215
<li class="nav-group-task">
218216
<a href="Typealiases.html#/s:14SignalProtocol22RatchetIdentityKeyPaira">RatchetIdentityKeyPair</a>
@@ -224,8 +222,8 @@
224222
<article class="main-content">
225223
<section>
226224
<section class="section">
227-
<h1>Enums</h1>
228-
<p>The following enums are available globally.</p>
225+
<h1>Enumerations</h1>
226+
<p>The following enumerations are available globally.</p>
229227

230228
</section>
231229
<section class="section task-group-section">
@@ -252,7 +250,7 @@ <h1>Enums</h1>
252250
<h4>Declaration</h4>
253251
<div class="language">
254252
<p class="aside-title">Swift</p>
255-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SignalErrorType</span><span class="p">:</span> <span class="kt">String</span></code></pre>
253+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SignalErrorType</span> <span class="p">:</span> <span class="kt">String</span></code></pre>
256254

257255
</div>
258256
</div>
@@ -266,25 +264,25 @@ <h4>Declaration</h4>
266264
<li class="item">
267265
<div>
268266
<code>
269-
<a name="/s:14SignalProtocol14CipherTextTypeO"></a>
270-
<a name="//apple_ref/swift/Enum/CipherTextType" class="dashAnchor"></a>
271-
<a class="token" href="#/s:14SignalProtocol14CipherTextTypeO">CipherTextType</a>
267+
<a name="/s:14SignalProtocol0A16EncryptionSchemeO"></a>
268+
<a name="//apple_ref/swift/Enum/SignalEncryptionScheme" class="dashAnchor"></a>
269+
<a class="token" href="#/s:14SignalProtocol0A16EncryptionSchemeO">SignalEncryptionScheme</a>
272270
</code>
273271
</div>
274272
<div class="height-container">
275273
<div class="pointer-container"></div>
276274
<section class="section">
277275
<div class="pointer"></div>
278276
<div class="abstract">
279-
<p>The <code>CipherTextType</code> enum describes the different types of messages.</p>
277+
<p>Specifies the type of algorithm to use for encryption and decryption.</p>
280278

281-
<a href="Enums/CipherTextType.html" class="slightly-smaller">See more</a>
279+
<a href="Enums/SignalEncryptionScheme.html" class="slightly-smaller">See more</a>
282280
</div>
283281
<div class="declaration">
284282
<h4>Declaration</h4>
285283
<div class="language">
286284
<p class="aside-title">Swift</p>
287-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">CipherTextType</span><span class="p">:</span> <span class="kt">UInt8</span><span class="p">,</span> <span class="kt">CustomStringConvertible</span></code></pre>
285+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SignalEncryptionScheme</span></code></pre>
288286

289287
</div>
290288
</div>
@@ -298,25 +296,25 @@ <h4>Declaration</h4>
298296
<li class="item">
299297
<div>
300298
<code>
301-
<a name="/s:14SignalProtocol0A16EncryptionSchemeO"></a>
302-
<a name="//apple_ref/swift/Enum/SignalEncryptionScheme" class="dashAnchor"></a>
303-
<a class="token" href="#/s:14SignalProtocol0A16EncryptionSchemeO">SignalEncryptionScheme</a>
299+
<a name="/s:14SignalProtocol14CipherTextTypeO"></a>
300+
<a name="//apple_ref/swift/Enum/CipherTextType" class="dashAnchor"></a>
301+
<a class="token" href="#/s:14SignalProtocol14CipherTextTypeO">CipherTextType</a>
304302
</code>
305303
</div>
306304
<div class="height-container">
307305
<div class="pointer-container"></div>
308306
<section class="section">
309307
<div class="pointer"></div>
310308
<div class="abstract">
311-
<p>Specifies the type of algorithm to use for encryption and decryption.</p>
309+
<p>The <code>CipherTextType</code> enum describes the different types of messages.</p>
312310

313-
<a href="Enums/SignalEncryptionScheme.html" class="slightly-smaller">See more</a>
311+
<a href="Enums/CipherTextType.html" class="slightly-smaller">See more</a>
314312
</div>
315313
<div class="declaration">
316314
<h4>Declaration</h4>
317315
<div class="language">
318316
<p class="aside-title">Swift</p>
319-
<pre class="highlight"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SignalEncryptionScheme</span></code></pre>
317+
<pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">CipherTextType</span> <span class="p">:</span> <span class="kt">UInt8</span><span class="p">,</span> <span class="kt">CustomStringConvertible</span></code></pre>
320318

321319
</div>
322320
</div>
@@ -328,8 +326,8 @@ <h4>Declaration</h4>
328326
</section>
329327
</section>
330328
<section id="footer">
331-
<p>&copy; 2018 <a class="link" href="https://github.com/christophhagen" target="_blank" rel="external">Christoph Hagen</a>. All rights reserved. (Last updated: 2018-02-13)</p>
332-
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.8.3</a>, a <a class="link" href="http://realm.io" target="_blank" rel="external">Realm</a> project.</p>
329+
<p>&copy; 2019 <a class="link" href="https://github.com/christophhagen" target="_blank" rel="external">Christoph Hagen</a>. All rights reserved. (Last updated: 2019-04-19)</p>
330+
<p>Generated by <a class="link" href="https://github.com/realm/jazzy" target="_blank" rel="external">jazzy ♪♫ v0.9.6</a>, a <a class="link" href="https://realm.io" target="_blank" rel="external">Realm</a> project.</p>
333331
</section>
334332
</article>
335333
</div>

0 commit comments

Comments
 (0)