Skip to content

Commit

Permalink
Re-generated the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@mattleibow
mattleibow committed Nov 17, 2018
1 parent a2f2d35 commit f37999c
Show file tree
Hide file tree
Showing 15 changed files with 2,461 additions and 55 deletions.
18 changes: 18 additions & 0 deletions cake/UpdateDocs.cake
View file
Expand Up @@ -305,6 +305,18 @@ Task ("docs-format-docs")
}
}
// remove the no-longer-obsolete document members
if (xdoc.Root.Name == "Type" && xdoc.Root.Attribute ("Name")?.Value == "SKDocument") {
xdoc.Root
.Elements ("Members")
.Elements ("Member")
.Where (e => e.Attribute ("MemberName")?.Value == "CreatePdf")
.Where (e => e.Elements ("MemberSignature").All (s => s.Attribute ("Value")?.Value != "M:SkiaSharp.SKDocument.CreatePdf(SkiaSharp.SKWStream,SkiaSharp.SKDocumentPdfMetadata,System.Single)"))
.SelectMany (e => e.Elements ("Attributes").Elements ("Attribute").Elements ("AttributeName"))
.Where (e => e.Value.Contains ("System.Obsolete"))
.Remove ();
}
// remove empty FrameworkAlternate elements
var emptyAlts = xdoc.Root
.Descendants ()
Expand All @@ -316,6 +328,12 @@ Task ("docs-format-docs")
}
}
// remove empty Attribute elements
xdoc.Root
.Descendants ("Attribute")
.Where (e => !e.Elements ().Any ())
.Remove ();
// count the types without docs
var typesWithDocs = xdoc.Root
.Elements ("Docs");
Expand Down
13 changes: 13 additions & 0 deletions changelogs/SkiaSharp/1.68.0/SkiaSharp.breaking.md
View file
Expand Up @@ -147,7 +147,10 @@ Modified methods:

```diff
public SKDocument CreatePdf (SKWStream stream, float dpi--- = 72---)
public SKDocument CreatePdf (string path, float dpi--- = 72---)
public SKDocument CreatePdf (SKWStream stream, SKDocumentPdfMetadata metadata, float dpi--- = 72---)
public SKDocument CreateXps (SKWStream stream, float dpi--- = 72---)
public SKDocument CreateXps (string path, float dpi--- = 72---)
```


Expand Down Expand Up @@ -185,6 +188,16 @@ protected virtual bool OnUseEncodedData (IntPtr data, IntPtr length);
```


#### Type Changed: SkiaSharp.SKPaint

Modified methods:

```diff
public bool GetFillPath (SKPath src, SKPath dst, float resScale--- = 1---)
public bool GetFillPath (SKPath src, SKPath dst, SKRect cullRect, float resScale--- = 1---)
```


#### Type Changed: SkiaSharp.SKPathEffect

Removed method:
Expand Down
191 changes: 183 additions & 8 deletions changelogs/SkiaSharp/1.68.0/SkiaSharp.md
View file
Expand Up @@ -184,6 +184,15 @@ public bool TryAllocPixels (SKImageInfo info, int rowBytes);
```


#### Type Changed: SkiaSharp.SKCanvas

Added method:

```csharp
public void DrawText (SKTextBlob text, float x, float y, SKPaint paint);
```


#### Type Changed: SkiaSharp.SKCodec

Removed property:
Expand Down Expand Up @@ -341,27 +350,64 @@ Rgba1010102 = 7,

#### Type Changed: SkiaSharp.SKDocument

Obsoleted methods:
Modified methods:

```diff
[Obsolete ("Use CreatePdf(SKWStream) instead.")]
public static SKDocument CreatePdf (SKWStream stream, float dpi);
[Obsolete ("Use CreatePdf(SKWStream, SKDocumentPdfMetadata) instead.")]
public static SKDocument CreatePdf (SKWStream stream, SKDocumentPdfMetadata metadata, float dpi);
public SKDocument CreatePdf (SKWStream stream, float dpi--- = 72---)
public SKDocument CreatePdf (string path, float dpi--- = 72---)
public SKDocument CreatePdf (SKWStream stream, SKDocumentPdfMetadata metadata, float dpi--- = 72---)
public SKDocument CreateXps (SKWStream stream, float dpi--- = 72---)
public SKDocument CreateXps (string path, float dpi--- = 72---)
```

Modified methods:
Obsoleted methods:

```diff
public SKDocument CreatePdf (SKWStream stream, float dpi--- = 72---)
public SKDocument CreatePdf (SKWStream stream, SKDocumentPdfMetadata metadata, float dpi--- = 72---)
[Obsolete ("Use CreatePdf(SKWStream, SKDocumentPdfMetadata) instead.")]
public static SKDocument CreatePdf (SKWStream stream, SKDocumentPdfMetadata metadata, float dpi);
```

