Updated docs, build 105

.docsanity.yaml

@@ -22,7 +22,7 @@ project:
 # The assemblies for which documentation should be generated, 
 # .xml files are expected in the same location
 assemblies:
-  - ./Build/Release/Topten.RichTextKit/netcoreapp2.1/Topten.RichTextKit.dll
+  - ./Build/Release/Topten.RichTextKit/netcoreapp2.0/Topten.RichTextKit.dll
 
 # Namespaces to be assumed when formatting fully qualified type names
 namespaces:

doc/.common.page

@@ -156,7 +156,6 @@ navTree:
               - text: Lines|./ref/Topten.RichTextKit.TextBlock.Lines
               - text: MaxHeight|./ref/Topten.RichTextKit.TextBlock.MaxHeight
               - text: MaxLines|./ref/Topten.RichTextKit.TextBlock.MaxLines
-              - text: MaxOverhang|./ref/Topten.RichTextKit.TextBlock.MaxOverhang
               - text: MaxWidth|./ref/Topten.RichTextKit.TextBlock.MaxWidth
               - text: MeasuredHeight|./ref/Topten.RichTextKit.TextBlock.MeasuredHeight
               - text: MeasuredOverhang|./ref/Topten.RichTextKit.TextBlock.MeasuredOverhang
@@ -234,12 +233,26 @@ navTree:
               - text: AsSlice|./ref/Topten.RichTextKit.Utils.Buffer[T].AsSlice
               - text: Clear|./ref/Topten.RichTextKit.Utils.Buffer[T].Clear
               - text: SubSlice|./ref/Topten.RichTextKit.Utils.Buffer[T].SubSlice
+      - text: MappedSlice<T>
+        subItems:
+          - text: Overview|./ref/Topten.RichTextKit.Utils.MappedSlice[T]
+          - text: Constructors|./ref/Topten.RichTextKit.Utils.MappedSlice[T]..ctor
+          - text: Properties
+            subItems:
+              - text: Item|./ref/Topten.RichTextKit.Utils.MappedSlice[T].Item
+              - text: Length|./ref/Topten.RichTextKit.Utils.MappedSlice[T].Length
+              - text: Mapping|./ref/Topten.RichTextKit.Utils.MappedSlice[T].Mapping
+              - text: Underlying|./ref/Topten.RichTextKit.Utils.MappedSlice[T].Underlying
+          - text: Methods
+            subItems:
+              - text: ToArray|./ref/Topten.RichTextKit.Utils.MappedSlice[T].ToArray
       - text: Slice<T>
         subItems:
           - text: Overview|./ref/Topten.RichTextKit.Utils.Slice[T]
           - text: Constructors|./ref/Topten.RichTextKit.Utils.Slice[T]..ctor
           - text: Properties
             subItems:
+              - text: Empty|./ref/Topten.RichTextKit.Utils.Slice[T].Empty
               - text: Item|./ref/Topten.RichTextKit.Utils.Slice[T].Item
               - text: Length|./ref/Topten.RichTextKit.Utils.Slice[T].Length
               - text: Start|./ref/Topten.RichTextKit.Utils.Slice[T].Start
@@ -247,6 +260,7 @@ navTree:
           - text: Methods
             subItems:
               - text: Clear|./ref/Topten.RichTextKit.Utils.Slice[T].Clear
+              - text: Fill|./ref/Topten.RichTextKit.Utils.Slice[T].Fill
               - text: SubSlice|./ref/Topten.RichTextKit.Utils.Slice[T].SubSlice
               - text: ToArray|./ref/Topten.RichTextKit.Utils.Slice[T].ToArray
       - text: Utf32Buffer

doc/measuring.page

