Skip to content
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.

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

Add code comments to QR code generation #517

Merged
merged 16 commits into from
May 6, 2024
Prev Previous commit
Next Next commit
Add EciMode comments
  • Loading branch information
Shane32 committed May 4, 2024
commit 4a57c424d960be884b5929595387aec1f56a96e9
23 changes: 23 additions & 0 deletions QRCoder/QRCodeGenerator.EciMode.cs
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 2,34 @@
{
public partial class QRCodeGenerator
{
/// <summary>
/// Enumerates the Extended Channel Interpretation (ECI) modes used in QR codes to handle different character encoding standards.
/// ECI mode allows QR codes to efficiently encode data using character sets other than the default ISO-8859-1.
/// </summary>
public enum EciMode
{
/// <summary>
/// Default encoding mode (typically ISO-8859-1). Used when no ECI mode is explicitly specified.
/// This mode is assumed in basic QR codes where no extended character sets are needed.
/// </summary>
Default = 0,

/// <summary>
/// Specifies the use of the ISO-8859-1 character set, covering most Western European languages.
/// This mode explicitly sets the encoding to ISO-8859-1, which includes characters used in languages such as English, French, German, and Spanish.
/// </summary>
Iso8859_1 = 3,

/// <summary>
/// Specifies the use of the ISO-8859-2 character set, which is primarily used for Central and Eastern European languages.
/// This includes characters used in languages such as Polish, Czech, Slovak, Hungarian, and Romanian.
/// </summary>
Iso8859_2 = 4,

/// <summary>
/// Specifies the use of UTF-8 encoding.
/// UTF-8 can encode any Unicode character and is useful for QR codes that need to support multi-language content.
/// </summary>
Utf8 = 26
}
}
Expand Down
Loading