From 167afaf1111af5dab7645ef6efd12528eaa0389d Mon Sep 17 00:00:00 2001 From: Korrawit Pruegsanusak Date: Thu, 12 Oct 2017 22:40:51 +0700 Subject: correct wrong doxygen syntax; also comments clean-up Change-Id: I6074241dfcdcd4ca8a365ab6e03f01028d2c1a7b Reviewed-on: https://gerrit.libreoffice.org/43344 Reviewed-by: Michael Stahl Tested-by: Michael Stahl --- include/comphelper/extract.hxx | 17 +++++++++-------- 1 file changed, 9 insertions(+), 8 deletions(-) (limited to 'include/comphelper') diff --git a/include/comphelper/extract.hxx b/include/comphelper/extract.hxx index 4f4072145e71..4330faa1a625 100644 --- a/include/comphelper/extract.hxx +++ b/include/comphelper/extract.hxx @@ -34,7 +34,7 @@ namespace cppu /** * Sets enum from int32 value. This function does NOT check for valid enum values! - *
+ * * @param nEnum int32 enum value * @param rType enum type * @return enum or empty any. @@ -48,10 +48,11 @@ inline css::uno::Any SAL_CALL int2enum( /** * Sets int32 from enum or int in any. - *
- * @param rnEnum [out] int32 enum value + * + * @param[out] rnEnum int32 enum value * @param rAny enum or int - * @param sal_True if enum or int value was set else sal_False. + * @retval true if enum or int value was set + * @retval false otherwise */ inline bool enum2int( sal_Int32 & rnEnum, const css::uno::Any & rAny ) { @@ -66,10 +67,10 @@ inline bool enum2int( sal_Int32 & rnEnum, const css::uno::Any & rAny ) /** * Sets int32 from enum or int in any with additional typecheck - *
- * @param rAny enum or int - * @param eRet the enum value as int. If there is not enum of the given type or + * + * @param[out] eRet the enum value as int. If there is no enum of the given type * a css::lang::IllegalArgumentException is thrown + * @param rAny enum or int * @throws css::lang::IllegalArgumentException */ template< typename E > @@ -88,7 +89,7 @@ inline void any2enum( E & eRet, const css::uno::Any & rAny ) } /** - * extracts a boolean either as a bool or an integer from + * Extracts a boolean either as a bool or an integer from * an any. If there is no bool or integer inside the any * a css::lang::IllegalArgumentException is thrown * -- cgit