Update the docs

Metalnem · May 5, 2018 · 2c791f6 · 2c791f6
1 parent e009051
commit 2c791f6
Show file tree

Hide file tree

Showing 6 changed files with 29 additions and 29 deletions.
diff --git a/README.md b/README.md
@@ -72,5 +72,5 @@ for the complete example.
 ## Installation
 
 ```
-> dotnet add package Noise.NET --version 0.9.5-rc
+> dotnet add package Noise.NET --version 0.9.6-rc
 ```
diff --git a/docs/api/Noise.Protocol.html b/docs/api/Noise.Protocol.html
@@ -584,19 +584,19 @@ <h5 class="exceptions">Exceptions</h5>
   </table>
   <span class="small pull-right mobile-hide">
     <span class="divider">|</span>
-    <a href="https://github.com/Metalnem/noise/new/master/apiSpec/new?filename=Noise_Protocol_Create_System_Boolean_System_Byte___System_Byte___System_Byte___System_Collections_Generic_IEnumerable_System_Byte____.md&amp;value=---%0Auid%3A%20Noise.Protocol.Create(System.Boolean%2CSystem.Byte%5B%5D%2CSystem.Byte%5B%5D%2CSystem.Byte%5B%5D%2CSystem.Collections.Generic.IEnumerable%7BSystem.Byte%5B%5D%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
+    <a href="https://github.com/Metalnem/noise/new/master/apiSpec/new?filename=Noise_Protocol_Create_System_Boolean_System_ReadOnlySpan_System_Byte__System_Byte___System_Byte___System_Collections_Generic_IEnumerable_System_Byte____.md&amp;value=---%0Auid%3A%20Noise.Protocol.Create(System.Boolean%2CSystem.ReadOnlySpan%7BSystem.Byte%7D%2CSystem.Byte%5B%5D%2CSystem.Byte%5B%5D%2CSystem.Collections.Generic.IEnumerable%7BSystem.Byte%5B%5D%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
   </span>
   <span class="small pull-right mobile-hide">
     <a href="https://github.com/Metalnem/noise/blob/master/Noise/Protocol.cs/#L133">View Source</a>
   </span>
   <a id="Noise_Protocol_Create_" data-uid="Noise.Protocol.Create*"></a>
-  <h4 id="Noise_Protocol_Create_System_Boolean_System_Byte___System_Byte___System_Byte___System_Collections_Generic_IEnumerable_System_Byte____" data-uid="Noise.Protocol.Create(System.Boolean,System.Byte[],System.Byte[],System.Byte[],System.Collections.Generic.IEnumerable{System.Byte[]})">Create(Boolean, Byte[], Byte[], Byte[], IEnumerable&lt;Byte[]&gt;)</h4>
+  <h4 id="Noise_Protocol_Create_System_Boolean_System_ReadOnlySpan_System_Byte__System_Byte___System_Byte___System_Collections_Generic_IEnumerable_System_Byte____" data-uid="Noise.Protocol.Create(System.Boolean,System.ReadOnlySpan{System.Byte},System.Byte[],System.Byte[],System.Collections.Generic.IEnumerable{System.Byte[]})">Create(Boolean, ReadOnlySpan&lt;Byte&gt;, Byte[], Byte[], IEnumerable&lt;Byte[]&gt;)</h4>
   <div class="markdown level1 summary"><p>Creates an initial <a class="xref" href="Noise.HandshakeState.html">HandshakeState</a>.</p>
 </div>
   <div class="markdown level1 conceptual"></div>
   <h5 class="decalaration">Declaration</h5>
   <div class="codewrapper">
-    <pre><code class="lang-csharp hljs">public HandshakeState Create(bool initiator, byte[] prologue = null, byte[] s = null, byte[] rs = null, IEnumerable&lt;byte[]&gt; psks = null)</code></pre>
+    <pre><code class="lang-csharp hljs">public HandshakeState Create(bool initiator, ReadOnlySpan&lt;byte&gt; prologue = default(ReadOnlySpan&lt;byte&gt;), byte[] s = null, byte[] rs = null, IEnumerable&lt;byte[]&gt; psks = null)</code></pre>
   </div>
   <h5 class="parameters">Parameters</h5>
   <table class="table table-bordered table-striped table-condensed">
