Skip to content

Add IntelliSense linking to Website Code Examples #33

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
mbkrispy merged 1 commit into from
Jan 16, 2023
Merged

Add IntelliSense linking to Website Code Examples #33

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions IronSoftware.Drawing/IronSoftware.Drawing.Common/AnyBitmap.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@
namespace IronSoftware.Drawing
{
/// <summary>
/// <para>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.</para>
/// <para>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.</para>
/// <para>Works nicely with popular Image and Bitmap formats such as System.Drawing.Bitmap, SkiaSharp, SixLabors.ImageSharp, Microsoft.Maui.Graphics.</para>
/// <para>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.</para>
/// <para>Unlike System.Drawing.Bitmap this bitmap object is self-memory-managing and does not need to be explicitly 'used' or 'disposed'.</para>
Expand Down Expand Up @@ -69,6 +69,7 @@ public override int GetHashCode()

/// <summary>
/// A Base64 encoded string representation of the raw image binary data.
/// <br/><para><b>Further Documentation:</b><br/><a href="https://ironsoftware.com/open-source/csharp/drawing/examples/bitmap-to-string/">Code Example</a></para>
/// </summary>
/// <returns>The bitmap data as a Base64 string.</returns>
/// <seealso cref="System.Convert.ToBase64String(byte[])"/>
Expand All @@ -88,6 +89,7 @@ public byte[] GetBytes()

/// <summary>
/// The raw image data as a <see cref="System.IO.MemoryStream"/>
/// <br/><para><b>Further Documentation:</b><br/><a href="https://ironsoftware.com/open-source/csharp/drawing/examples/bitmap-to-stream/">Code Example</a></para>
/// </summary>
/// <returns><see cref="System.IO.MemoryStream"/></returns>
public System.IO.MemoryStream GetStream()
Expand All @@ -97,6 +99,7 @@ public System.IO.MemoryStream GetStream()

/// <summary>
/// Creates an exact duplicate <see cref="AnyBitmap"/>
/// <br/><para><b>Further Documentation:</b><br/><a href="https://ironsoftware.com/open-source/csharp/drawing/examples/clone-anybitmap/">Code Example</a></para>
/// </summary>
/// <returns></returns>
public AnyBitmap Clone()
Expand All @@ -106,6 +109,7 @@ public AnyBitmap Clone()

/// <summary>
/// Creates an exact duplicate <see cref="AnyBitmap"/> of the cropped area.
/// <br/><para><b>Further Documentation:</b><br/><a href="https://ironsoftware.com/open-source/csharp/drawing/examples/clone-anybitmap/">Code Example</a></para>
/// </summary>
/// <param name="Rectangle">Defines the portion of this <see cref="AnyBitmap"/> to copy.</param>
/// <returns></returns>
Expand Down Expand Up @@ -138,6 +142,7 @@ public byte[] ExportBytes(ImageFormat Format = ImageFormat.Default, int Lossy =
/// <summary>
/// Exports the Bitmap as a file encoded in the <see cref="ImageFormat"/> of your choice.
/// <para>Add SkiaSharp, System.Drawing.Common, or SixLabors.ImageSharp to your project to enable the encoding feature.</para>
/// <para><b>Further Documentation:</b><br/><a href="https://ironsoftware.com/open-source/csharp/drawing/examples/export-anybitmap/">Code Example</a></para>
/// </summary>
/// <param name="File">A fully qualified file path.</param>
/// <param name="Format">An image encoding format.</param>
Expand All @@ -155,6 +160,7 @@ public void ExportFile(string File, ImageFormat Format = ImageFormat.Default, in
/// <summary>
/// Exports the Bitmap as a <see cref="MemoryStream"/> encoded in the <see cref="ImageFormat"/> of your choice.
/// <para>Add SkiaSharp, System.Drawing.Common, or SixLabors.ImageSharp to your project to enable the encoding feature.</para>
/// <para><b>Further Documentation:</b><br/><a href="https://ironsoftware.com/open-source/csharp/drawing/examples/bitmap-to-stream/">Code Example</a></para>
/// </summary>
/// <param name="Format">An image encoding format.</param>
/// <param name="Lossy">JPEG and WebP encoding quality (ignored for all other values of <see cref="ImageFormat"/>). Higher values return larger file sizes. 0 is lowest quality, 100 is highest.</param>
Expand Down Expand Up @@ -486,6 +492,7 @@ public static AnyBitmap FromUri(Uri Uri)

/// <summary>
/// Gets colors depth, in number of bits per pixel.
/// <br/><para><b>Further Documentation:</b><br/><a href="https://ironsoftware.com/open-source/csharp/drawing/examples/get-color-depth/">Code Example</a></para>
/// </summary>
public int BitsPerPixel
{
Expand All @@ -496,7 +503,8 @@ public int BitsPerPixel
}

/// <summary>
/// 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.
/// <br/><para><b>Further Documentation:</b><br/><a href="https://ironsoftware.com/open-source/csharp/drawing/examples/get-number-of-frames-in-anybitmap/">Code Example</a></para>
/// </summary>
/// <seealso cref="GetAllFrames" />
public int FrameCount
Expand All @@ -509,6 +517,7 @@ public int FrameCount

/// <summary>
/// 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.
/// <br/><para><b>Further Documentation:</b><br/><a href="https://ironsoftware.com/open-source/csharp/drawing/examples/get-frame-from-anybitmap/">Code Example</a></para>
/// </summary>
/// <seealso cref="FrameCount" />
/// <seealso cref="System.Linq" />
Expand Down
4 changes: 4 additions & 0 deletions IronSoftware.Drawing/IronSoftware.Drawing.Common/Color.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,7 @@ public partial class Color

/// <summary>
/// Construct a new <see cref="Color"/>.
/// <br/><para><b>Further Documentation:</b><br/><a href="https://ironsoftware.com/open-source/csharp/drawing/examples/create-color/">Code Example</a></para>
/// </summary>
/// <param name="colorcode">The hexadecimal representation of the combined color components arranged in rgb, argb, rrggbb, or aarrggbb format to match web syntax.</param>
public Color(string colorcode)
Expand Down Expand Up @@ -73,6 +74,7 @@ public Color(string colorcode)

/// <summary>
/// Construct a new <see cref="Color"/>.
/// <br/><para><b>Further Documentation:</b><br/><a href="https://ironsoftware.com/open-source/csharp/drawing/examples/create-color/">Code Example</a></para>
/// </summary>
/// <param name="alpha">The alpha component. Valid values are 0 through 255.</param>
/// <param name="red">The red component. Valid values are 0 through 255.</param>
Expand All @@ -88,6 +90,7 @@ public Color(int alpha, int red, int green, int blue)

/// <summary>
/// Construct a new <see cref="Color"/>.
/// <br/><para><b>Further Documentation:</b><br/><a href="https://ironsoftware.com/open-source/csharp/drawing/examples/create-color/">Code Example</a></para>
/// </summary>
/// <param name="red">The red component. Valid values are 0 through 255.</param>
/// <param name="green">The green component. Valid values are 0 through 255.</param>
Expand Down Expand Up @@ -915,6 +918,7 @@ public double GetLuminance()

/// <summary>
/// Gets the 32-bit ARGB value of this <see cref="Color"/> structure.
/// <br/><para><b>Further Documentation:</b><br/><a href="https://ironsoftware.com/open-source/csharp/drawing/examples/convert-color-to-32-bit-argb-value/">Code Example</a></para>
/// </summary>
/// <returns>The 32-bit ARGB value of this <see cref="Color"/>.</returns>
public int ToArgb()
Expand Down
1 change: 1 addition & 0 deletions IronSoftware.Drawing/IronSoftware.Drawing.Common/CropRectangle.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -60,6 +60,7 @@ public MeasurementUnits Units

/// <summary>
/// Convert this crop rectangle to the specified units of measurement using the specified DPI
/// <br/><para><b>Further Documentation:</b><br/><a href="https://ironsoftware.com/open-source/csharp/drawing/examples/convert-measurement-unit-of-croprectangle/">Code Example</a></para>
/// </summary>
/// <param name="units">Unit of measurement</param>
/// <param name="dpi">DPI (Dots per inch) for conversion</param>
Expand Down
4 changes: 4 additions & 0 deletions IronSoftware.Drawing/IronSoftware.Drawing.Common/Font.cs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,7 @@ public bool Strikeout

/// <summary>
/// Initializes a new Font that uses the specified existing FamilyName.
/// <br/><para><b>Further Documentation:</b><br/><a href="https://ironsoftware.com/open-source/csharp/drawing/examples/create-and-cast-font/">Code Example</a></para>
/// </summary>
/// <param name="FamilyName">The FontFamily of the new Font.</param>
public Font(string FamilyName)
Expand All @@ -78,6 +79,7 @@ public Font(string FamilyName)

/// <summary>
/// Initializes a new Font that uses the specified existing FamilyName and FontStyle enumeration.
/// <br/><para><b>Further Documentation:</b><br/><a href="https://ironsoftware.com/open-source/csharp/drawing/examples/create-and-cast-font/">Code Example</a></para>
/// </summary>
/// <param name="FamilyName">The FontFamily of the new Font.</param>
/// <param name="Style">The FontStyle to apply to the new Font. Multiple values of the FontStyle enumeration can be combined with the OR operator.</param>
Expand All @@ -89,6 +91,7 @@ public Font(string FamilyName, FontStyle Style)

/// <summary>
/// Initializes a new Font that uses the specified existing FamilyName, FontStyle enumeration, FontWeight, Bold, Italic and Size.
/// <br/><para><b>Further Documentation:</b><br/><a href="https://ironsoftware.com/open-source/csharp/drawing/examples/create-and-cast-font/">Code Example</a></para>
/// </summary>
/// <param name="FamilyName">The FontFamily of the new Font.</param>
/// <param name="Style">The FontStyle to apply to the new Font. Multiple values of the FontStyle enumeration can be combined with the OR operator.</param>
Expand All @@ -102,6 +105,7 @@ public Font(string FamilyName, FontStyle Style, float Size)

/// <summary>
/// Initializes a new Font that uses the specified existing FamilyName, FontWeight, Bold, Italic and Size.
/// <br/><para><b>Further Documentation:</b><br/><a href="https://ironsoftware.com/open-source/csharp/drawing/examples/create-and-cast-font/">Code Example</a></para>
/// </summary>
/// <param name="FamilyName">The FontFamily of the new Font.</param>
/// <param name="Size">The em-size of the new font in the units specified by the unit parameter.</param>
Expand Down