frameworks/prison/Mainpage.dox

0001 /**
0002  * \mainpage prison Prison barcode library
0003  *
0004  * %prison is a <a href="http://qt.nokia.com">Qt</a>-based barcode abstraction layer/library and provides uniform access
0005  * to generation of barcodes with data.
0006  *
0007  * \section overview Overview
0008  *
0009  * %prison has a Prison::AbstractBarcode, which is the base class for the actual barcode generators. Prison currently implements barcode generators for the following formats:
0010  * \li QRCode
0011  * \li Data Matrix
0012  * \li Aztec
0013  * \li Code39
0014  * \li Code93
0015  * \li Code128
0016  * \li PDF417
0017  *
0018  * %prison currently ships the org.kde.prison.Barcode QML element that can be used to render barcodes in QML code.
0019  *
0020  * \section supported Supported Barcode types
0021  *
0022  * There is basically two types of barcodes:
0023  * \li barcodes that carries the data
0024  * \li barcodes that carries a lookup number, and requires a specific server to look up the actual data.
0025  *
0026  * %prison isn't as such designed for the latter, it will probably work, but patches implementing barcode
0027  * support for such barcodes will not be accepted. A example is <a href="http://en.wikipedia.org/wiki/EZcode">EZCode</a>.
0028  *
0029  * %prison is currently using <a href="https://github.com/dmtx/libdmtx">libdmtx</a> for generation of  <a href="http://en.wikipedia.org/wiki/Datamatrix">DataMatrix</a> barcodes
0030  *
0031  * %prison is currently using <a href="https://fukuchi.org/works/qrencode/">libqrencode</a> for generation of <a href="http://en.wikipedia.org/wiki/QR_Code">QRCode</a> barcodes
0032  *
0033  *
0034  * \section scanner Prison Scanner
0035  *
0036  * A barcode scanner consuming a live video feed from QtMultimedia.
0037  *
0038  * Prison's barcode scanner can be used from C++ code using the Prison::VideoScanner class, or from QML using the org.kde.prison.scanner.VideoScanner QML element.
0039  *
0040  * There are standalone QML examples in tests/scanner-qt(5|6).qml demonstrating
0041  * the QML API.
0042  *
0043  * Barcode detection is implemented using the <a href="https://github.com/nu-book/zxing-cpp">ZXing</a> library, all formats supported by ZXing can be detected.
0044  *
0045  */
0046
0047
0048 // DOXYGEN_NAME=Prison
0049 // DOXYGEN_COPYRIGHT=2010-2011 <a href='mailto:sune@vuorela.dk'>Sune Vuorela</a>
0050 // DOXYGEN_EXCLUDE = testapp