From 4f5018c8ede117eb67f8f96a422d7d00185cba41 Mon Sep 17 00:00:00 2001 From: Michael Date: Mon, 16 Jan 2023 14:28:22 +0700 Subject: [PATCH] Add XML linking - Adds `href` links to website documentation code examples. --- .../IronSoftware.Drawing.Common/AnyBitmap.cs | 13 +++++++++++-- .../IronSoftware.Drawing.Common/Color.cs | 4 ++++ .../IronSoftware.Drawing.Common/CropRectangle.cs | 1 + .../IronSoftware.Drawing.Common/Font.cs | 4 ++++ 4 files changed, 20 insertions(+), 2 deletions(-) diff --git a/IronSoftware.Drawing/IronSoftware.Drawing.Common/AnyBitmap.cs b/IronSoftware.Drawing/IronSoftware.Drawing.Common/AnyBitmap.cs index c977259..c04c399 100644 --- a/IronSoftware.Drawing/IronSoftware.Drawing.Common/AnyBitmap.cs +++ b/IronSoftware.Drawing/IronSoftware.Drawing.Common/AnyBitmap.cs @@ -14,7 +14,7 @@ namespace IronSoftware.Drawing { /// - /// A universally compatible Bitmap format for .NET 7, .NET 6, .NET 5, and .NET Core. As well as compatiblity with Windows, NanoServer, IIS, macOS, Mobile, Xamarin, iOS, Android, Google Compute, Azure, AWS, and Linux. + /// A universally compatible Bitmap format for .NET 7, .NET 6, .NET 5, and .NET Core. As well as compatibility with Windows, NanoServer, IIS, macOS, Mobile, Xamarin, iOS, Android, Google Cloud, Azure, AWS, and Linux. /// Works nicely with popular Image and Bitmap formats such as System.Drawing.Bitmap, SkiaSharp, SixLabors.ImageSharp, Microsoft.Maui.Graphics. /// Implicit casting means that using this class to input and output Bitmap and image types from public API's gives full compatibility to all image type fully supported by Microsoft. /// Unlike System.Drawing.Bitmap this bitmap object is self-memory-managing and does not need to be explicitly 'used' or 'disposed'. @@ -69,6 +69,7 @@ public override int GetHashCode() /// /// A Base64 encoded string representation of the raw image binary data. + ///
Further Documentation:
Code Example /// /// The bitmap data as a Base64 string. /// @@ -88,6 +89,7 @@ public byte[] GetBytes() /// /// The raw image data as a + ///
Further Documentation:
Code Example /// /// public System.IO.MemoryStream GetStream() @@ -97,6 +99,7 @@ public System.IO.MemoryStream GetStream() /// /// Creates an exact duplicate + ///
Further Documentation:
Code Example /// /// public AnyBitmap Clone() @@ -106,6 +109,7 @@ public AnyBitmap Clone() /// /// Creates an exact duplicate of the cropped area. + ///
Further Documentation:
Code Example /// /// Defines the portion of this to copy. /// @@ -138,6 +142,7 @@ public byte[] ExportBytes(ImageFormat Format = ImageFormat.Default, int Lossy = /// /// Exports the Bitmap as a file encoded in the of your choice. /// Add SkiaSharp, System.Drawing.Common, or SixLabors.ImageSharp to your project to enable the encoding feature. + /// Further Documentation:
Code Example /// /// A fully qualified file path. /// An image encoding format. @@ -155,6 +160,7 @@ public void ExportFile(string File, ImageFormat Format = ImageFormat.Default, in /// /// Exports the Bitmap as a encoded in the of your choice. /// Add SkiaSharp, System.Drawing.Common, or SixLabors.ImageSharp to your project to enable the encoding feature. + /// Further Documentation:
Code Example /// /// An image encoding format. /// JPEG and WebP encoding quality (ignored for all other values of ). Higher values return larger file sizes. 0 is lowest quality, 100 is highest. @@ -486,6 +492,7 @@ public static AnyBitmap FromUri(Uri Uri) /// /// Gets colors depth, in number of bits per pixel. + ///
Further Documentation:
Code Example /// public int BitsPerPixel { @@ -496,7 +503,8 @@ public int BitsPerPixel } /// - /// Returns the number of frames in our loaded Image. Each “frame” is a page of an image such as Tiff or Gif. All other image formats return 1. + /// Returns the number of frames in our loaded Image. Each “frame” is a page of an image such as Tiff or Gif. All other image formats return 1. + ///
Further Documentation:
Code Example /// /// public int FrameCount @@ -509,6 +517,7 @@ public int FrameCount /// /// Returns all of the cloned frames in our loaded Image. Each "frame" is a page of an image such as Tiff or Gif. All other image formats return an IEnumerable of length 1. + ///
Further Documentation:
Code Example /// /// /// diff --git a/IronSoftware.Drawing/IronSoftware.Drawing.Common/Color.cs b/IronSoftware.Drawing/IronSoftware.Drawing.Common/Color.cs index 4251810..c46142a 100644 --- a/IronSoftware.Drawing/IronSoftware.Drawing.Common/Color.cs +++ b/IronSoftware.Drawing/IronSoftware.Drawing.Common/Color.cs @@ -38,6 +38,7 @@ public partial class Color /// /// Construct a new . + ///
Further Documentation:
Code Example /// /// The hexadecimal representation of the combined color components arranged in rgb, argb, rrggbb, or aarrggbb format to match web syntax. public Color(string colorcode) @@ -73,6 +74,7 @@ public Color(string colorcode) /// /// Construct a new . + ///
Further Documentation:
Code Example /// /// The alpha component. Valid values are 0 through 255. /// The red component. Valid values are 0 through 255. @@ -88,6 +90,7 @@ public Color(int alpha, int red, int green, int blue) /// /// Construct a new . + ///
Further Documentation:
Code Example /// /// The red component. Valid values are 0 through 255. /// The green component. Valid values are 0 through 255. @@ -915,6 +918,7 @@ public double GetLuminance() /// /// Gets the 32-bit ARGB value of this structure. + ///
Further Documentation:
Code Example /// /// The 32-bit ARGB value of this . public int ToArgb() diff --git a/IronSoftware.Drawing/IronSoftware.Drawing.Common/CropRectangle.cs b/IronSoftware.Drawing/IronSoftware.Drawing.Common/CropRectangle.cs index 94f4895..2063f1f 100644 --- a/IronSoftware.Drawing/IronSoftware.Drawing.Common/CropRectangle.cs +++ b/IronSoftware.Drawing/IronSoftware.Drawing.Common/CropRectangle.cs @@ -60,6 +60,7 @@ public MeasurementUnits Units /// /// Convert this crop rectangle to the specified units of measurement using the specified DPI + ///
Further Documentation:
Code Example /// /// Unit of measurement /// DPI (Dots per inch) for conversion diff --git a/IronSoftware.Drawing/IronSoftware.Drawing.Common/Font.cs b/IronSoftware.Drawing/IronSoftware.Drawing.Common/Font.cs index 6746fdc..26d64ea 100644 --- a/IronSoftware.Drawing/IronSoftware.Drawing.Common/Font.cs +++ b/IronSoftware.Drawing/IronSoftware.Drawing.Common/Font.cs @@ -69,6 +69,7 @@ public bool Strikeout /// /// Initializes a new Font that uses the specified existing FamilyName. + ///
Further Documentation:
Code Example /// /// The FontFamily of the new Font. public Font(string FamilyName) @@ -78,6 +79,7 @@ public Font(string FamilyName) /// /// Initializes a new Font that uses the specified existing FamilyName and FontStyle enumeration. + ///
Further Documentation:
Code Example /// /// The FontFamily of the new Font. /// The FontStyle to apply to the new Font. Multiple values of the FontStyle enumeration can be combined with the OR operator. @@ -89,6 +91,7 @@ public Font(string FamilyName, FontStyle Style) /// /// Initializes a new Font that uses the specified existing FamilyName, FontStyle enumeration, FontWeight, Bold, Italic and Size. + ///
Further Documentation:
Code Example /// /// The FontFamily of the new Font. /// The FontStyle to apply to the new Font. Multiple values of the FontStyle enumeration can be combined with the OR operator. @@ -102,6 +105,7 @@ public Font(string FamilyName, FontStyle Style, float Size) /// /// Initializes a new Font that uses the specified existing FamilyName, FontWeight, Bold, Italic and Size. + ///
Further Documentation:
Code Example /// /// The FontFamily of the new Font. /// The em-size of the new font in the units specified by the unit parameter.