Formatting API

[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / image-loader / sync-image-loader.h

diff --git a/dali-toolkit/public-api/image-loader/sync-image-loader.h b/dali-toolkit/public-api/image-loader/sync-image-loader.h
index c065664..ae922a8 100644 (file)
--- a/dali-toolkit/public-api/image-loader/sync-image-loader.h
+++ b/dali-toolkit/public-api/image-loader/sync-image-loader.h
@@ -2,7 +2,7 @@
 #define DALI_TOOLKIT_SYNC_IMAGE_LOADER_H
 
 /*
- * Copyright (c) 2016 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2020 Samsung Electronics Co., Ltd.
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -18,19 +18,24 @@
  */
 
 // EXTERNAL INCLUDES
-#include <string>
 #include <dali/public-api/images/image-operations.h>
 #include <dali/public-api/images/pixel-data.h>
+#include <string>
+
+// INTERNAL INCLUDES
+#include <dali-toolkit/public-api/dali-toolkit-common.h>
 
 namespace Dali
 {
-
 namespace Toolkit
 {
+/**
+ * @addtogroup dali_toolkit_image_loader
+ * @{
+ */
 
 namespace SyncImageLoader
 {
-
 /**
  * @brief The methods in the SyncImageLoader namespace are used to load pixel data from a URL synchronously.
  *
@@ -49,7 +54,7 @@ namespace SyncImageLoader
  */
 
 /**
- * @brief Load an image synchronously.
+ * @brief Loads an image synchronously.
  * Note: When using this method, the following defaults will be used:
  * fittingMode = FittingMode::DEFAULT
  * samplingMode = SamplingMode::BOX_THEN_LINEAR
@@ -58,14 +63,13 @@ namespace SyncImageLoader
  * @SINCE_1_2_14
  * @REMARK_INTERNET
  * @REMARK_STORAGE
- *
- * @param[in] url The URL of the image file to load.
- * @return A PixelData object containing the image, or an invalid object on failure.
+ * @param[in] url The URL of the image file to load
+ * @return A PixelData object containing the image, or an invalid object on failure
  */
-DALI_IMPORT_API PixelData Load( const std::string& url );
+DALI_TOOLKIT_API PixelData Load(const std::string& url);
 
 /**
- * @brief Load an image synchronously by specifying the target dimensions.
+ * @brief Loads an image synchronously by specifying the target dimensions.
  * Note: When using this method, the following defaults will be used:
  * fittingMode = FittingMode::DEFAULT
  * samplingMode = SamplingMode::BOX_THEN_LINEAR
@@ -74,34 +78,35 @@ DALI_IMPORT_API PixelData Load( const std::string& url );
  * @SINCE_1_2_14
  * @REMARK_INTERNET
  * @REMARK_STORAGE
- *
- * @param[in] url The URL of the image file to load.
- * @param[in] dimensions The width and height to fit the loaded image to.
- * @return A PixelData object containing the image, or an invalid object on failure.
+ * @param[in] url The URL of the image file to load
+ * @param[in] dimensions The width and height to fit the loaded image to
+ * @return A PixelData object containing the image, or an invalid object on failure
  */
-DALI_IMPORT_API PixelData Load( const std::string& url, ImageDimensions dimensions );
+DALI_TOOLKIT_API PixelData Load(const std::string& url, ImageDimensions dimensions);
 
 /**
- * @brief Load an image synchronously by specifying the target dimensions and options.
+ * @brief Loads an image synchronously by specifying the target dimensions and options.
  * @SINCE_1_2_14
  * @REMARK_INTERNET
  * @REMARK_STORAGE
- *
- * @param[in] url The URL of the image file to load.
- * @param[in] dimensions The width and height to fit the loaded image to.
- * @param[in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter.
- * @param[in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size.
- * @param[in] orientationCorrection Reorient the image to respect any orientation metadata in its header.
- * @return A PixelData object containing the image, or an invalid object on failure.
+ * @param[in] url The URL of the image file to load
+ * @param[in] dimensions The width and height to fit the loaded image to
+ * @param[in] fittingMode The method used to fit the shape of the image before loading to the shape defined by the size parameter
+ * @param[in] samplingMode The filtering method used when sampling pixels from the input image while fitting it to desired size
+ * @param[in] orientationCorrection Reorient the image to respect any orientation metadata in its header
+ * @return A PixelData object containing the image, or an invalid object on failure
  */
-DALI_IMPORT_API PixelData Load( const std::string& url,
-                ImageDimensions dimensions,
-                FittingMode::Type fittingMode,
-                SamplingMode::Type samplingMode,
-                bool orientationCorrection );
+DALI_TOOLKIT_API PixelData Load(const std::string& url,
+                                ImageDimensions    dimensions,
+                                FittingMode::Type  fittingMode,
+                                SamplingMode::Type samplingMode,
+                                bool               orientationCorrection);
 
 } // namespace SyncImageLoader
 
+/**
+ * @}
+ */
 } // namespace Toolkit
 
 } // namespace Dali