Skip to content

Commit 4a57c42

Browse files
committed
Add EciMode comments
1 parent a32ae07 commit 4a57c42

File tree

1 file changed

+23
-0
lines changed

1 file changed

+23
-0
lines changed

QRCoder/QRCodeGenerator.EciMode.cs

Lines changed: 23 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2,11 +2,34 @@
22
{
33
public partial class QRCodeGenerator
44
{
5+
/// <summary>
6+
/// Enumerates the Extended Channel Interpretation (ECI) modes used in QR codes to handle different character encoding standards.
7+
/// ECI mode allows QR codes to efficiently encode data using character sets other than the default ISO-8859-1.
8+
/// </summary>
59
public enum EciMode
610
{
11+
/// <summary>
12+
/// Default encoding mode (typically ISO-8859-1). Used when no ECI mode is explicitly specified.
13+
/// This mode is assumed in basic QR codes where no extended character sets are needed.
14+
/// </summary>
715
Default = 0,
16+
17+
/// <summary>
18+
/// Specifies the use of the ISO-8859-1 character set, covering most Western European languages.
19+
/// This mode explicitly sets the encoding to ISO-8859-1, which includes characters used in languages such as English, French, German, and Spanish.
20+
/// </summary>
821
Iso8859_1 = 3,
22+
23+
/// <summary>
24+
/// Specifies the use of the ISO-8859-2 character set, which is primarily used for Central and Eastern European languages.
25+
/// This includes characters used in languages such as Polish, Czech, Slovak, Hungarian, and Romanian.
26+
/// </summary>
927
Iso8859_2 = 4,
28+
29+
/// <summary>
30+
/// Specifies the use of UTF-8 encoding.
31+
/// UTF-8 can encode any Unicode character and is useful for QR codes that need to support multi-language content.
32+
/// </summary>
1033
Utf8 = 26
1134
}
1235
}

0 commit comments

Comments
 (0)