@@ -8,7 +8,7 @@ isMarkdown: false
 <li><a href="./ref/Topten.RichTextKit.TextBlock.MeasuredWidth">Topten.RichTextKit.TextBlock.MeasuredWidth</a></li>
 <li><a href="./ref/Topten.RichTextKit.TextBlock.MeasuredHeight">Topten.RichTextKit.TextBlock.MeasuredHeight</a></li>
 <li><a href="./ref/Topten.RichTextKit.TextBlock.MeasuredPadding">Topten.RichTextKit.TextBlock.MeasuredPadding</a></li>
-<li><a href="./ref/Topten.RichTextKit.TextBlock.MaxOverhang">Topten.RichTextKit.TextBlock.MaxOverhang</a></li>
+<li>[P:Topten.RichTextKit.TextBlock.MaxOverhang]</li>
 <li><a href="./ref/Topten.RichTextKit.TextBlock.MeasuredOverhang">Topten.RichTextKit.TextBlock.MeasuredOverhang</a></li>
 </ul>
 <h2 id="going-deeper">Going Deeper</h2>

doc/ref/Topten.RichTextKit.TextBlock.MaxOverhang.page

@@ -1,47 +0,0 @@
----
-title: "TextBlock.MaxOverhang"
-isMarkdown: false
-import: "../.common.page"
----
-
-<h1 data-nav-secondary-text="Definition" id="definition">TextBlock.MaxOverhang Property</h1>
-
-
-<p>
-    <small>
-        Assembly: Topten.RichTextKit.dll<br />
-        Namespace: <a href="./../ref/Topten.RichTextKit">Topten.RichTextKit</a><br />
-
-                Declaring Type: <a href="./../ref/Topten.RichTextKit.TextBlock">TextBlock</a><br />
-                        </small>
-</p>
-
-
-
-
-<p>Returns the maximum possible overhang based on the fonts used in this text block</p>
-
-
-<pre class="language-csharp"><code class="language-csharp">public SkiaSharp.SKRect MaxOverhang { get; }</code></pre>
-
-<h2 id="remarks">Remarks</h2><p>Some font's can overhang the left and right margins.  eg: a lowercase 'j' at
-the start of a line will often overhang to the left of the left margin.</p>
-<p>This property returns the maximum overhang in each direction based on the fonts
-used, but not the actual text or final layout.  This can be useful to get a
-consistent maximum possible overhang, although the returned value is often
-excessive (depending on the font).</p>
-<p>Currently only the left overhang is calculated.</p>
-<p>The return rectangle describes overhang amounts for each edge - not rectangle
-co-ordinates.</p>
-
-<h2 id="property-type">Property Type</h2>    <table class="name-description">
-        <tr>
-            <td>SkiaSharp.SKRect</td>
-            <td></td>
-        </tr>
-    </table>
-
-
-
-
-

doc/ref/Topten.RichTextKit.TextBlock.MeasuredOverhang.page

@@ -25,8 +25,7 @@ fonts used, and the supplied text.</p>
 
 <pre class="language-csharp"><code class="language-csharp">public SkiaSharp.SKRect MeasuredOverhang { get; }</code></pre>
 
-<h2 id="remarks">Remarks</h2><p>Currently only the left overhang is calculated.</p>
+<h2 id="remarks">Remarks</h2><p>The return rectangle describes overhang amounts for each edge - not
-<p>The return rectangle describes overhang amounts for each edge - not
 rectangle co-ordinates.</p>
 
 <h2 id="property-type">Property Type</h2>    <table class="name-description">

doc/ref/Topten.RichTextKit.TextBlock.page

@@ -81,11 +81,6 @@ ellipsis (<code>...</code>) character.</p>
                 <td><p>The maximum number of lines after which lines will be
 truncated and the final line will be appended with an
 ellipsis (<code>...</code>) character.</p>
-</td>
-            </tr>
-            <tr>
-                <td><a href="./../ref/Topten.RichTextKit.TextBlock.MaxOverhang">MaxOverhang</a></td>
-                <td><p>Returns the maximum possible overhang based on the fonts used in this text block</p>
 </td>
             </tr>
             <tr>

