* All the activities involved in terminating the application, including saving the application's states, must be done in the %OnAppTerminating() method.
* After this method, the application code cannot be executed. The application is destroyed subsequently. @n
*
- * An application can be terminated by either system, such as power-off and OOM, or others, such as self and other applications. @n
+ * An application can be terminated either by system, such as power-off and OOM, or others, such as self and other applications. @n
* When the termination by system, called an “urgent termination”, occurs, the method, %OnAppTerminating(), cannot be executed properly.
* For more details, while power-off, even if %OnAppTerminating() is called, it has a short time for executing. If the application is killed by OOM, %OnAppTerminating() is not called. @n
* Because %OnAppTerminating() is not likely to be called due to urgent termination, the application should save the critical data as they can do.
* @param[in] operationId The application control operation ID
* @param[in] pUriData A pointer to the URI data
* @param[in] pMimeType A pointer to the MIME type (RFC 2046) data
- * @param[in] pExtraData A pointer to an argument map of key and value pair where the key is of type String and the value is of type Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String
+ * @param[in] pExtraData A pointer to an argument map of key and value pair where the key is of type Tizen::Base::String and the value is of type %Tizen::Base::String or of type Tizen::Base::Collection::ArrayList of %Tizen::Base::String
* @remarks To reply to the application control request, use AppControlProviderManager::SendAppControlResult() with the given request ID.
* @remarks When the application receives the AppControl request on the background,
* %OnAppControlRequestReceived() is invoked before UiApp::OnForeground().
* @since 2.1
*
* @return The menu icon path of an application, @n
- * else an empty string is returned if there is no value @n
+ * else an empty string is returned if there is no value
*/
Tizen::Base::String GetAppMenuIconPath(void) const;
* @since 2.1
*
* @return The setting icon path of an application, @n
- * else an empty string is returned if there is no value @n
+ * else an empty string is returned if there is no value
*/
Tizen::Base::String GetAppSettingIconPath(void) const;
* @since 2.1
*
* @return The notification icon path of an application, @n
- * else an empty string is returned if there is no value @n
+ * else an empty string is returned if there is no value
*/
Tizen::Base::String GetAppNotificationIconPath(void) const;
* @privlevel platform
* @privilege %http://tizen.org/privilege/packagemanager.info
*
- * @return A pointer to the %PackageInfo instance, @n
+ * @return A pointer to the PackageInfo instance, @n
* else @c null if it fails
* @param[in] filePath The package file path
* @exception E_SUCCESS The method is successful.
* @privlevel public
* @privilege %http://tizen.org/privilege/package.info
*
- * @return A pointer to the list of the %PackageInfo instances, @n
+ * @return A pointer to the list of the PackageInfo instances, @n
* else @c null if it fails
* @param[in] packageFilterMap The predefined key(Tizen::Base::String)-value(Tizen::Base::Boolean) pairs for the package filter @n
* For more information on the predefined key-value pairs for package filter,
* @privlevel public
* @privilege %http://tizen.org/privilege/package.info
*
- * @return A pointer to the list of the %PackageAppInfo instances, @n
+ * @return A pointer to the list of the PackageAppInfo instances, @n
* else @c null if it fails
* @param[in] packageAppFilterMap The predefined key(Tizen::Base::String)-value(Tizen::Base::String or Tizen::Base::Boolean) pairs for the package app filter @n
* For more information on the predefined key-value pairs for package app filter,
* @privlevel public
* @privilege %http://tizen.org/privilege/package.info
*
- * @return A pointer to the list of the %PackageAppInfo instances, @n
+ * @return A pointer to the list of the PackageAppInfo instances, @n
* else @c null if it fails
* @param[in] packageFilterMap The predefined key(Tizen::Base::String)-value(Tizen::Base::Boolean) pairs for the package filter @n
* @param[in] packageAppFilterMap The predefined and user defined key(Tizen::Base::String)-value(Tizen::Base::String or Tizen::Base::Boolean) pairs for the package app filter @n
/**
- * The @c double buffer type.
+ * The @c double buffer type
* @since 2.0
*/
typedef Buffer <double> DoubleBuffer;
/**
-* The @c float buffer type.
+* The @c float buffer type
* @since 2.0
*/
typedef Buffer <float> FloatBuffer;
/**
-* The @c int buffer type.
+* The @c int buffer type
* @since 2.0
*/
typedef Buffer <int> IntBuffer;
/**
-* The @c long buffer type.
+* The @c long buffer type
* @since 2.0
*/
typedef Buffer <long> LongBuffer;
/**
-* The @c long @c long buffer type.
+* The @c long @c long buffer type
* @since 2.0
*/
typedef Buffer <long long> LongLongBuffer;
/**
-* The @c wchar_t buffer type.
+* The @c wchar_t buffer type
* @since 2.0
*/
typedef Buffer <wchar_t> WcharBuffer;
/**
-* The @c short buffer type.
+* The @c short buffer type
* @since 2.0
*/
typedef Buffer <short> ShortBuffer;
/**
* @file FBaseRtIEventArg.h
- * @brief This is the header file for the %IEventArg class.
+ * @brief This is the header file for the %IEventArg interface.
*
- * This file contains the declarations of the %IEventArg class.
+ * This file contains the declarations of the %IEventArg interface.
*/
#ifndef _FBASE_RT_IEVENT_ARG_H_
{
/**
* @interface IEventArg
-* @brief This is a tagging interface that all event argument must implement.
+* @brief This interface is a tagging interface that all event argument must implement.
+*
* @since 2.0
+*
+* The %IEventArg interface is a tagging interface that all event argument must implement.
*/
class IEventArg
{
/**
* @interface IEventListener
- * @brief This is a tagging interface that all event listeners must implement.
+ * @brief This interface is a tagging interface that all event listeners must implement.
*
* @since 2.0
*
* @file FBaseRtITimerEventListener.h
* @brief This is the header file for the %ITimerEventListener interface.
*
+ * This header file contains the declarations of the %ITimerEventListener interface.
*/
#ifndef _FBASE_RT_I_TIMER_EVENT_LISTENER_H_
#define _FBASE_RT_I_TIMER_EVENT_LISTENER_H_
* @return An error code
* @exception E_SUCCESS The method is successful in acquiring the lock.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method will block if called on already locked monitor object until monitor becomes availalbe.
+ * @remarks This method will block if called on already locked monitor object until monitor becomes available.
* @see Exit()
*/
result Enter(void);
* @return An error code
* @exception E_SUCCESS The method is successful.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method will block if called on already locked monitor object until mutex becomes availalbe.
+ * @remarks This method will block if called on already locked monitor object until mutex becomes available.
*/
result Acquire(void);
* @exception E_SUCCESS The method is successful.
* @exception E_OBJECT_LOCKED The mutex is already locked.
* @exception E_SYSTEM A system error has occurred.
- * @remarks This method will block if called on already locked monitor object until mutex becomes availalbe.
+ * @remarks This method will block if called on already locked monitor object until mutex becomes available.
*/
result TryToAcquire(void);
/**
* @file FBaseRtTypes.h
- * @brief This is the header file for types in the Runtime package.
+ * @brief This is the header file for the types in the Runtime package.
*
* This header file defines the types in the Runtime package.
*/
/**
* @struct TryTag
-* @brief This struct is used only for supporting non-blocking acquisition of a resource
+* @brief This struct is used only for supporting non-blocking acquisition of a resource.
*
-* This struct is used for just discriminating between blocking and non-blocking acquisition
+* The %TryTag struct is used for just discriminating between blocking and non-blocking acquisition
* of a resource. So, the definition is empty.
*
* @since 2.0
};
/**
-* @brief Used only for for just discriminating between blocking and non-blocking acquisition
+* @brief Used only for just discriminating between blocking and non-blocking acquisition.
*
* @code
* Mutex m;
WaitingLoop(const WaitingLoop& rhs);
//
- // The implementation of this copy assignment operator is intentionally blank and delcared as private to prohibit copying of objects.
+ // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
//
// @since 2.0
//
* @exception E_DATA_NOT_FOUND The privilege information does not exist.
* @exception E_OUT_OF_MEMORY The memory is insufficient.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling the method.
+ * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method.
* @exception E_SYSTEM An unexpected system error has occurred.
*/
static result CheckPrivilege(int privilege);
* @return An error code
* @param[in] privilege A string of the specified privilege
* @exception E_SUCCESS The method is successful and the request is granted.
- * @exception E_INVALID_ARG The specified @c privilege is invalid privilege string.
+ * @exception E_INVALID_ARG The specified @c privilege is an invalid privilege string.
* @exception E_DATA_NOT_FOUND The privilege information does not exist.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling the method.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result CheckPrivilege(const Tizen::Base::String& privilege);
* @param[in] packageId The package ID
* @param[in] privilege A string of the specified privilege
* @exception E_SUCCESS The method is successful and the request is granted.
- * @exception E_INVALID_ARG The specified @c privilege is invalid privilege string.
+ * @exception E_INVALID_ARG The specified @c privilege is an invalid privilege string.
* @exception E_DATA_NOT_FOUND The privilege information does not exist.
- * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call the method.
- * @exception E_USER_NOT_CONSENTED The user blocks an application from calling the method.
+ * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
+ * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
*/
static result CheckPrivilege(const Tizen::App::PackageId& packageId, const Tizen::Base::String& privilege);
AccessController(const AccessController& rhs);
/**
- * The implementation of this copy assignment operator is intentionally blank and delcared as private to prohibit copying of objects.
+ * The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects.
*/
AccessController& operator =(const AccessController& rhs);
* @final This class is not intended for extension.
*
* The %PrivacyInfo class represents the privacy information.
-* %PrivacyInfo provides methods to retrieve the name and description of privilege.
+* This class provides methods to retrieve the name and description of privilege.
*/
class _OSP_EXPORT_ PrivacyInfo
* @param[in] enable Set to @c true to enable the privacy setting, @n
* else @c false
* @exception E_SUCCESS The method is successful.
- * @exception E_INVALID_ARG The specified @c privacyId is invalid or the @c privacyId is not exist.
+ * @exception E_INVALID_ARG The specified @c privacyId is invalid or the @c privacyId does not exist.
*
*/
result Construct(const Tizen::Base::String& privacyId, bool enable = false);
*
* @since 2.1
*
- * @return The privacy ID.
+ * @return The privacy ID
*
*/
Tizen::Base::String GetId(void) const;
*
* @since 2.1
*
- * @param[in] enable A Boolean value indicating whether the privacy setting is enabled.
+ * @param[in] enable A Boolean value indicating whether the privacy setting is enabled
* @see IsEnabled()
*
*/
void SetEnabled(bool enable);
/**
- * Gets the localized display name of privacy.
+ * Gets a localized display name of privacy.
*
* @since 2.1
*
- * @return The display name of privacy, else an empty string is returned if there is no value.
+ * @return The display name of privacy, @n
+ * else an empty string is returned if there is no value
*
*/
Tizen::Base::String GetDisplayName(void) const;
/**
- * Gets the localized description of privacy.
+ * Gets a localized description of privacy.
*
* @since 2.1
*
- * @return The description of privacy, else an empty string is returned if there is no value.
+ * @return The description of privacy, @n
+ * else an empty string is returned if there is no value
*
*/
Tizen::Base::String GetDescription(void) const;
Tizen::Base::Collection::IList* GetPrivacyInfoListN(const Tizen::App::PackageId& packageId) const;
/**
- * Sets the specific privacy setting of a package
+ * Sets a specific privacy setting of a package.
*
* @since 2.1
* @privlevel platform
*
* @return An error code
* @param[in] packageId The package ID
- * @param[in] privacyInfo The privacy setting to be set
- *
+ * @param[in] privacyInfo The privacy information to set
* @exception E_SUCCESS The method is successful.
* @exception E_OBJ_NOT_FOUND The specified @c packageId is not found in privacy database or @n
- * the package did not be defined to access to the privacy information.
+ * the package is not defined to access the privacy information.
* @exception E_INVALID_ARG The specified @c packageId length is invalid.
* @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method.
* @exception E_SYSTEM The method cannot proceed due to a severe system error.
* @final This class is not intended for extension.
*
* The %PrivilegeInfo class represents the privilege information.
-* %PrivilegeInfo provides methods to retrieve the name and description of privilege.
+* This class provides methods to retrieve the name and description of privilege.
*
*/
*
* @since 2.1
*
- * @return The privilege ID.
+ * @return The privilege ID
*
*/
Tizen::Base::String GetId(void) const;
*
* @since 2.1
*
- * @return The display name of privilege, else an empty string is returned if there is no value.
+ * @return The display name of privilege, @n
+ * else an empty string is returned if there is no value
*
*/
Tizen::Base::String GetDisplayName(void) const;
*
* @since 2.1
*
- * @return The description of privilege, else an empty string is returned if there is no value.
+ * @return The description of privilege, @n
+ * else an empty string is returned if there is no value
*
*/
Tizen::Base::String GetDescription(void) const;
* @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.
+ * @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.
* @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.
+ * @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.
projects / platform / framework / native / appfw.git / commitdiff