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=dd8da9bb5669a9a23648d35b39d7f6c86c624205;hp=e1e34ec09827225b7fa1c391c0890c2227bd1c48;hb=fcc87538717836a4f9d9ca9ec7dfc242f5aa8431;hpb=306d2f61a1b64179e801fa8a0bb2bd7b4e9dd682 diff --git a/dali-toolkit/public-api/enums.h b/dali-toolkit/public-api/enums.h index e1e34ec..dd8da9b 100644 --- a/dali-toolkit/public-api/enums.h +++ b/dali-toolkit/public-api/enums.h @@ -2,7 +2,7 @@ #define __DALI_TOOLKIT_ENUMS_H__ /* - * Copyright (c) 2014 Samsung Electronics Co., Ltd. + * Copyright (c) 2015 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. @@ -23,28 +23,34 @@ 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 @@ -53,18 +59,22 @@ enum Type * @brief Query whether an orientation is vertical. * * @param[in] orientation The orientation. - * @return True if the orientation is vertical. + * @return true if the orientation is vertical. */ DALI_IMPORT_API bool IsVertical(ControlOrientation::Type orientation); /** * @brief Query whether an orientation is horizontal. * + * @SINCE_1_0.0 * @param[in] orientation The orientation. - * @return True if the orientation is horizontal. + * @return true if the orientation is horizontal. */ DALI_IMPORT_API bool IsHorizontal(ControlOrientation::Type orientation); +/** + * @} + */ } // namespace Toolkit } // namespace Dali