@@ -615,7 +615,7 @@ <h5 class="parameters">Parameters</h5>
 </td>
       </tr>
       <tr>
-        <td><span class="xref">System.Byte</span>[]</td>
+        <td><span class="xref">System.ReadOnlySpan</span>&lt;<span class="xref">System.Byte</span>&gt;</td>
         <td><span class="parametername">prologue</span></td>
         <td><p>A byte sequence which may be zero-length, or which may contain
 context information that both parties want to confirm is identical.</p>

diff --git a/docs/index.html b/docs/index.html
@@ -128,7 +128,7 @@ <h2 id="usage">Usage</h2>
 <p>See <a href="https://github.com/Metalnem/noise/tree/master/Noise.Examples">Noise.Examples</a>
 for the complete example.</p>
 <h2 id="installation">Installation</h2>
-<pre><code>&gt; dotnet add package Noise.NET --version 0.9.5-rc
+<pre><code>&gt; dotnet add package Noise.NET --version 0.9.6-rc
 </code></pre>
 </article>
           </div>

diff --git a/docs/manifest.json b/docs/manifest.json
@@ -59,7 +59,7 @@
           "hash": "wGYtrAt6VJY55h/O7P+6Dg=="
         }
       },
-      "is_incremental": false,
+      "is_incremental": true,
       "version": ""
     },
     {
@@ -83,7 +83,7 @@
           "hash": "avQjMWi5mo5gC5eVdT61SA=="
         }
       },
-      "is_incremental": false,
+      "is_incremental": true,
       "version": ""
     },
     {
@@ -128,10 +128,10 @@
       "output": {
         ".html": {
           "relative_path": "api/Noise.Protocol.html",
-          "hash": "2EAlAIz/M0gnLJXOMY/hOA=="
+          "hash": "D5unpWHTPGkb8vcfFdB91A=="
         }
       },
-      "is_incremental": false,
+      "is_incremental": true,
       "version": ""
     },
     {
@@ -143,7 +143,7 @@
           "hash": "+PwF7Ze27xUxKQRNemBDwA=="
         }
       },
-      "is_incremental": false,
+      "is_incremental": true,
       "version": ""
     },
     {
@@ -167,7 +167,7 @@
           "hash": "kO+puOFd2NGaoBUeyUNcaA=="
         }
       },
-      "is_incremental": false,
+      "is_incremental": true,
       "version": ""
     },
     {
@@ -179,7 +179,7 @@
           "hash": "RiuTzyoQxsW8dWzUvs2X+A=="
         }
       },
-      "is_incremental": false,
+      "is_incremental": true,
       "version": ""
     },
     {
@@ -188,7 +188,7 @@
       "output": {
         ".html": {
           "relative_path": "index.html",
-          "hash": "KSUSgvimDDIjp/IO4f6ieA=="
+          "hash": "rQDrW5WA5NoQ5S3oB6DJKA=="
         }
       },
       "is_incremental": false,
@@ -202,6 +202,11 @@
         "incrementalPhase": "build"
       },
       "processors": {
+        "TocDocumentProcessor": {
+          "can_incremental": false,
+          "details": "Processor TocDocumentProcessor cannot suppport incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.",
+          "incrementalPhase": "build"
+        },
         "ResourceDocumentProcessor": {
           "can_incremental": false,
           "details": "Processor ResourceDocumentProcessor cannot suppport incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.",
@@ -214,11 +219,6 @@
         "ConceptualDocumentProcessor": {
           "can_incremental": true,
           "incrementalPhase": "build"
-        },
-        "TocDocumentProcessor": {
-          "can_incremental": false,
-          "details": "Processor TocDocumentProcessor cannot suppport incremental build because the processor doesn't implement ISupportIncrementalDocumentProcessor interface.",
-          "incrementalPhase": "build"
         }
       }
     },