Added methods:

```csharp
public static SKDocument CreatePdf (SKWStream stream);
public static SKDocument CreatePdf (System.IO.Stream stream);
public static SKDocument CreatePdf (string path);
public static SKDocument CreatePdf (SKWStream stream, SKDocumentPdfMetadata metadata);
public static SKDocument CreatePdf (System.IO.Stream stream, SKDocumentPdfMetadata metadata);
public static SKDocument CreatePdf (System.IO.Stream stream, float dpi);
public static SKDocument CreatePdf (string path, SKDocumentPdfMetadata metadata);
public static SKDocument CreateXps (SKWStream stream);
public static SKDocument CreateXps (System.IO.Stream stream);
public static SKDocument CreateXps (string path);
public static SKDocument CreateXps (System.IO.Stream stream, float dpi);
```


#### Type Changed: SkiaSharp.SKDocumentPdfMetadata

Added constructors:

```csharp
public SKDocumentPdfMetadata (int encodingQuality);
public SKDocumentPdfMetadata (float rasterDpi);
public SKDocumentPdfMetadata (float rasterDpi, int encodingQuality);
```

Added fields:

```csharp
public static SKDocumentPdfMetadata Default;
public static const int DefaultEncodingQuality;
public static const float DefaultRasterDpi;
```

Added properties:

```csharp
public int EncodingQuality { get; set; }
public bool PdfA { get; set; }
public float RasterDpi { get; set; }
```


