X-Git-Url: http://review.tizen.org/git/?a=blobdiff_plain;f=inc%2FFSysAlarm.h;h=b1da170e1b1b6765a387b2886430c342d908dbfa;hb=20597a73bc3098301ba91a48378f3ef009c3be96;hp=902fd9bc84fdee1ce7f68367ff088e555d394126;hpb=391a218183d2aa7df6f0da67c08b0385767a6377;p=platform%2Fframework%2Fnative%2Fappfw.git

diff --git a/inc/FSysAlarm.h b/inc/FSysAlarm.h
index 902fd9b..b1da170 100644
--- a/inc/FSysAlarm.h
+++ b/inc/FSysAlarm.h
@@ -1,5 +1,4 @@
 //
-// Open Service Platform
 // Copyright (c) 2012 Samsung Electronics Co., Ltd.
 //
 // Licensed under the Apache License, Version 2.0 (the License);
@@ -49,11 +48,12 @@ class _OSP_EXPORT_ Alarm
 {
 public:
 	/**
-	 * This is the default constructor for this class.
+	 * This is the default constructor for this class. @n
+	 * The object is not fully constructed after this constructor is called. @n
+	 * For full construction, the Construct() method must be called right after calling this constructor.
 	 *
 	 * @since 2.0
 	 *
-	 * @remarks The object is not fully constructed after this constructor is called. For full construction, the Construct() method must be called right after calling this constructor. 
 	 */
 	Alarm(void);
 
@@ -83,67 +83,76 @@ public:
 	 *
 	 * @since	2.0
 	 *
+	 * @privlevel	public
 	 * @privilege	%http://tizen.org/privilege/alarm
 	 *
-	 * @return	An error code
-	 * @param[in]	duetime			The time for the alarm to ring. @n Any value with a unit that is less than a second is ignored.
-	 * @exception	E_SUCCESS		The method is successful.
+	 * @return		An error code
+	 * @param[in]	duetime				The time for the alarm to ring @n 
+	 *									Any value with a unit that is less than a second is ignored.
+	 * @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		The specified @c duetime is invalid.
-	 * @exception   E_SYSTEM		A system error has occurred.
-	 * @remarks     If this %Alarm instance is already registered by this method, existing alarm is cancelled automatically.
+	 * @exception   E_SYSTEM			A system error has occurred.
+	 * @remarks     If this %Alarm instance is already registered by this method, the existing alarm is cancelled automatically.
 	 */
 	result Set(const Tizen::Base::DateTime& duetime);
 
 	/**
 	 * Sets a repeating alarm.
 	 *
-	 * @since	2.0
+	 * @since		2.0
 	 *
+	 * @privlevel	public
 	 * @privilege	%http://tizen.org/privilege/alarm
 	 *
-	 * @return	An error code
-	 * @param[in]	start			The time for the alarm to ring first. @n Any value with a unit that is less than a second is ignored.
-	 * @param[in]	period			The interval in minutes between consecutive alarm rings.
-	 * @param[in]	pEnd			The time for the alarm ring to end. @n Any value with a unit that is less than a second is ignored.
-	 * @exception	E_SUCCESS		The method is successful.
+	 * @return		An error code
+	 * @param[in]	start			The time for the alarm to ring first @n 
+	 *								Any value with a unit that is less than a second is ignored.
+	 * @param[in]	period				The interval in minutes between consecutive alarm rings
+	 * @param[in]	pEnd					The time for the alarm ring to end @n 
+	 *								Any value with a unit that is less than a second is ignored.
+	 * @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.
-	 * @exception   E_SYSTEM		A system error has occurred.
-	 * @remarks     If this %Alarm instance is already registered by this method, existing alarm is cancelled automatically. @n If @c pEnd is @c null, the alarm repeats forever.
+	 * @exception   E_SYSTEM			A system error has occurred.
+	 * @remarks     
+	 *			- If this %Alarm instance is already registered by this method, existing alarm is cancelled automatically.
+	 *			- If @c pEnd is @c null, the alarm repeats forever.
 	 */
 	result Set(const Tizen::Base::DateTime& start, int period, const Tizen::Base::DateTime* pEnd = null);
 
 	/**
 	 * Cancels the alarm.
 	 *
-	 * @since	2.0
+	 * @since		2.0
 	 *
+	 * @privlevel	public
 	 * @privilege	%http://tizen.org/privilege/alarm
 	 *
-	 * @return	An error code
-	 * @exception	E_SUCCESS		The method is successful.
+	 * @return		An error code
+	 * @exception	E_SUCCESS			The method is successful.
 	 * @exception	E_PRIVILEGE_DENIED	The application does not have the privilege to call this method.
-	 * @exception   E_SYSTEM		A system error has occurred.
+	 * @exception   E_SYSTEM			A system error has occurred.
 	 */
 	result Cancel(void);
 
 	/**
 	 * Gets the start time for the current instance of %Alarm.
 	 *
-	 * @since	2.0
+	 * @since		2.0
 	 *
-	 * @return	An instance of Tizen::Base::DateTime indicating the start time for the alarm
-	 * @remarks     If this %Alarm instance is not registered by the Set() method, return value is default value of the Tizen::Base::DateTime class.
+	 * @return		An instance of Tizen::Base::DateTime indicating the start time for the alarm
+	 * @remarks     If this %Alarm instance is not registered by the Set() method, the return value is the default value of 
+	 * 				the Tizen::Base::DateTime instance.
 	 */
 	const Tizen::Base::DateTime GetStartTime(void) const;
 
 	/**
 	 * Gets the period of the current instance of %Alarm in minutes.
 	 *
-	 * @since	2.0
+	 * @since		2.0
 	 *
-	 * @return	The period of the current instance of %Alarm in minutes
+	 * @return		The period of the current instance of %Alarm in minutes
 	 * @remarks     If this %Alarm instance is not registered by the Set() method, return value is @c 0.
 	 */
 	int GetPeriod(void) const;
@@ -153,7 +162,7 @@ public:
 	 *
 	 * @since	2.0
 	 *
-	 * @return	 A pointer to Tizen::Base::DateTime indicating the end time for the alarm, @n
+	 * @return	A pointer to Tizen::Base::DateTime indicating the end time for the alarm, @n
 	 *			else @c null if the end time has not been set
 	 */
 	const Tizen::Base::DateTime* GetEndTime(void) const;