Update documentation to version 1.3

christophhagen · Apr 18, 2019 · 5f93c2c · 5f93c2c
1 parent acfe723
commit 5f93c2c
Show file tree

Hide file tree

Showing 131 changed files with 7,005 additions and 6,079 deletions.
diff --git a/Documentation/Classes.html b/Documentation/Classes.html
diff --git a/Documentation/Classes/ReceiverChain.html b/Documentation/Classes/ReceiverChain.html
diff --git a/Documentation/Classes/SenderKeyRecord.html b/Documentation/Classes/SenderKeyRecord.html
diff --git a/Documentation/Classes/SenderKeyState.html b/Documentation/Classes/SenderKeyState.html
diff --git a/Documentation/Classes/SessionRecord.html b/Documentation/Classes/SessionRecord.html
diff --git a/Documentation/Classes/SessionState.html b/Documentation/Classes/SessionState.html
diff --git a/Documentation/Classes/SignalError.html b/Documentation/Classes/SignalError.html
diff --git a/Documentation/Enums.html b/Documentation/Enums.html
@@ -1,7 +1,7 @@
 <!DOCTYPE html>
 <html lang="en">
   <head>
-    <title>Enums  Reference</title>
+    <title>Enumerations  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'>
@@ -10,7 +10,8 @@
 
   </head>
   <body>
-    <a title="Enums  Reference"></a>
+    <a name="//apple_ref/swift/Section/Enumerations" class="dashAnchor"></a>
+    <a title="Enumerations  Reference"></a>
     <header>
       <div class="content-wrapper">
         <p><a href="index.html">SignalProtocol Docs</a> (100% documented)</p>
@@ -21,7 +22,7 @@
       <p id="breadcrumbs">
         <a href="index.html">SignalProtocol Reference</a>
         <img id="carat" src="img/carat.png" />
-        Enums  Reference
+        Enumerations  Reference
       </p>
     </div>
     <div class="content-wrapper">
@@ -51,7 +52,7 @@
             </ul>
           </li>
           <li class="nav-group-name">
-            <a href="Enums.html">Enums</a>
+            <a href="Enums.html">Enumerations</a>
             <ul class="nav-group-tasks">
               <li class="nav-group-task">
                 <a href="Enums/CipherTextType.html">CipherTextType</a>
@@ -68,16 +69,19 @@
             <a href="Functions.html">Functions</a>
             <ul class="nav-group-tasks">
               <li class="nav-group-task">
-                <a href="Functions.html#/s:14SignalProtocol14getFingerprint33_4D265CAC7D325782566EF400BD6F4359LL10Foundation4DataVAF8identity_SS16stableIdentifierSi10iterationstKF">getFingerprint(identity:stableIdentifier:iterations:)</a>
+                <a href="Functions.html#/s:14SignalProtocol14getFingerprint33_4D265CAC7D325782566EF400BD6F4359LL8identity16stableIdentifier10iterations10Foundation4DataVAI_SSSitKF">getFingerprint(identity:stableIdentifier:iterations:)</a>
               </li>
               <li class="nav-group-task">
-                <a href="Functions.html#/s:14SignalProtocol13getLogicalKey33_4D265CAC7D325782566EF400BD6F4359LL10Foundation4DataVSayAA06PublicE0VG3for_tF">getLogicalKey(for:)</a>
+                <a href="Functions.html#/s:14SignalProtocol13getLogicalKey33_4D265CAC7D325782566EF400BD6F4359LL3for10Foundation4DataVSayAA06PublicE0VG_tF">getLogicalKey(for:)</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/GroupKeyStore.html">GroupKeyStore</a>
+              </li>
               <li class="nav-group-task">
                 <a href="Protocols/IdentityKeyStore.html">IdentityKeyStore</a>
               </li>
@@ -102,7 +106,7 @@
             </ul>
           </li>
           <li class="nav-group-name">
-            <a href="Structs.html">Structs</a>
+            <a href="Structs.html">Structures</a>
             <ul class="nav-group-tasks">
               <li class="nav-group-task">
                 <a href="Structs/CipherTextMessage.html">CipherTextMessage</a>
@@ -191,9 +195,6 @@
               <li class="nav-group-task">
                 <a href="Structs/SessionSignedPreKeyPublic.html">SessionSignedPreKeyPublic</a>
               </li>