Expand Down Expand Up @@ -576,6 +622,52 @@ public static SKMaskFilter CreateBlur (SKBlurStyle blurStyle, float sigma, SKRec
```


#### Type Changed: SkiaSharp.SKPaint

Modified methods:

```diff
public bool GetFillPath (SKPath src, SKPath dst, float resScale--- = 1---)
public bool GetFillPath (SKPath src, SKPath dst, SKRect cullRect, float resScale--- = 1---)
```

Added methods:

```csharp
public bool ContainsGlyphs (byte[] text);
public bool ContainsGlyphs (string text);
public bool ContainsGlyphs (IntPtr text, int length);
public int CountGlyphs (byte[] text);
public int CountGlyphs (string text);
public int CountGlyphs (IntPtr text, int length);
public SKPath GetFillPath (SKPath src);
public bool GetFillPath (SKPath src, SKPath dst);
public SKPath GetFillPath (SKPath src, SKRect cullRect);
public SKPath GetFillPath (SKPath src, float resScale);
public bool GetFillPath (SKPath src, SKPath dst, SKRect cullRect);
public SKPath GetFillPath (SKPath src, SKRect cullRect, float resScale);
public float[] GetGlyphWidths (byte[] text);
public float[] GetGlyphWidths (string text);
public float[] GetGlyphWidths (byte[] text, out SKRect[] bounds);
public float[] GetGlyphWidths (IntPtr text, int length);
public float[] GetGlyphWidths (string text, out SKRect[] bounds);
public float[] GetGlyphWidths (IntPtr text, int length, out SKRect[] bounds);
public ushort[] GetGlyphs (byte[] text);
public ushort[] GetGlyphs (string text);
public ushort[] GetGlyphs (IntPtr text, int length);
public float[] GetHorizontalTextIntercepts (byte[] text, float[] xpositions, float y, float upperBounds, float lowerBounds);
public float[] GetHorizontalTextIntercepts (string text, float[] xpositions, float y, float upperBounds, float lowerBounds);
public float[] GetHorizontalTextIntercepts (IntPtr text, int length, float[] xpositions, float y, float upperBounds, float lowerBounds);
public float[] GetPositionedTextIntercepts (byte[] text, SKPoint[] positions, float upperBounds, float lowerBounds);
public float[] GetPositionedTextIntercepts (string text, SKPoint[] positions, float upperBounds, float lowerBounds);
public float[] GetPositionedTextIntercepts (IntPtr text, int length, SKPoint[] positions, float upperBounds, float lowerBounds);
public float[] GetTextIntercepts (SKTextBlob text, float upperBounds, float lowerBounds);
public float[] GetTextIntercepts (byte[] text, float x, float y, float upperBounds, float lowerBounds);
public float[] GetTextIntercepts (string text, float x, float y, float upperBounds, float lowerBounds);
public float[] GetTextIntercepts (IntPtr text, int length, float x, float y, float upperBounds, float lowerBounds);
```


#### Type Changed: SkiaSharp.SKPath

Added properties:
Expand All @@ -592,6 +684,7 @@ Added methods:
```csharp
public SKPoint[] GetLine ();
public SKRect GetOvalBounds ();
public SKRect GetRect ();
public SKRect GetRect (out bool isClosed, out SKPathDirection direction);
public SKRoundRect GetRoundRect ();
```
Expand Down Expand Up @@ -701,6 +794,46 @@ public bool ScalePixels (SKPixmap destination, SKFilterQuality quality);
```


#### Type Changed: SkiaSharp.SKPoint

Added properties:

```csharp
public float Length { get; }
public float LengthSquared { get; }
```

Added methods:

```csharp
public static float Distance (SKPoint point, SKPoint other);
public static float DistanceSquared (SKPoint point, SKPoint other);
public static SKPoint Normalize (SKPoint point);
public static SKPoint Reflect (SKPoint point, SKPoint normal);
```


#### Type Changed: SkiaSharp.SKPointI

Added methods:

```csharp
public static float Distance (SKPointI point, SKPointI other);
public static float DistanceSquared (SKPointI point, SKPointI other);
public static SKPointI Normalize (SKPointI point);
public static SKPointI Reflect (SKPointI point, SKPointI normal);
```


#### Type Changed: SkiaSharp.SKRectI

Added method:

```csharp
public bool IntersectsWithInclusive (SKRectI rect);
```


#### Type Changed: SkiaSharp.SKRoundRect

Added property:
Expand Down Expand Up @@ -1104,6 +1237,48 @@ public sealed delegate SKSurfaceReleaseDelegate : System.MulticastDelegate, Syst
}
```

#### New Type: SkiaSharp.SKTextBlob

```csharp
public class SKTextBlob : SkiaSharp.SKObject, System.IDisposable {
// properties
public SKRect Bounds { get; }
public uint UniqueId { get; }
// methods
protected override void Dispose (bool disposing);
}
```

#### New Type: SkiaSharp.SKTextBlobBuilder

```csharp
public class SKTextBlobBuilder : SkiaSharp.SKObject, System.IDisposable {
// constructors
public SKTextBlobBuilder ();
// methods
public void AddHorizontalRun (SKPaint font, float y, ushort[] glyphs, float[] positions);
public void AddHorizontalRun (SKPaint font, float y, ushort[] glyphs, float[] positions, SKRect bounds);
public void AddHorizontalRun (SKPaint font, float y, ushort[] glyphs, float[] positions, byte[] utf8Text, uint[] clusters);
public void AddHorizontalRun (SKPaint font, float y, ushort[] glyphs, float[] positions, string text, uint[] clusters);
public void AddHorizontalRun (SKPaint font, float y, ushort[] glyphs, float[] positions, byte[] utf8Text, uint[] clusters, SKRect bounds);
public void AddHorizontalRun (SKPaint font, float y, ushort[] glyphs, float[] positions, string text, uint[] clusters, SKRect bounds);
public void AddPositionedRun (SKPaint font, ushort[] glyphs, SKPoint[] positions);
public void AddPositionedRun (SKPaint font, ushort[] glyphs, SKPoint[] positions, SKRect bounds);
public void AddPositionedRun (SKPaint font, ushort[] glyphs, SKPoint[] positions, byte[] utf8Text, uint[] clusters);
public void AddPositionedRun (SKPaint font, ushort[] glyphs, SKPoint[] positions, string text, uint[] clusters);
public void AddPositionedRun (SKPaint font, ushort[] glyphs, SKPoint[] positions, byte[] utf8Text, uint[] clusters, SKRect bounds);
public void AddPositionedRun (SKPaint font, ushort[] glyphs, SKPoint[] positions, string text, uint[] clusters, SKRect bounds);
public void AddRun (SKPaint font, float x, float y, ushort[] glyphs);
public void AddRun (SKPaint font, float x, float y, ushort[] glyphs, SKRect bounds);
public void AddRun (SKPaint font, float x, float y, ushort[] glyphs, byte[] utf8Text, uint[] clusters);
public void AddRun (SKPaint font, float x, float y, ushort[] glyphs, string text, uint[] clusters);
public void AddRun (SKPaint font, float x, float y, ushort[] glyphs, byte[] utf8Text, uint[] clusters, SKRect bounds);
public void AddRun (SKPaint font, float x, float y, ushort[] glyphs, string text, uint[] clusters, SKRect bounds);
public SKTextBlob Build ();
protected override void Dispose (bool disposing);
}
```

#### New Type: SkiaSharp.SKTrimPathEffectMode

```csharp
Expand Down

0 comments on commit f37999c

Please sign in to comment.