From 22a07fc4e7d5c62952d6f6586339aea26f8406a1 Mon Sep 17 00:00:00 2001 From: Hokwon Song Date: Fri, 19 Apr 2013 16:54:23 +0900 Subject: [PATCH] Apply reviewed doxygen Change-Id: If3a321e4269e11894bc0142cf113c4f29196daa0 Signed-off-by: Hokwon Song --- inc/FLclCalendar.h | 14 ++++++------ inc/FLclCurrency.h | 4 ++-- inc/FLclDateTimeFormatter.h | 4 ++-- inc/FLclDateTimeSymbols.h | 4 ++-- inc/FLclGregorianCalendar.h | 4 ++-- inc/FLclLocale.h | 10 ++++---- inc/FLclNumberFormatter.h | 6 ++--- inc/FLclNumberSymbols.h | 2 +- inc/FLclTimeZone.h | 8 +++---- inc/FSysIBootEventListener.h | 2 +- inc/FSysIScreenEventListener.h | 4 ++-- inc/FSysISettingEventListener.h | 2 +- inc/FSysISettingInfoSetValueAsyncResultListener.h | 2 +- inc/FSysPowerManager.h | 26 +++++++++++---------- inc/FSysVibrator.h | 28 +++++++++-------------- 15 files changed, 58 insertions(+), 62 deletions(-) diff --git a/inc/FLclCalendar.h b/inc/FLclCalendar.h index 5a5b6b6..997caaf 100644 --- a/inc/FLclCalendar.h +++ b/inc/FLclCalendar.h @@ -148,7 +148,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompCalendarAddTimeFieldPage "here". * @endif * @@ -183,7 +183,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompCalendarAfterPage "here". * @endif * @@ -225,7 +225,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompCalendarBeforePage "here". * @endif * @@ -312,7 +312,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompCalendarRollPage "here". * @endif * @@ -718,7 +718,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompCalendarCreateInstanceNPage "here". * @endif * @@ -746,7 +746,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompCalendarCreateInstanceNPage "here". * @endif * @@ -867,7 +867,7 @@ protected: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompCalendarConstructPage "here". * @endif * diff --git a/inc/FLclCurrency.h b/inc/FLclCurrency.h index e02bce2..532c960 100644 --- a/inc/FLclCurrency.h +++ b/inc/FLclCurrency.h @@ -81,7 +81,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompCurrencyConstructPage "here". * @endif * @@ -102,7 +102,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompCurrencyConstructPage "here". * @endif * diff --git a/inc/FLclDateTimeFormatter.h b/inc/FLclDateTimeFormatter.h index 7f3f284..4979ed2 100644 --- a/inc/FLclDateTimeFormatter.h +++ b/inc/FLclDateTimeFormatter.h @@ -157,7 +157,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompDateTimeFormatterCreateDateFormatterNPage "here". * @endif * @@ -214,7 +214,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompDateTimeFormatterCreateTimeFormatterNPage "here". * @endif * diff --git a/inc/FLclDateTimeSymbols.h b/inc/FLclDateTimeSymbols.h index 1bbed2f..cdf6260 100644 --- a/inc/FLclDateTimeSymbols.h +++ b/inc/FLclDateTimeSymbols.h @@ -79,7 +79,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompDateTimeSymbolsConstructPage "here". * @endif * @@ -102,7 +102,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompDateTimeSymbolsConstructPage "here". * @endif * diff --git a/inc/FLclGregorianCalendar.h b/inc/FLclGregorianCalendar.h index 54c2e87..5237a77 100644 --- a/inc/FLclGregorianCalendar.h +++ b/inc/FLclGregorianCalendar.h @@ -158,7 +158,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompGregorianCalendarConstructPage "here". * @endif * @@ -182,7 +182,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompGregorianCalendarConstructPage "here". * @endif * diff --git a/inc/FLclLocale.h b/inc/FLclLocale.h index 1c4db52..78b0fef 100644 --- a/inc/FLclLocale.h +++ b/inc/FLclLocale.h @@ -1093,7 +1093,7 @@ public: * @since 2.0 * * @param[in] languageCodeString The language code, @n - * To get the specfied LanguageCode with the locale's ISO-15924 abbreviation script code, @n + * To get the specified LanguageCode with the locale's ISO-15924 abbreviation script code, @n * the form of languageCodeString should combine the ISO 639-2 language codes and the locale's ISO-15924 abbreviation script code by "-". @n * For example, if the language code is "aze" and the script code is "latn", @n * the languageCodeString is "aze-latn", and the LanguageCode is LANGUAGE_AZE_LATIN. @@ -1118,7 +1118,7 @@ public: * * @param[in] languageCode The language code * @return The language code string associated with the @c languageCode, @n - * else an empty string if languageCode is invaild. + * else an empty string if languageCode is invalid. * @see StringToLanguageCode() */ static Tizen::Base::String LanguageCodeToString(LanguageCode languageCode); @@ -1130,7 +1130,7 @@ public: * * @param[in] countryCode The country code * @return The ISO 3166-1 alpha-2 country code string associated with the @c countryCode, @n - * else an empty string if countryCode is invaild. + * else an empty string if countryCode is invalid. */ static Tizen::Base::String CountryCodeToString(CountryCode countryCode); @@ -1143,7 +1143,7 @@ public: * @return The ISO 639-2 language code string associated with the @c languageCode, @n * or The ISO 639-2 language code string with the ISO-15924 script code @n * if the @c languageCode represents The ISO 639-2 language code with the ISO-15924 script code, @n - * else an empty string if languageCode is invaild. + * else an empty string if languageCode is invalid. */ static Tizen::Base::String LanguageCodeToTwoLetterLanguageCodeString(LanguageCode languageCode); @@ -1165,7 +1165,7 @@ public: * * @param[in] countryCode The country code * @return The ISO 3166-1 alpha-3 country code string associated with the @c countryCode, @n - * else an empty string if countryCode is invaild + * else an empty string if countryCode is invalid * @see CountryCodeToString() * @remark COUNTRY_AREA_419 returns an empty string, since it is not defined in the ISO 3166-1 alpha-3. */ diff --git a/inc/FLclNumberFormatter.h b/inc/FLclNumberFormatter.h index 8f2a19f..71cf879 100644 --- a/inc/FLclNumberFormatter.h +++ b/inc/FLclNumberFormatter.h @@ -124,7 +124,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompNumberFormatterCreateNumberFormatterNPage "here". * @endif * @@ -175,7 +175,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompNumberFormatterCreateCurrencyFormatterNPage "here". * @endif * @@ -226,7 +226,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompNumberFormatterCreatePercentFormatterNPage "here". * @endif * diff --git a/inc/FLclNumberSymbols.h b/inc/FLclNumberSymbols.h index c18f8cc..dd4513b 100644 --- a/inc/FLclNumberSymbols.h +++ b/inc/FLclNumberSymbols.h @@ -102,7 +102,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompNumberSymbolsConstructPage "here". * @endif * diff --git a/inc/FLclTimeZone.h b/inc/FLclTimeZone.h index 963d139..057b983 100644 --- a/inc/FLclTimeZone.h +++ b/inc/FLclTimeZone.h @@ -342,7 +342,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompTimeZoneGetOffsetPage "here". * @endif * @@ -368,7 +368,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompTimeZoneGetOffsetPage "here". * @endif * @@ -462,7 +462,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompTimeZoneGetTimeZonePage "here". * @endif * @@ -485,7 +485,7 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatibile applications. @n + * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompTimeZoneGetTimeZonePage "here". * @endif * diff --git a/inc/FSysIBootEventListener.h b/inc/FSysIBootEventListener.h index 0f8f439..e04c2c1 100644 --- a/inc/FSysIBootEventListener.h +++ b/inc/FSysIBootEventListener.h @@ -17,7 +17,7 @@ /** * @file FSysIBootEventListener.h - * @brief This is the header file of the %IBootEventListener interface. + * @brief This is the header file for the %IBootEventListener interface. * * This header file contains the declarations of the %IBootEventListener interface. */ diff --git a/inc/FSysIScreenEventListener.h b/inc/FSysIScreenEventListener.h index 1e8786a..146b244 100644 --- a/inc/FSysIScreenEventListener.h +++ b/inc/FSysIScreenEventListener.h @@ -17,7 +17,7 @@ /** * @file FSysIScreenEventListener.h - * @brief This is the header file of the %IScreenEventListener interface. + * @brief This is the header file for the %IScreenEventListener interface. * * This header file contains the declarations of the %IScreenEventListener interface. */ @@ -67,7 +67,7 @@ public: * * @since 2.1 * - * @param[in] brightness Screen brightness between @c 0 to @c 10. + * @param[in] brightness The screen brightness between @c 0 to @c 10 */ virtual void OnScreenBrightnessChanged(int brightness) {} diff --git a/inc/FSysISettingEventListener.h b/inc/FSysISettingEventListener.h index bbee668..968bbf0 100644 --- a/inc/FSysISettingEventListener.h +++ b/inc/FSysISettingEventListener.h @@ -17,7 +17,7 @@ /** * @file FSysISettingEventListener.h - * @brief This is the header file of the %ISettingEventListener interface. + * @brief This is the header file for the %ISettingEventListener interface. * * This header file contains the declarations of the %ISettingEventListener interface. */ diff --git a/inc/FSysISettingInfoSetValueAsyncResultListener.h b/inc/FSysISettingInfoSetValueAsyncResultListener.h index 59b993a..d554707 100644 --- a/inc/FSysISettingInfoSetValueAsyncResultListener.h +++ b/inc/FSysISettingInfoSetValueAsyncResultListener.h @@ -17,7 +17,7 @@ /* * @file FSysISettingInfoSetValueAsyncResultListener.h - * @brief This is the header file of the %ISettingInfoSetValueAsyncResultListener interface. + * @brief This is the header file for the %ISettingInfoSetValueAsyncResultListener interface. * * This header file contains the declarations of the %ISettingInfoSetValueAsyncResultListener interface. */ diff --git a/inc/FSysPowerManager.h b/inc/FSysPowerManager.h index d21e9f5..9b06edd 100644 --- a/inc/FSysPowerManager.h +++ b/inc/FSysPowerManager.h @@ -223,14 +223,13 @@ public: /** * Sets the screen event listener. * - * @since 2.0 - * * @deprecated This method is deprecated. @n - * Instead of using this method, please use AddScreenEventListener and RemoveScreenEventListener. + * Instead of using this method, use AddScreenEventListener() and RemoveScreenEventListener(). + * @since 2.0 * * @param[in] listener The screen event listener * @remarks This method always overwrites the first element of internal IScreenEventListener list. - * The first element added by AddScreentEventListener may be overwritten by this method, + * The first element added by AddScreenEventListener() may be overwritten by this method, * which may not be an expected behavior by API users. So, it is not recommended to use this method. */ static void SetScreenEventListener(IScreenEventListener& listener); @@ -245,7 +244,8 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OBJ_ALREADY_EXIST The listener has already been added. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see IScreenEventListener, RemoveScreenEventListener + * @see IScreenEventListener + * @see RemoveScreenEventListener() */ static result AddScreenEventListener(IScreenEventListener& listener); @@ -258,7 +258,8 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified listener cannot be found. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see IScreenEventListener, AddScreenEventListener + * @see IScreenEventListener + * @see AddScreenEventListener() */ static result RemoveScreenEventListener(IScreenEventListener& listener); @@ -266,14 +267,13 @@ public: /** * Sets the charging event listener. * - * @since 2.0 - * * @deprecated This method is deprecated. @n - * Instead of using this method, please use AddChargingEventListener and RemoveChargingEventListener. + * Instead of using this method, use AddChargingEventListener() and RemoveChargingEventListener(). + * @since 2.0 * * @param[in] listener The charging event listener * @remarks This method always overwrites the first element of internal IChargingEventListener list. - * The first element added by AddChargingEventListener may be overwritten by this method, + * The first element added by AddChargingEventListener() may be overwritten by this method, * which may not be an expected behavior by API users. So, it is not recommended to use this method. */ static void SetChargingEventListener(IChargingEventListener& listener); @@ -287,7 +287,8 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OBJ_ALREADY_EXIST The listener has already been added. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see IChargingEventListener, RemoveChargingEventListener + * @see IChargingEventListener + * @see RemoveChargingEventListener() */ static result AddChargingEventListener(IChargingEventListener& listener); @@ -300,7 +301,8 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified listener cannot be found. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see IChargingEventListener, AddChargingEventListener + * @see IChargingEventListener + * @see AddChargingEventListener() */ static result RemoveChargingEventListener(IChargingEventListener& listener); diff --git a/inc/FSysVibrator.h b/inc/FSysVibrator.h index 526305f..c4f3389 100644 --- a/inc/FSysVibrator.h +++ b/inc/FSysVibrator.h @@ -67,11 +67,11 @@ namespace Tizen { namespace System * goto CATCH; * } * - * // Initialize vibration pattern + * // Initializes the vibration pattern * IntensityDurationVibrationPattern patterns[4] = {{2000, 50}, {1000, 0}, {500, -1}, {1000, 80}}; * int length = sizeof(patterns); - * // Vibrate with a given pattern and repeat count + * // Vibrates with a given pattern and repeats count * vibrator.Start(patterns, length, 3); * * return E_SUCCESS; @@ -87,13 +87,13 @@ namespace Tizen { namespace System * @struct IntensityDurationVibrationPattern * @brief This struct has the specified duration and a vibration intensity level. * - * This can be used with Vibrator::Start(IntensityDurationVibrationPattern[] patterns, int length, int repeatCount) as a custom pattern. + * The %IntensityDurationVibrationPattern struct has the specified duration and a vibration intensity level. This can be used with Vibrator::Start(IntensityDurationVibrationPattern[] patterns, int length, int repeatCount) as a custom pattern. * * @since 2.1 */ struct _OSP_EXPORT_ IntensityDurationVibrationPattern { - int duration; /**< The duration in milliseconds when the vibrator is on. @n + int duration; /**< The duration in milliseconds when the vibrator is on @n * The @c duration is not allowed a negative value. */ int intensity; /**< The vibration intensity [@c -1~ @c 100]: @n @@ -143,22 +143,21 @@ public: /** - * Vibrates the device with the specified array pattern which has vibration intensity and duration. @n - * This method returns the result immediately so that the vibration occurs simultaneously as the device runs. @n + * Vibrates the device with a specified array pattern that has vibration intensity and duration. @n + * The %Start() method returns the result immediately so that the vibration occurs simultaneously as the device runs. @n * If this method is called again before the previous vibration stops, the previous vibration is canceled and the new vibration starts immediately. @n * If a new vibrator instance triggers the vibration, the vibrator merges the previous vibration pattern with the new one in the overlapped time. @n * If the system alert occurs such as ring vibration and a system event notification, the vibration can be interrupted. @n * If the application is terminated, the vibration is canceled. * * @since 2.1 - * * @privilege %http://tizen.org/privilege/vibrator * * @return An error code * - * @param[in] patterns An array of @c IntensityDurationVibrationPattern. - * @param[in] length The length of @c patterns. - * @param[in] repeatCount The number of repeat for pattern. This value has to be between 1 to 100. + * @param[in] patterns An array of @c IntensityDurationVibrationPattern + * @param[in] length The length of @c patterns + * @param[in] repeatCount The number of times the pattern repeats @n This value must be between @c 1 to @c 100. * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_INVALID_ARG A specified input parameter is invalid. @@ -173,10 +172,8 @@ public: * The %Start() method returns the result immediately so that the vibration occurs simultaneously as the device runs. * If this method is called again before the previous vibration stops, the previous vibration is canceled and the new vibration starts immediately. * - * @since 2.0 - * * @deprecated This method is deprecated. Instead of using this method, use Start(IntensityDurationVibrationPattern[] patterns, int length, int repeatCount). - * + * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/vibrator * @@ -207,10 +204,8 @@ public: * The %Start() method returns the result immediately so that the vibration occurs simultaneously as the device runs. * If this method is called again before the previous vibration stops, the previous vibration is canceled and the new vibration starts immediately. * - * @since 2.0 - * * @deprecated This method is deprecated. Instead of using this method, use Start(IntensityDurationVibrationPattern[] patterns, int length, int repeatCount). - * + * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/vibrator * @@ -236,7 +231,6 @@ public: * Turns the vibrator off. * * @since 2.0 - * * @privlevel public * @privilege %http://tizen.org/privilege/vibrator * -- 2.7.4