doc/ref/Topten.RichTextKit.Utils.MappedSlice[T]..ctor.page

@@ -0,0 +1,56 @@
+---
+title: "MappedSlice<T>..ctor"
+isMarkdown: false
+import: "../.common.page"
+---
+
+    <h1 data-nav-secondary-text="Definition" id="definition">MappedSlice&lt;T&gt; Constructor</h1>
+
+
+<p>
+    <small>
+        Assembly: Topten.RichTextKit.dll<br />
+        Namespace: <a href="./../ref/Topten.RichTextKit.Utils">Topten.RichTextKit.Utils</a><br />
+
+                Declaring Type: <a href="./../ref/Topten.RichTextKit.Utils.MappedSlice[T]">MappedSlice&lt;T&gt;</a><br />
+                        </small>
+</p>
+
+
+
+
+
+
+
+
+<p>Constructs a new mapped array</p>
+
+
+<pre class="language-csharp"><code class="language-csharp">public MappedSlice(Slice&lt;T&gt; data, Slice&lt;int&gt; mapping);</code></pre>
+
+
+<h2 id="parameters">Parameters</h2>    <table class="name-description">
+            <tr>
+                <td>
+                    
+                    <a href="./../ref/Topten.RichTextKit.Utils.Slice[T]">Slice&lt;T&gt;</a> data
+                </td>
+                <td><p>The data to be mapped</p>
+</td>
+            </tr>
+            <tr>
+                <td>
+                    
+                    <a href="./../ref/Topten.RichTextKit.Utils.Slice[T]">Slice&lt;int&gt;</a> mapping
+                </td>
+                <td><p>The index map</p>
+</td>
+            </tr>
+    </table>
+
+
+
+
+
+
+

doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].Item.page

@@ -0,0 +1,48 @@
+---
+title: "MappedSlice<T>.Item"
+isMarkdown: false
+import: "../.common.page"
+---
+
+<h1 data-nav-secondary-text="Definition" id="definition">MappedSlice&lt;T&gt;.Item Property</h1>
+
+
+<p>
+    <small>
+        Assembly: Topten.RichTextKit.dll<br />
+        Namespace: <a href="./../ref/Topten.RichTextKit.Utils">Topten.RichTextKit.Utils</a><br />
+
+                Declaring Type: <a href="./../ref/Topten.RichTextKit.Utils.MappedSlice[T]">MappedSlice&lt;T&gt;</a><br />
+                        </small>
+</p>
+
+
+
+
+<p>Gets a reference to a mapped element</p>
+
+
+<pre class="language-csharp"><code class="language-csharp">public ref T this[int index] { get; }</code></pre>
+
+
+<h2 id="parameters">Parameters</h2>    <table class="name-description">
+            <tr>
+                <td>
+                    
+                    <a href="https://docs.microsoft.com/dotnet/api/System.Int32">int</a> index
+                </td>
+                <td><p>The mapped index to be retrieved</p>
+</td>
+            </tr>
+    </table>
+<h2 id="property-type">Property Type</h2>    <table class="name-description">
+        <tr>
+            <td>ref T</td>
+            <td></td>
+        </tr>
+    </table>
+
+
+
+
+

doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].Length.page

@@ -0,0 +1,38 @@
+---
+title: "MappedSlice<T>.Length"
+isMarkdown: false
+import: "../.common.page"
+---
+
+<h1 data-nav-secondary-text="Definition" id="definition">MappedSlice&lt;T&gt;.Length Property</h1>
+
+
+<p>
+    <small>
+        Assembly: Topten.RichTextKit.dll<br />
+        Namespace: <a href="./../ref/Topten.RichTextKit.Utils">Topten.RichTextKit.Utils</a><br />
+
+                Declaring Type: <a href="./../ref/Topten.RichTextKit.Utils.MappedSlice[T]">MappedSlice&lt;T&gt;</a><br />
+                        </small>
+</p>
+
+
+
+
+<p>Gets the number of elements in this mapping</p>
+
+
+<pre class="language-csharp"><code class="language-csharp">public int Length { get; }</code></pre>
+
+
+<h2 id="property-type">Property Type</h2>    <table class="name-description">
+        <tr>
+            <td><a href="https://docs.microsoft.com/dotnet/api/System.Int32">int</a></td>
+            <td></td>
+        </tr>
+    </table>
+
+
+
+
+

doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].Mapping.page

@@ -0,0 +1,38 @@
+---
+title: "MappedSlice<T>.Mapping"
+isMarkdown: false
+import: "../.common.page"
+---
+
+<h1 data-nav-secondary-text="Definition" id="definition">MappedSlice&lt;T&gt;.Mapping Property</h1>
+
+
+<p>
+    <small>
+        Assembly: Topten.RichTextKit.dll<br />
+        Namespace: <a href="./../ref/Topten.RichTextKit.Utils">Topten.RichTextKit.Utils</a><br />
+
+                Declaring Type: <a href="./../ref/Topten.RichTextKit.Utils.MappedSlice[T]">MappedSlice&lt;T&gt;</a><br />
+                        </small>
+</p>
+
+
+
+
+<p>Get the index mapping for this mapped array</p>
+
+
+<pre class="language-csharp"><code class="language-csharp">public Slice&lt;int&gt; Mapping { get; }</code></pre>
+
+
+<h2 id="property-type">Property Type</h2>    <table class="name-description">
+        <tr>
+            <td><a href="./../ref/Topten.RichTextKit.Utils.Slice[T]">Slice&lt;int&gt;</a></td>
+            <td></td>
+        </tr>
+    </table>
+
+
+
+
+

doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].ToArray.page

@@ -0,0 +1,45 @@
+---
+title: "MappedSlice<T>.ToArray"
+isMarkdown: false
+import: "../.common.page"
+---
+
+    <h1 data-nav-secondary-text="Definition" id="definition">MappedSlice&lt;T&gt;.ToArray Method</h1>
+
+
+<p>
+    <small>
+        Assembly: Topten.RichTextKit.dll<br />
+        Namespace: <a href="./../ref/Topten.RichTextKit.Utils">Topten.RichTextKit.Utils</a><br />
+
+                Declaring Type: <a href="./../ref/Topten.RichTextKit.Utils.MappedSlice[T]">MappedSlice&lt;T&gt;</a><br />
+                        </small>
+</p>
+
+
+
+
+
+
+
+
+<p>Get the content of this mapped slice as an array</p>
+
+
+<pre class="language-csharp"><code class="language-csharp">public T[] ToArray();</code></pre>
+
+
+<h2 id="returns">Returns</h2>    <table class="name-description">
+        <tr>
+            <td>T[]</td>
+            <td><p>The content as an array</p>
+</td>
+        </tr>
+    </table>
+
+
+
+
+
+
+

doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].Underlying.page

@@ -0,0 +1,38 @@
+---
+title: "MappedSlice<T>.Underlying"
+isMarkdown: false
+import: "../.common.page"
+---
+
+<h1 data-nav-secondary-text="Definition" id="definition">MappedSlice&lt;T&gt;.Underlying Property</h1>
+
+
+<p>
+    <small>
+        Assembly: Topten.RichTextKit.dll<br />
+        Namespace: <a href="./../ref/Topten.RichTextKit.Utils">Topten.RichTextKit.Utils</a><br />
+
+                Declaring Type: <a href="./../ref/Topten.RichTextKit.Utils.MappedSlice[T]">MappedSlice&lt;T&gt;</a><br />
+                        </small>
+</p>
+
+
+
+
+<p>Get the underlying slice for this mapped array</p>
+
+
+<pre class="language-csharp"><code class="language-csharp">public Slice&lt;T&gt; Underlying { get; }</code></pre>
+
+
+<h2 id="property-type">Property Type</h2>    <table class="name-description">
+        <tr>
+            <td><a href="./../ref/Topten.RichTextKit.Utils.Slice[T]">Slice&lt;T&gt;</a></td>
+            <td></td>
+        </tr>
+    </table>
+
+
+
+
+

doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].page

@@ -0,0 +1,93 @@
+---
+title: "Topten.RichTextKit.Utils.MappedSlice<T>"
+isMarkdown: false
+import: "../.common.page"
+---
+
+<h1 id="definition" data-nav-secondary-text="Definition">MappedSlice&lt;T&gt; Struct</h1>
+
+
+<p>
+    <small>
+        Assembly: Topten.RichTextKit.dll<br />
+        Namespace: <a href="./../ref/Topten.RichTextKit.Utils">Topten.RichTextKit.Utils</a><br />
+            </small>
+</p>
+
+
+<p>Provides a mapped view of an underlying slice array, selecting arbitrary indicies
+from the source array</p>
+
+
+<pre class="language-csharp"><code class="language-csharp">public struct MappedSlice&lt;T&gt;</code></pre>
+
+    <h2 id="inherits">Inheritance</h2>
+    <p>
+        MappedSlice&lt;T&gt;
+ &rarr; <a href="https://docs.microsoft.com/dotnet/api/System.ValueType">ValueType</a> &rarr; <a href="https://docs.microsoft.com/dotnet/api/System.Object">object</a>    </p>
+
+
+
+
+    <h2 id="type-parameters">Type Parameters</h2>
+    <table class="name-description">
+            <tr>
+                <td>T</td>
+                <td><p>The element type of the underlying array</p>
+</td>
+            </tr>
+    </table>
+
+    <h2 id="constructors">Constructors</h2>
+    <table class="name-description">
+            <tr>
+                <td><a href="./../ref/Topten.RichTextKit.Utils.MappedSlice[T]..ctor">MappedSlice(Slice&lt;T&gt;, Slice&lt;int&gt;)</a></td>
+                <td><p>Constructs a new mapped array</p>
+</td>
+            </tr>
+    </table>
+
+
+
+
+    <h2 id="properties">Properties</h2>
+    <table class="name-description">
+            <tr>
+                <td><a href="./../ref/Topten.RichTextKit.Utils.MappedSlice[T].Item">Item[int]</a></td>
+                <td><p>Gets a reference to a mapped element</p>
+</td>
+            </tr>
+            <tr>
+                <td><a href="./../ref/Topten.RichTextKit.Utils.MappedSlice[T].Length">Length</a></td>
+                <td><p>Gets the number of elements in this mapping</p>
+</td>
+            </tr>
+            <tr>
+                <td><a href="./../ref/Topten.RichTextKit.Utils.MappedSlice[T].Mapping">Mapping</a></td>
+                <td><p>Get the index mapping for this mapped array</p>
+</td>
+            </tr>
+            <tr>
+                <td><a href="./../ref/Topten.RichTextKit.Utils.MappedSlice[T].Underlying">Underlying</a></td>
+                <td><p>Get the underlying slice for this mapped array</p>
+</td>
+            </tr>
+    </table>
+
+    <h2 id="methods">Methods</h2>
+    <table class="name-description">
+            <tr>
+                <td><a href="./../ref/Topten.RichTextKit.Utils.MappedSlice[T].ToArray">ToArray()</a></td>
+                <td><p>Get the content of this mapped slice as an array</p>
+</td>
+            </tr>
+    </table>
+
+
+
+
+
+
+
+
+

doc/ref/Topten.RichTextKit.Utils.Slice[T].Empty.page

