Skip to content

Commit 5a03f05

Browse files
committed
Documentation update
1 parent e755951 commit 5a03f05

4 files changed

Lines changed: 7 additions & 6 deletions

File tree

QrCodeGenerator/QrCode.cs

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -36,8 +36,9 @@ namespace Net.Codecrete.QrCodeGenerator
3636
/// <para>
3737
/// A QR code instance can be converted to a PNG (<see cref="ToPngBitmap"/>),
3838
/// SVG (<see cref="ToSvgString"/>) or BMP <see cref="ToBmpBitmap"/>) image.
39-
/// Or the QR code can be drawn or printed with custom code. The individual
40-
/// pixels can be queried with <see cref="GetModule"/>.
39+
/// Or the QR code can be drawn or printed with custom code by either
40+
/// processing a list of rectangles covering the dark modules (<see cref="ToRectangles"/>),
41+
/// or by querying the color of individual modules with <see cref="GetModule"/>.
4142
/// </para>
4243
/// </summary>
4344
/// <remarks>

QrCodeGenerator/QrCodeGenerator.csproj

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515

1616
Core features:
1717
- Supports encoding all 40 versions (sizes) and all 4 error correction levels, as per the QR Code Model 2 standard
18-
- Output formats: Raw modules/pixels of the QR symbol, SVG, XAML path, PNG and BMP files. For other raster bitmap formats, see project home page
18+
- Output formats: List of rectangles, raw modules/pixels of the QR symbol, SVG, XAML path, PNG and BMP files. For other raster bitmap formats, see [below](#raster-images--bitmaps).
1919
- Computes optimal data segments for shortest possible representation of payload
2020
- High speed: 10x faster than comparable libraries
2121
- Open source code under the permissive MIT License

QrCodeGenerator/docs/README.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -14,12 +14,12 @@ and about 10x faster than the original implementation.
1414
Core features:
1515

1616
- Supports encoding all 40 versions (sizes) and all 4 error correction levels, as per the QR Code Model 2 standard
17-
- Output formats: Raw modules/pixels of the QR symbol, SVG, XAML path, PNG and BMP files. For other raster bitmap formats, see [below](#raster-images--bitmaps).
17+
- Output formats: List of rectangles, raw modules/pixels of the QR symbol, SVG, XAML path, PNG and BMP files. For other raster bitmap formats, see [below](#raster-images--bitmaps).
1818
- Computes optimal segment modes for smallest possible QR code.
1919
- High speed: 10x faster than comparable libraries
2020
- Open source code under the permissive *MIT License*
2121
- Built for .NET Standard 2.0 and therefore runs on most modern .NET platforms (.NET Core, .NET Framework, Mono etc.).
22-
* Available as a [NuGet package](https://www.nuget.org/packages/Net.Codecrete.QrCodeGenerator/) (named *Net.Codecrete.QrCodeGenerator*)
22+
- Available as a [NuGet package](https://www.nuget.org/packages/Net.Codecrete.QrCodeGenerator/) (named *Net.Codecrete.QrCodeGenerator*)
2323
- Example code for WinForms, WPF, ASP.NET, ImageSharp, SkiaSharp and many more
2424

2525
Advanced features:

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ and about 10x faster than the original implementation.
1414
Core features:
1515

1616
- Supports encoding all 40 versions (sizes) and all 4 error correction levels, as per the QR Code Model 2 standard
17-
- Output formats: Raw modules/pixels of the QR symbol, SVG, XAML path, PNG and BMP files. For other raster bitmap formats, see [below](#raster-images--bitmaps).
17+
- Output formats: List of rectangles, raw modules/pixels of the QR symbol, SVG, XAML path, PNG and BMP files. For other raster bitmap formats, see [below](#raster-images--bitmaps).
1818
- Computes optimal segment modes for smallest possible QR code.
1919
- High speed: 10x faster than comparable libraries
2020
- Open source code under the permissive *MIT License*

0 commit comments

Comments
 (0)