X-Git-Url: http://review.tizen.org/git/?p=platform%2Fcore%2Fuifw%2Fdali-toolkit.git;a=blobdiff_plain;f=dali-toolkit%2Fpublic-api%2Fenums.h;h=e2529f2ebb7615071fa891431a2ff565f4858140;hp=e1e34ec09827225b7fa1c391c0890c2227bd1c48;hb=b694e7e2ae624e206e1548b1a863c554eb9cd4d7;hpb=2ddfbb9e23a7c3fc30e604236c41e0ef6d2ed6a2 diff --git a/dali-toolkit/public-api/enums.h b/dali-toolkit/public-api/enums.h index e1e34ec..e2529f2 100644 --- a/dali-toolkit/public-api/enums.h +++ b/dali-toolkit/public-api/enums.h @@ -1,8 +1,8 @@ -#ifndef __DALI_TOOLKIT_ENUMS_H__ -#define __DALI_TOOLKIT_ENUMS_H__ +#ifndef DALI_TOOLKIT_ENUMS_H +#define DALI_TOOLKIT_ENUMS_H /* - * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * Copyright (c) 2019 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. @@ -19,54 +19,64 @@ */ // INTERNAL INCLUDES -#include +#include namespace Dali { - /** * @brief DALi Toolkit namespace. + * @SINCE_1_0.0 */ namespace Toolkit { +/** + * @addtogroup dali_toolkit_controls + * @{ + */ /** * @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); +/** + * @} + */ } // namespace Toolkit } // namespace Dali -#endif // __DALI_TOOLKIT_ENUMS_H__ +#endif // DALI_TOOLKIT_ENUMS_H