doc: update barcode

Change-Id: I0795867c79a4f27e11aace789b2cb8c1ae2eb809
Signed-off-by: Kwanghoon Son <k.son@samsung.com>

diff --git a/LICENSE.APLv2 b/LICENSE.APLv2
index 54b213e0b69596792dbe12ef7e0b03bb61b74013..2eaddd8b286847af714fe6d2700b185106bf3591 100644 (file)
--- a/LICENSE.APLv2
+++ b/LICENSE.APLv2
@@ -1,4 +1,4 @@
-Copyright (c) 2000 - 2015 Samsung Electronics Co., Ltd. All rights reserved.
+Copyright (c) 2015 - 2024 Samsung Electronics Co., Ltd. All rights reserved.
 
                                  Apache License
                            Version 2.0, January 2004

diff --git a/include/mv_barcode_detect.h b/include/mv_barcode_detect.h
index 1c47a697e49b929041d319025e6840253e42d219..62498dcf61f3c1231ddd0aca08dfd933cf959bd5 100644 (file)
--- a/include/mv_barcode_detect.h
+++ b/include/mv_barcode_detect.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd All Rights Reserved
+ * Copyright (c) 2015 - 2024 Samsung Electronics Co., Ltd All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -141,7 +141,9 @@ typedef void (*mv_barcode_detected_cb)(mv_source_h source, mv_engine_config_h en
                                                                           const mv_barcode_type_e *types, int number_of_barcodes, void *user_data);
 
 /**
- * @brief Detects barcode(s) on source and reads message from it.
+ * @brief Detects barcodes on a given media source and reads the message from the detected barcodes.
+ * This function processes the specified region of interest (ROI) within the media source to identify barcodes \n
+ * and provides the results through a callback function.
  *
  * @since_tizen 2.4
  * @param [in] source            The media source handle

diff --git a/include/mv_barcode_generate.h b/include/mv_barcode_generate.h
index 2515e7278cdf4b568c1995474774f1b1f666bded..4e2928ad79b09a606d055daf9d252d046d84a6e3 100644 (file)
--- a/include/mv_barcode_generate.h
+++ b/include/mv_barcode_generate.h
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd All Rights Reserved
+ * Copyright (c) 2015 - 2024 Samsung Electronics Co., Ltd All Rights Reserved
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -35,7 +35,7 @@ extern "C" {
  */
 
 /**
- * @brief Define MV_BARCODE_GENERATE_ATTR_TEXT to set text attribute
+ * @brief Define #MV_BARCODE_GENERATE_ATTR_TEXT to set text attribute
  *        of the engine configuration.
  *
  * @since_tizen 2.4
@@ -43,14 +43,10 @@ extern "C" {
  *
  * @see mv_barcode_generate_attr_text_e
  */
-#define MV_BARCODE_GENERATE_ATTR_TEXT \
-       "MV_BARCODE_GENERATE_ATTR_TEXT" /**< Text:
-                                                               0-invisible,
-                                                               1-visible */
+#define MV_BARCODE_GENERATE_ATTR_TEXT "MV_BARCODE_GENERATE_ATTR_TEXT" /**< Text: 0-invisible, 1-visible */
 
 /**
- * @brief Defines MV_BARCODE_GENERATE_ATTR_COLOR_FRONT to set
-                 Barcode's foreground color attribute of the engine configuration.
+ * @brief Defines #MV_BARCODE_GENERATE_ATTR_COLOR_FRONT to set Barcode's foreground color attribute of the engine configuration.
  *
  * @since_tizen 3.0
  * @remarks This attribute represents RGB color as a hex triplet with six digits.
@@ -58,8 +54,7 @@ extern "C" {
 #define MV_BARCODE_GENERATE_ATTR_COLOR_FRONT "MV_BARCODE_GENERATE_ATTR_COLOR_FRONT"
 
 /**
- * @brief Defines MV_BARCODE_GENERATE_ATTR_COLOR_BACK to set
-                 Barcode's background color attribute of the engine configuration.
+ * @brief Defines #MV_BARCODE_GENERATE_ATTR_COLOR_BACK to set Barcode's background color attribute of the engine configuration.
  *
  * @since_tizen 3.0
  * @remarks This attribute represents RGB color as a hex triplet with six digits.
@@ -67,16 +62,16 @@ extern "C" {
 #define MV_BARCODE_GENERATE_ATTR_COLOR_BACK "MV_BARCODE_GENERATE_ATTR_COLOR_BACK"
 
 /**
- * @brief Defines MV_BARCODE_GENERATE_ATTR_EMBED_IMG_PATH to set
-                 Barcode's embed image absolute path attribute of the engine configuration.
+ * @brief Defines #MV_BARCODE_GENERATE_ATTR_EMBED_IMG_PATH to set Barcode's embed image absolute path attribute of the engine configuration.
+ * The embedded image will follow the shape defined by #MV_BARCODE_GENERATE_ATTR_FINDER_SHAPE and will be resized to 1/5 of image size.
  *
  * @since_tizen 8.0
  */
 #define MV_BARCODE_GENERATE_ATTR_EMBED_IMG_PATH "MV_BARCODE_GENERATE_ATTR_EMBED_IMG_PATH"
 
 /**
- * @brief Defines MV_BARCODE_GENERATE_ATTR_DATA_SHAPE to set
-                 Barcode's data shape attribute of the engine configuration.
+ * @brief Defines #MV_BARCODE_GENERATE_ATTR_DATA_SHAPE to set Barcode's data shape attribute of the engine configuration.
+ * Note that only #MV_BARCODE_GENERATE_ATTR_SHAPE_RECT and #MV_BARCODE_GENERATE_ATTR_SHAPE_CIRCLE are supported for data shapes.
  *
  * @since_tizen 8.0
  * @see mv_barcode_generate_attr_shape_e
@@ -84,8 +79,7 @@ extern "C" {
 #define MV_BARCODE_GENERATE_ATTR_DATA_SHAPE "MV_BARCODE_GENERATE_ATTR_DATA_SHAPE"
 
 /**
- * @brief Defines MV_BARCODE_GENERATE_ATTR_FINDER_SHAPE to set
-                 Barcode's finder shape attribute of the engine configuration.
+ * @brief Defines #MV_BARCODE_GENERATE_ATTR_FINDER_SHAPE to set Barcode's finder shape attribute of the engine configuration.
  *
  * @since_tizen 8.0
  * @see mv_barcode_generate_attr_shape_e