/**
* Initializes this instance of %QRCodeGenerator. @n
- * Every application must call %Construct() before calling any other methods of %QRCodeGenerator.
+ * Every application must call the %Construct() method before calling any other method of %QRCodeGenerator.
*
* @since 2.1
*
* @feature %http://tizen.org/feature/vision.qrcode_generation
*
- * @exception E_SUCCESS The method is successful.
+ * @exception E_SUCCESS The method is successful.
* @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature.
- * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
- * @remarks Before calling this method, check whether the feature is supported by
- * Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
+ * For more information, see <a href="../org.tizen.gettingstarted/html/tizen_overview/application_filtering.htm">Application Filtering</a>.
+ * @remarks Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&).
*/
result Construct(void);
/**
- * Gets a list of supported image file formats.
+ * Gets the list of supported image file formats.
*
* @since 2.1
*
- * @return A list of supported image file formats
+ * @return The list of supported image file formats
*/
static Tizen::Base::Collection::IListT<Tizen::Media::ImageFormat>* GetSupportedImageFileFormatsListN(void);
/**
- * Encodes a QR code into a file.
+ * Encodes the QR code into the file.
*
* @since 2.1
*
* @return An error code
- * @param[in] message The text to encode to QR code image
- * @param[in] mode The input text encoding format (@c QR_CODE_MODE_ALPHANUMERIC, @c QR_CODE_MODE_BYTE, @c QR_CODE_MODE_UTF8)
+ * @param[in] message The text used to encode the QR code image
+ * @param[in] mode The input text encoding format (@c QR_CODE_MODE_ALPHANUMERIC, @c QR_CODE_MODE_BYTE, or @c QR_CODE_MODE_UTF8)
* @param[in] errorCorrectionLevel The QR code error correction level
- * @param[in] compatibility The compatibility mode with zxing library for UTF-8 codes mode when mode is selected with @c QR_MODE_UTF8
+ * @param[in] compatibility The compatibility mode with the zxing library for the UTF-8 codes mode, which is activated when the mode selected is @c QR_MODE_UTF8
* @param[in] imageFilePath The file path of the generated QR code image
* @param[in] imageFormat The image file format of the generated QR code image
* @param[out] width The width of the generated QR code image
* @exception E_INVALID_ARG A specified input parameter is invalid.
* @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed.
*
- * @remarks QR code encoding for UTF-8 is not standardized as yet.
- * So we support UTF-8 encoding/decoding compatibility to zxing(http://code.google.com/p/zxing/) library.
+ * @remarks The QR code encoding for the UTF-8 codes mode is not standardized as yet,
+ * so the UTF-8 encoding/decoding compatibility with the zxing(http://code.google.com/p/zxing/) library is currently supported.
*/
result EncodeToFile(const Tizen::Base::String& message, QrCodeMode mode, QrCodeErrorCorrectionLevel errorCorrectionLevel, bool compatibility, const Tizen::Base::String& imageFilePath, Tizen::Media::ImageFormat imageFormat, int& width, int& height);
/**
- * Encodes a QR code into a byte buffer.
+ * Encodes the QR code into the byte buffer.
*
* @since 2.1
*
- * @return A pointer to the Tizen::Base::ByteBuffer instance containing the generated QR code image
- * @param[in] message The text to encode to QR code image
- * @param[in] mode The input text encoding format (@c QR_CODE_MODE_ALPHANUMERIC, @c QR_CODE_MODE_BYTE, @c QR_CODE_MODE_UTF8)
+ * @return A pointer to the Tizen::Base::ByteBuffer instance that contains the generated QR code image
+ * @param[in] message The text used to encode the QR code image
+ * @param[in] mode The input text encoding format (@c QR_CODE_MODE_ALPHANUMERIC, @c QR_CODE_MODE_BYTE, or @c QR_CODE_MODE_UTF8)
* @param[in] error_level The QR code error correction level
- * @param[in] compatibility The compatibility mode with zxing library for UTF-8 codes mode when mode is selected with @c QR_CODE_MODE_UTF8
+ * @param[in] compatibility The compatibility mode with the zxing library for the UTF-8 codes mode, which is activated when the mode selected is @c QR_CODE_MODE_UTF8
* @param[out] width The width of the generated QR code image
* @param[out] height The height of the generated QR code image
* @exception E_SUCCESS The method is successful.
* @exception E_INVALID_ARG A specified input parameter is invalid.
*
- * @remarks QR code encoding for UTF-8 is not standardized as yet.
- * So we support UTF-8 encoding/decoding compatibility to zxing(http://code.google.com/p/zxing/) library.
+ * @remarks The QR code encoding for the UTF-8 codes mode is not standardized as yet,
+ * so the UTF-8 encoding/decoding compatibility with the zxing(http://code.google.com/p/zxing/) library is currently supported.
*/
Tizen::Base::ByteBuffer* EncodeToBufferN(const Tizen::Base::String& message, QrCodeMode mode, QrCodeErrorCorrectionLevel error_level, bool compatibility, int& width, int& height);
projects / framework / osp / vision.git / blobdiff