Skip to content

Commit f5a4eaa

Browse files
committed
Update
1 parent e512a58 commit f5a4eaa

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

QRCoder/QRCodeGenerator.EncodingMode.cs

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,6 @@
1-
namespace QRCoder
1+
using System;
2+
3+
namespace QRCoder
24
{
35
public partial class QRCodeGenerator
46
{
@@ -27,7 +29,7 @@ private enum EncodingMode
2729

2830
/// <summary>
2931
/// Kanji encoding mode, which is used to encode characters from the Shift JIS character set, primarily for Japanese Kanji and Kana characters.
30-
/// One character is encoded into 13 bits.
32+
/// One character is encoded into 13 bits. This mode is not currently supported by QRCoder.
3133
/// </summary>
3234
Kanji = 8,
3335

QRCoder/QRCodeGenerator.cs

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -187,6 +187,14 @@ public static QRCodeData GenerateQrCode(byte[] binaryData, ECCLevel eccLevel)
187187
private static readonly BitArray _repeatingPattern = new BitArray(
188188
new[] { true, true, true, false, true, true, false, false, false, false, false, true, false, false, false, true });
189189

190+
/// <summary>
191+
/// Generates a QR code data structure using the provided BitArray, error correction level, and version.
192+
/// The BitArray provided is assumed to already include the count, encoding mode, and/or ECI mode information.
193+
/// </summary>
194+
/// <param name="bitArray">The BitArray containing the binary-encoded data to be included in the QR code. It should already contain the count, encoding mode, and/or ECI mode information.</param>
195+
/// <param name="eccLevel">The desired error correction level for the QR code. This impacts how much data can be recovered if damaged.</param>
196+
/// <param name="version">The version of the QR code, determining the size and complexity of the QR code data matrix.</param>
197+
/// <returns>A QRCodeData structure containing the full QR code matrix, which can be used for rendering or analysis.</returns>
190198
private static QRCodeData GenerateQrCode(BitArray bitArray, ECCLevel eccLevel, int version)
191199
{
192200
//Fill up data code word

0 commit comments

Comments
 (0)