-              <li class="nav-group-task">
-                <a href="Structs/SignalAddress.html">SignalAddress</a>
-              </li>
               <li class="nav-group-task">
                 <a href="Structs/SignalCommonCrypto.html">SignalCommonCrypto</a>
               </li>
@@ -203,16 +204,13 @@
               <li class="nav-group-task">
                 <a href="Structs/SignalMessage.html">SignalMessage</a>
               </li>
-              <li class="nav-group-task">
-                <a href="Structs/SignalSenderKeyName.html">SignalSenderKeyName</a>
-              </li>
               <li class="nav-group-task">
                 <a href="Structs/SymmetricParameters.html">SymmetricParameters</a>
               </li>
             </ul>
           </li>
           <li class="nav-group-name">
-            <a href="Typealiases.html">Typealiases</a>
+            <a href="Typealiases.html">Type Aliases</a>
             <ul class="nav-group-tasks">
               <li class="nav-group-task">
                 <a href="Typealiases.html#/s:14SignalProtocol22RatchetIdentityKeyPaira">RatchetIdentityKeyPair</a>
@@ -224,8 +222,8 @@
       <article class="main-content">
         <section>
           <section class="section">
-            <h1>Enums</h1>
-            <p>The following enums are available globally.</p>
+            <h1>Enumerations</h1>
+            <p>The following enumerations are available globally.</p>
 
           </section>
           <section class="section task-group-section">
@@ -252,7 +250,7 @@ <h1>Enums</h1>
                         <h4>Declaration</h4>
                         <div class="language">
                           <p class="aside-title">Swift</p>
-                          <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>
+                          <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>
 
                         </div>
                       </div>
@@ -266,25 +264,25 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:14SignalProtocol14CipherTextTypeO"></a>
-                    <a name="//apple_ref/swift/Enum/CipherTextType" class="dashAnchor"></a>
-                    <a class="token" href="#/s:14SignalProtocol14CipherTextTypeO">CipherTextType</a>
+                    <a name="/s:14SignalProtocol0A16EncryptionSchemeO"></a>
+                    <a name="//apple_ref/swift/Enum/SignalEncryptionScheme" class="dashAnchor"></a>
+                    <a class="token" href="#/s:14SignalProtocol0A16EncryptionSchemeO">SignalEncryptionScheme</a>
                     </code>
                   </div>
                   <div class="height-container">
                     <div class="pointer-container"></div>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>The <code>CipherTextType</code> enum describes the different types of messages.</p>
+                        <p>Specifies the type of algorithm to use for encryption and decryption.</p>
 
-                        <a href="Enums/CipherTextType.html" class="slightly-smaller">See more</a>
+                        <a href="Enums/SignalEncryptionScheme.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"><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>
+                          <pre class="highlight swift"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SignalEncryptionScheme</span></code></pre>
 
                         </div>
                       </div>
@@ -298,25 +296,25 @@ <h4>Declaration</h4>
                 <li class="item">
                   <div>
                     <code>
-                    <a name="/s:14SignalProtocol0A16EncryptionSchemeO"></a>
-                    <a name="//apple_ref/swift/Enum/SignalEncryptionScheme" class="dashAnchor"></a>
-                    <a class="token" href="#/s:14SignalProtocol0A16EncryptionSchemeO">SignalEncryptionScheme</a>
+                    <a name="/s:14SignalProtocol14CipherTextTypeO"></a>
+                    <a name="//apple_ref/swift/Enum/CipherTextType" class="dashAnchor"></a>
+                    <a class="token" href="#/s:14SignalProtocol14CipherTextTypeO">CipherTextType</a>
                     </code>
                   </div>
                   <div class="height-container">
                     <div class="pointer-container"></div>
                     <section class="section">
                       <div class="pointer"></div>
                       <div class="abstract">
-                        <p>Specifies the type of algorithm to use for encryption and decryption.</p>
+                        <p>The <code>CipherTextType</code> enum describes the different types of messages.</p>
 
-                        <a href="Enums/SignalEncryptionScheme.html" class="slightly-smaller">See more</a>
+                        <a href="Enums/CipherTextType.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"><code><span class="kd">public</span> <span class="kd">enum</span> <span class="kt">SignalEncryptionScheme</span></code></pre>
+                          <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>
 
                         </div>
                       </div>
@@ -328,8 +326,8 @@ <h4>Declaration</h4>
           </section>
         </section>
         <section id="footer">
-          <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>
-          <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>
+          <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>
+          <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>
         </section>
       </article>
     </div>