examples/common/QRCode/repo/java/src/main/java/io/nayuki/qrcodegen/package-info.java

   1 /**
   2  * Generates QR Codes from text strings and byte arrays.
   3  *
   4  * <p>This project aims to be the best, clearest QR Code generator library. The primary goals are flexible options and absolute correctness. Secondary goals are compact implementation size and good documentation comments.</p>
   5  * <p>Home page with live JavaScript demo, extensive descriptions, and competitor comparisons: <a href="https://www.nayuki.io/page/qr-code-generator-library">https://www.nayuki.io/page/qr-code-generator-library</a></p>
   6  *
   7  * <h2>Features</h2>
   8  * <p>Core features:</p>
   9  * <ul>
  10  *   <li><p>Available in 6 programming languages, all with nearly equal functionality: Java, TypeScript/JavaScript, Python, Rust, C++, C</p></li>
  11  *   <li><p>Significantly shorter code but more documentation comments compared to competing libraries</p></li>
  12  *   <li><p>Supports encoding all 40 versions (sizes) and all 4 error correction levels, as per the QR Code Model 2 standard</p></li>
  13  *   <li><p>Output formats: Raw modules/pixels of the QR symbol, SVG XML string, {@code BufferedImage} raster bitmap</p></li>
  14  *   <li><p>Encodes numeric and special-alphanumeric text in less space than general text</p></li>
  15  *   <li><p>Open source code under the permissive MIT License</p></li>
  16  * </ul>
  17  * <p>Manual parameters:</p>
  18  * <ul>
  19  *   <li><p>User can specify minimum and maximum version numbers allowed, then library will automatically choose smallest version in the range that fits the data</p></li>
  20  *   <li><p>User can specify mask pattern manually, otherwise library will automatically evaluate all 8 masks and select the optimal one</p></li>
  21  *   <li><p>User can specify absolute error correction level, or allow the library to boost it if it doesn't increase the version number</p></li>
  22  *   <li><p>User can create a list of data segments manually and add ECI segments</p></li>
  23  * </ul>
  24  * <p>Optional advanced features:</p>
  25  * <ul>
  26  *   <li><p>Encodes Japanese Unicode text in kanji mode to save a lot of space compared to UTF-8 bytes</p></li>
  27  *   <li><p>Computes optimal segment mode switching for text with mixed numeric/alphanumeric/general/kanji parts</p></li>
  28  * </ul>
  29  *
  30  * <h2>Examples</h2>
  31  * <p>Simple operation:</p>
  32  * <pre style="margin-left:2em">import java.awt.image.BufferedImage;
  33  *import java.io.File;
  34  *import javax.imageio.ImageIO;
  35  *import io.nayuki.qrcodegen.*;
  36  *
  37  *QrCode qr = QrCode.encodeText("Hello, world!", QrCode.Ecc.MEDIUM);
  38  *BufferedImage img = qr.toImage(4, 10);
  39  *ImageIO.write(img, "png", new File("qr-code.png"));</pre>
  40  * <p>Manual operation:</p>
  41  * <pre style="margin-left:2em">import java.util.List;
  42  *import io.nayuki.qrcodegen.*;
  43  *
  44  *List&lt;QrSegment&gt; segs = QrSegment.makeSegments("3141592653589793238462643383");
  45  *QrCode qr = QrCode.encodeSegments(segs, QrCode.Ecc.HIGH, 5, 5, 2, false);
  46  *for (int y = 0; y &lt; qr.size; y++) {
  47  *    for (int x = 0; x &lt; qr.size; x++) {
  48  *        (... paint qr.getModule(x, y) ...)
  49  *    }
  50  *}</pre>
  51  */
  52 package io.nayuki.qrcodegen;