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=84b1176925972ac41ddd5f328a3b55d0bce2dd55;hp=ff678a9009026d70a7f4a9bda6a5356d1312dbe5;hb=26d183fc49ba2b62bbd844d668f15d141efcd326;hpb=5c07fde9dd6a022e2080c871994499e56eff89aa diff --git a/dali-toolkit/public-api/enums.h b/dali-toolkit/public-api/enums.h index ff678a9..84b1176 100644 --- a/dali-toolkit/public-api/enums.h +++ b/dali-toolkit/public-api/enums.h @@ -25,46 +25,50 @@ namespace Dali { /** * @brief DALi Toolkit namespace. + * @SINCE_1_0.0 */ namespace Toolkit { /** - * @addtogroup dali-toolkit-controls + * @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); /** - * @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);