DALi Version 1.3.49
[platform/core/uifw/dali-toolkit.git] / dali-toolkit / public-api / enums.h
index f3f893f..08c922f 100644 (file)
@@ -2,7 +2,7 @@
 #define __DALI_TOOLKIT_ENUMS_H__
 
 /*
- * Copyright (c) 2015 Samsung Electronics Co., Ltd.
+ * Copyright (c) 2018 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.
  */
 
 // INTERNAL INCLUDES
-#include <dali/public-api/common/dali-common.h>
+#include <dali-toolkit/public-api/dali-toolkit-common.h>
 
 namespace Dali
 {
 /**
  * @brief DALi Toolkit namespace.
+ * @SINCE_1_0.0
  */
 namespace Toolkit
 {
@@ -35,38 +36,41 @@ namespace Toolkit
 
 /**
  * @brief Control Orientation namespace.
+ * @SINCE_1_0.0
  */
 namespace ControlOrientation
 {
 
 /**
- * @brief The internal orientation of a control.
+ * @brief Enumeration for the internal orientation of a control.
+ * @SINCE_1_0.0
  */
 enum Type
 {
-  Up,   ///< The contents of control are in a vertical layout, from top to bottom
-  Left, ///< The contents of control are in a horizontal layout, from left to right
-  Down, ///< The contents of control are in a vertical layout, from bottom to top
-  Right ///< The contents of control are in a horizontal layout, from right to left
+  Up,   ///< The contents of control are in a vertical layout, from top to bottom @SINCE_1_0.0
+  Left, ///< The contents of control are in a horizontal layout, from left to right @SINCE_1_0.0
+  Down, ///< The contents of control are in a vertical layout, from bottom to top @SINCE_1_0.0
+  Right ///< The contents of control are in a horizontal layout, from right to left @SINCE_1_0.0
 };
 
 } // namespace ControlOrientation
 
 /**
- * @brief Query whether an orientation is vertical.
+ * @brief Queries whether an orientation is vertical.
  *
- * @param[in] orientation The orientation.
- * @return True if the orientation is vertical.
+ * @param[in] orientation The orientation
+ * @return true if the orientation is vertical
  */
-DALI_IMPORT_API bool IsVertical(ControlOrientation::Type orientation);
+DALI_TOOLKIT_API bool IsVertical(ControlOrientation::Type orientation);
 
 /**
- * @brief Query whether an orientation is horizontal.
+ * @brief Queries whether an orientation is horizontal.
  *
- * @param[in] orientation The orientation.
- * @return True if the orientation is horizontal.
+ * @SINCE_1_0.0
+ * @param[in] orientation The orientation
+ * @return true if the orientation is horizontal
  */
-DALI_IMPORT_API bool IsHorizontal(ControlOrientation::Type orientation);
+DALI_TOOLKIT_API bool IsHorizontal(ControlOrientation::Type orientation);
 
 /**
  * @}