diff --git a/docs/xrefmap.yml b/docs/xrefmap.yml
@@ -505,15 +505,15 @@ references:
   commentId: M:Noise.Protocol.Create(Noise.ProtocolConfig)
   fullName: Noise.Protocol.Create(Noise.ProtocolConfig)
   nameWithType: Protocol.Create(ProtocolConfig)
-- uid: Noise.Protocol.Create(System.Boolean,System.Byte[],System.Byte[],System.Byte[],System.Collections.Generic.IEnumerable{System.Byte[]})
-  name: Create(Boolean, Byte[], Byte[], Byte[], IEnumerable<Byte[]>)
-  href: api/Noise.Protocol.html#Noise_Protocol_Create_System_Boolean_System_Byte___System_Byte___System_Byte___System_Collections_Generic_IEnumerable_System_Byte____
-  commentId: M:Noise.Protocol.Create(System.Boolean,System.Byte[],System.Byte[],System.Byte[],System.Collections.Generic.IEnumerable{System.Byte[]})
-  name.vb: Create(Boolean, Byte(), Byte(), Byte(), IEnumerable(Of Byte()))
-  fullName: Noise.Protocol.Create(System.Boolean, System.Byte[], System.Byte[], System.Byte[], System.Collections.Generic.IEnumerable<System.Byte[]>)
-  fullName.vb: Noise.Protocol.Create(System.Boolean, System.Byte(), System.Byte(), System.Byte(), System.Collections.Generic.IEnumerable(Of System.Byte()))
-  nameWithType: Protocol.Create(Boolean, Byte[], Byte[], Byte[], IEnumerable<Byte[]>)
-  nameWithType.vb: Protocol.Create(Boolean, Byte(), Byte(), Byte(), IEnumerable(Of Byte()))
+- uid: Noise.Protocol.Create(System.Boolean,System.ReadOnlySpan{System.Byte},System.Byte[],System.Byte[],System.Collections.Generic.IEnumerable{System.Byte[]})
+  name: Create(Boolean, ReadOnlySpan<Byte>, Byte[], Byte[], IEnumerable<Byte[]>)
+  href: api/Noise.Protocol.html#Noise_Protocol_Create_System_Boolean_System_ReadOnlySpan_System_Byte__System_Byte___System_Byte___System_Collections_Generic_IEnumerable_System_Byte____
+  commentId: M:Noise.Protocol.Create(System.Boolean,System.ReadOnlySpan{System.Byte},System.Byte[],System.Byte[],System.Collections.Generic.IEnumerable{System.Byte[]})
+  name.vb: Create(Boolean, ReadOnlySpan(Of Byte), Byte(), Byte(), IEnumerable(Of Byte()))
+  fullName: Noise.Protocol.Create(System.Boolean, System.ReadOnlySpan<System.Byte>, System.Byte[], System.Byte[], System.Collections.Generic.IEnumerable<System.Byte[]>)
+  fullName.vb: Noise.Protocol.Create(System.Boolean, System.ReadOnlySpan(Of System.Byte), System.Byte(), System.Byte(), System.Collections.Generic.IEnumerable(Of System.Byte()))
+  nameWithType: Protocol.Create(Boolean, ReadOnlySpan<Byte>, Byte[], Byte[], IEnumerable<Byte[]>)
+  nameWithType.vb: Protocol.Create(Boolean, ReadOnlySpan(Of Byte), Byte(), Byte(), IEnumerable(Of Byte()))
 - uid: Noise.Protocol.Create*
   name: Create
   href: api/Noise.Protocol.html#Noise_Protocol_Create_

diff --git a/index.md b/index.md
@@ -76,5 +76,5 @@ for the complete example.
 ## Installation
 
 ```
-> dotnet add package Noise.NET --version 0.9.5-rc
+> dotnet add package Noise.NET --version 0.9.6-rc
 ```