@@ -0,0 +1,38 @@
+---
+title: "Slice<T>.Empty"
+isMarkdown: false
+import: "../.common.page"
+---
+
+<h1 data-nav-secondary-text="Definition" id="definition">Slice&lt;T&gt;.Empty Property</h1>
+
+
+<p>
+    <small>
+        Assembly: Topten.RichTextKit.dll<br />
+        Namespace: <a href="./../ref/Topten.RichTextKit.Utils">Topten.RichTextKit.Utils</a><br />
+
+                Declaring Type: <a href="./../ref/Topten.RichTextKit.Utils.Slice[T]">Slice&lt;T&gt;</a><br />
+                        </small>
+</p>
+
+
+
+
+<p>A shared empty slice of type T</p>
+
+
+<pre class="language-csharp"><code class="language-csharp">public static Slice&lt;T&gt; Empty { get; }</code></pre>
+
+
+<h2 id="property-type">Property Type</h2>    <table class="name-description">
+        <tr>
+            <td><a href="./../ref/Topten.RichTextKit.Utils.Slice[T]">Slice&lt;T&gt;</a></td>
+            <td></td>
+        </tr>
+    </table>
+
+
+
+
+

doc/ref/Topten.RichTextKit.Utils.Slice[T].Fill.page

@@ -0,0 +1,47 @@
+---
+title: "Slice<T>.Fill"
+isMarkdown: false
+import: "../.common.page"
+---
+
+    <h1 data-nav-secondary-text="Definition" id="definition">Slice&lt;T&gt;.Fill Method</h1>
+
+
+<p>
+    <small>
+        Assembly: Topten.RichTextKit.dll<br />
+        Namespace: <a href="./../ref/Topten.RichTextKit.Utils">Topten.RichTextKit.Utils</a><br />
+
+                Declaring Type: <a href="./../ref/Topten.RichTextKit.Utils.Slice[T]">Slice&lt;T&gt;</a><br />
+                        </small>
+</p>
+
+
+
+
+
+
+
+
+<p>Fill the slice with a specified value</p>
+
+
+<pre class="language-csharp"><code class="language-csharp">public void Fill(T value);</code></pre>
+
+
+<h2 id="parameters">Parameters</h2>    <table class="name-description">
+            <tr>
+                <td>
+                    
+                    T value
+                </td>
+                <td></td>
+            </tr>
+    </table>
+
+
+
+
+
+
+

doc/ref/Topten.RichTextKit.Utils.Slice[T].page

@@ -59,6 +59,11 @@ import: "../.common.page"
 
     <h2 id="properties">Properties</h2>
     <table class="name-description">
+            <tr>
+                <td><a href="./../ref/Topten.RichTextKit.Utils.Slice[T].Empty">Empty</a></td>
+                <td><p>A shared empty slice of type T</p>
+</td>
+            </tr>
             <tr>
                 <td><a href="./../ref/Topten.RichTextKit.Utils.Slice[T].Item">Item[int]</a></td>
                 <td><p>Gets a reference to an element in the slice</p>
@@ -86,6 +91,11 @@ import: "../.common.page"
             <tr>
                 <td><a href="./../ref/Topten.RichTextKit.Utils.Slice[T].Clear">Clear()</a></td>
                 <td><p>Clears the entire slice content</p>
+</td>
+            </tr>
+            <tr>
+                <td><a href="./../ref/Topten.RichTextKit.Utils.Slice[T].Fill">Fill(T)</a></td>
+                <td><p>Fill the slice with a specified value</p>
 </td>
             </tr>
             <tr>

doc/ref/Topten.RichTextKit.Utils.page

@@ -33,6 +33,12 @@ import: "../.common.page"
 
     <h2 id="structs">Structs</h2>
     <table class="name-description">
+            <tr>
+                <td><a href="./../ref/Topten.RichTextKit.Utils.MappedSlice[T]"> MappedSlice&lt;T&gt;</a></td>
+                <td><p>Provides a mapped view of an underlying slice array, selecting arbitrary indicies
+from the source array</p>
+</td>
+            </tr>
             <tr>
                 <td><a href="./../ref/Topten.RichTextKit.Utils.Slice[T]"> Slice&lt;T&gt;</a></td>
                 <td><p>Represents a slice of an array</p>