Format code & update example

2025-04-16 18:25:57 -05:00
parent 40c941bf1b
commit 05ef848a2a
12 changed files with 835 additions and 652 deletions
@@ -30,60 +30,66 @@

 /**
 * @class QrCodeGenerator
- * @brief The QrCodeGenerator class is a simple C++ class that uses the qrcodegen library
- * to generate QR codes from QStrings in Qt applications.
+ * @brief The QrCodeGenerator class is a simple C++ class that uses the
+ * qrcodegen library to generate QR codes from QStrings in Qt applications.
 */
 class QrCodeGenerator : public QObject
 {
 public:
-    /**
-     * @brief Constructs a QrCodeGenerator object.
-     * @param parent The parent QObject.
-     */
-    explicit QrCodeGenerator(QObject *parent = nullptr);
+  /**
+   * @brief Constructs a QrCodeGenerator object.
+   * @param parent The parent QObject.
+   */
+  explicit QrCodeGenerator(QObject *parent = nullptr);

-    /**
-     * @brief Generates a QR code from the given data and error correction level.
-     * @param data The QString containing the data to encode in the QR code.
-     * @param size The desired width/height of the generated image (default: 500).
-     * @param borderSize The desired border width of the generated image (default: 1).
-     * @param errorCorrection The desired error correction level (default:
-     * qrcodegen::QrCode::Ecc::MEDIUM).
-     *
-     * @return QImage containing the generated QR code.
-     */
-    QImage generateQr(const QString &data, const quint16 size = 1000, const quint16 borderSize = 1,
-                      qrcodegen::QrCode::Ecc errorCorrection = qrcodegen::QrCode::Ecc::MEDIUM);
+  /**
+   * @brief Generates a QR code from the given data and error correction level.
+   * @param data The QString containing the data to encode in the QR code.
+   * @param size The desired width/height of the generated image (default: 500).
+   * @param borderSize The desired border width of the generated image (default:
+   * 1).
+   * @param errorCorrection The desired error correction level (default:
+   * qrcodegen::QrCode::Ecc::MEDIUM).
+   *
+   * @return QImage containing the generated QR code.
+   */
+  QImage generateQr(const QString &data, const quint16 size = 1000,
+                    const quint16 borderSize = 1,
+                    qrcodegen::QrCode::Ecc errorCorrection
+                    = qrcodegen::QrCode::Ecc::MEDIUM);

-    /**
-     * @brief Generates a QR code from the given data and error correction level.
-     * @param data The QString containing the data to encode in the QR code.
-     * @param borderSize The desired border width of the generated image (default: 1).
-     * @param errorCorrection The desired error correction level (default:
-     * qrcodegen::QrCode::Ecc::MEDIUM).
-     *
-     * @return QString string containing the generated QR code in SVG format.
-     */
-    QString generateSvgQr(const QString &data, const quint16 borderSize = 1,
-                          qrcodegen::QrCode::Ecc errorCorrection = qrcodegen::QrCode::Ecc::MEDIUM);
+  /**
+   * @brief Generates a QR code from the given data and error correction level.
+   * @param data The QString containing the data to encode in the QR code.
+   * @param borderSize The desired border width of the generated image (default:
+   * 1).
+   * @param errorCorrection The desired error correction level (default:
+   * qrcodegen::QrCode::Ecc::MEDIUM).
+   *
+   * @return QString string containing the generated QR code in SVG format.
+   */
+  QString generateSvgQr(const QString &data, const quint16 borderSize = 1,
+                        qrcodegen::QrCode::Ecc errorCorrection
+                        = qrcodegen::QrCode::Ecc::MEDIUM);

 private:
-    /**
-     * @brief Converts a qrcodegen::QrCode object to a SVG image.
-     * @param qrCode The qrcodegen::QrCode object to convert.
-     * @param border The desired border width of the generated image (default: 1).
-     *
-     * @return SVG containing the QR code.
-     */
-    QString toSvgString(const qrcodegen::QrCode &qr, quint16 border) const;
+  /**
+   * @brief Converts a qrcodegen::QrCode object to a SVG image.
+   * @param qrCode The qrcodegen::QrCode object to convert.
+   * @param border The desired border width of the generated image (default: 1).
+   *
+   * @return SVG containing the QR code.
+   */
+  QString toSvgString(const qrcodegen::QrCode &qr, quint16 border) const;

-    /**
-     * @brief Converts a qrcodegen::QrCode object to a QImage.
-     * @param qrCode The qrcodegen::QrCode object to convert.
-     * @param size The desired width/height of the generated image.
-     * @param borderSize The desired border width of the generated image.
-     *
-     * @return QImage containing the QR code.
-     */
-    QImage qrCodeToImage(const qrcodegen::QrCode &qrCode, quint16 border, const quint16 size) const;
+  /**
+   * @brief Converts a qrcodegen::QrCode object to a QImage.
+   * @param qrCode The qrcodegen::QrCode object to convert.
+   * @param size The desired width/height of the generated image.
+   * @param borderSize The desired border width of the generated image.
+   *
+   * @return QImage containing the QR code.
+   */
+  QImage qrCodeToImage(const qrcodegen::QrCode &qrCode, quint16 border,
+                       const quint16 size) const;
 };