From 30819c2d4a8e55fa08dbe5df92186cab56d5a6ed Mon Sep 17 00:00:00 2001 From: Brad Robinson Date: Thu, 8 Aug 2019 18:59:01 +1000 Subject: [PATCH] Updated docs, build 105 --- .docsanity.yaml | 2 +- doc/.common.page | 16 +++- doc/measuring.page | 2 +- ...ten.RichTextKit.TextBlock.MaxOverhang.page | 47 ---------- ...ichTextKit.TextBlock.MeasuredOverhang.page | 3 +- doc/ref/Topten.RichTextKit.TextBlock.page | 5 - ...ichTextKit.Utils.MappedSlice[T]..ctor.page | 56 +++++++++++ ...RichTextKit.Utils.MappedSlice[T].Item.page | 48 ++++++++++ ...chTextKit.Utils.MappedSlice[T].Length.page | 38 ++++++++ ...hTextKit.Utils.MappedSlice[T].Mapping.page | 38 ++++++++ ...hTextKit.Utils.MappedSlice[T].ToArray.page | 45 +++++++++ ...xtKit.Utils.MappedSlice[T].Underlying.page | 38 ++++++++ ...pten.RichTextKit.Utils.MappedSlice[T].page | 93 +++++++++++++++++++ ...pten.RichTextKit.Utils.Slice[T].Empty.page | 38 ++++++++ ...opten.RichTextKit.Utils.Slice[T].Fill.page | 47 ++++++++++ .../Topten.RichTextKit.Utils.Slice[T].page | 10 ++ doc/ref/Topten.RichTextKit.Utils.page | 6 ++ 17 files changed, 475 insertions(+), 57 deletions(-) delete mode 100644 doc/ref/Topten.RichTextKit.TextBlock.MaxOverhang.page create mode 100644 doc/ref/Topten.RichTextKit.Utils.MappedSlice[T]..ctor.page create mode 100644 doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].Item.page create mode 100644 doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].Length.page create mode 100644 doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].Mapping.page create mode 100644 doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].ToArray.page create mode 100644 doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].Underlying.page create mode 100644 doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].page create mode 100644 doc/ref/Topten.RichTextKit.Utils.Slice[T].Empty.page create mode 100644 doc/ref/Topten.RichTextKit.Utils.Slice[T].Fill.page diff --git a/.docsanity.yaml b/.docsanity.yaml index 4940d5d..07dd5d3 100644 --- a/.docsanity.yaml +++ b/.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: diff --git a/doc/.common.page b/doc/.common.page index 8f4c5a5..6feb74e 100644 --- a/doc/.common.page +++ b/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 + 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 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 diff --git a/doc/measuring.page b/doc/measuring.page index 008ebbb..a14e5c7 100644 --- a/doc/measuring.page +++ b/doc/measuring.page @@ -8,7 +8,7 @@ isMarkdown: false
  • Topten.RichTextKit.TextBlock.MeasuredWidth
  • Topten.RichTextKit.TextBlock.MeasuredHeight
  • Topten.RichTextKit.TextBlock.MeasuredPadding
    • -
  • Topten.RichTextKit.TextBlock.MaxOverhang
    • +
  • [P:Topten.RichTextKit.TextBlock.MaxOverhang]
  • Topten.RichTextKit.TextBlock.MeasuredOverhang

    • Going Deeper

    diff --git a/doc/ref/Topten.RichTextKit.TextBlock.MaxOverhang.page b/doc/ref/Topten.RichTextKit.TextBlock.MaxOverhang.page deleted file mode 100644 index 411022e..0000000 --- a/doc/ref/Topten.RichTextKit.TextBlock.MaxOverhang.page +++ /dev/null @@ -1,47 +0,0 @@ ---- -title: "TextBlock.MaxOverhang" -isMarkdown: false -import: "../.common.page" ---- - -

    TextBlock.MaxOverhang Property

    - - -

    - - Assembly: Topten.RichTextKit.dll
    - Namespace: Topten.RichTextKit
    - - Declaring Type: TextBlock
    -     -

    - - - - -

    Returns the maximum possible overhang based on the fonts used in this text block

    - - -
    public SkiaSharp.SKRect MaxOverhang { get; }
    - -

    Remarks

    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.

    -

    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).

    -

    Currently only the left overhang is calculated.

    -

    The return rectangle describes overhang amounts for each edge - not rectangle -co-ordinates.

    - -

    Property Type

    - - - - -
    SkiaSharp.SKRect
    - - - - - diff --git a/doc/ref/Topten.RichTextKit.TextBlock.MeasuredOverhang.page b/doc/ref/Topten.RichTextKit.TextBlock.MeasuredOverhang.page index 00a27f3..f7a4111 100644 --- a/doc/ref/Topten.RichTextKit.TextBlock.MeasuredOverhang.page +++ b/doc/ref/Topten.RichTextKit.TextBlock.MeasuredOverhang.page @@ -25,8 +25,7 @@ fonts used, and the supplied text.

    public SkiaSharp.SKRect MeasuredOverhang { get; }
    -

    Remarks

    Currently only the left overhang is calculated.

    -

    The return rectangle describes overhang amounts for each edge - not +

    Remarks

    The return rectangle describes overhang amounts for each edge - not rectangle co-ordinates.

    Property Type

    diff --git a/doc/ref/Topten.RichTextKit.TextBlock.page b/doc/ref/Topten.RichTextKit.TextBlock.page index e65c4b8..d81e865 100644 --- a/doc/ref/Topten.RichTextKit.TextBlock.page +++ b/doc/ref/Topten.RichTextKit.TextBlock.page @@ -81,11 +81,6 @@ ellipsis (...) character.

    - - - - diff --git a/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T]..ctor.page b/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T]..ctor.page new file mode 100644 index 0000000..277810c --- /dev/null +++ b/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T]..ctor.page @@ -0,0 +1,56 @@ +--- +title: "MappedSlice<T>..ctor" +isMarkdown: false +import: "../.common.page" +--- + +

    MappedSlice<T> Constructor

    + + +

    + + Assembly: Topten.RichTextKit.dll
    + Namespace: Topten.RichTextKit.Utils
    + + Declaring Type: MappedSlice<T>
    +     +

    + + + + + + + + +

    Constructs a new mapped array

    + + +
    public MappedSlice(Slice<T> data, Slice<int> mapping);
    + + +

    Parameters

    The maximum number of lines after which lines will be truncated and the final line will be appended with an ellipsis (...) character.

    -
    MaxOverhang

    Returns the maximum possible overhang based on the fonts used in this text block
    + + + + + + + + +
    + + Slice<T> data +

    The data to be mapped

    +
    + + Slice<int> mapping +

    The index map

    +
    + + + + + + + diff --git a/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].Item.page b/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].Item.page new file mode 100644 index 0000000..ff567ec --- /dev/null +++ b/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].Item.page @@ -0,0 +1,48 @@ +--- +title: "MappedSlice<T>.Item" +isMarkdown: false +import: "../.common.page" +--- + +

    MappedSlice<T>.Item Property

    + + +

    + + Assembly: Topten.RichTextKit.dll
    + Namespace: Topten.RichTextKit.Utils
    + + Declaring Type: MappedSlice<T>
    +     +

    + + + + +

    Gets a reference to a mapped element

    + + +
    public ref T this[int index] { get; }
    + + +

    Parameters

    + + + + +
    + + int index +

    The mapped index to be retrieved

    +
    +

    Property Type

    + + + + +
    ref T
    + + + + + diff --git a/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].Length.page b/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].Length.page new file mode 100644 index 0000000..ab68d19 --- /dev/null +++ b/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].Length.page @@ -0,0 +1,38 @@ +--- +title: "MappedSlice<T>.Length" +isMarkdown: false +import: "../.common.page" +--- + +

    MappedSlice<T>.Length Property

    + + +

    + + Assembly: Topten.RichTextKit.dll
    + Namespace: Topten.RichTextKit.Utils
    + + Declaring Type: MappedSlice<T>
    +     +

    + + + + +

    Gets the number of elements in this mapping

    + + +
    public int Length { get; }
    + + +

    Property Type

    + + + + +
    int
    + + + + + diff --git a/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].Mapping.page b/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].Mapping.page new file mode 100644 index 0000000..e259ef9 --- /dev/null +++ b/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].Mapping.page @@ -0,0 +1,38 @@ +--- +title: "MappedSlice<T>.Mapping" +isMarkdown: false +import: "../.common.page" +--- + +

    MappedSlice<T>.Mapping Property

    + + +

    + + Assembly: Topten.RichTextKit.dll
    + Namespace: Topten.RichTextKit.Utils
    + + Declaring Type: MappedSlice<T>
    +     +

    + + + + +

    Get the index mapping for this mapped array

    + + +
    public Slice<int> Mapping { get; }
    + + +

    Property Type

    + + + + +
    Slice<int>
    + + + + + diff --git a/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].ToArray.page b/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].ToArray.page new file mode 100644 index 0000000..e2fc5ea --- /dev/null +++ b/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].ToArray.page @@ -0,0 +1,45 @@ +--- +title: "MappedSlice<T>.ToArray" +isMarkdown: false +import: "../.common.page" +--- + +

    MappedSlice<T>.ToArray Method

    + + +

    + + Assembly: Topten.RichTextKit.dll
    + Namespace: Topten.RichTextKit.Utils
    + + Declaring Type: MappedSlice<T>
    +     +

    + + + + + + + + +

    Get the content of this mapped slice as an array

    + + +
    public T[] ToArray();
    + + +

    Returns

    + + + + +
    T[]

    The content as an array

    +
    + + + + + + + diff --git a/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].Underlying.page b/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].Underlying.page new file mode 100644 index 0000000..bb2afb5 --- /dev/null +++ b/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].Underlying.page @@ -0,0 +1,38 @@ +--- +title: "MappedSlice<T>.Underlying" +isMarkdown: false +import: "../.common.page" +--- + +

    MappedSlice<T>.Underlying Property

    + + +

    + + Assembly: Topten.RichTextKit.dll
    + Namespace: Topten.RichTextKit.Utils
    + + Declaring Type: MappedSlice<T>
    +     +

    + + + + +

    Get the underlying slice for this mapped array

    + + +
    public Slice<T> Underlying { get; }
    + + +

    Property Type

    + + + + +
    Slice<T>
    + + + + + diff --git a/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].page b/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].page new file mode 100644 index 0000000..b778b14 --- /dev/null +++ b/doc/ref/Topten.RichTextKit.Utils.MappedSlice[T].page @@ -0,0 +1,93 @@ +--- +title: "Topten.RichTextKit.Utils.MappedSlice<T>" +isMarkdown: false +import: "../.common.page" +--- + +

    MappedSlice<T> Struct

    + + +

    + + Assembly: Topten.RichTextKit.dll
    + Namespace: Topten.RichTextKit.Utils
    +     +

    + + +

    Provides a mapped view of an underlying slice array, selecting arbitrary indicies +from the source array

    + + +
    public struct MappedSlice<T>
    + +

    Inheritance

    +

    + MappedSlice<T> + → ValueType → object

    + + + + +

    Type Parameters

    + + + + + +
    T

    The element type of the underlying array

    +
    + +

    Constructors

    + + + + + +
    MappedSlice(Slice<T>, Slice<int>)

    Constructs a new mapped array

    +
    + + + + +

    Properties

    + + + + + + + + + + + + + + + + + +
    Item[int]

    Gets a reference to a mapped element

    +
    Length

    Gets the number of elements in this mapping

    +
    Mapping

    Get the index mapping for this mapped array

    +
    Underlying

    Get the underlying slice for this mapped array

    +
    + +

    Methods

    + + + + + +
    ToArray()

    Get the content of this mapped slice as an array

    +
    + + + + + + + + + diff --git a/doc/ref/Topten.RichTextKit.Utils.Slice[T].Empty.page b/doc/ref/Topten.RichTextKit.Utils.Slice[T].Empty.page new file mode 100644 index 0000000..ad39263 --- /dev/null +++ b/doc/ref/Topten.RichTextKit.Utils.Slice[T].Empty.page @@ -0,0 +1,38 @@ +--- +title: "Slice<T>.Empty" +isMarkdown: false +import: "../.common.page" +--- + +

    Slice<T>.Empty Property

    + + +

    + + Assembly: Topten.RichTextKit.dll
    + Namespace: Topten.RichTextKit.Utils
    + + Declaring Type: Slice<T>
    +     +

    + + + + +

    A shared empty slice of type T

    + + +
    public static Slice<T> Empty { get; }
    + + +

    Property Type

    + + + + +
    Slice<T>
    + + + + + diff --git a/doc/ref/Topten.RichTextKit.Utils.Slice[T].Fill.page b/doc/ref/Topten.RichTextKit.Utils.Slice[T].Fill.page new file mode 100644 index 0000000..24fdd47 --- /dev/null +++ b/doc/ref/Topten.RichTextKit.Utils.Slice[T].Fill.page @@ -0,0 +1,47 @@ +--- +title: "Slice<T>.Fill" +isMarkdown: false +import: "../.common.page" +--- + +

    Slice<T>.Fill Method

    + + +

    + + Assembly: Topten.RichTextKit.dll
    + Namespace: Topten.RichTextKit.Utils
    + + Declaring Type: Slice<T>
    +     +

    + + + + + + + + +

    Fill the slice with a specified value

    + + +
    public void Fill(T value);
    + + +

    Parameters

    + + + + +
    + + T value +
    + + + + + + + diff --git a/doc/ref/Topten.RichTextKit.Utils.Slice[T].page b/doc/ref/Topten.RichTextKit.Utils.Slice[T].page index 15503d6..a60c5a3 100644 --- a/doc/ref/Topten.RichTextKit.Utils.Slice[T].page +++ b/doc/ref/Topten.RichTextKit.Utils.Slice[T].page @@ -59,6 +59,11 @@ import: "../.common.page"

    Properties

    + + + + + + + + diff --git a/doc/ref/Topten.RichTextKit.Utils.page b/doc/ref/Topten.RichTextKit.Utils.page index 8950821..e60825a 100644 --- a/doc/ref/Topten.RichTextKit.Utils.page +++ b/doc/ref/Topten.RichTextKit.Utils.page @@ -33,6 +33,12 @@ import: "../.common.page"

    Structs

    Empty

    A shared empty slice of type T

    +
    Item[int]

    Gets a reference to an element in the slice

    @@ -86,6 +91,11 @@ import: "../.common.page"
    Clear()

    Clears the entire slice content

    +
    Fill(T)

    Fill the slice with a specified value
    + + + +
    MappedSlice<T>

    Provides a mapped view of an underlying slice array, selecting arbitrary indicies +from the source array

    +
    Slice<T>

    Represents a slice of an array