From: VARINDER PRATAP SINGH Date: Wed, 6 Nov 2013 10:09:49 +0000 (+0000) Subject: Merge "Applied sizeof operator on fixed sized array to calculate size." into tizen_2.2 X-Git-Tag: submit/tizen/20131210.080830^2^2~2 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=89cadcf7665edb2d2bcf3d683308f6101b97044a;hp=c8dfff71aaa6c1d23efa76399166b57a8b4d9363;p=platform%2Fframework%2Fnative%2Fappfw.git Merge "Applied sizeof operator on fixed sized array to calculate size." into tizen_2.2 --- diff --git a/CMakeLists.txt b/CMakeLists.txt index a210271..1d9fa9b 100644 --- a/CMakeLists.txt +++ b/CMakeLists.txt @@ -40,11 +40,6 @@ INSTALL(DIRECTORY ${LIBRARY_OUTPUT_PATH}/ DESTINATION lib/osp PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ GROUP_EXECUTE GROUP_READ WORLD_EXECUTE WORLD_READ) -INSTALL(DIRECTORY ${LIBRARY_OUTPUT_PATH}/ DESTINATION lib/osp - FILES_MATCHING PATTERN "libosp-newlib.so*" - PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ - GROUP_EXECUTE GROUP_READ - WORLD_EXECUTE WORLD_READ) INSTALL(DIRECTORY ${LIBRARY_OUTPUT_PATH}/ DESTINATION lib/osp-server FILES_MATCHING PATTERN "libosp-appfw-server.so*" PERMISSIONS OWNER_EXECUTE OWNER_WRITE OWNER_READ @@ -62,6 +57,7 @@ INSTALL(DIRECTORY ${LIBRARY_OUTPUT_PATH}/debug/ DESTINATION lib/osp/debug WORLD_EXECUTE WORLD_READ) INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/res/common/opt/usr/etc DESTINATION ../opt/usr) +INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/res/common/usr/bin DESTINATION ../usr) IF("${ARCH}" MATCHES "arm") INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/res/arm/usr/etc DESTINATION ../usr) ELSEIF("${ARCH}" MATCHES "x86") @@ -76,5 +72,5 @@ INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/src/locales/inc/ DESTINATION include/osp/l INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/src/security/inc/ DESTINATION include/osp/security FILES_MATCHING PATTERN "*.h") INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/src/system/inc/ DESTINATION include/osp/system FILES_MATCHING PATTERN "*.h") INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/src/text/inc/ DESTINATION include/osp/text FILES_MATCHING PATTERN "*.h") -INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/src/server/inc/ DESTINATION include/osp/server/ FILES_MATCHING PATTERN "*.h") -INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/src/system-server/inc/ DESTINATION include/osp/system-server/ FILES_MATCHING PATTERN "*.h") +INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/src/server/appfw/inc/ DESTINATION include/osp/server/appfw/ FILES_MATCHING PATTERN "*.h") +INSTALL(DIRECTORY ${CMAKE_SOURCE_DIR}/src/server/system/inc/ DESTINATION include/osp/server/system/ FILES_MATCHING PATTERN "*.h") diff --git a/inc/FApp.h b/inc/FApp.h index cb241e2..55d51f4 100644 --- a/inc/FApp.h +++ b/inc/FApp.h @@ -60,12 +60,12 @@ * @since 2.0 * * @remarks @b Header @b %file: @b \#include @b @n - * @b Library : @b osp-appfw + * @b Library: @b osp-appfw * * The %App namespace contains classes for application development, including application life-cycle management, usage of - * functionality exported by other applications through AppControl, and access to application registry and resources. %Tizen + * the functionality exported by other applications through AppControl, and access to the application registry and resources. %Tizen * also provides various macros for debugging purposes. - * @n + * * For more information on the %App namespace features and the macros, see App Guide and Debugging Macros. * * The following diagram illustrates the relationships between the classes belonging to the %App namespace. diff --git a/inc/FAppApp.h b/inc/FAppApp.h index 851b84f..b79916f 100644 --- a/inc/FAppApp.h +++ b/inc/FAppApp.h @@ -47,7 +47,7 @@ class AppResource; * * The %App class is the base class of a %Tizen native application. * A %Tizen native application must be inherited from the UiApp or ServiceApp class. These classes are inherited from the %App class. This class provides the basic features necessary to define an application. - * @n + * * For more information on the class features, see App Guide, Application Life-cycle, and System Events. * */ @@ -84,12 +84,12 @@ public: /** * @if OSPDEPREC - * Gets the list of the launch arguments. @n + * Gets the list of launch arguments. @n * For more information on the launch arguments, see Launching Other Applications. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated. Instead of using this method, it is recommended to use IAppControlProviderEventListener - * to acquire delivered arguments list. + * to acquire the delivered arguments list. * @since 2.0 * * @return A pointer to the list that contains the Tizen::Base::String instances of the launch arguments @@ -114,7 +114,7 @@ public: * Gets the locale-independent name of the application. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT @@ -130,14 +130,14 @@ public: * @section CompGetAppNamePageIssue Issues * Implementation of this method in %Tizen API versions prior to 2.1 has the following issue: @n * - * -# GetAppName() returns the localized name of the application while the meaning of the application name is ambiguous. - * There are different use cases for locale-dependent name and localized name and the platform does not provide - * a method for obtaining language-neutral name. + * -# The GetAppName() method returns the localized name of the application while the meaning of the application name is ambiguous. + * There are different use cases for the locale-dependent name and the localized name. The platform does not provide + * any method for obtaining the language-neutral name. * * @section CompGetAppNamePageResolution Resolutions * The issue mentioned above is resolved in %Tizen API version 2.1 as follows: @n * - * -# GetAppDisplayName() is introduced to acquire localized name and GetAppName() returns locale-independent application name. + * -# The GetAppDisplayName() method is introduced to acquire the localized application name and the GetAppName() method returns the locale-independent application name. */ /** @@ -170,7 +170,7 @@ public: AppId GetAppId(void) const; /** - * Gets the path of the application's root directory where the application is installed. + * Gets the path to the application's root directory where the application is installed. * * @since 2.0 * @@ -179,7 +179,7 @@ public: Tizen::Base::String GetAppRootPath(void) const; /** - * Gets the path of the application's data directory used to store its own private data. + * Gets the path to the application's data directory where its private data is stored. * * @since 2.0 * @@ -188,8 +188,7 @@ public: Tizen::Base::String GetAppDataPath(void) const; /** - * Gets the path of the application's resource directory that ships resource files delivered with the application - * package. + * Gets the path to the application's resource directory that ships the resource files that are delivered with the application package. * * @since 2.0 * @@ -198,7 +197,7 @@ public: Tizen::Base::String GetAppResourcePath(void) const; /** - * Gets the path of the application's shared directory to export data to other applications. + * Gets the path to the application's shared directory to export data to other applications. * * @since 2.1 * @@ -212,7 +211,7 @@ public: * * @since 2.0 * - * @return An error code + * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE This instance is in an invalid state. */ @@ -224,20 +223,20 @@ public: * including restoring the application's states, must be done in the %OnAppInitializing() method. * If this method fails, the application's state changes to App::TERMINATED. * - * @since 2.0 + * @since 2.0 * - * @return @c true if the method is successful, @n - * else @c false + * @return @c true if the method is successful, @n + * else @c false * @param[in] appRegistry The instance of AppRegistry that manages the application's states * @remarks Introducing the modal dialogs (for example, MessageBox) in this method is not allowed, - * because it blocks the initialization procedure. + * because it blocks the initialization procedure. */ virtual bool OnAppInitializing(AppRegistry& appRegistry) = 0; /** * Called when the application's initialization is finished. @n * After the %OnAppInitialized() method succeeds, the application's state changes to App::RUNNING. - * If this method fails, the application's state changes to App::TERMINATING and the App::OnAppTerminating() method is called. + * If this method fails, the application's state changes to App::TERMINATING and the OnAppTerminating() method is called. * * @since 2.0 * @@ -249,7 +248,7 @@ public: /** * Called when the application is requested to terminate. @n * The %OnAppWillTerminate() method returns @c false to prevent the application from getting terminated. - * If this method returns @c true, the application's state changes to App::TERMINATING and the App::OnAppTerminating() method is called. + * If this method returns @c true, the application's state changes to App::TERMINATING and the OnAppTerminating() method is called. * * @since 2.0 * @@ -260,22 +259,22 @@ public: /** * Called when the application's state changes to App::TERMINATING. @n - * All the activities involved in terminating the application, including saving the application's states, must be done in the %OnAppTerminating() method. + * All the activities involved in terminating the application, including saving the application's states, must be done by the %OnAppTerminating() method. * After this method, the application code cannot be executed. The application is destroyed subsequently. @n * - * An application's termination is triggered either by the system or other applications. @n - * When the termination is triggered by the system because of conditions such as power-off and OOM, it is called "urgent termination" and during these terminations %OnAppTerminating(), cannot be executed properly. + * An application's termination is triggered either by the system or by other applications. @n + * When the termination is triggered by the system because of conditions, such as power-off, and OOM, it is called "urgent termination" and during these terminations the %OnAppTerminating() method cannot be executed properly. * When an application is terminated because of a power-off, although this method is called, it should be executed in a short duration. And when an application is killed by OOM, this method is not called. @n - * This implies that this method is not likely to be called during an urgent termination, and hence the application should save the critical data as often as possible. - * For example, the application can set a check point or use the callback for low memory. - * When an application is terminated by self or other applications, it is called "normal termination" and during these terminations this method is executed properly because more time is provided for executing it as compared to an urgent termination (however, it does have a limit of 3-5 seconds). @n + * This implies that this method is not likely to be called during an urgent termination, and hence the application should save its critical data as often as possible. + * For example, the application can set a check point or use a callback for low memory issues. + * When an application terminates itself or is terminated by other applications, it is called "normal termination" and during these terminations this method is executed properly because more time is provided for execution as compared to an urgent termination (however, it does have a limit of 3-5 seconds). @n * When this method is called, the main loop has already been quit. * Thus, the application should not use any kind of asynchronous API that has callbacks triggered by the main loop. * * @since 2.0 * - * @return @c true if the method is successful, @n - * else @c false + * @return @c true if the method is successful, @n + * else @c false * @param[in] appRegistry The instance that manages the application's states * @param[in] urgentTermination Set to @c true if the application is terminated by the system, @n * else @c false @@ -283,7 +282,7 @@ public: virtual bool OnAppTerminating(AppRegistry& appRegistry, bool urgentTermination = false) = 0; /** - * Called when the system detects that the system wide memory or application heap memory is insufficient to run the application any further. @n + * Called when the system detects that the system wide memory or the application heap memory is insufficient to run the application any further. @n * Resources that are not in use currently can be released using the %OnLowMemory() method. * * @since 2.0 @@ -292,7 +291,7 @@ public: /** * Called when the battery level changes. @n - * It is recommended that the application decides whether to terminate by itself by considering its own battery power consumption, if the battery level is Tizen::System::BATTERY_LEVEL_CRITICAL. + * It is recommended that the application decides whether to terminate itself by considering its own battery power consumption, if the battery level is Tizen::System::BATTERY_LEVEL_CRITICAL. * * @since 2.0 * @@ -307,7 +306,7 @@ public: * * @return An error code * @param[in] requestId The user defined event ID - * @param[in] pArgs A pointer to an argument list of type Tizen::Base::String + * @param[in] pArgs A pointer to the argument list of type Tizen::Base::String * @exception E_SUCCESS The method is successful. * @see OnUserEventReceivedN() */ @@ -319,12 +318,12 @@ public: * @since 2.0 * * @param[in] requestId The user defined event ID - * @param[in] pArgs A pointer to an argument list of type Tizen::Base::String + * @param[in] pArgs A pointer to the argument list of type Tizen::Base::String */ virtual void OnUserEventReceivedN(RequestId requestId, Tizen::Base::Collection::IList* pArgs); /** - * Gets the %App instance's pointer. + * Gets a pointer to the %App instance. * * @since 2.0 * diff --git a/inc/FAppAppControl.h b/inc/FAppAppControl.h index 2d195cd..80ede82 100644 --- a/inc/FAppAppControl.h +++ b/inc/FAppAppControl.h @@ -46,7 +46,7 @@ class IAppControlResponseListener; * For more information, see Contact Application Control. * * @brief [Deprecated] -* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.contacts". * @since 2.0 * @endif @@ -59,9 +59,9 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_CONTACT; * * For more information, see Calendar Application Control. * -* @brief [Deprecated] +* @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. -* Instead of this variable, use the literal, L"tizen.calendar". +* Instead of this variable, use the literal, L"tizen.calendar". * @since 2.0 * @endif */ @@ -71,12 +71,12 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_CALENDAR; * @if OSPDEPREC * The Todo %AppControl ID. * -* @brief [Deprecated] -* @deprecated This application control provider name is deprecated. -* @b OPERATION_PICK: -* @since 2.0 +* @brief [Deprecated] +* @deprecated This application control provider name is deprecated. +* @b OPERATION_PICK: +* @since 2.0 * -* @remarks This constant is currently not available. +* @remarks This constant is currently not available. * @endif */ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_TODO; @@ -87,9 +87,9 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_TODO; * * For more information, see Call Application Control. * -* @brief [Deprecated] -* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. -* Instead of this variable, use the literal, L"tizen.phone" with operation L"http://tizen.org/appcontrol/operation/dial". +* @brief [Deprecated] +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. +* Instead of this variable, use the literal, L"tizen.phone", with the operation L"http://tizen.org/appcontrol/operation/dial". * @since 2.0 * @endif */ @@ -102,10 +102,10 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_DIAL; * * For more information, see Call Application Control. * -* @brief [Deprecated] -* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. -* Instead of this variable, use the literal, L"tizen.phone" with operation L"http://tizen.org/appcontrol/operation/call". -* @since 2.0 +* @brief [Deprecated] +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. +* Instead of this variable, use the literal, L"tizen.phone", with the operation L"http://tizen.org/appcontrol/operation/call". +* @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/systeminfo * @@ -121,13 +121,14 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_CALL; * * For more information, see Message Application Control. * -* @brief [Deprecated] -* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. +* @brief [Deprecated] +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.messages". * @since 2.0 * -* @remarks An MMS attachment may contain either an image, audio, video, vCard, vCalendar or a combination of an image, audio, vCard, and vCalendar files. @n -* MMS attachments cannot contain a video in combination with an image or an audio file. +* @remarks +* - An MMS attachment may contain either an image, an audio, a video, a vCard, a vCalendar, or a combination of an image, an audio, a vCard, and a vCalendar file. +* - MMS attachments cannot contain a video in combination with an image or an audio file. * @endif */ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_MESSAGE; @@ -138,9 +139,9 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_MESSAGE; * * For more information, see Email Application Control. * -* @brief [Deprecated] -* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. -* Instead of this variable, use the literal, L"tizen.email". +* @brief [Deprecated] +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. +* Instead of this variable, use the literal, L"tizen.email". * @since 2.0 * @endif */ @@ -152,9 +153,9 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_EMAIL; * * For more information, see Media Application Control. * -* @brief [Deprecated] -* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. -* Instead of this variable, use the literal, L"tizen.filemanager" or L"tizen.gallery". +* @brief [Deprecated] +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. +* Instead of this variable, use the literal, L"tizen.filemanager", or L"tizen.gallery". * @since 2.0 * @endif */ @@ -166,8 +167,8 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_MEDIA; * * For more information, see Image Application Control. * -* @brief [Deprecated] -* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. +* @brief [Deprecated] +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.imageviewer". * @since 2.0 * @endif @@ -180,8 +181,8 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_IMAGE; * * For more information, see Video Application Control. * -* @brief [Deprecated] -* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. +* @brief [Deprecated] +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.videoplayer". * @since 2.0 * @endif @@ -194,10 +195,10 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_VIDEO; * * For more information, see Audio Application Control. * -* @brief [Deprecated] -* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. +* @brief [Deprecated] +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.musicplayer". -* @since 2.0 +* @since 2.0 * @endif */ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_AUDIO; @@ -208,10 +209,10 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_AUDIO; * * For more information, see Browser Application Control. * -* @brief [Deprecated] -* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. +* @brief [Deprecated] +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.internet". -* @since 2.0 +* @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/web.service * @endif @@ -224,8 +225,8 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_BROWSER; * * For more information, see Camera Application Control. * -* @brief [Deprecated] -* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. +* @brief [Deprecated] +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.camera". * @since 2.0 * @endif @@ -238,10 +239,10 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_CAMERA; * * For more information, see Bluetooth Application Control. * -* @brief [Deprecated] -* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. +* @brief [Deprecated] +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.bluetooth". -* @since 2.0 +* @since 2.0 * @endif */ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_BT; @@ -252,8 +253,8 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_BT; * * For more information, see Settings Application Control. * -* @brief [Deprecated] -* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. +* @brief [Deprecated] +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.settings". * @since 2.0 * @endif @@ -266,10 +267,10 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_SETTINGS; * * For more information, see Contact Application Control. * -* @brief [Deprecated] +* @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.contacts". -* @since 2.0 +* @since 2.0 * @endif */ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_CONTACT; @@ -280,7 +281,7 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_CONTACT; * * For more information, see Certificate Manager Application Control. * -* @brief [Deprecated] +* @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.certificatemanager". * @since 2.0 @@ -294,7 +295,7 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_CERTIFICATE_MA * * For more information, see Calendar Application Control. * -* @brief [Deprecated] +* @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.calendar". * @since 2.0 @@ -309,10 +310,10 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_CALENDAR; * * For more information, see Call Application Control. * -* @brief [Deprecated] +* @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.phone". -* @since 2.0 +* @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/systeminfo * @@ -327,14 +328,14 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_CALL; * * For more information, see Message Application Control. * -* @brief [Deprecated] +* @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.messages". -* @since 2.0 +* @since 2.0 * -* @remarks An MMS attachment may contain either an image, audio, video, vCard, vCalendar or a combination of an image, audio, vCard, and vCalendar files. @n -* MMS attachments cannot contain a video in combination with an image or an audio file. @n -* From Tizen 2.0, the CC and BCC recipients are merged with the TO recipients when launching the MMS app control. +* @remarks An MMS attachment may contain either an image, an audio, a video, a vCard, a vCalendar, or a combination of an image, an audio, a vCard, and a vCalendar file. @n +* MMS attachments cannot contain a video in combination with an image or an audio file. @n +* From %Tizen 2.0, the CC and BCC recipients are merged with the TO recipients while launching the MMS application control. * @endif */ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_MESSAGE; @@ -345,10 +346,10 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_MESSAGE; * * For more information, see Email Application Control. * -* @brief [Deprecated] +* @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.email". -* @since 2.0 +* @since 2.0 * @endif */ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_EMAIL; @@ -359,9 +360,9 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_EMAIL; * * For more information, see Media Application Control. * -* @brief [Deprecated] +* @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. -* Instead of this variable, use the literal, L"tizen.filemanager" or L"tizen.gallery". +* Instead of this variable, use the literal, L"tizen.filemanager", or L"tizen.gallery". * @since 2.0 * @endif */ @@ -373,22 +374,22 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_MEDIA; * * For more information, see Image Application Control. * -* @brief [Deprecated] +* @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.imageviewer". -* @since 2.0 +* @since 2.0 * @endif */ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_IMAGE; -/* +/** * @if OSPDEPREC -* The ImageCrop application control provider ID @n +* The Image Editor %AppControl provider ID @n * -* @brief [Deprecated] +* @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in a future release. * use the literal, L"tizen.imageeditor", instead of this variable. -* @since 2.0 +* @since 2.0 * @endif */ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_IMAGE_EDITOR; @@ -399,7 +400,7 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_IMAGE_EDITOR; * * For more information, see Video Application Control. * -* @brief [Deprecated] +* @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.videoplayer". * @since 2.0 @@ -413,10 +414,10 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_VIDEO; * * For more information, see Audio Application Control. * -* @brief [Deprecated] +* @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.musicplayer". -* @since 2.0 +* @since 2.0 * @endif */ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_AUDIO; @@ -427,10 +428,10 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_AUDIO; * * For more information, see Browser Application Control. * -* @brief [Deprecated] +* @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.internet". -* @since 2.0 +* @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/web.service * @@ -445,10 +446,10 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_BROWSER; * * For more information, see Camera Application Control. * -* @brief [Deprecated] +* @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.camera". -* @since 2.0 +* @since 2.0 * @endif */ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_CAMERA; @@ -459,12 +460,12 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_CAMERA; * * For more information, see Bluetooth Application Control. * -* @brief [Deprecated] +* @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.bluetooth". -* @since 2.0 +* @since 2.0 * -* @remarks Bluetooth functionality cannot be tested on the Emulator. +* @remarks Bluetooth functionality cannot be tested on the Emulator. * @endif */ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_BLUETOOTH; @@ -475,7 +476,7 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_BLUETOOTH; * * For more information, see Settings Application Control. * -* @brief [Deprecated] +* @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"tizen.settings". * @since 2.0 @@ -488,8 +489,8 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_PROVIDER_SETTINGS; * Operation Add. @n * Adds an application item. * -* @brief [Deprecated] -* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. +* @brief [Deprecated] +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/add". * @since 2.0 * @endif @@ -499,12 +500,12 @@ _OSP_EXPORT_ extern const Tizen::Base::String OPERATION_ADD; /** * @if OSPDEPREC * Operation Pick. @n -* Picks some application item(s). +* Picks an application item(s). * -* @brief [Deprecated] -* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. +* @brief [Deprecated] +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/pick". -* @since 2.0 +* @since 2.0 * @endif */ _OSP_EXPORT_ extern const Tizen::Base::String OPERATION_PICK; @@ -514,10 +515,10 @@ _OSP_EXPORT_ extern const Tizen::Base::String OPERATION_PICK; * Operation Edit. @n * Edits an application item. * -* @brief [Deprecated] -* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. +* @brief [Deprecated] +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/edit". -* @since 2.0 +* @since 2.0 * @endif */ _OSP_EXPORT_ extern const Tizen::Base::String OPERATION_EDIT; @@ -527,10 +528,10 @@ _OSP_EXPORT_ extern const Tizen::Base::String OPERATION_EDIT; * Operation View. @n * Shows the application content. * -* @brief [Deprecated] -* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. +* @brief [Deprecated] +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/view". -* @since 2.0 +* @since 2.0 * @endif */ _OSP_EXPORT_ extern const Tizen::Base::String OPERATION_VIEW; @@ -540,10 +541,10 @@ _OSP_EXPORT_ extern const Tizen::Base::String OPERATION_VIEW; * Operation Play. @n * Plays the application content. * -* @brief [Deprecated] -* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. +* @brief [Deprecated] +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/view". -* @since 2.0 +* @since 2.0 * @endif */ _OSP_EXPORT_ extern const Tizen::Base::String OPERATION_PLAY; @@ -553,10 +554,10 @@ _OSP_EXPORT_ extern const Tizen::Base::String OPERATION_PLAY; * Operation Default. @n * * Uses the default operation specific to the application control. -* An application control can export its functionality using an operation. If the application control exports only one operation, OPERATION_DEFAULT can act as an alias for the operation. +* An application control can export its functionality using an operation. If the application control exports only one operation, ::OPERATION_DEFAULT can act as the alias for that operation. * -* @brief [Deprecated] -* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. +* @brief [Deprecated] +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/main". * @since 2.0 * @endif @@ -567,8 +568,8 @@ _OSP_EXPORT_ extern const Tizen::Base::String OPERATION_DEFAULT; * @if OSPDEPREC * Operation Capture. * -* @brief [Deprecated] -* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. +* @brief [Deprecated] +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/createcontent". * @since 2.0 * @endif @@ -581,10 +582,10 @@ _OSP_EXPORT_ extern const Tizen::Base::String OPERATION_CAPTURE; * Operation Add. @n * Adds an application item. * -* @brief [Deprecated] +* @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/add". -* @since 2.0 +* @since 2.0 * @endif */ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_OPERATION_ADD; @@ -643,7 +644,7 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_OPERATION_CONFIGURE; * Operation Default. @n * * Uses the default operation specific to the application control. -* An application control can export its functionality using an operation. If the application control exports only one operation, OPERATION_DEFAULT can act as an alias for the operation. +* An application control can export its functionality using an operation. If the application control exports only one operation, ::OPERATION_DEFAULT can act as an alias for that operation. * * @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. @@ -683,12 +684,12 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_OPERATION_EDIT; * @if OSPDEPREC * Operation Main. @n * -* All the application exports the implicit %AppControl with %APPCONTROL_OPERATION_MAIN operation. +* All the applications export the implicit %AppControl with the %APPCONTROL_OPERATION_MAIN operation. * * @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/main". -* @since 2.0 +* @since 2.0 * @endif */ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_OPERATION_MAIN; @@ -696,10 +697,10 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_OPERATION_MAIN; /** * @if OSPDEPREC * Operation Pick. @n -* Picks some application item(s). +* Picks an application item(s). * * @brief [Deprecated] -* @deprecated This variable is providyed only for backward compatibility and will be deleted in the near future. +* @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of this variable, use the literal, L"http://tizen.org/appcontrol/operation/pick". * @since 2.0 * @endif @@ -722,7 +723,7 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_OPERATION_PLAY; /** * @if OSPDEPREC * Operation Record. @n -* Records the content. +* Records the application content. * * @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. @@ -735,7 +736,7 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_OPERATION_RECORD; /** * @if OSPDEPREC * Operation Share. @n -* Shares the contents. +* Shares the application content. * * @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. @@ -761,7 +762,7 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_OPERATION_VIEW; /** * @if OSPDEPREC * Operation Crop. @n -* Shows image with the crop rectangle. +* Shows the image with the crop rectangle. * * @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. @@ -773,7 +774,7 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_OPERATION_CROP; /** * @if OSPDEPREC - * Not specified category. + * No specified category. * * @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. @@ -873,7 +874,7 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_CATEGORY_EMAIL; /** * @if OSPDEPREC * The media category. @n - * Specifying App::APPCONTROL_CATEGORY_MEDIA is equivalent to specifying all the App::APPCONTROL_CATEGORY_AUDIO, + * Specifying %APPCONTROL_CATEGORY_MEDIA is equivalent to specifying the App::APPCONTROL_CATEGORY_AUDIO, * App::APPCONTROL_CATEGORY_IMAGE, and App::APPCONTROL_CATEGORY_VIDEO categories. * * @brief [Deprecated] @@ -973,7 +974,7 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_CATEGORY_VIDEO; /** * @if OSPDEPREC - * The complete URI handling category corresponding to AppManager::StartAppControl(). + * The complete URI handling category corresponding to the AppManager::StartAppControl() method. * * @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. @@ -1006,7 +1007,7 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_RESULT_FAILED; /** * @if OSPDEPREC - * The %AppControl operation is canceled. + * The %AppControl operation is cancelled. * * @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. @@ -1031,9 +1032,9 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_RESULT_TERMINATED; * @brief This class represents the application control behavior. * @since 2.0 * -* @final This class is not intended for extension. +* @final This class is not intended for extension. * -* The %AppControl class represents the application control behavior that provides a standard mechanism for using specific operations exported by other applications. +* The %AppControl class represents the application control behavior that provides a standard mechanism for using specific operations exported by other applications. * * For more information on the class features, see Application Controls. * @@ -1052,7 +1053,7 @@ _OSP_EXPORT_ extern const Tizen::Base::String APPCONTROL_RESULT_TERMINATED; * String telUri = L"tel:12345678900"; * * AppControl* pAc = AppManager::FindAppControlN(L"tizen.phone", L"http://tizen.org/appcontrol/operation/dial"); -* if(pAc) +* if(pAc) * { * pAc->Start(&telUri, null, null, null); * delete pAc; @@ -1087,24 +1088,21 @@ public: * @privilege %http://tizen.org/privilege/application.launch * * @return An error code - * @param[in] pDataList The data list to deliver to the resolved application control @n - * The maximum size of the list is 4096 bytes. - * @param[in] pListener The application control callback listener @n - * Some application controls need to get the callback result by implementing the IAppControlEventListener interface. + * @param[in] pDataList The data list to deliver to the resolved application control @n + * The maximum size of the list is 4096 bytes. + * @param[in] pListener The application control callback listener @n + * Some application controls get the callback result by implementing the IAppControlEventListener interface. * @exception E_SUCCESS The method is successful. * @exception E_MAX_EXCEEDED The size of @c pDataList has exceeded the maximum limit. - * @exception E_OBJ_NOT_FOUND The target application control resource is not found. - * @exception E_IN_PROGRESS The application control is in progress: @n - * - The application has already started an %AppControl. @n + * @exception E_OBJ_NOT_FOUND The target application control resource has not been found. + * @exception E_IN_PROGRESS The application control is in progress: + * - The application has already started an %AppControl. * - The target application has already started. * @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. - * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate of target application. @b Since: @b 2.1 - * @remarks If the IAppControlEventListener instance (@c pListener) needs to get the - * callback result for an application control, it must be valid till - * IAppControlEventListener::OnAppControlCompleted() is invoked. - * For example, a form object listener must not be deleted before the - * system invokes %IAppControlEventListener::OnAppControlCompleted(). + * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate as that of the target application. @b Since: @b 2.1 + * @remarks If the specified @c pListener needs to get the callback result for an application control, it must be valid till IAppControlEventListener::OnAppControlCompleted() is invoked. @n + * For example, a form object listener must not be deleted before the system invokes %IAppControlEventListener::OnAppControlCompleted(). * @see AppManager::FindAppControlN() * @see AppManager::FindAppControlsN() * @endif @@ -1112,8 +1110,8 @@ public: result Start(const Tizen::Base::Collection::IList* pDataList, IAppControlEventListener* pListener); /** - * Starts the found application control. @n - * Once the found application starts, the calling application goes to the background and the found + * Starts the located application control. @n + * Once the located application starts, the calling application goes to the background and the located * application is displayed. * * @since 2.0 @@ -1121,22 +1119,22 @@ public: * @privilege %http://tizen.org/privilege/application.launch * * @return An error code - * @param[in] pUriData A pointer to the URI data - * @param[in] pDataType 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 String or of type ArrayList of String to deliver to the resolved application @n - * The maximum size is 16 kilo bytes. - * @param[in] pListener The application control callback listener @n - * Some application need to get the result by implementing the IAppControlResponseListener interface. + * @param[in] pUriData A pointer to the URI data + * @param[in] pDataType A pointer to the MIME type (RFC 2046) data + * @param[in] pExtraData A pointer to the argument map of the 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, which is delivered to the resolved application @n + * The maximum size is 16 kilo bytes. + * @param[in] pListener The application control callback listener @n + * Some applications get the result by implementing the IAppControlResponseListener interface. * @exception E_SUCCESS The method is successful. * @exception E_MAX_EXCEEDED The size of @c pExtraData has exceeded the maximum limit. - * @exception E_OBJ_NOT_FOUND The target application control is not found. + * @exception E_OBJ_NOT_FOUND The target application control has not been found. * @exception E_IN_PROGRESS The application control is in progress: @n * - The application has already started an %AppControl. * @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. - * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate of target application. @b Since: @b 2.1 - * @remarks If the calling application needs to get some result for application control, - * it must be valid till IAppControlResponseListener::OnAppControlCompleteResponseReceived() is invoked. + * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate as that of the target application. @b Since: @b 2.1 + * @remarks If the calling application needs to get some result for the application control, + * it must be valid till IAppControlResponseListener::OnAppControlCompleteResponseReceived() is invoked. @n * For example, a form object listener must not be deleted before the * system invokes %IAppControlResponseListener::OnAppControlCompleteResponseReceived(). * @see AppManager::FindAppControlN() @@ -1145,9 +1143,9 @@ public: result Start(const Tizen::Base::String* pUriData, const Tizen::Base::String* pDataType, const Tizen::Base::Collection::IMap* pExtraData, IAppControlResponseListener* pListener); /** - * Finds the matching application control with given operation ID, URI pattern, data type, and category and - * starts the found one. @n - * If there are more than one application controls found, then the selection is shown for user and the one that the user selects is started. + * Finds the matching application control with the given operation ID, URI pattern, data type, and category, after which it + * starts the found application control. @n + * If more than one application control is found, then user selection is enabled and the one selected by the user is started. * When the found application control is started, the URI pattern, MIME type, and extra data is delivered using IAppControlProviderEventListener. * * @since 2.0 @@ -1155,22 +1153,22 @@ public: * @privilege %http://tizen.org/privilege/application.launch * * @return An error code - * @param[in] operationId The operation ID - * @param[in] pUriPattern A URI pattern which is used for application control resolution and is delivered as the argument - * @param[in] pDataType The MIME type (RFC 2046) or file extension @n - * The '.' prefix must be used when specifying the file extension. - * @param[in] pCategory The application control category - * @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 to deliver to - * the resolved application @n - * The maximum size is 16 kilo bytes. - * @param[in] pListener A listener that gets notified - * @exception E_SUCCESS The method is successful. - * @exception E_MAX_EXCEEDED The size of @c pDataList has exceeded the maximum limit. - * @exception E_OBJ_NOT_FOUND The application control is not found. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @param[in] operationId The operation ID + * @param[in] pUriPattern The URI pattern that is used for the application control resolution which is delivered as an argument + * @param[in] pDataType The MIME type (RFC 2046) or file extension @n + * The '.' prefix must be used while specifying the file extension. + * @param[in] pCategory The application control category + * @param[in] pExtraData A pointer to the argument map of the 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 which is delivered to + * the resolved application @n + * The maximum size is 16 kilo bytes. + * @param[in] pListener The listener that gets notified + * @exception E_SUCCESS The method is successful. + * @exception E_MAX_EXCEEDED The size of @c pDataList has exceeded the maximum limit. + * @exception E_OBJ_NOT_FOUND The application control has not been found. + * @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. - * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate of target application. @b Since: @b 2.1 + * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate as that of the target application. @b Since: @b 2.1 */ static result FindAndStart(const Tizen::Base::String& operationId, const Tizen::Base::String* pUriPattern, const Tizen::Base::String* pDataType, const Tizen::Base::String* pCategory, const Tizen::Base::Collection::IMap* pExtraData, IAppControlResponseListener* pListener); @@ -1179,7 +1177,7 @@ public: * * @since 2.0 * - * @param[in] pListener The listener to stop receiving the application control result + * @param[in] pListener The listener to stop from receiving the application control result */ static void StopAppControlResponseListener(IAppControlResponseListener* pListener); @@ -1188,7 +1186,7 @@ public: * * @since 2.0 * - * @return The name of the application providing this %AppControl instance + * @return The name of the application that provides this %AppControl instance */ Tizen::Base::String GetAppName(void) const; @@ -1202,16 +1200,16 @@ public: AppId GetAppId(void) const; /** - * @if OSPDEPREC + * @if OSPDEPREC * Gets the associated application control provider ID. * * @brief [Deprecated] - * @deprecated This method is deprecated because application ID replaced the role of provider ID. @n + * @deprecated This method is deprecated because the application ID has replaced the role of the provider ID. @n * Instead of using this method, use GetAppId(). * @since 2.0 * * @return The application control provider ID - * @endif + * @endif */ Tizen::Base::String GetAppControlProviderId(void) const; @@ -1229,9 +1227,9 @@ public: * * @since 2.0 * - * @return A pointer to the list of application control categories, @n - * else @c null if an error occurs - * @exception E_SUCCESS The method is successful. + * @return A pointer to the list of application control categories, @n + * else @c null if an error occurs + * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -1241,16 +1239,19 @@ public: /** * Stops the activated application control. @n - * The %Stop() method works only with the following %AppControls provided by the platform: + * The %Stop() method works only with the following AppControls provided by the platform: * tizen.bluetooth, tizen.calendar, tizen.camera, tizen.certificatemanager, tizen.contacts, * tizen.email, tizen.filemanager, tizen.gallery, tizen.imageviewer, tizen.mmsmessages, and tizen.smsmessages. * * @since 2.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/application.launch * - * @return An error code - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. - * @exception E_INVALID_OPERATION The application control is not permitted to call this method. + * @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_INVALID_OPERATION The application control is not permitted to call this method. * @remarks This method is asynchronous. */ result Stop(void); diff --git a/inc/FAppAppControlProviderManager.h b/inc/FAppAppControlProviderManager.h index fe2038d..01d0365 100644 --- a/inc/FAppAppControlProviderManager.h +++ b/inc/FAppAppControlProviderManager.h @@ -52,9 +52,8 @@ class IAppControlProviderEventListener; * The %AppControl provider registers or unregisters the IAppControlProviderEventListener listener * for providing the %AppControl functionality, looks up for the delivered %AppControl request information, * and sends the %AppControl result back to the calling application. @n - * - * The request ID is used to identify each %AppControl request and can be acquired using - * IAppControlProviderEventListener::OnAppControlRequestReceived(). + * The request ID is used to identify each %AppControl request and can be acquired using the + * IAppControlProviderEventListener::OnAppControlRequestReceived() method. * */ class _OSP_EXPORT_ AppControlProviderManager @@ -62,12 +61,12 @@ class _OSP_EXPORT_ AppControlProviderManager { public: /** - * Gets the application control provider manager instance. + * Gets a pointer to the %AppControlProviderManager instance. * * @since 2.0 * - * @return A pointer to the %AppControlProviderManager instance if it succeeds, @n - * else @c null + * @return A pointer to the %AppControlProviderManager instance, @n + * else @c null if it fails */ static AppControlProviderManager* GetInstance(void); @@ -75,23 +74,23 @@ public: * Sets the application control provider listener to the application control provider manager. @n * The listener gets notified when the application control request is received from other applications. * To unset the listener, pass a @c null value to the listener parameter. @n - * - * If the application does not set the listener using %SetAppControlProviderEventListener(), + * If the application does not set the listener using the %SetAppControlProviderEventListener() method, * then the application is launched or moves to the foreground without invoking any listener * for the application request from another application. * * @since 2.0 * - * @return An error code - * @param[in] pListener The application control provider listener - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE This instance has not been properly constructed. - * @exception E_INVALID_OPERATION The listener must be set for the valid %App class. - * @exception E_SYSTEM A system error has occurred. - * @remarks If the application is newly launched with the AppControl request, then %SetAppControlProviderEventListener() must - * be set before invoking IAppControlProviderEventListener::OnAppControlRequestReceived(). - * For valid %AppControl request handling, %SetAppControlProviderEventListener() must be called within - * App::OnAppInitializing(). + * @return An error code + * @param[in] pListener The application control provider listener + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_STATE This instance has not been properly constructed. + * @exception E_INVALID_OPERATION The listener must be set for the valid App class. + * @exception E_SYSTEM A system error has occurred. + * @remarks + * - If the application is newly launched with the AppControl request, then the %SetAppControlProviderEventListener() method must + * be set before invoking the IAppControlProviderEventListener::OnAppControlRequestReceived() method. + * - For valid %AppControl request handling, the %SetAppControlProviderEventListener() method within App::OnAppInitializing() + * must be called. */ result SetAppControlProviderEventListener(IAppControlProviderEventListener* pListener); @@ -100,30 +99,30 @@ public: * * @since 2.0 * - * @return The application ID @n - * If an error occurs, an empty string is returned. - * @param[in] reqId The requestID - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The application control request is not found. + * @return The application ID, @n + * else an empty string is returned if an error occurs + * @param[in] reqId The requestID + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The application control request has not been found. * @exception E_INVALID_STATE This instance has not been properly constructed. - * @exception E_SYSTEM A system error has occurred. + * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. */ AppId GetClientAppId(RequestId reqId) const; /** * Sends the result list for the application control request. @n - * The client receives the result by implementing IAppControlResponseListener::OnAppControlCompleteResponseReceived(). + * The client receives the result by implementing the IAppControlResponseListener::OnAppControlCompleteResponseReceived() method. * * @since 2.0 * - * @return An error code - * @param[in] reqId The application control request ID + * @return An error code + * @param[in] reqId The application control request ID * @param[in] appControlResult The application control result - * @param[in] pExtraData A pointer to an extra 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 type Tizen::Base::Collection::ArrayList of %Tizen::Base::String - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The application control request is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] pExtraData A pointer to the extra argument map of the 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 + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The application control request has not been found. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ result SendAppControlResult(RequestId reqId, AppCtrlResult appControlResult, const Tizen::Base::Collection::IMap* pExtraData); diff --git a/inc/FAppAppManager.h b/inc/FAppAppManager.h index fb86252..4a32bce 100644 --- a/inc/FAppAppManager.h +++ b/inc/FAppAppManager.h @@ -57,10 +57,10 @@ class MapDataControl; * @final This class is not intended for extension. * * The %AppManager class manages all the applications. - * The application manager supports normal and conditional application launch, and application control search and launch. + * The application manager supports both normal and conditional application launch as well as application control search and launch. * It looks up the specific application control from the application control registry and creates an application control instance. - * @n - * For more information on the class features, see Launching Other Applications and Registering a Launch Condition, and Application Controls. + * + * For more information on the class features, see Launching Other Applications, Registering a Launch Condition, and Application Controls. */ class _OSP_EXPORT_ AppManager : public Tizen::Base::Object @@ -75,7 +75,7 @@ public: */ enum LaunchOption { - LAUNCH_OPTION_DEFAULT /**< The launch option: default */ + LAUNCH_OPTION_DEFAULT /**< The default launch option */ }; /** @@ -84,16 +84,18 @@ public: * * @since 2.0 * - * @return A pointer to the newly created AppControl instance if a matched %AppControl is found, @n - * else @c null + * @return A pointer to the newly created AppControl instance, if a matched %AppControl is found, @n + * else @c null if it fails * @param[in] appId The application ID * @param[in] operationId The operation ID * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The application control is not found. - * @exception E_SYSTEM A system error has occurred. @n - * Either the file operation or the DB operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks %Tizen platform defines platform-defined alias for application ID and this aliased application ID + * @exception E_OBJ_NOT_FOUND The application control has not been found. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - Either the file operation or the DB operation has failed. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - The %Tizen platform defines a platform-defined alias for the application ID and this aliased application ID * can be used to find the AppControl. For more information, see * here. * @@ -109,26 +111,27 @@ public: static AppControl* FindAppControlN(const AppId& appId, const Tizen::Base::String& operationId); /** - * Finds a list of AppControl instances that matches the specified operation ID, category, + * Finds a list of AppControl instances that match the specified operation ID, category, * data type, and URI pattern. * * @since 2.0 * - * @return A pointer to the list of the AppControl instances that matches the specified operation ID, category, URI, and data type, @n - * else @c null if it fails - * @param[in] pOperationId The operation ID - * @param[in] pCategory The application category - * @param[in] pDataType The MIME type (RFC 2046) or file extension @n - * The '.' prefix must be used when specifying the file extension. - * @param[in] pUriPattern The URI pattern + * @return A pointer to the list of the AppControl instances that match the specified operation ID, category, URI, and data type, @n + * else @c null if it fails + * @param[in] pOperationId The operation ID + * @param[in] pCategory The application category + * @param[in] pDataType The MIME type (RFC 2046) or file extension @n + * The '.' prefix must be used while specifying the file extension. + * @param[in] pUriPattern The URI pattern * - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG At least one of the specified @c pOperationId, @c pCategory, @c pDataType, or @c pUriScheme must not be @c null. - * @exception E_INVALID_FORMAT The specified URI scheme is invalid (RFC 2396). + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG At least one of the specified @c pOperationId, @c pCategory, @c pDataType, or @c pUriScheme must not be @c null. + * @exception E_INVALID_FORMAT The specified URI scheme is invalid (RFC 2396). * @exception E_UNSUPPORTED_FORMAT The specified file extension for @c pDataType is not supported. - * @exception E_OBJ_NOT_FOUND The application control is not found. - * @exception E_SYSTEM A system error has occurred. @n - * Either the file operation or the DB operation has failed. + * @exception E_OBJ_NOT_FOUND The application control has not been found. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - Either the file operation or the DB operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Base::Collection::IList* FindAppControlsN(const Tizen::Base::String* pOperationId, const Tizen::Base::String* pCategory, const Tizen::Base::String* pDataType, const Tizen::Base::String* pUriPattern); @@ -136,9 +139,9 @@ public: /** * @if OSPDEPREC * Starts the application control if there is only one application control that matches the specified URI, operation ID, and data type. @n - * If there are more than one application controls, the one that the user selects is started. + * If there are more than one application controls, then the user selected one is started. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated because IAppControlListener is deprecated and replaced by IAppControlResponselistener. * Instead of using this method, use AppControl::FindAndStart(). * @since 2.0 @@ -146,19 +149,19 @@ public: * @privilege %http://tizen.org/privilege/application.launch * * @return An error code - * @param[in] uriData The URI that has a maximum size of @c 1024 bytes - * @param[in] pOperationId The operation ID - * @param[in] pDataType The MIME type (RFC 2046) or file extension @n - * The '.' prefix must be used for the @c dataType when specifying the file extension. - * @param[in] pListener A listener that gets notified when the resolved application control has started - * @exception E_SUCCESS The method is successful. - * @exception E_MAX_EXCEEDED The size of @c uri has exceeded the maximum limit. + * @param[in] uriData The URI that has a maximum size of @c 1024 bytes + * @param[in] pOperationId The operation ID + * @param[in] pDataType The MIME type (RFC 2046) or file extension @n + * The '.' prefix must be used for the @c dataType while specifying the file extension. + * @param[in] pListener The listener that gets notified when the resolved application control is started + * @exception E_SUCCESS The method is successful. + * @exception E_MAX_EXCEEDED The size of @c uri has exceeded the maximum limit. * @exception E_UNSUPPORTED_FORMAT The specified file extension for @c pDataType is not supported. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_OBJ_NOT_FOUND The application control is not found. - * @exception E_IN_PROGRESS The target application control is in progress. - * @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. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_OBJ_NOT_FOUND The application control has not been found. + * @exception E_IN_PROGRESS The target application control is in progress. + * @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. * * @see App::GetAppArgumentListN() * @see FindAppControlN() @@ -177,34 +180,33 @@ public: /** * @if OSPDEPREC * Starts the application control if there is only one application control that matches the specified operation ID, category, URI, and data type. @n - * If there are more than one application controls, the one that the user selects is started. + * If there are more than one application controls, then the user selected one is started. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated because IAppControlListener is deprecated and replaced by IAppControlResponselistener. * Instead of using this method, use AppControl::FindAndStart(). * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/application.launch * - * @return An error code - * @param[in] pOperationId The operation ID - * @param[in] pCategory The application control category - * @param[in] pDataType The MIME type (RFC 2046) or file extension @n - * The '.' prefix must be used when specifying the file extension. - * @param[in] pUriPattern A URI pattern which is used for application control resolution and delivered as the argument - * @param[in] pDataList The data list that is delivered to the resolved application control @n - * It has a maximum size of @c 1024 bytes. - * @param[in] pListener A listener that gets notified when the resolved application control has started - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG At least one of the specified @c pOperationId, @c pCategory, @c pDataType, or @c pUri must not be @c null. - * @exception E_MAX_EXCEEDED The size of @c pDataList has exceeded the maximum limit. + * @return An error code + * @param[in] pOperationId The operation ID + * @param[in] pCategory The application control category + * @param[in] pDataType The MIME type (RFC 2046) or file extension @n + * The '.' prefix must be used while specifying the file extension. + * @param[in] pUriPattern The URI pattern which is used for the application control resolution and is delivered as an argument + * @param[in] pDataList The data list that is delivered to the resolved application control @n + * It has a maximum size of @c 1024 bytes. + * @param[in] pListener The listener that gets notified when the resolved application control is started + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG At least one of the specified @c pOperationId, @c pCategory, @c pDataType, or @c pUri must not be @c null. + * @exception E_MAX_EXCEEDED The size of @c pDataList has exceeded the maximum limit. * @exception E_UNSUPPORTED_FORMAT The specified file extension for @c pDataType is not supported. - * @exception E_OBJ_NOT_FOUND The application control is not found. - * @exception E_IN_PROGRESS The target application control is in progress. - * @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. + * @exception E_OBJ_NOT_FOUND The application control has not been found. + * @exception E_IN_PROGRESS The target application control is in progress. + * @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. * @remarks For delivered launch arguments, see App::GetAppArgumentListN(). - * @see App::GetAppArgumentListN() * @see FindAppControlsN() * @see AppControl::Start() * @endif @@ -217,12 +219,12 @@ public: * * @since 2.0 * - * @return A pointer to the SqlDataControl instance if a matching data control is found, @n - * else @c null + * @return A pointer to the SqlDataControl instance, if a matching data control is found, @n + * else @c null if it fails * @param[in] providerId The provider ID * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The data control specified with the @c providerId is not found. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_OBJ_NOT_FOUND The data control specified with the @c providerId has not been found. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -235,12 +237,12 @@ public: * * @since 2.0 * - * @return A pointer to the MapDataControl instance if a matching data control is found, @n - * else @c null + * @return A pointer to the MapDataControl instance, if a matching data control is found, @n + * else @c null if it fails * @param[in] providerId The provider ID * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The data control specified with the @c providerId is not found. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_OBJ_NOT_FOUND The data control specified with the @c providerId has not been found. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -248,7 +250,7 @@ public: static MapDataControl* GetMapDataControlN(const Tizen::Base::String& providerId); /** - * Gets the path of the read-only shared directory exported by an other application specified with an application ID. + * Gets the path of the read-only shared directory exported by another application specified with an application ID. * * @since 2.0 * @@ -256,16 +258,16 @@ public: * else an empty string if an exception occurs * @param[in] appId The application ID * @exception E_SUCCESS The method is successful. - * @exception E_APP_NOT_INSTALLED The expected shared directory cannot be found - * because the application specified with @c appId cannot be installed. + * @exception E_APP_NOT_INSTALLED The expected shared directory has not been found + * because the application specified by @c appId cannot be installed. * @remarks - * - The returned path can be invalid when the application with specified with @c appId is uninstalled. - * - The specific error code can be accessed using the GetLastResult() method. + * - The returned path can be invalid when the application specified by @c appId is uninstalled. + * - The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Base::String GetAppSharedPath(const AppId& appId); /** - * Gets the application manager instance. + * Gets a pointer to the %AppManager instance. * * @since 2.0 * @@ -277,28 +279,28 @@ public: /** * @if OSPDEPREC * Launches the default application with the given @c appId. @n - * The launch arguments are given as App::OnUserEventReceivedN() or can be obtained by - * invoking App::GetAppArgumentListN(), especially within App::OnAppInitializing(). + * The launch arguments are given by the App::OnUserEventReceivedN() method or can be obtained by + * invoking the App::GetAppArgumentListN() method, especially within App::OnAppInitializing(). * * @brief [Deprecated] - * @deprecated This method is deprecated because sending argument with %LaunchApplication() is not recommended. @n - * Instead of using this method, use %LaunchApplication() without launch arguments or AppControl::Start(). - * @since 2.0 + * @deprecated This method is deprecated because sending arguments through the %LaunchApplication() method is not recommended. @n + * Instead of using this method, use the %LaunchApplication() method without launch arguments or AppControl::Start(). + * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/application.launch * - * @return An error code - * @param[in] appId The application's ID to execute + * @return An error code + * @param[in] appId The ID of the application to execute * @param[in] pArguments A pointer to the list of string arguments that has a maximum size of @c 1024 bytes * @param[in] option The launch option (currently only AppManager::LAUNCH_OPTION_DEFAULT is available) * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @exception E_INVALID_ARG The specified @c appId is empty. - * @exception E_OBJ_NOT_FOUND The target application is not installed. + * @exception E_OBJ_NOT_FOUND The target application has not been installed. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_MAX_EXCEEDED The size of @c appId or @c pArguments has exceeded the maximum limit. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate of target application. @b Since: @b 2.1 + * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate as that of the target application. @b Since: @b 2.1 * @endif */ result LaunchApplication(const AppId& appId, const Tizen::Base::Collection::IList* pArguments, LaunchOption option = LAUNCH_OPTION_DEFAULT); @@ -306,18 +308,18 @@ public: /** * Launches the default application with the given @c appId. * - * @since 2.0 + * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/application.launch * - * @return An error code - * @param[in] appId The application's ID to execute + * @return An error code + * @param[in] appId The ID of the application to execute * @param[in] option The launch option (currently only AppManager::LAUNCH_OPTION_DEFAULT is available) * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @exception E_APP_NOT_INSTALLED The target application is not installed. + * @exception E_APP_NOT_INSTALLED The target application has not been installed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate of target application. @b Since: @b 2.1 + * @exception E_ILLEGAL_ACCESS The application is not signed with the same certificate as that of the target application. @b Since: @b 2.1 */ result LaunchApplication(const AppId& appId, LaunchOption option = LAUNCH_OPTION_DEFAULT); @@ -329,33 +331,35 @@ public: * @privilege %http://tizen.org/privilege/appmanager.kill @n * (%http://tizen.org/privilege/application.kill is deprecated.) * - * @return An error code - * @param[in] appId The application's ID to execute + * @return An error code + * @param[in] appId The ID of the application to execute * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. - * @exception E_OBJ_NOT_FOUND The application is either not installed or is not running. + * @exception E_OBJ_NOT_FOUND Either of the following conditions has occurred: + * - The application is not installed. + * - The application is not running. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ result TerminateApplication(const AppId& appId); /** - * Checks whether an application is running. + * Checks whether the application is running. * * @since 2.0 * - * @return @c true if the application is running, @n - * else @c false - * @param[in] appId The installed application ID + * @return @c true if the application is running, @n + * else @c false + * @param[in] appId The installed application's ID */ bool IsRunning(const AppId& appId) const; /** - * Gets a list of running applications at the time of invocation. + * Gets the list of running applications at the time of the invocation. * * @since 2.0 * - * @return A pointer to the running state application list (AppId), @n - * else @c null if an error occurs + * @return A pointer to the running state application list (AppId), @n + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. @@ -365,53 +369,56 @@ public: /** * Registers an application with a specific condition and launches it if the condition is met. @n - * If the requested application is already running, the application is notified through IAppLaunchConditionEventListener::OnAppLaunchConditionMetN(). - * The launch arguments are given as input parameters to %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN(). + * If the requested application is already running, the application is notified through the IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method. + * The launch arguments are given as input parameters to the %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method. * - * @since 2.0 + * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/application.launch - * @feature %http://tizen.org/feature/network.nfc for L"NFC='command'" or %http://tizen.org/feature/usb.accessory for "Serial='command'" in the value of @c condition + * @feature %http://tizen.org/feature/network.nfc for L"NFC='command'" or %http://tizen.org/feature/usb.accessory for "Serial='command'" in the value of @c condition * * @return An error code * @param[in] condition The launch condition for the application @n - * The condition has L"Key='value'" format and is case sensitive. To use single or double quotes in the condition values, prefix them with a slash (\' or \"). @n - * For more information on the condition formats, see Registering a Launch Condition. - * - - - - - - - -
Condition FormatMeaning
L"DateTime='mm/dd/yyyy hh:mm:ss'"The specified condition is the local due time.
L"DueTime='mm/dd/yyyy hh:mm:ss' LaunchPeriod='mm'"The specific condition is the time period after due time.
L"WeeklyTime='EEE HH:mm:ss'"The specified condition is a day of a week with a specific time at which the application is launched on a weekly basis. For multiple descriptions, "," delimiter can be used as shown in the following example:
i"'Mon 09:00:00', 'Tue 09:00:00', 'Wed 09:00:00', 'Thu 09:00:00', 'Fri 09:00:00'"
To specify the day of the week, it must be in one of the following supported string format:
Mon: Monday
Tue: Tuesday
Wed: Wednesday
Thu: Thursday
Fri: Friday
Sat: Saturday
Sun: Sunday
L"Serial='command'"The specified condition is a serial - communication input command.
L"NFC='command'"The specified condition is a Near Field Communication (NFC) tag that has the NFC Data Exchange Format (NDEF) data. -
@n - - * - * @param[in] pArguments A list of string arguments that has a maximum size of @c 1024 bytes @n - * The parameter can also contain @c null. @n - * For more information on the arguments, see Launching Other Applications. - * @param[in] option The launch option (currently only AppManager::LAUNCH_OPTION_DEFAULT is available) - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The launch condition is empty or too long (Maximum 400 bytes). - * @exception E_INVALID_FORMAT The specified condition format is invalid. - * @exception E_INVALID_CONDITION The specified condition format is valid but the condition has at least one or more invalid values. - * @exception E_OBJ_ALREADY_EXIST The specified @c condition is already registered by a different application. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_MAX_EXCEEDED The size of @c pArguments has exceeded the maximum limit. - * @exception E_SYSTEM A system error has occurred. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. For more information, see Application Filtering. @b Since: @b 2.1 - * - * @remarks When the registered application is about to be launched, the registered launch condition and arguments are given as parameters to IAppLaunchConditionEventListener::OnAppLaunchConditionMetN(). - * @remarks The newly introduced launch condition does not work on the previous SDK version and the E_INVALID_CONDITION exception is returned. - * @remarks Registering the same launch condition overwrites the previous launch argument without throwing an exception. - * @remarks The launch period requires more consideration because an inappropriate short period value may lead - * to an adverse effect on the device battery. - * @remarks For the NFC launch condition, the detected NDEF message can be acquired using the @c pExtraData parameter of the %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method. - * @remarks Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&). + * The condition has L"Key='value'" format and is case sensitive. To use single or double quotes in the condition values, prefix them with a slash (\' or \"). @n + * For more information on the condition formats, see Registering a Launch Condition. + * + * + * + * + * + * + * + * + *
Condition FormatMeaning
L"DateTime='mm/dd/yyyy hh:mm:ss'"The specified condition is the local due time.
L"DueTime='mm/dd/yyyy hh:mm:ss' LaunchPeriod='mm'"The specified condition is the time period after the due time.
L"WeeklyTime='EEE HH:mm:ss'"The specified condition is a day of a week with a specific time at which the application is launched on a weekly basis. For multiple descriptions, "," delimiter can be used as shown in the following example:
i"'Mon 09:00:00', 'Tue 09:00:00', 'Wed 09:00:00', 'Thu 09:00:00', 'Fri 09:00:00'"
To specify the day of the week, it must be in one of the following supported string format:
Mon: Monday
Tue: Tuesday
Wed: Wednesday
Thu: Thursday
Fri: Friday
Sat: Saturday
Sun: Sunday
L"Serial='command'"The specified condition is a serial + * communication input command.
L"NFC='command'"The specified condition is a Near Field Communication (NFC) tag that has the NFC Data Exchange Format (NDEF) data. + *
@n + * + * + * @param[in] pArguments The list of string arguments that has a maximum size of @c 1024 bytes @n + * This parameter can also contain @c null. @n + * For more information on the arguments, see Launching Other Applications. + * @param[in] option The launch option (currently only AppManager::LAUNCH_OPTION_DEFAULT is available) + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The launch condition is empty or too long (Maximum 400 bytes). + * @exception E_INVALID_FORMAT The specified condition format is invalid. + * @exception E_INVALID_CONDITION The specified condition format is valid but the condition has at least one or more invalid values. + * @exception E_OBJ_ALREADY_EXIST The specified @c condition is already registered by a different application. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_MAX_EXCEEDED The size of @c pArguments has exceeded the maximum limit. + * @exception E_SYSTEM A system error has occurred. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. + * For more information, see Application Filtering. @b Since: @b 2.1 + * + * @remarks + * - When the registered application is about to be launched, the registered launch condition and arguments are given as parameters to the + * IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method. + * - For the NFC launch condition, the detected NDEF message can be acquired using the @c pExtraData parameter of the + * %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method. + * - The newly introduced launch condition does not work on the previous SDK version and @c E_INVALID_CONDITION is returned. + * - Registering the same launch condition overwrites the previous launch argument without throwing an exception. + * - The launch period requires more consideration because an inappropriate short period value may lead to an adverse effect on the device battery. + * - Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&). * @see UnregisterAppLaunch() * @see IsAppLaunchRegistered() * @see LaunchApplication(const AppId&, LaunchOption); @@ -439,16 +446,16 @@ public: /** * Unregisters the previously registered launch condition. * - * @since 2.0 + * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/application.launch * * @return An error code - * @exception E_SUCCESS Either of the following conditions has occurred: + * @exception E_SUCCESS Either of the following conditions has occurred: * - The method is successful. * - There is no registered launch condition. - * @exception E_SYSTEM A system error has occurred. - * @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_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @see RegisterAppLaunch() * @see IsAppLaunchRegistered() */ @@ -464,7 +471,7 @@ public: * @return An error code * @param[in] condition The launch condition for the application * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified launch condition is not found. + * @exception E_OBJ_NOT_FOUND The specified launch condition has not been found. * @exception E_SYSTEM A system error has occurred. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. @@ -474,11 +481,11 @@ public: result UnregisterAppLaunch(const Tizen::Base::String& condition); /** - * Checks whether a launch condition is registered for the application. + * Checks whether the launch condition is registered for the application. * * @since 2.0 * - * @return @c true if a condition is already registered to the application invoking this method, @n + * @return @c true if the condition is already registered for the application, @n * else @c false * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. @@ -490,59 +497,62 @@ public: bool IsAppLaunchRegistered(void) const; /** - * Registers the specified application with a specific condition and launches it if the condition is met. @n - * If the requested application is already running, the application is notified through IAppLaunchConditionEventListener::OnAppLaunchConditionMetN(). - * The launch arguments are given as input parameters to %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN(). + * Registers the specified application with the specified condition and launches it if the condition is met. @n + * If the requested application is already running, the application is notified through the IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method. + * The launch arguments are given as input parameters to the %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method. * * @since 2.0 * @privlevel partner * @privilege %http://tizen.org/privilege/appmanager.launch - * @feature %http://tizen.org/feature/network.nfc for L"NFC='command'" or %http://tizen.org/feature/usb.accessory for L"Serial='command'" in the value of @c condition + * @feature %http://tizen.org/feature/network.nfc for L"NFC='command'", or %http://tizen.org/feature/usb.accessory for L"Serial='command'" in the value of @c condition * * @return An error code * @param[in] appId The ID of the application registered for launch * @param[in] condition The launch condition for the application @n * The condition has L"Key='value'" format and is case sensitive. To use single or double quotes in the condition values, prefix them with a slash (\' or \"). @n * For more information on the condition formats, see Registering a Launch Condition. - * - - - - - - - -
Condition FormatMeaning
L"DateTime='mm/dd/yyyy hh:mm:ss'"The specified condition is the local due time.
L"DueTime='mm/dd/yyyy hh:mm:ss' LaunchPeriod='mm'"The specific condition is the time period after due time.
L"WeeklyTime='EEE HH:mm:ss'"The specified condition is a day of a week with a specific time at which the application is launched on a weekly basis. For multiple descriptions, "," delimiter can be used as shown in the following example:
i"'Mon 09:00:00', 'Tue 09:00:00', 'Wed 09:00:00', 'Thu 09:00:00', 'Fri 09:00:00'"
To specify the day of the week, it must be in one of the following supported string format:
Mon: Monday
Tue: Tuesday
Wed: Wednesday
Thu: Thursday
Fri: Friday
Sat: Saturday
Sun: Sunday
L"Serial='command'"The specified condition is a serial - communication input command.
L"NFC='command'"The specified condition is a Near Field Communication (NFC) tag that has the NFC Data Exchange Format (NDEF) data. -
@n - - * - * @param[in] pArguments A list of string arguments that has a maximum size of @c 1024 bytes @n - * The parameter can also contain @c null. @n - * For more information on the arguments, see Launching Other Applications. - * @param[in] option The launch option (currently only AppManager::LAUNCH_OPTION_DEFAULT is available) - * @exception E_SUCCESS The method is successful. - * @exception E_APP_NOT_INSTALLED The application is not installed. - * @exception E_INVALID_ARG The launch condition is empty or too long (Maximum 400 bytes). - * @exception E_INVALID_FORMAT The specified condition format is invalid. - * @exception E_INVALID_CONDITION The specified condition format is valid but the condition has at least one or more invalid values. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_MAX_EXCEEDED The size of @c pArguments has exceeded the maximum limit. - * @exception E_SYSTEM A system error has occurred. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. For more information, see Application Filtering. @b Since: @b 2.1 - * - * @remarks When the registered application is about to be launched, the registered launch condition and arguments are given as parameters to IAppLaunchConditionEventListener::OnAppLaunchConditionMetN(). - * @remarks The newly introduced launch condition does not work on the previous SDK version and the @c E_INVALID_CONDITION exception is returned. - * @remarks Registering the same launch condition overwrites the previous launch argument without throwing an exception. - * @remarks The launch period requires more consideration because an inappropriate short period value may lead - * to an adverse effect on the device battery. - * @remarks For the NFC launch condition, the detected NDEF message can be acquired using the @c pExtraData parameter of the %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method. - * @remarks Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&). + * + * + * + * + * + * + * + * + *
Condition FormatMeaning
L"DateTime='mm/dd/yyyy hh:mm:ss'"The specified condition is the local due time.
L"DueTime='mm/dd/yyyy hh:mm:ss' LaunchPeriod='mm'"The specified condition is the time period after the due time.
L"WeeklyTime='EEE HH:mm:ss'"The specified condition is a day of a week with a specific time at which the application is launched on a weekly basis. For multiple descriptions, "," delimiter can be used as shown in the following example:
i"'Mon 09:00:00', 'Tue 09:00:00', 'Wed 09:00:00', 'Thu 09:00:00', 'Fri 09:00:00'"
To specify the day of the week, it must be in one of the following supported string format:
Mon: Monday
Tue: Tuesday
Wed: Wednesday
Thu: Thursday
Fri: Friday
Sat: Saturday
Sun: Sunday
L"Serial='command'"The specified condition is a serial + * communication input command.
L"NFC='command'"The specified condition is a Near Field Communication (NFC) tag that has the NFC Data Exchange Format (NDEF) data. + *
@n + * + * + * @param[in] pArguments The list of string arguments that has a maximum size of @c 1024 bytes @n + * The parameter can also contain @c null. @n + * For more information on the arguments, see Launching Other Applications. + * @param[in] option The launch option (currently only AppManager::LAUNCH_OPTION_DEFAULT is available) + * @exception E_SUCCESS The method is successful. + * @exception E_APP_NOT_INSTALLED The application has not been installed. + * @exception E_INVALID_ARG The launch condition is empty or too long (Maximum 400 bytes). + * @exception E_INVALID_FORMAT The specified condition format is invalid. + * @exception E_INVALID_CONDITION The specified condition format is valid but the condition has at least one or more invalid values. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_MAX_EXCEEDED The size of @c pArguments has exceeded the maximum limit. + * @exception E_SYSTEM A system error has occurred. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. + * For more information, see Application Filtering. @b Since: @b 2.1 + * + * @remarks + * - When the registered application is about to be launched, the registered launch condition and arguments are given as parameters to the + * IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method. + * - For the NFC launch condition, the detected NDEF message can be acquired using the @c pExtraData parameter of the + * %IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() method. + * - The newly introduced launch condition does not work on the previous SDK version and @c E_INVALID_CONDITION is returned. + * - Registering the same launch condition overwrites the previous launch argument without throwing an exception. + * - The launch period requires more consideration because an inappropriate short period value may lead + * to an adverse effect on the device battery. + * - Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&). * @see UnregisterAppLaunch() * @see IsAppLaunchRegistered() * @see LaunchApplication(const AppId&, LaunchOption); - * @see IAppLaunchConditionEventListener::OnAppLaunchConditionMetN() * @see Tizen::Base::DateTime::ToString() * @see Tizen::Io::SerialPort */ @@ -556,12 +566,12 @@ public: * @privilege %http://tizen.org/privilege/appmanager.launch * * @return An error code - * @param[in] appId The application ID + * @param[in] appId The application ID * @param[in] pCondition The launch condition to unregister @n * If the parameter contains @c null, all the conditions are unregistered. * @exception E_SUCCESS The method is successful. - * @exception E_APP_NOT_INSTALLED The application is not installed. - * @exception E_OBJ_NOT_FOUND The specified launch condition is not found. + * @exception E_APP_NOT_INSTALLED The application has not been installed. + * @exception E_OBJ_NOT_FOUND The specified launch condition has not been found. * @exception E_SYSTEM A system error has occurred. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. @@ -578,13 +588,13 @@ public: * @privlevel partner * @privilege %http://tizen.org/privilege/appmanager.launch * - * @return @c true if a condition is already registered to the specified application with the specified condition, @n + * @return @c true if the condition is already registered for the specified application with the specified condition, @n * else @c false - * @param[in] appId The application ID - * @param[in] pCondition The launch condition to register for the specified @c appId @n - * If the parameter contains @c null, the method checks for any registered launch condition for the specified @c appId. + * @param[in] appId The application ID + * @param[in] pCondition The launch condition to register for the specified @c appId @n + * If the parameter contains @c null, the method checks for any registered launch condition for the specified @c appId. * @exception E_SUCCESS The method is successful. - * @exception E_APP_NOT_INSTALLED The application is not installed. + * @exception E_APP_NOT_INSTALLED The application has not been installed. * @exception E_SYSTEM A system error has occurred. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. @@ -601,11 +611,11 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] listener The listener to receive the checkpoint event - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_ALREADY_EXIST The listener is already set. - * @exception E_SYSTEM A system error has occurred. + * @return An error code + * @param[in] listener The listener to receive the checkpoint event + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_ALREADY_EXIST The listener is already set. + * @exception E_SYSTEM A system error has occurred. * */ result SetCheckpointEventListener(IAppCheckpointEventListener& listener); @@ -613,20 +623,20 @@ public: /** * @if OSPDEPREC * Sends the result list for the application control request. @n - * The client can get the result list by implementing IAppControlEventListener::OnAppControlCompleted(). + * The client gets the result list by implementing the IAppControlEventListener::OnAppControlCompleted() method. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated because a new method has been added. @n - * Instead of using this method, use AppControlProviderManager::SendAppControlResult(). + * Instead of using this method, use AppControlProviderManager::SendAppControlResult(). * @since 2.0 * * @return An error code - * @param[in] appControlRequestId The application control request ID @n - * The application control request ID is given as an argument for - * App::GetAppArgumentListN() or App::OnUserEventReceivedN(). - * @param[in] pResultList The list of the result strings of the application control + * @param[in] appControlRequestId The application control request ID @n + * The application control request ID is given as an argument to the + * App::GetAppArgumentListN() method or the App::OnUserEventReceivedN() method. + * @param[in] pResultList The list of the result strings of the application control * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The application control request is not found. + * @exception E_OBJ_NOT_FOUND The application control request has not been found. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. * @see IAppControlEventListener @@ -635,23 +645,23 @@ public: static result SendAppControlResult(const Tizen::Base::String& appControlRequestId, const Tizen::Base::Collection::IList* pResultList); /** - * Sets an IAppLaunchConditionEventListener to the %AppManager. @n - * The listener gets notified when the application is launched by the registered condition. - * - * @since 2.0 - * - * @param[in] pListener The event listener @n - * To unset the listener, pass a @c null value to the listener parameter. - * @remarks If the application is newly launched by the condition, then %SetAppLaunchConditionEventListener() must - * be set within App::OnAppInitializing(). - * If the application does not set the listener using %SetAppLaunchConditionEventListener(), - * then the application is launched without invoking any listener for the condition. - * @see RegisterAppLaunch() - */ + * Sets an IAppLaunchConditionEventListener for the %AppManager. @n + * The listener gets notified when the application is launched by the registered condition. + * + * @since 2.0 + * + * @param[in] pListener The event listener @n + * To unset the listener, pass a @c null value to the listener parameter. + * @remarks If the application is newly launched by the condition, then the %SetAppLaunchConditionEventListener() method + * within App::OnAppInitializing() must be set. @n + * If the application does not set the listener using the %SetAppLaunchConditionEventListener() method, + * then the application is launched without invoking any listener for the condition. + * @see RegisterAppLaunch() + */ void SetAppLaunchConditionEventListener(IAppLaunchConditionEventListener* pListener); /** - * Adds an IActiveAppEventListener to the %AppManager. @n + * Adds an IActiveAppEventListener for the %AppManager. @n * The listener gets notified when the active application is changed. * * @since 2.0 @@ -666,7 +676,7 @@ public: * @exception E_OBJ_ALREADY_EXIST The listener is already added. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks Active application is the top most window with focus. + * @remarks The active application is the top most window with focus. * @see GetActiveApp() * @see RemoveActiveAppEventListener() */ @@ -683,7 +693,7 @@ public: * @return An error code * @param[in] listener The event listener * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c listener is not found. + * @exception E_OBJ_NOT_FOUND The specified @c listener has not been found. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @see GetActiveApp() @@ -692,7 +702,7 @@ public: result RemoveActiveAppEventListener(IActiveAppEventListener& listener); /** - * Gets the current active application AppId. + * Gets the current active application's ID. * * @since 2.0 * @@ -700,48 +710,49 @@ public: * @privilege %http://tizen.org/privilege/appusage * * @return An error code - * @param[out] appId The AppId of the active application + * @param[out] appId The ID of the active application * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks Active application is the top most window with focus. + * @remarks The active application is the top most window with focus. * @see AddActiveAppEventListener() * @see RemoveActiveAppEventListener() */ result GetActiveApp(AppId& appId); /** - * Checks whether the specified application is declared as preferred application for any AppControl resolution + * Checks whether the specified application is declared as the preferred application for any AppControl resolution * * @since 2.2 - * @privlevel platform + * @privlevel platform * @privilege %http://tizen.org/privilege/appmanager.setting * * @return @c true if the application is running, @n - * else @c false - * @param[in] appId Application ID - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @exception E_APP_NOT_INSTALLED The specified application is not installed. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks For more information on AppControl resolution, see Application Controls. + * else @c false + * @param[in] appId The application ID + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_APP_NOT_INSTALLED The specified application has not been installed. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - For more information on AppControl resolution, see Application Controls. */ bool IsUserPreferredAppForAppControlResolution(const AppId& appId) const; /** - * Clear user preference for all AppControl resolutions on the specified application. + * Clears the user preference for all the AppControl resolutions of the specified application. * * @since 2.2 - * @privlevel platform + * @privlevel platform * @privilege %http://tizen.org/privilege/appmanager.setting * - * @return An error code + * @return An error code * @param[in] appId The preferred application's ID - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @exception E_APP_NOT_INSTALLED The specified application is not installed. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_APP_NOT_INSTALLED The specified application has not been installed. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @remarks For more information on AppControl resolution, see Application Controls. */ result ClearUserPreferenceForAppControlResolution(const AppId& appId); diff --git a/inc/FAppAppRegistry.h b/inc/FAppAppRegistry.h index 0defc91..e85933c 100644 --- a/inc/FAppAppRegistry.h +++ b/inc/FAppAppRegistry.h @@ -38,7 +38,7 @@ namespace Tizen { namespace App * * @final This class is not intended for extension. * - * The %AppRegistry class lets an application to save or restore its preferences. + * The %AppRegistry class lets an application save or restore its preferences. * An instance of this class can be obtained through the Application class. * Also, since an application's state is generally restored in the App::OnAppInitializing() method and saved in the App::OnAppTerminating() method, an instance of this class is passed as an argument when these methods are invoked. * @n @@ -142,12 +142,12 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] key A key corresponding to the value - * @param[in] value A string value + * @return An error code + * @param[in] key The key corresponding to the string value + * @param[in] value The string value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly. - * @exception E_KEY_ALREADY_EXIST The key has already been used in the application preferences. + * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly. + * @exception E_KEY_ALREADY_EXIST The specified @c key has already been used in the application preferences. * @remarks In order to save the value in the persistent storage, the Save() method must be called. */ result Add(const Tizen::Base::String& key, const Tizen::Base::String& value); @@ -157,12 +157,12 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] key A key corresponding to the value - * @param[in] value An integer value + * @return An error code + * @param[in] key The key corresponding to the integer value + * @param[in] value The integer value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly. - * @exception E_KEY_ALREADY_EXIST The key has already been used in the application preferences. + * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly. + * @exception E_KEY_ALREADY_EXIST The specified @c key has already been used in the application preferences. * @remarks In order to save the value in the persistent storage, the Save() method must be called. */ result Add(const Tizen::Base::String& key, int value); @@ -172,56 +172,56 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] key A key corresponding to the value - * @param[in] value A floating point value + * @return An error code + * @param[in] key The key corresponding to the floating point value + * @param[in] value The floating point value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly. - * @exception E_KEY_ALREADY_EXIST The key has already been used in the application preferences. + * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly. + * @exception E_KEY_ALREADY_EXIST The specified @c key has already been used in the application preferences. * @remarks In order to save the value in the persistent storage, the Save() method must be called. */ result Add(const Tizen::Base::String& key, double value); /** - * Sets a string value associated with the specified @c key. + * Sets the string value associated with the specified @c key. * * @since 2.0 * - * @return An error code - * @param[in] key A key corresponding to the value - * @param[in] value A string value + * @return An error code + * @param[in] key The key corresponding to the string value + * @param[in] value The string value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly. + * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly. * @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences. * @remarks In order to save the value in the persistent storage, the Save() method must be called. */ result Set(const Tizen::Base::String& key, const Tizen::Base::String& value); /** - * Sets an integer value associated with the specified @c key. + * Sets the integer value associated with the specified @c key. * * @since 2.0 * - * @return An error code - * @param[in] key A key corresponding to the value - * @param[in] value An integer value + * @return An error code + * @param[in] key The key corresponding to the integer value + * @param[in] value The integer value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly. + * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly. * @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences. * @remarks In order to save the value in the persistent storage, the Save() method must be called. */ result Set(const Tizen::Base::String& key, int value); /** - * Sets a floating point value associated with the specified @c key. + * Sets the floating point value associated with the specified @c key. * * @since 2.0 * - * @return An error code - * @param[in] key A key corresponding to the value - * @param[in] value A floating point value + * @return An error code + * @param[in] key The key corresponding to the floating point value + * @param[in] value The floating point value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly. + * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly. * @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences. * @remarks In order to save the value in the persistent storage, the Save() method must be called. */ @@ -233,72 +233,72 @@ public: * * @since 2.0 * - * @return An error code + * @return An error code * @exception E_SUCCESS The method is successful. */ result Save(void); /** - * Removes a preference associated with the specified @c key. + * Removes the preference associated with the specified @c key. * * @since 2.0 * - * @return An error code - * @param[in] key The key of the value to remove - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] key The key of the value to remove + * @exception E_SUCCESS The method is successful. * @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences. */ result Remove(const Tizen::Base::String& key); /** - * Gets a string value associated with the specified @c key. + * Gets the string value associated with the specified @c key. * * @since 2.0 * - * @return An error code - * @param[in] key The key of the value to retrieve - * @param[out] value A string value to retrieve + * @return An error code + * @param[in] key The key of the string value to retrieve + * @param[out] value The string value to retrieve * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly. + * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly. * @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences. */ result Get(const Tizen::Base::String& key, Tizen::Base::String& value) const; /** - * Gets an integer value associated with the specified @c key. + * Gets the integer value associated with the specified @c key. * * @since 2.0 * - * @return An error code - * @param[in] key The key of the value to retrieve - * @param[out] value An integer value to retrieve + * @return An error code + * @param[in] key The key of the integer value to retrieve + * @param[out] value The integer value to retrieve * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly. + * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly. * @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences. */ result Get(const Tizen::Base::String& key, int& value) const; /** - * Gets a floating point value associated with the specified @c key. + * Gets the floating point value associated with the specified @c key. * * @since 2.0 * - * @return An error code - * @param[in] key The key of the value to retrieve - * @param[out] value A floating point value to retrieve + * @return An error code + * @param[in] key The key of the floating point value to retrieve + * @param[out] value The floating point value to retrieve * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c key is empty or is string with '\0' and @htmlonly '\n' @endhtmlonly. + * @exception E_INVALID_ARG The specified @c key is empty or is a string with '\0' and @htmlonly '\n' @endhtmlonly. * @exception E_KEY_NOT_FOUND The specified @c key is not used in the application preferences. */ result Get(const Tizen::Base::String& key, double& value) const; /** - * Gets the %AppRegistry instance pointer. + * Gets a pointer to the %AppRegistry instance. * * @since 2.0 * - * @return A pointer to the %AppRegistry instance, @n - * else @c null if it fails + * @return A pointer to the %AppRegistry instance, @n + * else @c null if it fails */ static AppRegistry* GetInstance(void); diff --git a/inc/FAppAppResource.h b/inc/FAppAppResource.h index 4382222..af96e60 100644 --- a/inc/FAppAppResource.h +++ b/inc/FAppAppResource.h @@ -15,8 +15,8 @@ // /** - * @file FAppAppResource.h - * @brief This is the header file for the %AppResource class. + * @file FAppAppResource.h + * @brief This is the header file for the %AppResource class. * * This header file contains the declarations of the %AppResource class. */ @@ -35,19 +35,19 @@ namespace Tizen { namespace App { /** -* @class AppResource -* @brief This class provides convenient methods to load application resources at run time. +* @class AppResource +* @brief This class provides convenient methods to load application resources at run time. * * @since 2.0 * * @final This class is not intended for extension. * * The %AppResource class provides convenient methods to load application resources at run time: @n -* - Use AppResource::GetString() to get handle and display localized strings. -* - Use AppResource::GetBitmapN() to obtain a bitmap image that matches the screen density. -* - If the matching image does not exist, the image of the baseline density folder, ScreenDensity-High is used. +* - Use the AppResource::GetString() method to get a handle and display localized strings. +* - Use the AppResource::GetBitmapN() method to obtain a bitmap image that matches the screen density. +* - If a matching image does not exist, the image of the baseline density folder, ScreenDensity-High is used. * -* The instance of this class can be obtained through App::GetAppResource(). +* The instance of this class can be obtained through the App::GetAppResource() method. * * The following example demonstrates how to use the %AppResource class to get strings. * @@ -103,60 +103,62 @@ public: * @return An error code * @param[in] resourceId The resource ID of type Tizen::Base::String that describes the resource * @param[out] loadedString The string obtained from the loaded application resource - * @exception E_SUCCESS The method is successful. - * @exception E_FAILURE The argument passed is not found. - * @exception E_INVALID_ARG The argument passed to a method contains an invalid resource ID. + * @exception E_SUCCESS The method is successful. + * @exception E_FAILURE The argument passed has not been found. + * @exception E_INVALID_ARG The argument passed to the method contains an invalid resource ID. */ result GetString(const Tizen::Base::String& resourceId, Tizen::Base::String& loadedString) const; /** * Gets the bitmap at the specified path. @n * The %GetBitmapN() method interprets the given resource path and reads the best matching image file for the current device resolution. @n - * To load the bitmap image from a file, give the name of the file as the input parameter and not the file path (For example: "img.png"). - * Then, the system will first look for the image file in the folder specific to the current device resolution, such as + * To load the bitmap image from a file, give the name of the file as the input parameter and not the file path (For example, "img.png"). + * The system will first look for the image file in the folder specific to the current device resolution, such as * '720x1280' and if the file does not exist, it will then search the folder that corresponds to the current screen density, * such as 'screen-density-xhigh'. After searching the density folder, all the other density folders are searched in the order high to low. * If the requested image file is found in a density-specific folder that is different from the current screen density, the bitmap returned from this method is pre-scaled. - * But in case of requested image file is saved as ".#.png" (For example : "img.#.png"), then a bitmap instance which is value of returned pointer is not pre-scaled. - * So, it is recommended to use ".#.png" as extension (For example : "ninePatchImg.#.png") for nine-patch image file. + * But in case the requested image file is saved as ".#.png" (For example, "img.#.png"), then the bitmap instance of the returned pointer is not pre-scaled. + * So, it is recommended to use ".#.png" as the extension (For example, "ninePatchImg.#.png") for a nine-patch image file. * Currently supported image formats are: JPEG, GIF, PNG, BMP, TIFF, and WBMP. * For more information on the features, see Resource Fallback and Prescaling. * * @since 2.0 * - * @return A pointer to the Bitmap instance generated from the specified file + * @return A pointer to the Tizen::Graphics::Bitmap instance generated from the specified file * @param[in] imagePath The relative path starting from the directory @b "res/screen-density-XXX/" or @b "res/AxB", @n - * where A and B represent the screen width and height of the supported device models, respectively. + * where A and B represent the screen width and screen height of the supported device models, respectively. * @param[in] pixelFormat The pixel format of the resulting bitmap * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_UNSUPPORTED_FORMAT The image file format or specified pixel format is not supported. + * @exception E_UNSUPPORTED_FORMAT Either the image file format or the specified @c pixelFormat is not supported. * @exception E_FILE_NOT_FOUND The specified file cannot be found. * @exception E_SYSTEM A system error has occurred. * @remarks * - The specific error code can be accessed using the GetLastResult() method. - * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer here. + * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. + * For more information on how to handle the out-of-memory exception, refer + * here. */ Tizen::Graphics::Bitmap* GetBitmapN(const Tizen::Base::String& imagePath, Tizen::Graphics::BitmapPixelFormat pixelFormat) const; /** * Gets the bitmap at the specified path. @n * The %GetBitmapN() method interprets the given resource path and reads the best matching image file for the current device resolution. @n - * To load the bitmap image from a file, give the name of the file as the input parameter and not the file path (For example: "img.png"). - * Then, the system will first look for the image file in the folder specific to the current device resolution, such as + * To load the bitmap image from a file, give the name of the file as the input parameter and not the file path (For example, "img.png"). + * The system will first look for the image file in the folder specific to the current device resolution, such as * '720x1280' and if the file does not exist, it will then search the folder that corresponds to the current screen density, * such as 'screen-density-xhigh'. After searching the density folder, all the other density folders are searched in the order high to low. * If the requested image file is found in a density-specific folder that is different from the current screen density, the bitmap returned from this method is pre-scaled. - * But in case of requested image file is saved as ".#.png" (For example : "img.#.png"), then a bitmap instance which is value of returned pointer is not pre-scaled. - * So, it is recommended to use ".#.png" as extension (For example : "ninePatchImg.#.png") for nine-patch image file. + * But in case the requested image file is saved as ".#.png" (For example, "img.#.png"), then the bitmap instance of the returned pointer is not pre-scaled. + * So, it is recommended to use ".#.png" as the extension (For example, "ninePatchImg.#.png") for a nine-patch image file. * Currently supported image formats are: JPEG, GIF, PNG, BMP, TIFF, and WBMP. * For more information on the features, see Resource Fallback and Prescaling. * * @since 2.0 * - * @return A pointer to the Tizen::Graphics::Bitmap instance generated from the specified file + * @return A pointer to the Tizen::Graphics::Bitmap instance generated from the specified file * @param[in] imagePath The relative path starting from the density directory @b "res/screen-density-XXX/" or @b "res/AxB", @n - * where A and B represent the width and height of the screen of the supported device models, respectively + * where A and B represent the screen width and screen height of the supported device models, respectively * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * @exception E_UNSUPPORTED_FORMAT The image file format is not supported. @@ -164,70 +166,75 @@ public: * @exception E_SYSTEM A system error has occurred. * @remarks * - The specific error code can be accessed using the GetLastResult() method. - * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is E_OUT_OF_MEMORY or not. For more information on how to handle the out-of-memory exception, refer here. + * - There is a high probability for an occurrence of an out-of-memory exception. If possible, check whether the exception is @c E_OUT_OF_MEMORY or not. + * For more information on how to handle the out-of-memory exception, refer + * here. */ Tizen::Graphics::Bitmap* GetBitmapN(const Tizen::Base::String& imagePath) const; /** - * Gets the %AppResource instance pointer. + * Gets a pointer to the %AppResource instance. * - * @since 2.0 + * @since 2.0 * - * @return A pointer to the %AppResource instance, @n - * else @c null if it fails + * @return A pointer to the %AppResource instance, @n + * else @c null if it fails */ static AppResource* GetInstance(void); /** - * Gets the resource instance of the specified resource path. - * @since 2.0 + * Gets an %AppResource instance of the specified @c resourcePath. + * @since 2.0 * @return A pointer to the %AppResource instance, @n * else @c null if it fails * @param[in] resourcePath The relative path starting from the resource directory path of the current application * @exception E_SUCCESS The method is successful. - * @exception E_FILE_NOT_FOUND The specified resource path does not exist. - * @exception E_INVALID_ARG The length of the specified path is @c 0 or exceeds system limitations. - * @exception E_SYSTEM Initializing string and bitmap resource is failed due to system error. + * @exception E_FILE_NOT_FOUND The specified @c resourcePath does not exist. + * @exception E_INVALID_ARG Either of the following conditions has occured: + * - The length of the specified path is @c 0. + * - The length of the specified path exceeds system limitations. + * @exception E_SYSTEM Initializing the string and the bitmap resource has failed due to a system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static AppResource* LoadAppResource(const Tizen::Base::String& resourcePath); /** - * Gets the application resource instance of the specified @c appId. + * Gets an %AppResource instance of the specified @c appId. * * @since 2.0 * * @privlevel platform - * @privilege %http://tizen.org/privilege/appsetting + * @privilege %http://tizen.org/privilege/appsetting * * @return A pointer to the %AppResource instance, @n * else @c null if it fails - * @param[in] appId The AppId of the installed application + * @param[in] appId The ID of the installed application * @exception E_SUCCESS The method is successful. - * @exception E_DATA_NOT_FOUND The instance of specified @c appId does not provide the string resource. + * @exception E_DATA_NOT_FOUND The specified @c appId does not provide the required string resource. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_APP_NOT_INSTALLED The specified @c appId is not found in the list of installed applications. - * @exception E_SYSTEM Initializing string and bitmap resource has failed due to a system error. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_APP_NOT_INSTALLED The specified @c appId has not been found in the list of installed applications. + * @exception E_SYSTEM Initializing the string and the bitmap resource has failed due to a system error. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static AppResource* GetInstanceByAppId(const AppId& appId); /** - * Releases the application resource instance of the specified @c appId. + * Releases the %AppResource instance of the specified @c appId. * * @since 2.0 * - * @privlevel platform + * @privlevel platform * @privilege %http://tizen.org/privilege/appsetting * * @return An error code - * @param[in] appId The AppId of the installed application + * @param[in] appId The ID of the installed application * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The application resource instance of the specified @c appId is not found. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks Individual instances are managed by the platform. @n - * It is recommended to release instances to reduce memory usage. + * @exception E_OBJ_NOT_FOUND The application resource instance of the specified @c appId has not been found. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @remarks + * - Individual instances are managed by the platform. + * - It is recommended to release instances to reduce memory usage. */ static result ReleaseInstanceByAppId(const AppId& appId); diff --git a/inc/FAppAppSetting.h b/inc/FAppAppSetting.h index df63ca9..303b430 100644 --- a/inc/FAppAppSetting.h +++ b/inc/FAppAppSetting.h @@ -50,15 +50,16 @@ class IAppSettingEventListener; * @final This class is not intended for extension. * * The %AppSetting class is a helper class for an application to save or restore its settings. - * A setting entity is composed of a string-typed key and a value. The value type must be only of these three types: @c int, @c bool, and @c String. - * The settings are pre-defined in setting/setting.xml in the application's base directory + * A setting entity is composed of a string-typed key and a value. The value type must only be of three types: @c int, @c bool, and @c String. + * The settings are pre-defined at setting/setting.xml in the application's base directory * and they can be easily set with %Tizen IDE (Creating and Using Application Settings, Application Settings Editor). - * (The setting.xml is a symbolic link to the currently used setting file, which is related to the current version of the application.) @n - * The %AppSetting class is basically used for specific applications such as IME, which have no UI. + * (setting.xml is a symbolic link to the currently used setting file, which is related to the current version of the application.) @n + * The %AppSetting class is basically used for specific applications which have no UI, such as IME. * Because the applications have no external way to modify their settings, users can adjust the setting values through the setting application, which is delegated to manage the settings. - * For supporting the consistency of setting values between two applications, the target application and the setting application, when setting a value in the setting application, the target application is notified from the setting application through - * IAppSettingEventListener::OnAppSettingChanged() - * For detailed example on this class, see Task: App Setting. + * For supporting the consistency between the setting values of two applications, that is, the target application and the setting application, the setting application notifies the target application through + * the IAppSettingEventListener::OnAppSettingChanged() method when setting a value. + * + * For a detailed example on the %AppSetting class, see Task: App Setting. * * @see IAppSettingEventListener */ @@ -67,11 +68,11 @@ class _OSP_EXPORT_ AppSetting { public: /** - * Gets the application setting instance. + * Gets the pointer to the %AppSetting instance. * * @since 2.0 * - * @return A pointer to the %AppSetting instance for the last setting, @n + * @return The pointer to the %AppSetting instance for the last setting, @n * else @c null if it fails * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -81,24 +82,23 @@ public: static AppSetting* GetInstance(void); /** - * Gets the application setting instance of the specified version. + * Gets the pointer to the %AppSetting instance of the specified version. * * @since 2.0 * - * @return A pointer to the %AppSetting instance, @n + * @return The pointer to the %AppSetting instance, @n * else @c null if it fails - * @param[in] settingVersion The version of setting is retrieved from GetAppSettingVersionListN() + * @param[in] settingVersion The version of the setting which is retrieved from GetAppSettingVersionListN() * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified version is not found. + * @exception E_OBJ_NOT_FOUND The specified version has not been found. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see GetAppSettingVersionListN() */ static AppSetting* GetInstance(const Tizen::Base::String& settingVersion); /** - * Gets the application setting instance of the specified AppId. + * Gets an %AppSetting instance of the specified ID. * * @since 2.0 * @@ -107,12 +107,12 @@ public: * * @return A pointer to the %AppSetting instance, @n * else @c null if it fails - * @param[in] appId The AppId of the application that has a valid application setting + * @param[in] appId The ID of the application that has a valid application setting * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The instance of specified AppId does not have setting information. + * @exception E_OBJ_NOT_FOUND The specified @c appId does not have the required setting information. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_APP_NOT_INSTALLED The AppId is not found. + * @exception E_APP_NOT_INSTALLED The @c appId has not been found. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -121,7 +121,7 @@ public: static AppSetting* GetInstanceByAppId(const AppId& appId); /** - * Releases the specified application setting instance. + * Releases the specified %AppSetting instance. * * @since 2.0 * @@ -129,24 +129,28 @@ public: * @privilege %http://tizen.org/privilege/appsetting * * @return An error code - * @param[in] appId The AppId of the application that has a valid application setting + * @param[in] appId The ID of the application that has a valid application setting * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified instance of AppId is not found or already released. + * @exception E_OBJ_NOT_FOUND Either of the following conditions has occurred: + * - The specified @c appId has not been found. + * - The specified @c appId is already released. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks Individual instances are managed by the platform. @n - * It is recommended to release instances to reduce memory usage. + * @remarks + * - Individual instances are managed by the platform. + * - It is recommended to release instances to reduce memory usage. * @see GetInstanceByAppId() */ static result ReleaseInstanceByAppId(const AppId& appId); /** - * Gets a list of all the versions that existed prior to the current version. @n - * The versions listed are based on the setting.xml file, which is generated when an application is installed. + * Gets the list of all the versions that existed prior to the current version. @n + * The versions are listed based on the setting.xml file, which is generated when an application is installed. * * @since 2.0 * - * @return A pointer to the list that contains the Tizen::Base::String instances of version list @n - * The latest version string is located in the first position. If the old version does not exist then return empty collection. + * @return A pointer to the list that contains the Tizen::Base::String instances of the version list @n + * The latest version string is located at the first position @n + * If the old version does not exist then an empty collection is returned. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -155,108 +159,108 @@ public: static Tizen::Base::Collection::IList* GetAppSettingVersionListN(void); /** - * Gets a @c bool value associated with the specified @c id. + * Gets the @c bool value associated with the specified @c id. * * @since 2.0 * * @return An error code - * @param[in] id The ID of the value to retrieve - * @param[out] value A boolean value to retrieve + * @param[in] id The ID of the boolean value to retrieve + * @param[out] value The boolean value to retrieve * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_OBJ_NOT_FOUND The specified @c id is not found in the application setting. + * @exception E_OBJ_NOT_FOUND The specified @c id has not been found in the application setting. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_TYPE_MISMATCH The operation has attempted to access different types. + * @exception E_TYPE_MISMATCH The types accessed by the method do not match. */ result GetValue(const Tizen::Base::String& id, bool& value) const; /** - * Gets an integer value associated with the specified @c id. + * Gets the integer value associated with the specified @c id. * * @since 2.0 * * @return An error code - * @param[in] id The ID of the value to retrieve - * @param[out] value An integer value to retrieve + * @param[in] id The ID of the integer value to retrieve + * @param[out] value The integer value to retrieve * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_OBJ_NOT_FOUND The specified @c id is not found in the application setting. + * @exception E_OBJ_NOT_FOUND The specified @c id has not been found in the application setting. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_TYPE_MISMATCH The operation has attempted to access different types. + * @exception E_TYPE_MISMATCH The types accessed by the method do not match. */ result GetValue(const Tizen::Base::String& id, int& value) const; /** - * Gets a string value associated with the specified @c id. + * Gets the string value associated with the specified @c id. * * @since 2.0 * * @return An error code - * @param[in] id The id of the value to retrieve - * @param[out] value A string value to retrieve + * @param[in] id The ID of the string value to retrieve + * @param[out] value The string value to retrieve * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_OBJ_NOT_FOUND The specified @c id is not found in the application setting. + * @exception E_OBJ_NOT_FOUND The specified @c id has not been found in the application setting. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_TYPE_MISMATCH The operation has attempted to access different types. + * @exception E_TYPE_MISMATCH The types accessed by the method do not match. */ result GetValue(const Tizen::Base::String& id, Tizen::Base::String& value) const; /** - * Sets a @c bool value associated with the specified @c id. + * Sets the @c bool value associated with the specified @c id. * * @since 2.0 * * @return An error code - * @param[in] id The ID of the value to modify - * @param[in] value A boolean value + * @param[in] id The ID of the boolean value to modify + * @param[in] value The boolean value * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_OBJ_NOT_FOUND The specified @c id is not found in the application setting. + * @exception E_OBJ_NOT_FOUND The specified @c id has not been found in the application setting. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_TYPE_MISMATCH The operation has attempted to access different types. + * @exception E_TYPE_MISMATCH The types accessed by the method do not match. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ result SetValue(const Tizen::Base::String& id, bool value); /** - * Sets an integer value associated with the specified @c id. + * Sets the integer value associated with the specified @c id. * * @since 2.0 * * @return An error code - * @param[in] id The ID of the value to modify - * @param[in] value An integer value + * @param[in] id The ID of the integer value to modify + * @param[in] value The integer value * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_OBJ_NOT_FOUND The specified @c id is not found in the application setting. - * @exception E_OUT_OF_RANGE The specified @c value is out of range. + * @exception E_OBJ_NOT_FOUND The specified @c id has not been found in the application setting. + * @exception E_OUT_OF_RANGE The specified @c value is out of the valid range. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_TYPE_MISMATCH The operation has attempted to access different types. + * @exception E_TYPE_MISMATCH The types accessed by the method do not match. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ result SetValue(const Tizen::Base::String& id, int value); /** - * Sets a string value associated with the specified @c id. + * Sets the string value associated with the specified @c id. * * @since 2.0 * * @return An error code - * @param[in] id The ID of the value to modify - * @param[in] value A string value + * @param[in] id The ID of the string value to modify + * @param[in] value The string value * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_OBJ_NOT_FOUND The specified @c id is not found in the application setting. - * @exception E_OUT_OF_RANGE The specified string length is out of range. + * @exception E_OBJ_NOT_FOUND The specified @c id has not been found in the application setting. + * @exception E_OUT_OF_RANGE The specified string length is out of the valid range. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_TYPE_MISMATCH The operation has attempted to access different types. + * @exception E_TYPE_MISMATCH The types accessed by the method do not match. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ result SetValue(const Tizen::Base::String& id, const Tizen::Base::String& value); /** - * Sets a setting event listener. + * Sets the setting event listener. * * @since 2.0 * diff --git a/inc/FAppDataControlProviderManager.h b/inc/FAppDataControlProviderManager.h index 0b01c03..384730e 100644 --- a/inc/FAppDataControlProviderManager.h +++ b/inc/FAppDataControlProviderManager.h @@ -54,7 +54,7 @@ class IMapDataControlProviderEventListener; * * @final This class is not intended for extension. * - * The %DataControlProviderManager class helps a data control provider application to handle data control requests from other applications and to send results or error message for each data control operation. + * The %DataControlProviderManager class helps a data control provider application to handle data control requests from other applications, and to send results or error messages for each data control operation. */ class _OSP_EXPORT_ DataControlProviderManager : public Tizen::Base::Object @@ -62,8 +62,8 @@ class _OSP_EXPORT_ DataControlProviderManager public: /** - * Sets an SQL-friendly interface based data control provider listener to the data control provider manager. @n - * The listener gets notified when a data control request is received from the other applications. + * Sets an SQL-friendly interface based data control provider listener for the data control provider manager. @n + * The listener gets notified when a data control request is received from other applications. * To unset the listener, pass a @c null value to the listener parameter. * * @since 2.0 @@ -73,16 +73,16 @@ public: * The listener must implement the ISqlDataControlProviderEventListener interface. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE This instance has not been properly constructed. - * @exception E_INVALID_OPERATION The listener must be set for a service application. + * @exception E_INVALID_OPERATION The listener has not been set for a service application. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks This method must be called in App::OnAppInitializing() for setting the data control provider listener + * @remarks This method must be called by the App::OnAppInitializing() method for setting the data control provider listener * before receiving the data control request. */ result SetSqlDataControlProviderEventListener(ISqlDataControlProviderEventListener* pListener); /** - * Sets a key-value structured data control provider listener to the data control provider manager. @n - * The listener gets notified when a data control request is received from the other applications. + * Sets a key-value structured data control provider listener for the data control provider manager. @n + * The listener gets notified when a data control request is received from other applications. * To unset the listener, pass a @c null value to the listener parameter. * * @since 2.0 @@ -92,15 +92,15 @@ public: * The listener must implement the IMapDataControlProviderEventListener interface. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE This instance has not been properly constructed. - * @exception E_INVALID_OPERATION The listener must be set for a service application. + * @exception E_INVALID_OPERATION The listener has not been set for a service application. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks This method must be called in App::OnAppInitializing() for setting the data control provider listener + * @remarks This method must be called by the App::OnAppInitializing() method for setting the data control provider listener * before receiving the data control request. */ result SetMapDataControlProviderEventListener(IMapDataControlProviderEventListener* pListener); /** - * Sends the success result and the result set of SELECT request to the application requesting the SQL-friendly interface based + * Sends the success result and the result set of the SELECT request to the application requesting for the SQL-friendly interface based * data control. @n * The data control provider must call the %SendSqlDataControlSelectResult() method to notify success to the requesting application. * The application requesting the data control can get the success result and the result set @@ -113,25 +113,24 @@ public: * @param[in] pDbEnum The Tizen::Io::DbEnumerator instance to obtain the result set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG Either of the following conditions has occurred: - * - This method cannot send result for the specified @c reqId of INSERT, UPDATE, or DELETE requests. - * - Tizen::Io::Database or Tizen::Io::DbStatement instance associated with the specified @c pDbEnum is deleted. - * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId does not exist. - * @exception E_OBJECT_LOCKED The database instance associated to the specified @c pDbEnum is locked. - * @exception E_INVALID_FORMAT The database file associated to the specified @c pDbEnum is malformed. + * - The result for the specified @c reqId of the INSERT, UPDATE, or DELETE request cannot be sent. + * - The Tizen::Io::Database or Tizen::Io::DbStatement instance associated with the specified @c pDbEnum is deleted. + * @exception E_OBJ_NOT_FOUND The data control request specified by the @c reqId does not exist. + * @exception E_OBJECT_LOCKED The database instance associated with the specified @c pDbEnum is locked. + * @exception E_INVALID_FORMAT The database file associated with the specified @c pDbEnum is in an invalid format. * @exception E_IO Either of the following conditions has occurred: - * - An unexpected device failure has occurred as the media ejected suddenly. - * - %File corruption is detected. - * @exception E_MAX_EXCEEDED The size of sending buffer has exceeded the maximum limit. + * - An unexpected device failure has occurred as the media ejected suddenly. + * - %File corruption has been detected. + * @exception E_MAX_EXCEEDED The size of the sending buffer has exceeded the maximum limit. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @see Tizen::App::DataControlProviderManager::SendSqlDataControlInsertResult() * @see Tizen::App::DataControlProviderManager::SendSqlDataControlUpdateDeleteResult() * @see Tizen::App::DataControlProviderManager::SendDataControlError() - * @see Tizen::App::ISqlDataControlProviderEventListener */ result SendSqlDataControlSelectResult(RequestId reqId, Tizen::Io::IDbEnumerator* pDbEnum); /** - * Sends the success result of INSERT request and the last inserted row ID to the application requesting + * Sends the success result of the INSERT request and the last inserted row ID to the application requesting for * the SQL-friendly interface based data control. @n * The data control provider must call the %SendSqlDataControlInsertResult() method to notify success to the requesting application. * The application requesting the data control can get the success result and the last inserted row ID @@ -141,21 +140,20 @@ public: * * @return An error code * @param[in] reqId The request ID - * @param[in] insertRowId The row ID of database changed by INSERT request + * @param[in] insertRowId The row ID of the database changed by the INSERT request * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG This method cannot send result for the specified @c reqId of SELECT, UPDATE, or DELETE request. - * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId does not exist. + * @exception E_INVALID_ARG The result for the specified @c reqId of the SELECT, UPDATE, or DELETE request cannot be sent. + * @exception E_OBJ_NOT_FOUND The data control request specified by the @c reqId does not exist. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @see Tizen::App::DataControlProviderManager::SendSqlDataControlSelectResult() * @see Tizen::App::DataControlProviderManager::SendSqlDataControlUpdateDeleteResult() * @see Tizen::App::DataControlProviderManager::SendDataControlError() - * @see Tizen::App::ISqlDataControlProviderEventListener * @see Tizen::Io::Database::GetLastInsertRowId() */ result SendSqlDataControlInsertResult(RequestId reqId, long long insertRowId); /** - * Sends the success result of UPDATE / DELETE request to the application requesting the SQL-friendly interface based data control. @n + * Sends the success result of the UPDATE or DELETE request to the application requesting for the SQL-friendly interface based data control. @n * The data control provider must call the %SendSqlDataControlUpdateDeleteResult() method to notify success to the requesting application. * The application requesting the data control can get the success result by implementing Tizen::App::ISqlDataControlResponseListener. * @@ -164,8 +162,8 @@ public: * @return An error code * @param[in] reqId The request ID * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG This method cannot send result for the specified @c reqId of SELECT or INSERT request. - * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId does not exist. + * @exception E_INVALID_ARG The result for the specified @c reqId of the SELECT or INSERT request cannot be sent. + * @exception E_OBJ_NOT_FOUND The data control request specified by the @c reqId does not exist. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @see Tizen::App::DataControlProviderManager::SendSqlDataControlSelectResult() * @see Tizen::App::DataControlProviderManager::SendSqlDataControlInsertResult() @@ -175,7 +173,7 @@ public: result SendSqlDataControlUpdateDeleteResult(RequestId reqId); /** - * Sends the success result and the result list of the provider to the application requesting the key-value structured + * Sends the success result and the result list of the provider to the application requesting for the key-value structured * data control. @n * The data control provider must call the %SendMapDataControlResult() method to notify success to the requesting application. * The application requesting the data control can get the success result and the result set @@ -187,23 +185,22 @@ public: * @param[in] reqId The request ID * @param[in] pResultValueList The result list to request @n * The type of objects contained in the specified @c pResultValueList must be - * Tizen::Base::String class. + * Tizen::Base::String. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG Either of the following conditions has occurred: - * - The specified @c pResultValueList must be @c null if the request is one of - * AddValue, SetValue, RemoveValue queries. - * - The specified @c pResultValueList must not be @c null if the request is - * GetValue() query. - * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId does not exist. - * @exception E_MAX_EXCEEDED The size of sending buffer has exceeded the maximum limit. + * - The specified @c pResultValueList must be @c null if the request is an + * AddValue(), SetValue(), or RemoveValue() query. + * - The specified @c pResultValueList must not be @c null if the request is + * a GetValue() query. + * @exception E_OBJ_NOT_FOUND The data control request specified by the @c reqId does not exist. + * @exception E_MAX_EXCEEDED The size of the sending buffer has exceeded the maximum limit. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @see Tizen::App::DataControlProviderManager::SendDataControlError() - * @see Tizen::App::IMapDataControlProviderEventListener */ result SendMapDataControlResult(RequestId reqId, Tizen::Base::Collection::IList* pResultValueList = null); /** - * Sends the provider error message to the application requesting the data control. @n + * Sends the provider error message to the application requesting for the data control. @n * The data control provider must call the %SendDataControlError() method to notify failure to the requesting application. * The application requesting the data control can get the failure result and the error message * by implementing Tizen::App::ISqlDataControlResponseListener. @@ -214,26 +211,26 @@ public: * @param[in] reqId The request ID * @param[in] errorMsg The provider-defined error message * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The data control request specified with the @c reqId does not exist. - * @exception E_MAX_EXCEEDED The size of sending buffer has exceeded the maximum limit. + * @exception E_OBJ_NOT_FOUND The data control request specified by the @c reqId does not exist. + * @exception E_MAX_EXCEEDED The size of the sending buffer has exceeded the maximum limit. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The recommended data size is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size. + * @remarks The recommended data size is under 16KB because a severe system performance degradation may occur for larger messages. @n + * @c E_MAX_EXCEEDED may be returned for messages over 16KB size. * @see Tizen::App::DataControlProviderManager::SendSqlDataControlSelectResult() * @see Tizen::App::DataControlProviderManager::SendSqlDataControlInsertResult() * @see Tizen::App::DataControlProviderManager::SendSqlDataControlUpdateDeleteResult() * @see Tizen::App::DataControlProviderManager::SendMapDataControlResult() - * @see Tizen::App::ISqlDataControlProviderEventListener * @see Tizen::App::IMapDataControlProviderEventListener */ result SendDataControlError(RequestId reqId, const Tizen::Base::String& errorMsg); /** - * Gets the data control provider manager instance. + * Gets a pointer to the %DataControlProviderManager instance. * * @since 2.0 * - * @return A pointer to the %DataControlProviderManager instance if it succeeds, @n - * else @c null + * @return A pointer to the %DataControlProviderManager instance, @n + * else @c null if it fails */ static DataControlProviderManager* GetInstance(void); diff --git a/inc/FAppIActiveAppEventListener.h b/inc/FAppIActiveAppEventListener.h index ad98435..5ae5546 100644 --- a/inc/FAppIActiveAppEventListener.h +++ b/inc/FAppIActiveAppEventListener.h @@ -33,13 +33,12 @@ namespace Tizen { namespace App /** * @interface IActiveAppEventListener - * @brief This interface is the listener interface for receiving the AppId of active application. + * @brief This interface is the listener interface for receiving the ID of an active application. * * @since 2.0 * - * * The %IActiveAppEventListener interface is the listener interface for receiving the active application change events. - * The class that processes an active application change event implements this interface and registers using + * The class that processes an active application change event implements this interface and registers it using * the AppManager::AddActiveAppEventListener() method. * */ @@ -48,8 +47,8 @@ class _OSP_EXPORT_ IActiveAppEventListener { public: /** - * This polymorphic destructor should be overridden if required. This way, - * the destructors of the derived classes are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 * @@ -61,7 +60,7 @@ public: * * @since 2.0 * - * @param[in] appId The AppId of the active application + * @param[in] appId The ID of the active application */ virtual void OnActiveAppChanged(const AppId& appId) = 0; diff --git a/inc/FAppIAppCheckPointEventListener.h b/inc/FAppIAppCheckPointEventListener.h index a427fee..4bfbb36 100644 --- a/inc/FAppIAppCheckPointEventListener.h +++ b/inc/FAppIAppCheckPointEventListener.h @@ -15,8 +15,8 @@ // /** - * @file FAppIAppCheckPointEventListener.h - * @brief This is the header file for the %IAppCheckpointEventListener interface. + * @file FAppIAppCheckPointEventListener.h + * @brief This is the header file for the %IAppCheckpointEventListener interface. * * This header file contains the declarations of the %IAppCheckpointEventListener interface. @n * If a checkpoint event is generated, a method of this interface is called. @@ -34,13 +34,13 @@ class AppRegistry; /** * @interface IAppCheckpointEventListener - * @brief This interface defines the listener for the checkpoint event. + * @brief This interface defines the listener for a checkpoint event. * * @since 2.0 * - * The %IAppCheckpointEventListener interface is used for receiving the checkpoint event. - * The event is fired when the system is about to terminate an application due to, for example, low memory or when another application - * is being launched. + * The %IAppCheckpointEventListener interface is used for receiving a checkpoint event. + * The event is fired when the system is about to terminate an application due to reasons such as, low memory or when another application + * is being launched. * @n * For more information on the class features, see Multitasking in Tizen. * @@ -50,7 +50,7 @@ class _OSP_EXPORT_ IAppCheckpointEventListener { public: /** - * This polymorphic destructor should be overridden if required. + * This polymorphic destructor should be overridden if required. @n * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 @@ -61,7 +61,7 @@ public: * Called when a checkpoint event occurs. * * @since 2.0 - * @param[in] appRegistry The application registry + * @param[in] appRegistry The application's registry */ virtual void OnAppCheckpointing(AppRegistry& appRegistry) = 0; diff --git a/inc/FAppIAppControlEventListener.h b/inc/FAppIAppControlEventListener.h index d1cbfe9..6bbd777 100644 --- a/inc/FAppIAppControlEventListener.h +++ b/inc/FAppIAppControlEventListener.h @@ -15,10 +15,12 @@ // /** - * @file FAppIAppControlEventListener.h - * @brief This is the header file for the %IAppControlEventListener interface. + * @if OSPDEPREC + * @file FAppIAppControlEventListener.h + * @brief This is the header file for the %IAppControlEventListener interface. * * This header file contains the declarations of the %IAppControlEventListener interface. + * @endif */ #ifndef _FAPP_IAPP_CONTROL_EVENT_LISTENER_H_ @@ -35,7 +37,7 @@ namespace Tizen { namespace App /** * @if OSPDEPREC * @interface IAppControlEventListener -* @brief [Deprecated] This interface defines a listener for the AppControl result events. +* @brief [Deprecated] This interface defines a listener for the %AppControl result events. * * @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface. * @since 2.0 @@ -49,7 +51,7 @@ class _OSP_EXPORT_ IAppControlEventListener public: /** * @if OSPDEPREC - * This polymorphic destructor should be overridden if required. + * This polymorphic destructor should be overridden if required. @n * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @brief [Deprecated] @@ -63,24 +65,24 @@ public: /** * @if OSPDEPREC * Called when the application control is completed. @n - * The client can get callback result for some application controls by implementing this listener. @n - * %OnAppControlCompleted() is called after AppControl::Start() with listener for some application controls. + * The client can get the callback result for some application controls by implementing this listener. @n + * The %OnAppControlCompleted() method is called after AppControl::Start() is done listening to application controls. * * @brief [Deprecated] * * @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface. * @since 2.0 * - * @param[in] providerId The provider ID - * @param[in] operationId The operation ID used in application control invocation - * @param[in] pResultList The list of callback strings of application control + * @param[in] providerId The provider ID + * @param[in] operationId The operation ID used for application control invocation + * @param[in] pResultList The list of callback strings for application control * - * @remarks The specified @c pResultList provides the result code for the first array element. - * @remarks When the invoked application control is terminated without sending a result, - * then this method is invoked with @c pResultList and it contains App::APPCONTROL_RESULT_TERMINATED. - * @remarks Switching forms using Tizen::Ui::Controls::Frame::SetCurrentForm() in this listener disables the upcoming form - * (UiApp::OnForeground()). If %UiApp::OnForeground() is being used in the application logic, - * it is recommended to avoid switching forms in this listener. + * @remarks + * - The specified @c pResultList provides the result code for the first array element. + * - When the invoked application control is terminated without sending a result, + * then this method is invoked with @c pResultList and it contains App::APPCONTROL_RESULT_TERMINATED. + * - Switching forms using Tizen::Ui::Controls::Frame::SetCurrentForm() in this listener disables the upcoming form + * (UiApp::OnForeground()). @n If the %UiApp::OnForeground() method is being used in the application logic, it is recommended to avoid switching forms in this listener. * @see Tizen::App::AppControl * @endif */ diff --git a/inc/FAppIAppControlListener.h b/inc/FAppIAppControlListener.h index 3e93a04..1abb694 100644 --- a/inc/FAppIAppControlListener.h +++ b/inc/FAppIAppControlListener.h @@ -15,10 +15,12 @@ // /** - * @file FAppIAppControlListener.h - * @brief This is the header file for the %IAppControlListener interface. + * @if OSPDEPREC + * @file FAppIAppControlListener.h + * @brief This is the header file for the %IAppControlListener interface. * * This header file contains the declarations of the %IAppControlListener interface. + * @endif */ #ifndef _FAPP_IAPP_CONTROL_LISTENER_H_ @@ -36,7 +38,7 @@ namespace Tizen { namespace App /** * @if OSPDEPREC * @interface IAppControlListener - * @brief [Deprecated] This interface defines a listener for the AppControl start and result events. + * @brief [Deprecated] This interface defines a listener for the %AppControl start and result events. * * @deprecated This interface is deprecated. Instead of using this interface, use the IAppControlResponseListener interface. * @since 2.0 @@ -51,7 +53,7 @@ class _OSP_EXPORT_ IAppControlListener public: /** * @if OSPDEPREC - * This polymorphic destructor should be overridden if required. + * This polymorphic destructor should be overridden if required. @n * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @brief [Deprecated] diff --git a/inc/FAppIAppControlProviderEventListener.h b/inc/FAppIAppControlProviderEventListener.h index abcb7a2..626a8b5 100644 --- a/inc/FAppIAppControlProviderEventListener.h +++ b/inc/FAppIAppControlProviderEventListener.h @@ -52,7 +52,7 @@ class _OSP_EXPORT_ IAppControlProviderEventListener { public: /** - * This polymorphic destructor should be overridden if required. + * This polymorphic destructor should be overridden if required. @n * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 @@ -65,16 +65,17 @@ public: * * @since 2.0 * - * @param[in] reqId The application control request ID + * @param[in] reqId The application control request ID * @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 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(). - * @remarks When the application control is resolved with the file extension with AppControl::FindAndStart(), - * the delivered file extension is converted to the corresponding MIME type in the @c pMimeType parameter. + * @param[in] pExtraData A pointer to the argument map of the 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 the AppControlProviderManager::SendAppControlResult() method with the given request ID. @n + * When the application receives the AppControl request in the background, + * the %OnAppControlRequestReceived() method is invoked before the UiApp::OnForeground() method. + * - When the application control is resolved with the file extension returned by the AppControl::FindAndStart() method, + * the delivered file extension is converted to the corresponding MIME type in the @c pMimeType parameter. */ virtual void OnAppControlRequestReceived(RequestId reqId, const Tizen::Base::String& operationId, const Tizen::Base::String* pUriData, const Tizen::Base::String* pMimeType, const Tizen::Base::Collection::IMap* pExtraData) = 0; diff --git a/inc/FAppIAppControlResponseListener.h b/inc/FAppIAppControlResponseListener.h index 61c613f..57174e2 100644 --- a/inc/FAppIAppControlResponseListener.h +++ b/inc/FAppIAppControlResponseListener.h @@ -15,8 +15,8 @@ // /** - * @file FAppIAppControlResponseListener.h - * @brief This is the header file for the %IAppControlResponseListener interface. + * @file FAppIAppControlResponseListener.h + * @brief This is the header file for the %IAppControlResponseListener interface. * * This header file contains the declarations of the %IAppControlResponseListener interface. */ @@ -49,7 +49,7 @@ class _OSP_EXPORT_ IAppControlResponseListener { public: /** - * This polymorphic destructor should be overridden if required. + * This polymorphic destructor should be overridden if required. @n * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 @@ -57,37 +57,36 @@ public: virtual ~IAppControlResponseListener(void) {} /** - * Called when the response for application control completion is received. + * Called when the response for an application control completion is received. * * @since 2.0 * - * @param[in] appId The ID of the requested application - * @param[in] operationId The operation ID used in application control invocation + * @param[in] appId The ID of the requested application + * @param[in] operationId The operation ID used in the application control invocation * @param[in] appControlResult The application control result - * @param[in] pExtraData A pointer to an result map of key and value pair where the key of type Tizen::Base::String and the value of - * type %Tizen::Base::String or of type Tizen::Base::ArrayList of %Tizen::Base::String + * @param[in] pExtraData A pointer to the result map of the 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 The application control completion result is received when the requested application control - * sends the result using AppControlProviderManager::SendAppControlResult(). + * sends the result using the AppControlProviderManager::SendAppControlResult() method. * @see AppControl */ virtual void OnAppControlCompleteResponseReceived(const AppId& appId, const Tizen::Base::String& operationId, AppCtrlResult appControlResult, const Tizen::Base::Collection::IMap* pExtraData) = 0; /** - * Called when the application control is about to start or to be canceled by the user resolution. @n + * Called when the application control is about to start or is to be cancelled by the user resolution. @n * The calling application can get the result of the resolution by implementing this empty body method. * * @since 2.0 * - * @param[in] appId The ID of the requested application - * @param[in] operationId The operation ID used in application control invocation - * @param[in] r The result of the application control start response @n - * The exception code may be given through this parameter. - * @exception E_SUCCESS The method is successful. - * @exception E_OPERATION_CANCELED The application control resolve request is canceled by a user operation. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @exception E_SYSTEM A system error has occurred. + * @param[in] appId The ID of the requested application + * @param[in] operationId The operation ID used in the application control invocation + * @param[in] r The result of the application control start response @n + * The following exceptions may be given through this parameter. + * @exception E_SUCCESS The method is successful. + * @exception E_OPERATION_CANCELED The application control resolve request has been cancelled by the user operation. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_SYSTEM A system error has occurred. * @remarks This method is invoked only for the implicit AppControl resolution. - * @see AppControl * @see AppControl::FindAndStart() */ virtual void OnAppControlStartResponseReceived(const AppId& appId, const Tizen::Base::String& operationId, result r) {} diff --git a/inc/FAppIAppFrame.h b/inc/FAppIAppFrame.h index 646db61..14c5248 100644 --- a/inc/FAppIAppFrame.h +++ b/inc/FAppIAppFrame.h @@ -15,8 +15,8 @@ // /** - * @file FAppIAppFrame.h - * @brief This is the header file for the %IAppFrame interface. + * @file FAppIAppFrame.h + * @brief This is the header file for the %IAppFrame interface. * * This header file contains the declarations of the %IAppFrame interface. */ @@ -39,13 +39,14 @@ namespace Tizen { namespace App * * @since 2.0 * - * The %IAppFrame interface provides methods for the application frame. A frame is the outermost boundary of the application UI. + * The %IAppFrame interface provides methods for the application frame. + * A frame is the outermost boundary of the application UI. */ class IAppFrame { public: /** - * This polymorphic destructor should be overridden if required. + * This polymorphic destructor should be overridden if required. @n * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 @@ -57,7 +58,7 @@ public: * * @since 2.0 * - * @return A pointer to the Tizen::Graphics::Canvas class + * @return A pointer to the Tizen::Graphics::Canvas instance */ virtual Tizen::Graphics::Canvas* GetCanvasN(void) const = 0; @@ -66,8 +67,8 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] listener A Tizen::Ui::IKeyEventListener instance to add + * @return An error code + * @param[in] listener An instance of Tizen::Ui::IKeyEventListener to add * @exception E_SUCCESS The method is successful. */ virtual result AddKeyEventListener(Tizen::Ui::IKeyEventListener& listener) = 0; @@ -77,8 +78,8 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] listener A Tizen::Ui::IKeyEventListener instance to remove + * @return An error code + * @param[in] listener An instance of Tizen::Ui::IKeyEventListener to remove * @exception E_SUCCESS The method is successful. */ virtual result RemoveKeyEventListener(Tizen::Ui::IKeyEventListener& listener) = 0; @@ -88,9 +89,9 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] listener A Tizen::Ui::ITouchEventListener instance to add - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] listener An instance of Tizen::Ui::ITouchEventListener to add + * @exception E_SUCCESS The method is successful. */ virtual result AddTouchEventListener(Tizen::Ui::ITouchEventListener& listener) = 0; @@ -99,8 +100,8 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] listener A Tizen::Ui::ITouchEventListener instance to add + * @return An error code + * @param[in] listener An instance of Tizen::Ui::ITouchEventListener to add * @exception E_SUCCESS The method is successful. */ virtual result RemoveTouchEventListener(Tizen::Ui::ITouchEventListener& listener) = 0; @@ -110,8 +111,8 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] listener A Tizen::Ui::IWindowEventListener instance to remove + * @return An error code + * @param[in] listener An instance of Tizen::Ui::IWindowEventListener to remove * @exception E_SUCCESS The method is successful. */ virtual result AddWindowEventListener(Tizen::Ui::IWindowEventListener& listener) = 0; @@ -121,8 +122,8 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] listener A Tizen::Ui::IWindowEventListener instance to remove + * @return An error code + * @param[in] listener An instance of Tizen::Ui::IWindowEventListener to remove * @exception E_SUCCESS The method is successful. */ virtual result RemoveWindowEventListener(Tizen::Ui::IWindowEventListener& listener) = 0; @@ -132,11 +133,11 @@ public: * * @since 2.0 * - * @return A pointer to Tizen::Ui::Controls::Frame if successful, @n - * else @c null - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE This instance is in an invalid state. - * @exception E_UNSUPPORTED_OPERATION This method cannot be supported. + * @return A pointer to the Tizen::Ui::Controls::Frame instance, @n + * else @c null if it fails + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_STATE This instance is in an invalid state. + * @exception E_UNSUPPORTED_OPERATION This method is not supported. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Ui::Controls::Frame* GetFrame(void) = 0; diff --git a/inc/FAppIAppLaunchConditionEventListener.h b/inc/FAppIAppLaunchConditionEventListener.h index f898c78..05d50be 100644 --- a/inc/FAppIAppLaunchConditionEventListener.h +++ b/inc/FAppIAppLaunchConditionEventListener.h @@ -15,8 +15,8 @@ // /** - * @file FAppIAppLaunchConditionEventListener.h - * @brief This is the header file for the %IAppLaunchConditionEventListener interface. + * @file FAppIAppLaunchConditionEventListener.h + * @brief This is the header file for the %IAppLaunchConditionEventListener interface. * * This header file contains the declarations of the %IAppLaunchConditionEventListener interface. */ @@ -47,7 +47,7 @@ class _OSP_EXPORT_ IAppLaunchConditionEventListener { public: /** - * This polymorphic destructor should be overridden if required. + * This polymorphic destructor should be overridden if required. @n * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 @@ -60,17 +60,17 @@ public: * @since 2.0 * * @param[in] condition The registered condition for the application launch - * @param[in] pArguments A list of string arguments specified when the condition is registered - * @param[in] pExtraData A pointer to the instance of object that system delivered, @n + * @param[in] pArguments The list of string arguments specified when the condition is registered + * @param[in] pExtraData A pointer to the Tizen::Base::Object instance that the system delivered, @n * else @c null if there is no extra data * - * @remarks If extra data is required to be delivered, @c pExtraData contains the data, + * @remarks If the extra data has to be delivered, @c pExtraData contains the data, * and this must be freed by the launched application after use. - * ( Currently, only NFC condition uses this to deliver to Tizen::Net::Nfc::NdefMessage. ) + * ( Currently, only the NFC condition uses this to deliver to Tizen::Net::Nfc::NdefMessage. ) * @see Tizen::App::AppManager::RegisterAppLaunch() * @see Tizen::App::AppManager::SetAppLaunchConditionEventListener() * - * The following example demonstrates how to use the %OnAppLaunchConditionMetN() method to get Tizen::Net::Nfc::NdefMessage instance, when an application is launched by NFC condition. + * The following example demonstrates how to use the %OnAppLaunchConditionMetN() method to get the Tizen::Net::Nfc::NdefMessage instance, when an application is launched by the NFC condition. * @code * NdefMessage* pMessage = dynamic_cast(pExtraData); * @endcode diff --git a/inc/FAppIAppSettingEventListener.h b/inc/FAppIAppSettingEventListener.h index 9436dc6..b0a2a82 100644 --- a/inc/FAppIAppSettingEventListener.h +++ b/inc/FAppIAppSettingEventListener.h @@ -33,12 +33,12 @@ namespace Tizen { namespace App /** * @interface IAppSettingEventListener - * @brief This interface is the listener interface for receiving the setting change events. + * @brief This interface is the listener interface for receiving setting change events. * * @since 2.0 * - * The %IAppSettingEventListener interface is the listener interface for receiving the setting change events. - * The class that processes a setting change event implements this interface and registers using + * The %IAppSettingEventListener interface is the listener interface for receiving setting change events. + * The class that processes a setting change event implements this interface and registers it using * the AppSetting::SetAppSettingEventListener() method. * */ @@ -47,12 +47,12 @@ class _OSP_EXPORT_ IAppSettingEventListener { public: /** - * This polymorphic destructor should be overridden if required. This way, - * the destructors of the derived classes are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 * - * @remarks This method is invoked only in the main thread + * @remarks This method is invoked only in the main thread. */ virtual ~IAppSettingEventListener(void) {} @@ -63,7 +63,7 @@ public: * * @param[in] id The ID of the application setting whose value is changed * - * @remarks This method is invoked only in the main thread + * @remarks This method is invoked only in the main thread. */ virtual void OnAppSettingChanged(const Tizen::Base::String& id) = 0; diff --git a/inc/FAppIMapDataControlProviderEventListener.h b/inc/FAppIMapDataControlProviderEventListener.h index a16c753..ebc8562 100644 --- a/inc/FAppIMapDataControlProviderEventListener.h +++ b/inc/FAppIMapDataControlProviderEventListener.h @@ -33,11 +33,11 @@ namespace Tizen { namespace App /** * @interface IMapDataControlProviderEventListener - * @brief This interface defines a listener for dealing with key-value structured data control request. + * @brief This interface defines a listener for dealing with a key-value structured data control request. * * @since 2.0 * - * The %IMapDataControlProviderEventListener interface defines a listener for dealing with key-value structured data control request. + * The %IMapDataControlProviderEventListener interface defines a listener for dealing with a key-value structured data control request. * * The following example demonstrates how to use the %IMapDataControlProviderEventListener interface. * @code @@ -177,7 +177,7 @@ class _OSP_EXPORT_ IMapDataControlProviderEventListener public: /** - * This polymorphic destructor should be overridden if required. + * This polymorphic destructor should be overridden if required. @n * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 @@ -185,74 +185,74 @@ public: virtual ~IMapDataControlProviderEventListener(void) {} /** - * Called when the request for getting the value list is received from key-value structured data control consumer. @n + * Called when the request for obtaining the value list is received from the key-value structured data control consumer. @n * The provider must implement this listener for providing its own data. * * @since 2.0 * * @param[in] reqId The request ID * @param[in] providerId The data control provider ID - * @param[in] dataId A string for identifying a specific map to get from @n + * @param[in] dataId The string that identifies the specific map to obtain from @n * The string consists of one or more components, separated by a slash('/'). - * @param[in] key A key of the value list to obtain - * @remarks For replying to the data control request, use DataControlProviderManager::SendMapDataControlResult() - * or DataControlProviderManager::SendDataControlError(). + * @param[in] key The key of the value list to obtain + * @remarks For replying to the data control request, use the DataControlProviderManager::SendMapDataControlResult() method + * or the DataControlProviderManager::SendDataControlError() method. */ virtual void OnMapDataControlGetValueRequestReceived(RequestId reqId, const Tizen::Base::String& providerId, const Tizen::Base::String& dataId, const Tizen::Base::String& key) = 0; /** - * Called when the request for adding the value is received from key-value structured data control consumer. @n + * Called when the request for adding the value is received from the key-value structured data control consumer. @n * The provider must implement this listener for providing its own data. * * @since 2.0 * * @param[in] reqId The request ID * @param[in] providerId The data control provider ID - * @param[in] dataId A string for identifying a specific map to add to @n + * @param[in] dataId The string that identifies the specific map to add to @n * The string consists of one or more components, separated by a slash('/'). - * @param[in] key A key of the value list to add - * @param[in] value A value to add - * @remarks For replying to the data control request, use DataControlProviderManager::SendMapDataControlResult() - * or DataControlProviderManager::SendDataControlError(). + * @param[in] key The key of the value list to add + * @param[in] value The value to add + * @remarks For replying to the data control request, use the DataControlProviderManager::SendMapDataControlResult() method + * or the DataControlProviderManager::SendDataControlError() method. */ virtual void OnMapDataControlAddValueRequestReceived(RequestId reqId, const Tizen::Base::String& providerId, const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value) = 0; /** - * Called when the request for replacing the value is received from key-value structured data control consumer. @n + * Called when the request for replacing the value is received from the key-value structured data control consumer. @n * The provider must implement this listener for providing its own data. * * @since 2.0 * * @param[in] reqId The request ID * @param[in] providerId The data control provider ID - * @param[in] dataId A string for identifying a specific map to update @n + * @param[in] dataId The string that identifies the specific map to update @n * The string consists of one or more components, separated by a slash('/'). - * @param[in] key A key of the value to replace - * @param[in] oldValue A value to replace - * @param[in] newValue A new value to replace the existing value - * @remarks For replying to the data control request, use DataControlProviderManager::SendMapDataControlResult() - * or DataControlProviderManager::SendDataControlError(). + * @param[in] key The key of the value to replace + * @param[in] oldValue The value to replace + * @param[in] newValue The new value that replaces the existing value + * @remarks For replying to the data control request, use the DataControlProviderManager::SendMapDataControlResult() method + * or the DataControlProviderManager::SendDataControlError() method. */ virtual void OnMapDataControlSetValueRequestReceived(RequestId reqId, const Tizen::Base::String& providerId, const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& oldValue, const Tizen::Base::String& newValue) = 0; /** - * Called when the request for removing the value is received from key-value structured data control consumer. @n + * Called when the request for removing the value is received from the key-value structured data control consumer. @n * The provider must implement this listener for providing its own data. * * @since 2.0 * * @param[in] reqId The request ID * @param[in] providerId The data control provider ID - * @param[in] dataId A string for identifying a specific map to remove from @n + * @param[in] dataId The string that identifies the specific map to remove from @n * The string consists of one or more components, separated by a slash('/'). - * @param[in] key A key of the value to remove - * @param[in] value A value to remove - * @remarks For replying to the data control request, use DataControlProviderManager::SendMapDataControlResult() - * or DataControlProviderManager::SendDataControlError(). + * @param[in] key The key of the value to remove + * @param[in] value The value to remove + * @remarks For replying to the data control request, use the DataControlProviderManager::SendMapDataControlResult() method + * or the DataControlProviderManager::SendDataControlError() method. */ virtual void OnMapDataControlRemoveValueRequestReceived(RequestId reqId, const Tizen::Base::String& providerId, const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value) = 0; diff --git a/inc/FAppIMapDataControlResponseListener.h b/inc/FAppIMapDataControlResponseListener.h index 7c3fd13..9f9f011 100644 --- a/inc/FAppIMapDataControlResponseListener.h +++ b/inc/FAppIMapDataControlResponseListener.h @@ -46,7 +46,7 @@ class _OSP_EXPORT_ IMapDataControlResponseListener public: /** - * This polymorphic destructor should be overridden if required. + * This polymorphic destructor should be overridden if required. @n * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 @@ -54,20 +54,20 @@ public: virtual ~IMapDataControlResponseListener(void) {} /** - * Called when the result value list is received from key-value structured data control provider. @n + * Called when the result value list is received from the key-value structured data control provider. @n * The application requesting the data control can get the result value list by implementing this listener. @n - * This listener must be registered by MapDataControl::SetMapDataControlResponseListener() for receiving the result value set. - * It is called after MapDataControl::GetValue(). + * This listener must be registered by the MapDataControl::SetMapDataControlResponseListener() method for receiving the result value set. + * It is called after the MapDataControl::GetValue() method. * * @since 2.0 * * @param[in] reqId The request ID * @param[in] providerId The data control provider ID - * @param[in] dataId A string for identifying a specific map to get from @n + * @param[in] dataId The string that identifies the specific map to obtain from @n * The string consists of one or more components, separated by a slash('/'). - * @param[in] resultValueList The result value list of data control request getting matching values @n - * The type of objects contained in the specified @c resultValueList is - * Tizen::Base::String class. + * @param[in] resultValueList The result value list of the data control request that gets the matching values @n + * The type of objects contained in the specified @c resultValueList are + * Tizen::Base::String. * @param[in] providerResult Set to @c true if the data control provider successfully processed the request getting the values, @n * else @c false * @param[in] pErrorMsg The error message from the data control provider @@ -77,16 +77,16 @@ public: bool providerResult, const Tizen::Base::String* pErrorMsg) = 0; /** - * Called when the response is received from key-value structured data control provider. @n + * Called when the response is received from the key-value structured data control provider. @n * The application requesting the data control can get the result by implementing this listener. @n - * This listener must be registered by MapDataControl::SetMapDataControlResponseListener() for receiving the result response. - * It is called after MapDataControl::AddValue(). + * This listener must be registered by the MapDataControl::SetMapDataControlResponseListener() method for receiving the result response. + * It is called after the MapDataControl::AddValue() method. * * @since 2.0 * * @param[in] reqId The request ID * @param[in] providerId The data control provider ID - * @param[in] dataId A string for identifying a specific map to add to @n + * @param[in] dataId The string that identifies the specific map to add to @n * The string consists of one or more components, separated by a slash('/'). * @param[in] providerResult Set to @c true if the data control provider successfully processed the request adding a value, @n * else @c false @@ -96,16 +96,16 @@ public: const Tizen::Base::String& dataId, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0; /** - * Called when the response is received from key-value structured data control provider. @n - * The application requesting the data control can get the result for some data controls by implementing this listener. @n - * This listener must be registered by MapDataControl::SetMapDataControlResponseListener() for receiving the result response. - * It is called after MapDataControl::SetValue(). + * Called when the response is received from the key-value structured data control provider. @n + * The application requesting the data control can get the result by implementing this listener. @n + * This listener must be registered by the MapDataControl::SetMapDataControlResponseListener() method for receiving the result response. + * It is called after the MapDataControl::SetValue() method. * * @since 2.0 * * @param[in] reqId The request ID * @param[in] providerId The data control provider ID - * @param[in] dataId A string for identifying a specific map to update @n + * @param[in] dataId The string that identifies the specific map to update @n * The string consists of one or more components, separated by a slash('/'). * @param[in] providerResult Set to @c true if the data control provider successfully processed the request replacing a value, @n * else @c false @@ -115,16 +115,16 @@ public: const Tizen::Base::String& dataId, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0; /** - * Called when the response is received from key-value structured data control provider. @n - * The application requesting the data control can get the result for some data controls by implementing this listener. @n - * This listener must be registered by MapDataControl::SetMapDataControlResponseListener() for receiving the result response. - * It is called after MapDataControl::RemoveValue(). + * Called when the response is received from the key-value structured data control provider. @n + * The application requesting the data control can get the result by implementing this listener. @n + * This listener must be registered by the MapDataControl::SetMapDataControlResponseListener() method for receiving the result response. + * It is called after the MapDataControl::RemoveValue() method. * * @since 2.0 * * @param[in] reqId The request ID * @param[in] providerId The data control provider ID - * @param[in] dataId A string for identifying a specific map to remove from @n + * @param[in] dataId The string that identifies the specific map to remove from @n * The string consists of one or more components, separated by a slash('/'). * @param[in] providerResult Set to @c true if the data control provider successfully processed the request removing a value, @n * else @c false diff --git a/inc/FAppISqlDataControlProviderEventListener.h b/inc/FAppISqlDataControlProviderEventListener.h index 4a3305e..7990750 100644 --- a/inc/FAppISqlDataControlProviderEventListener.h +++ b/inc/FAppISqlDataControlProviderEventListener.h @@ -34,11 +34,11 @@ namespace Tizen { namespace App /** * @interface ISqlDataControlProviderEventListener - * @brief This interface defines a listener for dealing with SQL-friendly interface based data control request. + * @brief This interface defines a listener for dealing with an SQL-friendly interface based data control request. * * @since 2.0 * - * The %ISqlDataControlProviderEventListener interface defines a listener for dealing with SQL-friendly interface based data control request. + * The %ISqlDataControlProviderEventListener interface defines a listener for dealing with an SQL-friendly interface based data control request. * * The following example demonstrates how to use the %ISqlDataControlProviderEventListener interface. * @@ -242,7 +242,7 @@ class _OSP_EXPORT_ ISqlDataControlProviderEventListener public: /** - * This polymorphic destructor should be overridden if required. + * This polymorphic destructor should be overridden if required. @n * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 @@ -250,88 +250,88 @@ public: virtual ~ISqlDataControlProviderEventListener(void) {} /** - * Called when a select request is received from an application using SQL-friendly interface based data control. @n + * Called when the select request is received from an application using an SQL-friendly interface based data control. @n * The provider must implement this listener for providing its own data. * * @since 2.0 * * @param[in] reqId The request ID - * @param[in] providerId The provider ID for identifying the data control - * @param[in] dataId A string for identifying a specific table to query from @n - * The string consists of one or more components, separated by a slash('/'). - * If the specified @c pColumnList is @c null, all columns are selected. - * @param[in] pColumnList A list of column names to query @n - * The type of objects contained in the specified @c pColumnList is - * Tizen::Base::String class. - * @param[in] pWhere A filter to select desired rows to query @n + * @param[in] providerId The provider ID that identifies the data control + * @param[in] dataId The string that identifies the specific table to query from @n + * The string consists of one or more components, separated by a slash('/') @n + * If the specified @c pColumnList is @c null, all the columns are selected. + * @param[in] pColumnList The list of column names to query @n + * The type of objects contained in the specified @c pColumnList are + * Tizen::Base::String. + * @param[in] pWhere The filter that selects the desired rows to query @n * It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as * column1 = 'stringValue' AND column2 = numericValue. - * @param[in] pOrder The sorting order of rows to query @n + * @param[in] pOrder The sorting order of the rows to query @n * It is an SQL 'ORDER BY' clause excluding the 'ORDER BY' itself. - * @remarks For replying to the data control request, use DataControlProviderManager::SendSqlDataControlSelectResult() - * or DataControlProviderManager::SendDataControlError(). + * @remarks For replying to the data control request, use the DataControlProviderManager::SendSqlDataControlSelectResult() method + * or the DataControlProviderManager::SendDataControlError() method. */ virtual void OnSqlDataControlSelectRequestReceived(RequestId reqId, const Tizen::Base::String& providerId, const Tizen::Base::String& dataId, const Tizen::Base::Collection::IList* pColumnList, const Tizen::Base::String* pWhere, const Tizen::Base::String* pOrder) = 0; /** - * Called when an insert request is received from an application using SQL-friendly interface based data control. @n + * Called when the insert request is received from an application using an SQL-friendly interface based data control. @n * The provider must implement this listener for providing its own data. * * @since 2.0 * * @param[in] reqId The request ID - * @param[in] providerId The provider ID for identifying the data control - * @param[in] dataId A string for identifying a specific table to insert into @n + * @param[in] providerId The provider ID that identifies the data control + * @param[in] dataId The string that identifies the specific table to insert into @n * The string consists of one or more components, separated by a slash('/'). - * @param[in] insertMap The field values in a record to insert @n - * The type of objects contained in the specified @c insertMap is - * Tizen::Base::String class. - * @remarks For replying to the data control request, use DataControlProviderManager::SendSqlDataControlInsertResult() - * or DataControlProviderManager::SendDataControlError(). + * @param[in] insertMap The field values to insert in the record @n + * The type of objects contained in the specified @c insertMap are + * Tizen::Base::String. + * @remarks For replying to the data control request, use the DataControlProviderManager::SendSqlDataControlInsertResult() method + * or the DataControlProviderManager::SendDataControlError() method. */ virtual void OnSqlDataControlInsertRequestReceived(RequestId reqId, const Tizen::Base::String& providerId, const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& insertMap) = 0; /** - * Called when an update request is received from an application using SQL-friendly interface based data control. @n + * Called when the update request is received from an application using an SQL-friendly interface based data control. @n * The provider must implement this listener for providing its own data. * * @since 2.0 * * @param[in] reqId The request ID - * @param[in] providerId The provider ID for identifying the data control - * @param[in] dataId A string for identifying a specific table to update @n + * @param[in] providerId The provider ID that identifies the data control + * @param[in] dataId The string that identifies the specific table to update @n * The string consists of one or more components, separated by a slash('/'). - * @param[in] updateMap The field values in a record to update @n - * The type of objects contained in the specified @c updateMap is - * Tizen::Base::String class. - * @param[in] pWhere A filter to select desired rows to update @n + * @param[in] updateMap The field values to update in the record @n + * The type of objects contained in the specified @c updateMap are + * Tizen::Base::String. + * @param[in] pWhere The filter to select the desired rows to update @n * It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as * column1 = 'stringValue' AND column2 = numericValue. - * @remarks For replying to the data control request, use DataControlProviderManager::SendSqlDataControlUpdateDeleteResult() - * or DataControlProviderManager::SendDataControlError(). + * @remarks For replying to the data control request, use the DataControlProviderManager::SendSqlDataControlUpdateDeleteResult() method + * or the DataControlProviderManager::SendDataControlError() method. */ virtual void OnSqlDataControlUpdateRequestReceived(RequestId reqId, const Tizen::Base::String& providerId, const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& updateMap, const Tizen::Base::String* pWhere) = 0; /** - * Called when a delete request is received from an application using SQL-friendly interface based data control. @n + * Called when the delete request is received from an application using an SQL-friendly interface based data control. @n * The provider must implement this listener for providing its own data. * * @since 2.0 * * @param[in] reqId The request ID - * @param[in] providerId The provider ID for identifying the data control - * @param[in] dataId A string for identifying a specific table to delete from @n + * @param[in] providerId The provider ID that identifies the data control + * @param[in] dataId The string that identifies the specific table to delete from @n * The string consists of one or more components, separated by a slash('/'). - * @param[in] pWhere A filter to select desired rows to delete @n + * @param[in] pWhere The filter to select the desired rows to delete @n * It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as * column1 = 'stringValue' AND column2 = numericValue. - * @remarks For replying to the data control request, use DataControlProviderManager::SendSqlDataControlUpdateDeleteResult() - * or DataControlProviderManager::SendDataControlError(). + * @remarks For replying to the data control request, use the DataControlProviderManager::SendSqlDataControlUpdateDeleteResult() method + * or the DataControlProviderManager::SendDataControlError() method. */ virtual void OnSqlDataControlDeleteRequestReceived(RequestId reqId, const Tizen::Base::String& providerId, const Tizen::Base::String& dataId, const Tizen::Base::String* pWhere) = 0; diff --git a/inc/FAppISqlDataControlResponseListener.h b/inc/FAppISqlDataControlResponseListener.h index 819d6ef..3418bd3 100644 --- a/inc/FAppISqlDataControlResponseListener.h +++ b/inc/FAppISqlDataControlResponseListener.h @@ -34,11 +34,11 @@ namespace Tizen { namespace App /** * @interface ISqlDataControlResponseListener -* @brief This interface defines a listener for the SQL-friendly interface based data control response. +* @brief This interface defines a listener for an SQL-friendly interface based data control response. * * @since 2.0 * -* The %ISqlDataControlResponseListener interface defines a listener for the SQL-friendly interface based data control response. +* The %ISqlDataControlResponseListener interface defines a listener for an SQL-friendly interface based data control response. */ class _OSP_EXPORT_ ISqlDataControlResponseListener : virtual public Tizen::Base::Runtime::IEventListener @@ -46,7 +46,7 @@ class _OSP_EXPORT_ ISqlDataControlResponseListener public: /** - * This polymorphic destructor should be overridden if required. + * This polymorphic destructor should be overridden if required. @n * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 @@ -54,18 +54,18 @@ public: virtual ~ISqlDataControlResponseListener(void) {} /** - * Called when the result set is received from SQL-friendly interface based data control provider. @n + * Called when the result set is received from an SQL-friendly interface based data control provider. @n * The application requesting the data control can get the query result by implementing this listener. @n - * This listener must be registered by SqlDataControl::SetSqlDataControlResponseListener() for receiving the result set. - * It is called after SqlDataControl::Select(). + * This listener must be registered by the SqlDataControl::SetSqlDataControlResponseListener() method for receiving the result set. + * It is called after the SqlDataControl::Select() method. * * @since 2.0 * * @param[in] reqId The request ID * @param[in] providerId The data control provider ID - * @param[in] dataId A string for identifying a specific table to query from @n + * @param[in] dataId The string that identifies the specific table to query from @n * The string consists of one or more components, separated by a slash('/'). - * @param[in] resultSetEnumerator Navigates the result of data control select request + * @param[in] resultSetEnumerator Navigates the result of the data control select request * @param[in] providerResult Set to @c true if the data control provider successfully processed the query request, @n * else @c false * @param[in] pErrorMsg The error message from the data control provider @@ -74,19 +74,19 @@ public: const Tizen::Base::String& dataId, Tizen::Io::IDbEnumerator& resultSetEnumerator, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0; /** - * Called when the response is received from SQL-friendly interface based data control provider. @n - * The application requesting the data control can get insert result by implementing this listener. @n - * This listener must be registered by SqlDataControl::SetSqlDataControlResponseListener() for receiving the result response. - * It is called after SqlDataControl::Insert(). + * Called when the response is received from an SQL-friendly interface based data control provider. @n + * The application requesting the data control can get the insert result by implementing this listener. @n + * This listener must be registered by the SqlDataControl::SetSqlDataControlResponseListener() method for receiving the result response. + * It is called after the SqlDataControl::Insert() method. * * @since 2.0 * * @param[in] reqId The request ID * @param[in] providerId The data control provider ID - * @param[in] dataId A string for identifying a specific table to insert into @n + * @param[in] dataId The string that identifies the specific table to insert into @n * The string consists of one or more components, separated by a slash('/'). * @param[in] insertRowId The inserted row ID set by the data control provider if the specified @c providerResult is @c true, @n - * else @c -1 + * else @c -1 if it fails * @param[in] providerResult Set to @c true if the data control provider successfully processed the insert request, @n * else @c false * @param[in] pErrorMsg The error message from the data control provider @@ -95,16 +95,16 @@ public: const Tizen::Base::String& dataId, long long insertRowId, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0; /** - * Called when the response is received from SQL-friendly interface based data control provider. @n - * The application requesting the data control can get update result implementing this listener. @n - * This listener must be registered by SqlDataControl::SetSqlDataControlResponseListener() for receiving the result response. - * It is called after SqlDataControl::Update(). + * Called when the response is received from an SQL-friendly interface based data control provider. @n + * The application requesting the data control can get the update result implementing this listener. @n + * This listener must be registered by the SqlDataControl::SetSqlDataControlResponseListener() method for receiving the result response. + * It is called after the SqlDataControl::Update() method. * * @since 2.0 * * @param[in] reqId The request ID * @param[in] providerId The data control provider ID - * @param[in] dataId A string for identifying a specific table to update @n + * @param[in] dataId The string that identifies the specific table to update @n * The string consists of one or more components, separated by a slash('/'). * @param[in] providerResult Set to @c true if the data control provider successfully processed the update request, @n * else @c false @@ -114,16 +114,16 @@ public: const Tizen::Base::String& dataId, bool providerResult, const Tizen::Base::String* pErrorMsg) = 0; /** - * Called when the response is received from SQL-friendly interface based data control provider. @n - * The application requesting the data control can get delete result by implementing this listener. @n - * This listener must be registered by SqlDataControl::SetSqlDataControlResponseListener() for receiving the result response. - * It is called after SqlDataControl::Delete(). + * Called when the response is received from an SQL-friendly interface based data control provider. @n + * The application requesting the data control can get the delete result by implementing this listener. @n + * This listener must be registered by the SqlDataControl::SetSqlDataControlResponseListener() method for receiving the result response. + * It is called after the SqlDataControl::Delete() method. * * @since 2.0 * * @param[in] reqId The request ID * @param[in] providerId The data control provider ID - * @param[in] dataId A string for identifying a specific table to delete from @n + * @param[in] dataId The string that identifies the specific table to delete from @n * The string consists of one or more components, separated by a slash('/'). * @param[in] providerResult Set to @c true if the data control provider successfully processed the delete request, @n * else @c false diff --git a/inc/FAppMapDataControl.h b/inc/FAppMapDataControl.h index 8b451ab..3b70645 100755 --- a/inc/FAppMapDataControl.h +++ b/inc/FAppMapDataControl.h @@ -47,7 +47,7 @@ class IMapDataControlResponseListener; * * The %MapDataControl class represents the key-value structured data control behavior, that provides a standard mechanism * for accessing specific data exported by other applications. - * Data control provider can share its own data to data control consumers. + * A data control provider can share its data with data control consumers. * * For more information on the class features, see Data Controls. * @@ -111,130 +111,146 @@ public: virtual ~MapDataControl(void); /** - * Gets the value list associated with the specified @c key, from a key-values map owned by key-value structured data control provider. @n + * Gets the value list associated with the specified @c key, from the key-values map owned by the key-value structured data control provider. @n * The %GetValue() method is asynchronous. - * For receiving the response from data control provider, set the listener - * with MapDataControl::SetMapDataControlResponseListener(). @n - * When the requested value list has been received from data control provider, + * For receiving the response from the data control provider, set the listener + * using the MapDataControl::SetMapDataControlResponseListener() method. @n + * When the requested value list has been received from the data control provider, * the IMapDataControlResponseListener::OnMapDataControlGetValueResponseReceived() method is called. * * @since 2.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/datacontrol.consumer * * @return An error code - * @param[in] dataId A string for identifying specific data, usually a registry section to get from @n - * The string consists of one or more components, separated by a slash('/'). - * @param[in] key A key of the value list to obtain - * @param[out] reqId The ID of the request - * @param[in] pageNo The page number of the value set @n - * It starts from @c 1. - * @param[in] countPerPage The desired maximum count of the data item on the page + * @param[in] dataId The string that identifies the specific data, usually a registry section to get from @n + * The string consists of one or more components, separated by a slash('/'). + * @param[in] key The key of the value list to obtain + * @param[out] reqId The ID of the request + * @param[in] pageNo The page number of the value set @n + * It starts from @c 1. + * @param[in] countPerPage The desired maximum count of the data items per page * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE This instance has not been properly constructed as yet. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The specified @c pageNo parameter is less than @c 1. - * - The specified @c countPerPage parameter is less than @c 1. - * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n - * - Access is denied due to insufficient permission. - * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1 - * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n - * - The total size of method arguments has exceeded the maximum limit. - * - The number of requests sent has exceeded the maximum limit. + * @exception E_INVALID_STATE This instance has not been constructed properly as yet. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c pageNo is less than @c 1. + * - The specified @c countPerPage is less than @c 1. + * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: + * - The access is denied due to insufficient permission. + * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1 + * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: + * - The total size of the method arguments has exceeded the maximum limit. + * - The number of requests sent have exceeded the maximum limit. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_SYSTEM A system error has occurred. - * @remarks The total size of method arguments is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size. + * @remarks The total size of the method arguments is under 16KB because a severe system performance degradation may occur for larger messages. @n + * @c E_MAX_EXCEEDED may be returned for messages over 16KB. */ result GetValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, RequestId& reqId, int pageNo = 1, int countPerPage = 20); /** - * Adds the value associated with the specified @c key, to a key-values map owned by key-value structured data control provider. @n + * Adds the value associated with the specified @c key, to the key-values map owned by the key-value structured data control provider. @n * The %AddValue() method is asynchronous. - * For receiving the response from data control provider, set the listener - * with MapDataControl::SetMapDataControlResponseListener(). @n + * For receiving the response from the data control provider, set the listener + * using the MapDataControl::SetMapDataControlResponseListener() method. @n * When the response has been received from the data control provider, * the IMapDataControlResponseListener::OnMapDataControlAddValueResponseReceived() method is called. * * @since 2.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/datacontrol.consumer * * @return An error code - * @param[in] dataId A string for identifying specific data, usually a registry section to add to @n - * The string consists of one or more components, separated by a slash('/'). - * @param[in] key A key of the value list to add - * @param[in] value A value to add - * @param[out] reqId The ID of the request + * @param[in] dataId The string that identifies the specific data, usually a registry section to add to @n + * The string consists of one or more components, separated by a slash('/'). + * @param[in] key The key of the value list to add + * @param[in] value The value to add + * @param[out] reqId The ID of the request * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE This instance has not been properly constructed as yet. - * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n - * - Access is denied due to insufficient permission. - * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1 - * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n - * - The total size of method arguments has exceeded the maximum limit. - * - The number of requests sent has exceeded the maximum limit. + * @exception E_INVALID_STATE This instance has not been constructed properly as yet. + * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: + * - The access is denied due to insufficient permission. + * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1 + * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: + * - The total size of the method arguments has exceeded the maximum limit. + * - The number of requests sent have exceeded the maximum limit. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_SYSTEM A system error has occurred. - * @remarks The total size of method arguments is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size. + * @remarks The total size of the method arguments is under 16KB because a severe system performance degradation may occur for larger messages. @n + * @c E_MAX_EXCEEDED may be returned for messages over 16KB. */ result AddValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value, RequestId& reqId); /** - * Sets the value associated with the specified @c key with a new value. @n - * The key-values map is owned by key-value structured data control provider. @n + * Sets the value associated with the specified @c key to a new value. @n + * The key-values map is owned by the key-value structured data control provider. @n * The %SetValue() method is asynchronous. - * For receiving the response from data control provider, set the listener - * with MapDataControl::SetMapDataControlResponseListener(). @n + * For receiving the response from the data control provider, set the listener + * using the MapDataControl::SetMapDataControlResponseListener() method. @n * When the response has been received from the data control provider, * the IMapDataControlResponseListener::OnMapDataControlSetValueResponseReceived() method is called. * * @since 2.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/datacontrol.consumer * * @return An error code - * @param[in] dataId A string for identifying specific data, usually a registry section to update @n - * The string consists of one or more components, separated by a slash('/'). - * @param[in] key A key of the value to replace - * @param[in] oldValue A value to replace - * @param[in] newValue A new value to replace the existing value - * @param[out] reqId The ID of the request + * @param[in] dataId The string that identifies the specific data, usually a registry section to update @n + * The string consists of one or more components, separated by a slash('/'). + * @param[in] key The key of the value to replace + * @param[in] oldValue The value to replace + * @param[in] newValue The new value that replaces the existing value + * @param[out] reqId The ID of the request * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE This instance has not been properly constructed as yet. - * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n - * - Access is denied due to insufficient permission. - * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1 - * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n - * - The total size of method arguments has exceeded the maximum limit. - * - The number of requests sent has exceeded the maximum limit. + * @exception E_INVALID_STATE This instance has not been constructed properly as yet. + * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: + * - The access is denied due to insufficient permission. + * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1 + * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: + * - The total size of the method arguments has exceeded the maximum limit. + * - The number of requests sent have exceeded the maximum limit. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_SYSTEM A system error has occurred. - * @remarks The total size of method arguments is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size. + * @remarks The total size of the method arguments is under 16KB because a severe system performance degradation may occur for larger messages. @n + * @c E_MAX_EXCEEDED may be returned for messages over 16KB. */ result SetValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& oldValue, const Tizen::Base::String& newValue, RequestId& reqId); /** - * Removes the value associated with the specified @c key, from a key-values map owned by key-value structured data control provider. @n + * Removes the value associated with the specified @c key, from the key-values map owned by the key-value structured data control provider. @n * The %RemoveValue() method is asynchronous. - * For receiving the response from data control provider, set the listener - * with MapDataControl::SetMapDataControlResponseListener(). @n + * For receiving the response from the data control provider, set the listener + * using the MapDataControl::SetMapDataControlResponseListener() method. @n * When the response has been received from the data control provider, * the IMapDataControlResponseListener::OnMapDataControlRemoveValueResponseReceived() method is called. * * @since 2.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/datacontrol.consumer * * @return An error code - * @param[in] dataId A string for identifying specific data, usually a registry section to remove from @n - * The string consists of one or more components, separated by a slash('/'). - * @param[in] key A key of the value to remove - * @param[in] value A value to remove - * @param[out] reqId The ID of the request + * @param[in] dataId The string that identifies the specific data, usually a registry section to remove from @n + * The string consists of one or more components, separated by a slash('/'). + * @param[in] key The key of the value to remove + * @param[in] value The value to remove + * @param[out] reqId The ID of the request * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE This instance has not been properly constructed as yet. - * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n - * - Access is denied due to insufficient permission. - * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1 - * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: @n - * - The total size of method arguments has exceeded the maximum limit. - * - The number of requests sent has exceeded the maximum limit. + * @exception E_INVALID_STATE This instance has not been constructed properly as yet. + * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: + * - The access is denied due to insufficient permission. + * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1 + * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: + * - The total size of the method arguments has exceeded the maximum limit. + * - The number of requests sent have exceeded the maximum limit. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_SYSTEM A system error has occurred. - * @remarks The total size of method arguments is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size. + * @remarks The total size of the method arguments is under 16KB because a severe system performance degradation may occur for larger messages. @n + * @c E_MAX_EXCEEDED may be returned for messages over 16KB. */ result RemoveValue(const Tizen::Base::String& dataId, const Tizen::Base::String& key, const Tizen::Base::String& value, RequestId& reqId); /** - * Sets the MAP-based data control listener to this instance. + * Sets the MAP-based data control listener for this instance. * * @since 2.0 * @@ -243,7 +259,7 @@ public: * Some data controls need to get the callback result by implementing * the IMapDataControlResponseListener interface. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE This instance has not been properly constructed. + * @exception E_INVALID_STATE This instance has not been constructed properly as yet. * @exception E_SYSTEM A system error has occurred. */ result SetMapDataControlResponseListener(IMapDataControlResponseListener* pListener); diff --git a/inc/FAppNotificationManager.h b/inc/FAppNotificationManager.h index 954f572..2bbff00 100644 --- a/inc/FAppNotificationManager.h +++ b/inc/FAppNotificationManager.h @@ -79,8 +79,8 @@ static const int MAX_NOTIFICATION_BADGE_NUMBER = 999; * @final This class is not intended for extension. * * The %NotificationManager class provides methods to alert the user about a notification. - * @n - * For more information about the class features, see Notifications. + * + * For more information on the class features, see Notifications. * * The following example demonstrates how to use the %NotificationManager class. * @@ -157,13 +157,13 @@ public: * @since 2.0 * @privilege %http://tizen.org/privilege/notification * - * @return The current badge number + * @return The current badge number, @n + * else @c -1 if it fails * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. - * @exception E_OBJ_NOT_FOUND The application is not installed. + * @exception E_OBJ_NOT_FOUND The application has not been installed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks The specific error code can be accessed using the GetLastResult() method. @n - * In case of failure, this method returns @c -1. + * @remarks The specific error code can be accessed using the GetLastResult() method. * @endif */ int GetBadgeNumber(void); @@ -175,16 +175,17 @@ public: * @brief [Deprecated] * * @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class. - * @since 2.0 + * @since 2.0 * @privilege %http://tizen.org/privilege/notification * * @return An error code * @param[in] badgeNumber The badge number * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the specified @c badgeNumber is less than @c 0. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The specified @c badgeNumber is less than @c 0. * @exception E_SYSTEM A system error has occurred. - * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy. + * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @endif */ @@ -197,16 +198,17 @@ public: * @brief [Deprecated] * * @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class. - * @since 2.0 + * @since 2.0 * @privilege %http://tizen.org/privilege/notification * * @return An error code * @param[in] messageText The notification message * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. * @exception E_SYSTEM A system error has occurred. - * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy. + * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @endif */ @@ -214,22 +216,23 @@ public: /** * @if OSPDEPREC - * Notifies the user using a message and badge number. + * Notifies the user using a message and a badge number. * * @brief [Deprecated] * * @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class. - * @since 2.0 + * @since 2.0 * @privilege %http://tizen.org/privilege/notification * * @return An error code * @param[in] messageText The notification message * @param[in] badgeNumber The badge number * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c badgeNumber is less than @c 0, or - * the length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c badgeNumber is less than @c 0. + * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. * @exception E_SYSTEM A system error has occurred. - * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy. + * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @endif */ @@ -237,31 +240,30 @@ public: /** * @if OSPDEPREC - * Notifies the user using a message and badge number. @n + * Notifies the user using a message and a badge number. @n * If the user checks the message, @c launchArguments is delivered to the application. @n * @c launchArguments is delivered as the value of the %http://tizen.org/appcontrol/data/notification key - * for IAppControlProviderEventListener::OnAppControlRequestReceived(). + * for the IAppControlProviderEventListener::OnAppControlRequestReceived() method. * * @brief [Deprecated] * * @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class. - * @since 2.0 + * @since 2.0 * @privilege %http://tizen.org/privilege/notification * * @return An error code * @param[in] messageText The notification message * @param[in] badgeNumber The badge number - * @param[in] launchArguments The message for application + * @param[in] launchArguments The message for the application * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - A specified input parameter is invalid. @n - * - The specified @c badgeNumber is less than @c 0. @n - * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c badgeNumber is less than @c 0. + * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. * - The length of the specified @c launchArguments is greater than App::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH. * @exception E_SYSTEM A system error has occurred. - * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy. + * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @see IAppControlProviderEventListener::OnAppControlRequestReceived() * @endif */ result Notify(const Tizen::Base::String& messageText, int badgeNumber, const Tizen::Base::String& launchArguments); @@ -273,12 +275,12 @@ public: * @brief [Deprecated] * * @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class. - * @since 2.0 + * @since 2.0 * @privilege %http://tizen.org/privilege/notification * * @return An error code - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM A system error has occurred. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @remarks This method returns @c E_SUCCESS when there is no outstanding notification. * @endif @@ -292,16 +294,17 @@ public: * @brief [Deprecated] * * @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class. - * @since 2.0 + * @since 2.0 * @privilege %http://tizen.org/privilege/notification * * @return An error code * @param[in] messageText The notification message * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. * @exception E_SYSTEM A system error has occurred. - * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy. + * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @endif */ @@ -311,24 +314,24 @@ public: * @if OSPDEPREC * Notifies the user about the ongoing activity using a message. @n * @c launchArguments is delivered as the value of the %http://tizen.org/appcontrol/data/notification key - * for IAppControlProviderEventListener::OnAppControlRequestReceived(). + * for the IAppControlProviderEventListener::OnAppControlRequestReceived() method. * * @brief [Deprecated] * * @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class. - * @since 2.0 + * @since 2.0 * @privilege %http://tizen.org/privilege/notification * * @return An error code * @param[in] messageText The notification message - * @param[in] launchArguments The launch arguments for the application + * @param[in] launchArguments The launch arguments for the application * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - A specified input parameter is invalid. @n - * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. * - The length of the specified @c launchArguments is greater than App::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH. * @exception E_SYSTEM A system error has occurred. - * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy. + * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @endif */ @@ -341,7 +344,7 @@ public: * @brief [Deprecated] * * @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class. - * @since 2.0 + * @since 2.0 * @privilege %http://tizen.org/privilege/notification * * @return An error code @@ -360,17 +363,17 @@ public: * @brief [Deprecated] * * @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class. - * @since 2.0 + * @since 2.0 * @privilege %http://tizen.org/privilege/notification * - * @return The current badge number + * @return The current badge number, @n + * else @c -1 if it fails * @param[in] appId The application ID * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. - * @exception E_OBJ_NOT_FOUND The application is not installed. + * @exception E_OBJ_NOT_FOUND The application has not been installed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks The specific error code can be accessed using the GetLastResult() method. @n - * In case of failure, this method returns @c -1. + * @remarks The specific error code can be accessed using the GetLastResult() method. * @endif */ int GetBadgeNumber(const AppId& appId); @@ -382,7 +385,7 @@ public: * @brief [Deprecated] * * @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class. - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/notification @n @@ -392,10 +395,11 @@ public: * @param[in] appId The application ID * @param[in] badgeNumber The badge number * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c badgeNumber is less than @c 0. - * @exception E_APP_NOT_INSTALLED The application is not installed. - * @exception E_INVALID_OPERATION The target application with the specified application ID is not permitted to receive any notification as per the %Tizen platform policy. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c badgeNumber is less than @c 0. + * @exception E_APP_NOT_INSTALLED The application has not been installed. + * @exception E_INVALID_OPERATION The target application with the specified @c appId is not permitted to receive any notification as per the Tizen platform policy. * @exception E_SYSTEM A system error has occurred. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @endif @@ -409,7 +413,7 @@ public: * @brief [Deprecated] * * @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class. - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/notification @n @@ -419,10 +423,11 @@ public: * @param[in] appId The application ID * @param[in] messageText The notification message * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. - * @exception E_APP_NOT_INSTALLED The application is not installed. - * @exception E_INVALID_OPERATION The target application with the specified application ID is not permitted to receive any notification as per the %Tizen platform policy. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. + * @exception E_APP_NOT_INSTALLED The application has not been installed. + * @exception E_INVALID_OPERATION The target application with the specified @c appId is not permitted to receive any notification as per the Tizen platform policy. * @exception E_SYSTEM A system error has occurred. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @endif @@ -431,12 +436,12 @@ public: /** * @if OSPDEPREC - * Notifies the user using a message and badge number on behalf of the specified application. + * Notifies the user using a message and a badge number on behalf of the specified application. * * @brief [Deprecated] * * @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class. - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/notification @n @@ -447,12 +452,12 @@ public: * @param[in] messageText The notification message * @param[in] badgeNumber The badge number * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - A specified input parameter is invalid. @n - * - The specified @c badgeNumber is less than @c 0. @n - * - The length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. - * @exception E_APP_NOT_INSTALLED The application is not installed. - * @exception E_INVALID_OPERATION The target application with the specified application ID is not permitted to receive any notification as per the %Tizen platform policy. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c badgeNumber is less than @c 0. + * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. + * @exception E_APP_NOT_INSTALLED The application has not been installed. + * @exception E_INVALID_OPERATION The target application with the specified @c appId is not permitted to receive any notification as per the Tizen platform policy. * @exception E_SYSTEM A system error has occurred. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @endif @@ -461,31 +466,31 @@ public: /** * @if OSPDEPREC - * Notifies the user using a message and badge number on behalf of the specified application. @n - * If the user checks the message, the @c launchArguments is delivered to the application. + * Notifies the user using a message and a badge number on behalf of the specified application. @n + * If the user checks the message, @c launchArguments is delivered to the application. * * @brief [Deprecated] * * @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class. - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/notification @n * (%http://tizen.org/privilege/notificationmanager is deprecated.) * - * @return An error code + * @return An error code * @param[in] appId The application ID - * @param[in] messageText The notification message - * @param[in] launchArguments The launch arguments for the application + * @param[in] messageText The notification message + * @param[in] launchArguments The launch arguments for the application * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - A specified input parameter is invalid. @n - * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. @n - * - The length of the specified @c launchArguments is greater than App::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH. - * @exception E_APP_NOT_INSTALLED The application is not installed. - * @exception E_INVALID_OPERATION The target application with the specified application ID is not permitted to receive any notification as per the %Tizen platform policy. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. + * - The length of the specified @c launchArguments is greater than App::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH. + * @exception E_APP_NOT_INSTALLED The application has not been installed. + * @exception E_INVALID_OPERATION The target application with the specified @c appId is not permitted to receive any notification as per the Tizen platform policy. * @exception E_SYSTEM A system error has occurred. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @endif */ result NotifyOnBehalf(const AppId& appId, const Tizen::Base::String& messageText, const Tizen::Base::String& launchArguments); @@ -497,7 +502,7 @@ public: * @brief [Deprecated] * * @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class. - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/notification @n @@ -507,12 +512,13 @@ public: * @param[in] appId The application ID * @param[in] messageText The notification message * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. - * @exception E_APP_NOT_INSTALLED The application is not installed. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. + * @exception E_APP_NOT_INSTALLED The application has not been installed. * @exception E_SYSTEM A system error has occurred. - * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @endif */ result NotifyOngoingActivityOnBehalf(const AppId& appId, const Tizen::Base::String& messageText); @@ -524,7 +530,7 @@ public: * @brief [Deprecated] * * @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class. - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/notification @n @@ -533,16 +539,16 @@ public: * @return An error code * @param[in] appId The application ID * @param[in] messageText The notification message - * @param[in] launchArguments The launch arguments for application + * @param[in] launchArguments The launch arguments for the application * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - A specified input parameter is invalid. @n - * - The length of @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. @n - * - The length of @c launchArguments is greater than App::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH. - * @exception E_APP_NOT_INSTALLED The application is not installed. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The length of the specified @c messageText is greater than App::MAX_NOTIFICATION_MESSAGE_LENGTH. + * - The length of the specified @c launchArguments is greater than App::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH. + * @exception E_APP_NOT_INSTALLED The application has not been installed. * @exception E_SYSTEM A system error has occurred. - * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the %Tizen platform policy. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @endif */ result NotifyOngoingActivityOnBehalf(const AppId& appId, const Tizen::Base::String& messageText, const Tizen::Base::String& launchArguments); @@ -554,7 +560,7 @@ public: * @brief [Deprecated] * * @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class. - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/notification @n @@ -563,10 +569,10 @@ public: * @return An error code * @param[in] appId The application ID * @exception E_SUCCESS The method is successful. - * @exception E_APP_NOT_INSTALLED The application is not installed. + * @exception E_APP_NOT_INSTALLED The application has not been installed. * @exception E_SYSTEM A system error has occurred. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks Although there is no outstanding notification for the calling application, this method returns @c E_SUCCESS. + * @remarks Even if there is no outstanding notification for the calling application, this method returns @c E_SUCCESS. * @endif */ result RemoveOngoingActivityNotificationOnBehalf(const AppId& appId); @@ -578,7 +584,7 @@ public: * @brief [Deprecated] * * @deprecated This class is deprecated. Instead of using this class, use the Tizen::Shell::NotificationManager class. - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/notification @n @@ -587,10 +593,10 @@ public: * @return An error code * @param[in] appId The application ID * @exception E_SUCCESS The method is successful. - * @exception E_APP_NOT_INSTALLED The application is not installed. + * @exception E_APP_NOT_INSTALLED The application has not been installed. * @exception E_SYSTEM A system error has occurred. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks Although there is no outstanding notification for the calling application, this method returns @c E_SUCCESS. + * @remarks Even if there is no outstanding notification for the calling application, this method returns @c E_SUCCESS. * @endif */ result RemoveNotificationOnBehalf(const AppId& appId); diff --git a/inc/FAppPkg.h b/inc/FAppPkg.h index 4c49503..e0dc1ed 100755 --- a/inc/FAppPkg.h +++ b/inc/FAppPkg.h @@ -38,9 +38,9 @@ * @since 2.0 * * @remarks @b Header @b %file: @b \#include @b @n - * @b Library : @b osp-appfw + * @b Library: @b osp-appfw * - * The %Package namespace contains classes and interfaces for information of packages and management of its installation or uninstallation. + * The %Package namespace contains classes and interfaces for obtaining the information and managing the installation or uninstallation of a package. * * The following diagram illustrates the relationships between the classes belonging to the %Package namespace. * @image html app_package_namespace_classdiagram.png diff --git a/inc/FAppPkgIPackageInstallationEventListener.h b/inc/FAppPkgIPackageInstallationEventListener.h index 96d33bb..dc55cc3 100755 --- a/inc/FAppPkgIPackageInstallationEventListener.h +++ b/inc/FAppPkgIPackageInstallationEventListener.h @@ -32,7 +32,7 @@ namespace Tizen { namespace App { namespace Package /** * @enum PackageInstallationResult * - * Defines the result of package installation. + * Defines the result of a package installation. * * @since 2.0 */ @@ -40,26 +40,26 @@ enum PackageInstallationResult { PACKAGE_INSTALLATION_RESULT_SUCCESS = 0, /**< Success */ PACKAGE_INSTALLATION_RESULT_INVALID_PACKAGE, /**< An invalid package */ - PACKAGE_INSTALLATION_RESULT_STORAGE_FULL, /**< The installation target storage is full. */ + PACKAGE_INSTALLATION_RESULT_STORAGE_FULL, /**< The installation's target storage is full */ }; /** * @interface IPackageInstallationEventListener -* @brief This interface defines a listener for a package installation and uninstallation. +* @brief This interface defines a listener for a package's installation and uninstallation. * * @since 2.0 * -* The %IPackageInstallationEventListener interface defines a listener that is notified for events related to installation or uninstallation of packages on a device. +* The %IPackageInstallationEventListener interface defines a listener that is notified about events related to the installation or uninstallation of a package on a device. * The events include installation completion, uninstallation completion, and installation progress. -* This listener is registered with the PackageManager::AddPackageInstallationEventListener() method and unregistered with the PackageManager::RemovePackageInstallationEventListener() method. -* Generally, this listener is used in system applications such as application service that utilizes packages' (un)installation information in a system. +* This listener is registered using the PackageManager::AddPackageInstallationEventListener() method and unregistered using the PackageManager::RemovePackageInstallationEventListener() method. +* Generally, this listener is used in system applications such as an application service that utilizes a package's (un)installation information that is present in the system. */ class _OSP_EXPORT_ IPackageInstallationEventListener : virtual public Tizen::Base::Runtime::IEventListener { public: /** - * This polymorphic destructor should be overridden if required. + * This polymorphic destructor should be overridden if required. @n * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 @@ -79,13 +79,13 @@ public: /** * Called when a package uninstallation is completed. @n - * The value of @c uninstallationResult is @c true if the uninstallation is successful, else @c false. + * The value of @c uninstallationResult is @c true if the uninstallation is successful, otherwise it is @c false. * * @since 2.0 * - * @param[in] packageId The package ID + * @param[in] packageId The package ID * @param[in] uninstallationResult Set to @c true if the uninstallation is successful, @n - * else @c false + * else @c false */ virtual void OnPackageUninstallationCompleted(const PackageId& packageId, bool uninstallationResult) = 0; @@ -95,7 +95,7 @@ public: * @since 2.0 * * @param[in] packageId The package ID - * @param[in] progress The progress of an installation in percentage + * @param[in] progress The progress of the installation in percentage */ virtual void OnPackageInstallationInProgress(const PackageId& packageId, int progress) = 0; diff --git a/inc/FAppPkgIPackageInstallationResponseListener.h b/inc/FAppPkgIPackageInstallationResponseListener.h index da8e6df..b4d203c 100755 --- a/inc/FAppPkgIPackageInstallationResponseListener.h +++ b/inc/FAppPkgIPackageInstallationResponseListener.h @@ -37,9 +37,9 @@ namespace Tizen { namespace App { namespace Package * * @since 2.0 * - * The %IPackageInstallationResponseListener interface defines a listener that is notified for events related to installation of a target package. - * The events include installation result and installation progress information. - * Generally, applications such as %Tizen Store use this listener in a package installation step. + * The %IPackageInstallationResponseListener interface defines a listener that is notified about events related to the installation of a target package. + * The events include the installation result and the installation progress information. + * Generally, applications such as the Tizen Store use this listener in a package installation step. * @see PackageManager::InstallPackage() */ class _OSP_EXPORT_ IPackageInstallationResponseListener @@ -47,7 +47,7 @@ class _OSP_EXPORT_ IPackageInstallationResponseListener { public: /** - * This polymorphic destructor should be overridden if required. + * This polymorphic destructor should be overridden if required. @n * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 @@ -61,7 +61,7 @@ public: * * @since 2.0 * - * @param[in] packageId The package ID + * @param[in] packageId The package ID * @param[in] installationResult The installation result * */ @@ -73,7 +73,7 @@ public: * @since 2.0 * * @param[in] packageId The package ID - * @param[in] progress The progress of an installation in percentage + * @param[in] progress The progress of the installation in percentage * */ virtual void OnPackageInstallationInProgressResponseReceived(const PackageId& packageId, int progress) = 0; diff --git a/inc/FAppPkgIPackageUninstallationResponseListener.h b/inc/FAppPkgIPackageUninstallationResponseListener.h index 4609804..7e2afcf 100755 --- a/inc/FAppPkgIPackageUninstallationResponseListener.h +++ b/inc/FAppPkgIPackageUninstallationResponseListener.h @@ -37,9 +37,9 @@ namespace Tizen { namespace App { namespace Package * * @since 2.0 * - * The %IPackageUninstallationResponseListener interface defines a listener that is notified for events related to uninstallation of a target package. - * The events include uninstallation result. - * Generally, applications such as %Tizen Store use this listener in a package uninstallation step. + * The %IPackageUninstallationResponseListener interface defines a listener that is notified about events related to the uninstallation of a target package. + * The events include the uninstallation result. + * Generally, applications such as the %Tizen Store use this listener in a package uninstallation step. * @see PackageManager::UninstallPackage() * */ @@ -48,7 +48,7 @@ class _OSP_EXPORT_ IPackageUninstallationResponseListener { public: /** - * This polymorphic destructor should be overridden if required. + * This polymorphic destructor should be overridden if required. @n * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 @@ -58,13 +58,13 @@ public: /** * Called when a package uninstallation is completed. @n - * The value of @c uninstallationResult is @c true if the uninstallation is successful, else @c false. + * The value of @c uninstallationResult is @c true if the uninstallation is successful, otherwise it is @c false. * * @since 2.0 * * @param[in] packageId The package ID * @param[in] uninstallationResult Set to @c true if the uninstallation is successful, @n - * else @c false + * else @c false * */ virtual void OnPackageUninstallationResponseReceived(const PackageId& packageId, bool uninstallationResult) = 0; diff --git a/inc/FAppPkgPackageAppInfo.h b/inc/FAppPkgPackageAppInfo.h index 7604bd4..db74266 100755 --- a/inc/FAppPkgPackageAppInfo.h +++ b/inc/FAppPkgPackageAppInfo.h @@ -38,13 +38,13 @@ namespace Tizen { namespace App { namespace Package /** * @class PackageAppInfo - * @brief This class represents the information of the application in package. + * @brief This class represents the information of an application in a package. * * @since 2.0 * * @final This class is not intended for extension. * - * The %PackageAppInfo class provides the information of the application in package. + * The %PackageAppInfo class provides the information of an application in a package. * */ class _OSP_EXPORT_ PackageAppInfo @@ -59,11 +59,11 @@ public: virtual ~PackageAppInfo(void); /** - * Gets an application ID. + * Gets the application ID. * * @since 2.0 * - * @return An application ID + * @return The application ID */ AppId GetAppId(void) const; @@ -72,7 +72,7 @@ public: * * @since 2.0 * - * @return The name of an application + * @return The name of the application */ Tizen::Base::String GetAppName(void) const; @@ -81,7 +81,7 @@ public: * * @since 2.0 * - * @return The display name of an application + * @return The display name of the application */ Tizen::Base::String GetAppDisplayName(void) const; @@ -90,7 +90,7 @@ public: * * @since 2.1 * - * @return The menu icon path of an application, @n + * @return The menu icon path of the application, @n * else an empty string is returned if there is no value */ Tizen::Base::String GetAppMenuIconPath(void) const; @@ -100,8 +100,8 @@ public: * * @since 2.1 * - * @return The setting icon path of an application, @n - * else an empty string is returned if there is no value + * @return The setting icon path of the application, @n + * else an empty string is returned if there is no value */ Tizen::Base::String GetAppSettingIconPath(void) const; @@ -110,7 +110,7 @@ public: * * @since 2.1 * - * @return The notification icon path of an application, @n + * @return The notification icon path of the application, @n * else an empty string is returned if there is no value */ Tizen::Base::String GetAppNotificationIconPath(void) const; @@ -118,10 +118,10 @@ public: /** * Gets the menu icon of an application. * - * @since 2.1 + * @since 2.1 * - * @return A pointer to the menu icon of an application, @n - * else @c null if it fails + * @return A pointer to the menu icon of the application, @n + * else @c null if it fails * @exception E_SUCCESS The method is successful. * @exception E_FILE_NOT_FOUND The menu icon does not exist. * @exception E_UNSUPPORTED_FORMAT The image file format is not supported. @@ -134,13 +134,13 @@ public: * * @since 2.1 * - * @return A pointer to a map of key(Tizen::Base::String) and value(Tizen::Base::String) pairs of the metadata, @n + * @return A pointer to the map of the key(Tizen::Base::String) and value(%Tizen::Base::String) pairs of the metadata, @n * else @c null if it fails * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks - * - The specific error code can be accessed using the GetLastResult() method. - * - Application can use the metadata to set app-wide information. + * - The specific error code can be accessed using the GetLastResult() method. + * - An application can use the metadata to set the app-wide information. */ Tizen::Base::Collection::IMap* GetAppMetadataListN(void) const; @@ -158,22 +158,22 @@ public: Tizen::Base::Collection::IList* GetAppCategoryListN(void) const; /** - * Checks whether an application is visible on the menu. + * Checks if an application is visible on the menu. * * @since 2.0 * - * @return @c true if an application is visible on the menu, @n + * @return @c true if the application is visible on the menu, @n * else @c false - * @remarks If the return value is @c false, it is recommended not to display the application on the menu. + * @remarks If the return value is @c false, it is not recommended to display the application on the menu. */ bool IsMenuIconVisible(void) const; /** - * Checks whether an application is the main application of the package. + * Checks if an application is the main application of the package. * * @since 2.0 * - * @return @c true if an application is the main application of the package, @n + * @return @c true if the application is the main application of the package, @n * else @c false */ bool IsMainApp(void) const; diff --git a/inc/FAppPkgPackageInfo.h b/inc/FAppPkgPackageInfo.h old mode 100644 new mode 100755 index 65dc94d..42a11c8 --- a/inc/FAppPkgPackageInfo.h +++ b/inc/FAppPkgPackageInfo.h @@ -54,11 +54,11 @@ public: virtual ~PackageInfo(void); /** - * Gets a package ID. + * Gets the package ID. * * @since 2.0 * - * @return A package ID + * @return The package ID */ PackageId GetId(void) const; @@ -67,7 +67,7 @@ public: * * @since 2.0 * - * @return The version of a package + * @return The version of the package */ Tizen::Base::String GetVersion(void) const; @@ -76,7 +76,7 @@ public: * * @since 2.0 * - * @return The display name of a package + * @return The display name of the package */ Tizen::Base::String GetDisplayName(void) const; @@ -85,7 +85,7 @@ public: * * @since 2.0 * - * @return The description of a package, @n + * @return The description of the package, @n * else an empty string is returned if there is no value */ Tizen::Base::String GetDescription(void) const; @@ -95,7 +95,7 @@ public: * * @since 2.0 * - * @return The author of a package, @n + * @return The author of the package, @n * else an empty string is returned if there is no value */ Tizen::Base::String GetAuthor(void) const; @@ -105,56 +105,56 @@ public: * * @since 2.0 * - * @return The URL of a package, @n + * @return The URL of the package, @n * else an empty string is returned if there is no value */ Tizen::Base::String GetUrl(void) const; /** - * Gets the date and time when a package is installed. + * Gets the date and the time when a package is installed. * * @since 2.0 * - * @return An instance of Tizen::Base::DateTime when a package is installed + * @return An instance of Tizen::Base::DateTime which contains the package installation details */ Tizen::Base::DateTime GetInstallationTime(void) const; /** - * Checks whether a package is installed in the external storage. + * Checks if a package is installed in the external storage. * * @since 2.0 * - * @return @c true if a package is installed in the external storage, @n + * @return @c true if the package is installed in the external storage, @n * else @c false */ bool IsInstalledInExternalStorage(void) const; /** - * Checks whether it is possible to uninstall a package. + * Checks if it is possible to uninstall a package. * * @since 2.0 * - * @return @c true if it is possible to uninstall a package, @n + * @return @c true if it is possible to uninstall the package, @n * else @c false */ bool IsUninstallable(void) const; /** - * Checks whether it is possible to move a package to either internal or external storage. + * Checks if it is possible to move a package to either the internal or the external storage. * * @since 2.0 * - * @return @c true if it is possible to move a package to either internal or external storage, @n + * @return @c true if it is possible to move the package to either the internal or the external storage, @n * else @c false */ bool IsMovable(void) const; /** - * Checks whether a package is downloaded. + * Checks if a package is downloaded. * * @since 2.0 * - * @return @c true if a package is downloaded, @n + * @return @c true if the package is downloaded, @n * else @c false */ bool IsDownloaded(void) const; @@ -164,7 +164,7 @@ public: * * @since 2.0 * - * @return The size of a package + * @return The size of the package */ long long GetSize(void) const; @@ -173,7 +173,7 @@ public: * * @since 2.0 * - * @return The data size of a package + * @return The data size of the package */ long long GetDataSize(void) const; @@ -212,11 +212,11 @@ public: * * @since 2.0 * - * @return A pointer to PackageAppInfo + * @return A pointer to the PackageAppInfo instance * @param[in] appId The application ID * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_OBJ_NOT_FOUND The application information is not found. + * @exception E_OBJ_NOT_FOUND The application information has not been found. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -225,12 +225,12 @@ public: /** * Gets the type of a package. * - * @since 2.0 + * @since 2.0 * @privlevel platform * @privilege %http://tizen.org/privilege/packagemanager.setting @n - * (%http://tizen.org/privilege/packagesetting is deprecated.) + * (%http://tizen.org/privilege/packagesetting is deprecated.) * - * @return The package type + * @return The package type */ PackageType GetType(void) const; @@ -239,10 +239,10 @@ public: * * @since 2.1 * - * @return A pointer to the list of Tizen::Security::PrivilegeInfo instances, @n + * @return A pointer to the list of the Tizen::Security::PrivilegeInfo instances, @n * else @c null if it fails - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* GetPrivilegeListN(void) const; diff --git a/inc/FAppPkgPackageManager.h b/inc/FAppPkgPackageManager.h index 59d24a2..ee3ce3e 100755 --- a/inc/FAppPkgPackageManager.h +++ b/inc/FAppPkgPackageManager.h @@ -45,20 +45,20 @@ class IPackageUninstallationResponseListener; */ enum PackageType { - PACKAGE_TYPE_TPK, /**< TIZEN Native package */ - PACKAGE_TYPE_WGT, /**< TIZEN %Web package */ - PACKAGE_TYPE_RPM, /**< TIZEN Core package */ + PACKAGE_TYPE_TPK, /**< %Tizen native package */ + PACKAGE_TYPE_WGT, /**< %Tizen Web package */ + PACKAGE_TYPE_RPM, /**< %Tizen Core package */ }; /** * @class PackageManager - * @brief This class gets the information of packages and manages package installation or uninstallation. + * @brief This class gets the information of a package and manages the package's installation or uninstallation. * * @since 2.0 * * @final This class is not intended for extension. * - * The %PackageManager class provides methods to install or uninstall the packages, retrieves the information of the packages that are installed on the device. + * The %PackageManager class provides methods to install or uninstall a package and retrieve the information of a package that is installed on the device. * * For more information on the class features, see Package Management. * @@ -73,7 +73,8 @@ public: * @since 2.0 * * @return The package ID, @n - * else @c packageId.IsEmtpy() == true is returned if an error occurs + * else an empty package ID if an error occurs @n + * Checks with packageId.IsEmpty() whether the package ID is empty. * @param[in] appId The application ID * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. @@ -84,10 +85,10 @@ public: /** * Adds a package installation event listener. * - * @since 2.0 + * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/package.info @n - * (%http://tizen.org/privilege/packageinfo is deprecated.) + * (%http://tizen.org/privilege/packageinfo is deprecated.) * * @return An error code * @param[in] listener The package installation event listener @@ -103,31 +104,33 @@ public: * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/package.info @n - * (%http://tizen.org/privilege/packageinfo is deprecated.) + * (%http://tizen.org/privilege/packageinfo is deprecated.) * * @return An error code * @param[in] listener The package installation event listener * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The listener is not added or is already removed. + * @exception E_OBJ_NOT_FOUND Either of the following conditions has occurred: + * - The listener is not added. + * - The listener is already removed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ result RemovePackageInstallationEventListener(IPackageInstallationEventListener& listener); /** - * Gets a package information with the specific package ID. + * Gets the package information with the specific package ID. * * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/package.info @n - * (%http://tizen.org/privilege/packageinfo is deprecated.) + * (%http://tizen.org/privilege/packageinfo is deprecated.) * - * @return A pointer to PackageInfo + * @return A pointer to the PackageInfo instance * @param[in] packageId The package ID - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @exception E_PKG_NOT_INSTALLED The package is not installed. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_PKG_NOT_INSTALLED The package has not been installed. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @remarks The specific error code can be accessed using the GetLastResult() method. */ PackageInfo* GetPackageInfoN(const PackageId& packageId) const; @@ -138,9 +141,9 @@ public: * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/package.info @n - * (%http://tizen.org/privilege/packageinfo is deprecated.) + * (%http://tizen.org/privilege/packageinfo is deprecated.) * - * @return A pointer to PackageAppInfo + * @return A pointer to the PackageAppInfo instance * @param[in] appId The application ID * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. @@ -156,7 +159,7 @@ public: * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/package.info @n - * (%http://tizen.org/privilege/packageinfo is deprecated.) + * (%http://tizen.org/privilege/packageinfo is deprecated.) * * @return A pointer to the list of the PackageInfo instances, @n * else @c null if it fails @@ -173,11 +176,11 @@ public: * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/package.info @n - * (%http://tizen.org/privilege/packageinfo is deprecated.) + * (%http://tizen.org/privilege/packageinfo is deprecated.) * - * @return @c true if a package is installed, @n - * else @c false - * @param[in] packageId The package ID + * @return @c true if the package is installed, @n + * else @c false + * @param[in] packageId The package ID * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -188,7 +191,8 @@ public: /** * Installs a package. @n - * The %InstallPackage() method operates asynchronously, that is, it ends immediately without an installation response. The application is notified when the installation is completed, so the response is available through the IPackageInstallationResponseListener::OnPackageInstallationCompleted() method, if this method returns @c E_SUCCESS. + * The %InstallPackage() method operates asynchronously, that is, it ends immediately without an installation response. + * The application is notified when the installation is completed, so the response is available through the IPackageInstallationResponseListener::OnPackageInstallationCompleted() method, if this method returns @c E_SUCCESS. * * @since 2.0 * @privlevel platform @@ -202,13 +206,17 @@ public: * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks A listener instance ownership is transferred to the platform. After notifying result, the listener instance is removed automatically. A reuse of the listener instance is not allowed. + * @remarks + * - A listener instance ownership is transferred to the platform. + * - After notifying the result, the listener instance is removed automatically. + * - A reuse of the listener instance is not allowed. */ result InstallPackage(const PackageId& packageId, const Tizen::Base::String& packagePath, IPackageInstallationResponseListener* pListener); /** * Uninstalls a package with the specified package ID. @n - * The %UninstallPackage() method operates asynchronously, that is, it ends immediately without an uninstallation response. The application is notified when the uninstallation is completed, so the response is available through the IPackageUninstallationResponseListener::OnPackageUninstallationCompleted() method, if this method returns @c true. + * The %UninstallPackage() method operates asynchronously, that is, it ends immediately without an uninstallation response. + * The application is notified when the uninstallation is completed, so the response is available through the IPackageUninstallationResponseListener::OnPackageUninstallationCompleted() method, if this method returns @c true. * * @since 2.0 * @privlevel platform @@ -220,74 +228,78 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @exception E_PKG_NOT_INSTALLED The package is not installed. + * @exception E_PKG_NOT_INSTALLED The package has not been installed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks A listener instance ownership is transferred to the platform. After notifying result, the listener instance is removed automatically. A reuse of the listener instance is not allowed. + * @remarks + * - A listener instance ownership is transferred to the platform. + * - After notifying the result, the listener instance is removed automatically. + * - A reuse of the listener instance is not allowed. */ result UninstallPackage(const PackageId& packageId, IPackageUninstallationResponseListener* pListener); /** - * Moves a package with the specified package ID to an external storage. + * Moves a package with the specified package ID to the external storage. * - * @since 2.0 + * @since 2.0 * @privlevel platform * @privilege %http://tizen.org/privilege/packagemanager.setting @n - * (%http://tizen.org/privilege/packagesetting is deprecated.) + * (%http://tizen.org/privilege/packagesetting is deprecated.) * * @return An error code * @param[in] packageId The package ID * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_INVALID_OPERATION The package is already installed in an external storage. + * @exception E_INVALID_OPERATION The package is already installed in the external storage. * @exception E_STORAGE_FULL The storage is full. - * @exception E_PKG_NOT_INSTALLED The package is not installed. + * @exception E_PKG_NOT_INSTALLED The package has not been installed. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ result MoveToExternalStorage(const PackageId& packageId); /** - * Moves a package with the specified package ID to an internal storage. + * Moves a package with the specified package ID to the internal storage. * - * @since 2.0 + * @since 2.0 * @privlevel platform * @privilege %http://tizen.org/privilege/packagemanager.setting @n - * (%http://tizen.org/privilege/packagesetting is deprecated.) + * (%http://tizen.org/privilege/packagesetting is deprecated.) * * @return An error code * @param[in] packageId The package ID * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_INVALID_OPERATION The package is already installed in an internal storage. + * @exception E_INVALID_OPERATION The package is already installed in the internal storage. * @exception E_STORAGE_FULL The storage is full. - * @exception E_PKG_NOT_INSTALLED The package is not installed. + * @exception E_PKG_NOT_INSTALLED The package has not been installed. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ result MoveToInternalStorage(const PackageId& packageId); /** - * Gets a package information from a specific file. @n The supported file extensions are tpk and wgt. + * Gets the package information from a specific file. @n + * The supported file extensions are tpk and wgt. * * @since 2.1 * @privlevel platform * @privilege %http://tizen.org/privilege/packagemanager.info * * @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. - * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed. - * @exception E_UNSUPPORTED_FORMAT The specified format is invalid or not supported. - * @exception E_PARSING_FAILED The method has failed to parse the package file or xml file(s) inside the package. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * else @c null if it fails + * @param[in] filePath The package file path + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed. + * @exception E_UNSUPPORTED_FORMAT The specified format is invalid or not supported. + * @exception E_PARSING_FAILED The method has failed to parse the package file or xml file(s) inside the package. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ PackageInfo* GetPackageInfoFromFileN(const Tizen::Base::String& filePath) const; /** - * Gets the package information list with the package filter. + * Gets the package information list using the package filter. * * @since 2.1 * @privlevel public @@ -296,18 +308,18 @@ public: * @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, - * see the predefined key-value pairs for package filter. - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * For more information on the predefined key-value pairs for the package filter, + * see the predefined key-value pairs for the package filter. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* GetPackageInfoListN(const Tizen::Base::Collection::IMap& packageFilterMap) const; /** - * Gets the application information list with the package app filter. + * Gets the application information list using the package application filter. * * @since 2.1 * @privlevel public @@ -315,47 +327,47 @@ public: * * @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, see - * the predefined key-value pairs for package app filter. - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @param[in] packageAppFilterMap The predefined key(Tizen::Base::String)-value(Tizen::Base::String or Tizen::Base::Boolean) pairs for the package application filter @n + * For more information, see + * the predefined key-value pairs for the package application filter. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* GetPackageAppInfoListN(const Tizen::Base::Collection::IMap& packageAppFilterMap) const; /** - * Gets the application information list with the package filter and package app filter. + * Gets the application information list using the package filter and the package application filter. * * @since 2.1 * @privlevel public * @privilege %http://tizen.org/privilege/package.info * * @return A pointer to the list of the PackageAppInfo instances, @n - * else @c null if it fails + * 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 user defined key-value pairs can be added in of manifest.xml. @n For more information, - * see the predefined key-value pairs - * for package filter and the - * predefined key-value pairs for package app filter. - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @param[in] packageAppFilterMap The predefined and user defined key(Tizen::Base::String)-value(%Tizen::Base::String or Tizen::Base::Boolean) pairs for the package application filter @n + * The user defined key-value pairs can be added in the of the manifest.xml. @n For more information, + * see the predefined key-value pairs + * for the package filter, and the + * predefined key-value pairs for the package application filter. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* GetPackageAppInfoListN(const Tizen::Base::Collection::IMap& packageFilterMap, const Tizen::Base::Collection::IMap& packageAppFilterMap) const; /** - * Gets the package manager instance. + * Gets a pointer to the %PackageManager instance. * * @since 2.0 * * @return A pointer to the %PackageManager instance, @n - * else @c null + * else @c null if it fails * @remarks The specific error code can be accessed using the GetLastResult() method. */ static PackageManager* GetInstance(void); diff --git a/inc/FAppServiceApp.h b/inc/FAppServiceApp.h index 2f2091a..fa57cb8 100644 --- a/inc/FAppServiceApp.h +++ b/inc/FAppServiceApp.h @@ -37,14 +37,14 @@ typedef ServiceApp* (*ServiceAppInstanceFactory)(void); /** * @class ServiceApp - * @brief This class is the base class of a %Tizen native service application. + * @brief This class is the base class of the %Tizen native service application. * * @since 2.0 * - * The %ServiceApp class is the base class of a %Tizen native service application which has no UI. + * The %ServiceApp class is the base class of the %Tizen native service application which has no UI. * A %Tizen native service application must inherit from the %ServiceApp class. This class provides the basic features necessary to define the * %Tizen native service application. - * @n + * * For more information on the class features, see App Guide and Native Application Model. * */ @@ -60,7 +60,7 @@ public: virtual ~ServiceApp(void); /** - * Gets the %ServiceApp instance's pointer. + * Gets a pointer to the %ServiceApp instance. * * @since 2.0 * @@ -71,17 +71,17 @@ public: /** * Executes an application implemented by inheriting this class. @n - * The %Execute() method must be called from the entry method - OspMain(), which is generated by IDE. + * The %Execute() method must be called from the entry method, that is, OspMain(), which is generated by IDE. * * @since 2.0 * * @return An error code - * @param[in] pServiceAppFactory The factory method that creates this %ServiceApp's instance - * @param[in] pArguments The launch arguments for %App + * @param[in] pServiceAppFactory The factory method that creates this %ServiceApp instance + * @param[in] pArguments The launch arguments for the application * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INIT_FAILED The initialization failure during OnAppInitializing(). + * @exception E_INIT_FAILED The initialization using the OnAppInitializing() method has failed. * @exception E_SYSTEM A system error has occurred. */ static result Execute(ServiceAppInstanceFactory pServiceAppFactory, const Tizen::Base::Collection::IList* pArguments); diff --git a/inc/FAppSqlDataControl.h b/inc/FAppSqlDataControl.h index 8b7c98e..a6acf0b 100755 --- a/inc/FAppSqlDataControl.h +++ b/inc/FAppSqlDataControl.h @@ -45,15 +45,15 @@ class ISqlDataControlResponseListener; /** * @class SqlDataControl - * @brief This class represents the SQL-friendly interface based data control behavior. + * @brief This class represents the SQL-friendly interface based data control's behavior. * * @since 2.0 * * @final This class is not intended for extension. * - * The %SqlDataControl class represents the data control behavior, that provides a standard mechanism - * for accessing specific data exported by other applications. - * Data control provider can share its own data to data control consumers. + * The %SqlDataControl class represents the data control's behavior that provides a standard mechanism + * for accessing the specific data exported by other applications. + * A data control provider can share its data with data control consumers. * * For more information on the class features, see Data Controls. * @@ -122,157 +122,174 @@ public: /** * Selects the specified columns to be queried. @n - * The result set of the specified columns is retrieved from a table owned by an SQL-friendly interface based data control provider. @n + * The result set of the specified columns is retrieved from a table owned by the SQL-friendly interface based data control provider. @n * The %Select() method is asynchronous. - * For receiving the response from the data control provider, set the listener with - * SqlDataControl::SetSqlDataControlResponseListener(). @n + * For receiving the response from the data control provider, set the listener using + * the SqlDataControl::SetSqlDataControlResponseListener() method. @n * When the requested result set has been received from the data control provider, * the ISqlDataControlResponseListener::OnSqlDataControlSelectResponseReceived() method is called. * * @since 2.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/datacontrol.consumer * * @return An error code - * @param[in] dataId A string for identifying specific data, usually a database table to query from @n + * @param[in] dataId The string that identifies the specific data, usually a database table to query from @n * The string consists of one or more components, separated by a slash('/'). - * @param[in] pColumnList A list of column names to query @n + * @param[in] pColumnList The list of column names to query @n * The type of objects contained in the specified @c pColumnList must be - * Tizen::Base::String class. - * If the specified @c pColumnList is @c null, all columns are selected. - * @param[in] pWhere A filter to select desired rows to query @n + * Tizen::Base::String @n + * If the specified @c pColumnList is @c null, all the columns are selected. + * @param[in] pWhere The filter to select the desired rows to query @n * It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as - * column1 = 'stringValue' AND column2 = numericValue. @n - * If the value is string, the value must be wrapped in single quotes. - * Otherwise it is not needed to wrap the numeric value in single quotes. - * For more information on the SQL statement, see SQLite SQL documents. - * @param[in] pOrder The sorting order of rows to query @n + * column1 = 'stringValue' AND column2 = numericValue @n + * If the value is a string, the value must be wrapped in single quotes, + * otherwise it need not be wrapped in single quotes @n + * For more information on the SQL statement, see SQLite SQL documents. + * @param[in] pOrder The sorting order of the rows to query @n * It is an SQL 'ORDER BY' clause excluding the 'ORDER BY' itself. * @param[out] reqId The request ID - * @param[in] pageNo The page number of the result set @n It starts from @c 1. - * @param[in] countPerPage The desired maximum count of rows on a page + * @param[in] pageNo The page number of the result set @n + * It starts from @c 1. + * @param[in] countPerPage The desired maximum count of the rows per page * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE This instance has not been properly constructed. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_STATE This instance has not been constructed properly. + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The specified @c pColumnList is empty. - * - The specified @c pageNo parameter is less than @c 1. - * - The specified @c countPerPage parameter is less than @c 1. - * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n - * - Access is denied due to insufficient permission. - * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1 + * - The specified @c pageNo is less than @c 1. + * - The specified @c countPerPage is less than @c 1. + * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: + * - The access is denied due to insufficient permission. + * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1 * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: - * - The size of sending buffer has exceeded the maximum limit. - * - The number of sending requests has exceeded the maximum limit. + * - The size of the sending buffer has exceeded the maximum limit. + * - The number of sending requests have exceeded the maximum limit. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_SYSTEM A system error has occurred. - * @remarks The recommended data size is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size. + * @remarks The recommended data size is under 16KB because a severe system performance degradation may occur for larger messages. @n + * @c E_MAX_EXCEEDED may be returned for messages over 16KB. */ result Select(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IList* pColumnList, const Tizen::Base::String* pWhere, const Tizen::Base::String *pOrder, RequestId& reqId, int pageNo = 1, int countPerPage = 20); /** - * Inserts new rows into a table owned by an SQL-friendly interface based data control provider. @n + * Inserts new rows into a table owned by the SQL-friendly interface based data control provider. @n * The %Insert() method is asynchronous. - * For receiving the response from the data control provider, set the listener with - * SqlDataControl::SetSqlDataControlResponseListener(). @n + * For receiving the response from the data control provider, set the listener using + * the SqlDataControl::SetSqlDataControlResponseListener() method. @n * When the response has been received from the data control provider, * the ISqlDataControlResponseListener::OnSqlDataControlInsertResponseReceived() method is called. * * @since 2.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/datacontrol.consumer * * @return An error code - * @param[in] dataId A string for identifying specific data, usually a database table to insert into @n + * @param[in] dataId The string that identifies the specific data, usually a database table to insert into @n * The string consists of one or more components, separated by a slash('/'). * @param[in] insertMap The column-value pairs to insert @n - * The type of objects must be Tizen::Base::String class. @n - * If the value is string, the value must be wrapped in - * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes. - * For more information on the SQL statement, see SQLite SQL documents. + * The type of objects must be Tizen::Base::String @n + * If the value is a string, the value must be wrapped in single quotes, + * else it need not be wrapped in single quotes @n + * For more information on the SQL statement, see SQLite SQL documents. * @param[out] reqId The request ID * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE This instance has not been properly constructed. + * @exception E_INVALID_STATE This instance has not been constructed properly. * @exception E_INVALID_ARG The specified @c insertMap is empty. - * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n - * - Access is denied due to insufficient permission. - * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1 + * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: + * - The access is denied due to insufficient permission. + * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1 * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: - * - The size of sending buffer has exceeded the maximum limit. - * - The number of sending requests has exceeded the maximum limit. + * - The size of the sending buffer has exceeded the maximum limit. + * - The number of sending requests have exceeded the maximum limit. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_SYSTEM A system error has occurred. - * @remarks The recommended data size is under 1MB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 1MB size. + * @remarks The recommended data size is under 1MB because a severe system performance degradation may occur for larger messages. @n + * @c E_MAX_EXCEEDED may be returned for messages over 1MB. */ result Insert(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& insertMap, RequestId& reqId); /** - * Updates values of a table owned by an SQL-friendly interface based data control provider. @n + * Updates values of a table owned by the SQL-friendly interface based data control provider. @n * The %Update() method is asynchronous. - * For receiving the response from the data control provider, set the listener with - * SqlDataControl::SetSqlDataControlResponseListener(). @n + * For receiving the response from the data control provider, set the listener using + * the SqlDataControl::SetSqlDataControlResponseListener() method. @n * When the response has been received from the data control provider, * the ISqlDataControlResponseListener::OnSqlDataControlUpdateResponseReceived() method is called. * * @since 2.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/datacontrol.consumer * * @return An error code - * @param[in] dataId A string for identifying specific data, usually a database table to update @n + * @param[in] dataId The string that identifies the specific data, usually a database table to update @n * The string consists of one or more components, separated by a slash('/'). * @param[in] updateMap The column-value pairs to update @n - * The type of objects must be Tizen::Base::String class. @n - * If the value is string, the value must be wrapped in - * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes. - * For more information on the SQL statement, see SQLITE SQL documents. - * @param[in] pWhere A filter to select desired rows to update @n + * The type of objects must be Tizen::Base::String @n + * If the value is a string, the value must be wrapped in single quotes, + * else it need not be wrapped in single quotes @n + * For more information on the SQL statement, see SQLITE SQL documents. + * @param[in] pWhere The filter to select the desired rows to update @n * It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as - * column1 = 'stringValue' AND column2 = numericValue. @n - * If the value is string, the value must be wrapped in - * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes. - * For more information on the SQL statement, see SQLITE SQL documents. + * column1 = 'stringValue' AND column2 = numericValue @n + * If the value is a string, the value must be wrapped in single quotes, + * else it is not wrapped in single quotes @n + * For more information on the SQL statement, see SQLITE SQL documents. * @param[out] reqId The request ID * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE This instance has not been properly constructed. + * @exception E_INVALID_STATE This instance has not been constructed properly. * @exception E_INVALID_ARG The specified @c updateMap is empty. - * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n - * - Access is denied due to insufficient permission. - * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1 + * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: + * - The access is denied due to insufficient permission. + * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1 * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: - * - The size of sending buffer has exceeded the maximum limit. - * - The number of sending requests has exceeded the maximum limit. + * - The size of the sending buffer has exceeded the maximum limit. + * - The number of sending requests have exceeded the maximum limit. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_SYSTEM A system error has occurred. - * @remarks The recommended data size is under 1MB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 1MB size. + * @remarks The recommended data size is under 1MB because a severe system performance degradation may occur for larger messages. @n + * @c E_MAX_EXCEEDED may be returned for messages over 1MB. */ result Update(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& updateMap, const Tizen::Base::String* pWhere, RequestId& reqId); /** - * Deletes rows of a table owned by an SQL-friendly interface based data control provider. @n + * Deletes rows of a table owned by the SQL-friendly interface based data control provider. @n * The %Delete() method is asynchronous. - * For receiving the response from the data control provider, set the listener with - * SqlDataControl::SetSqlDataControlResponseListener(). @n + * For receiving the response from the data control provider, set the listener using + * the SqlDataControl::SetSqlDataControlResponseListener() method. @n * When the response has been received from the data control provider, * the ISqlDataControlResponseListener::OnSqlDataControlDeleteResponseReceived() method is called. * * @since 2.0 + * @privlevel public + * @privilege %http://tizen.org/privilege/datacontrol.consumer * * @return An error code - * @param[in] dataId A string for identifying specific data, usually a database table to delete from @n + * @param[in] dataId The string that identifies the specific data, usually a database table to delete from @n * The string consists of one or more components, separated by a slash('/'). - * @param[in] pWhere A filter to select desired rows to delete @n + * @param[in] pWhere The filter to select the desired rows to delete @n * It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as - * column1 = 'stringValue' AND column2 = numericValue. - * If it is @c null, all rows are deleted. @n - * If the value is string, the value must be wrapped in - * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes. - * For more information on the SQL statement, see SQLITE SQL documents. + * column1 = 'stringValue' AND column2 = numericValue @n + * If it is @c null, all the rows are deleted @n + * If the value is a string, the value must be wrapped in single quotes, + * else it need not be wrapped in single quotes @n + * For more information on the SQL statement, see SQLITE SQL documents. * @param[out] reqId The request ID * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE This instance has not been properly constructed. - * @exception E_INVALID_ARG A specified parameter is invalid. - * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n - * - Access is denied due to insufficient permission. - * - The application using this method is not signed with the same certificate of provider application. @b Since: @b 2.1 + * @exception E_INVALID_STATE This instance has not been constructed properly. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: + * - The access is denied due to insufficient permission. + * - The application using this method is not signed with the same certificate as that of the provider application. @b Since: @b 2.1 * @exception E_MAX_EXCEEDED Either of the following conditions has occurred: - * - The size of sending buffer has exceeded the maximum limit. - * - The number of sending requests has exceeded the maximum limit. + * - The size of the sending buffer has exceeded the maximum limit. + * - The number of sending requests have exceeded the maximum limit. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_SYSTEM A system error has occurred. - * @remarks The recommended data size is under 16KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 16KB size. + * @remarks The recommended data size is under 16KB because a severe system performance degradation may occur for larger messages. @n + * @c E_MAX_EXCEEDED may be returned for messages over 16KB. */ result Delete(const Tizen::Base::String& dataId, const Tizen::Base::String* pWhere, RequestId& reqId); @@ -283,10 +300,10 @@ public: * * @return An error code * @param[in] pListener The data control callback listener @n - * Some data controls need to get the callback result by implementing + * Some data controls get the callback result by implementing * the ISqlDataControlResponseListener interface. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE This instance has not been properly constructed. + * @exception E_INVALID_STATE This instance has not been constructed properly. * @exception E_SYSTEM A system error has occurred. */ result SetSqlDataControlResponseListener(ISqlDataControlResponseListener* pListener); diff --git a/inc/FAppTypes.h b/inc/FAppTypes.h index 98f136b..b5e0216 100644 --- a/inc/FAppTypes.h +++ b/inc/FAppTypes.h @@ -16,10 +16,9 @@ /** * @file FAppTypes.h - * @brief This is the header file for the enumerations of the App class. + * @brief This is the header file for the enumerations of the %App class. * - * This header file contains the declarations of the enumerations of the App class. - * @see Application + * This header file contains the declarations of the enumerations of the App class. */ #ifndef _FAPP_TYPES_H_ @@ -47,10 +46,10 @@ typedef Tizen::Base::String AppId; /** * @if OSPDEPREC * The application secret - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This type is deprecated because the associated App::GetAppSecret() method is deprecated. * - * @since 2.0 + * @since 2.0 * @endif */ typedef Tizen::Base::String AppSecret; @@ -65,8 +64,8 @@ enum AppState { INITIALIZING, /**< The application has been launched */ RUNNING, /**< The application has been initialized and is currently being executed */ - TERMINATING, /**< The application is about to exit and releases its resources and saves its preferences */ - TERMINATED /**< The application has been destroyed */ + TERMINATING, /**< The application is about to exit, release its resources, and save its preferences */ + TERMINATED /**< The application has been destroyed */ }; /** @@ -77,9 +76,9 @@ enum AppState */ enum AppUiState { - APP_UI_STATE_FOREGROUND = 0x01, /**< The application is completely visible on foreground */ + APP_UI_STATE_FOREGROUND = 0x01, /**< The application is completely visible in the foreground */ APP_UI_STATE_PARTIAL_BACKGROUND = 0x02, /**< The application is partially hidden by another window, such as a system pop-up */ - APP_UI_STATE_BACKGROUND = 0x04 /**< The application is completely hidden by a full-screen window, usually by another application or an application control */ + APP_UI_STATE_BACKGROUND = 0x04 /**< The application is completely hidden by a full-screen window, usually by another application, or an application control */ }; /** @@ -92,42 +91,41 @@ enum AppCtrlResult { APP_CTRL_RESULT_SUCCEEDED = 0x00, /**< The application operation is successful */ APP_CTRL_RESULT_FAILED = 0x01, /**< The application operation has failed */ - APP_CTRL_RESULT_CANCELED = 0x02, /**< The application operation is canceled by the callee application */ - APP_CTRL_RESULT_TERMINATED = 0x04, /**< The callee application is terminated without sending the result */ + APP_CTRL_RESULT_CANCELED = 0x02, /**< The application operation is cancelled by the calling application */ + APP_CTRL_RESULT_TERMINATED = 0x04, /**< The calling application is terminated without sending the result */ APP_CTRL_RESULT_ABORTED = 0x08, /**< The application operation is aborted by the platform */ }; /** * @if OSPDEPREC * The application launch request ID. @n - * Represents the application launch arguments in App::App::OnUserEventReceivedN(). + * Represents the application launch arguments in the App::App::OnUserEventReceivedN() method. * * @brief [Deprecated] - * @deprecated This variable is deprecated. From %Tizen API version 2.1, App::App::OnUserEventReceivedN() - * is not invoked for the request from application and %AppLaunchRequestId is not used anymore. + * @deprecated This variable is deprecated. From Tizen API version 2.1, the App::App::OnUserEventReceivedN() + * method is not invoked for the request from the application and the %AppLaunchRequestId() method is not used anymore. * Instead, use IAppControlProviderEventListener. - * @since 2.0 + * @since 2.0 * - * @see App::App::OnUserEventReceivedN() * @endif */ const long AppLaunchRequestId = (-0xFFFF); /** * @if OSPDEPREC - * Defines the launch type - normal launch. + * Defines the launch type, for example, normal launch. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. * Instead of using this variable, it is recommended to use IAppControlProviderEventListener to acquire the launch information. - * @since 2.0 + * @since 2.0 * @endif */ _OSP_EXPORT_ extern const Tizen::Base::String APP_LAUNCH_NORMAL; /** * @if OSPDEPREC - * Defines the launch type - conditional launch. + * Defines the launch type, for example, conditional launch. * * @brief [Deprecated] * @deprecated This variable is provided only for backward compatibility and will be deleted in the near future. diff --git a/inc/FAppUiApp.h b/inc/FAppUiApp.h index bd5c709..757c463 100644 --- a/inc/FAppUiApp.h +++ b/inc/FAppUiApp.h @@ -43,10 +43,10 @@ typedef UiApp* (*UiAppInstanceFactory)(void); * * @since 2.0 * - * The %UiApp class is the base class of a %Tizen native UI application. + * The %UiApp class is the base class of a %Tizen native UI application.@n * A %Tizen native UI application must inherit from the %UiApp class. This class provides the basic features necessary to define the * %Tizen native UI application. - * @n + * * For more information on the class features, see App Guide and Native Application Model. * */ @@ -62,24 +62,24 @@ public: virtual ~UiApp(void); /** - * Gets the first frame in the frame list of the UI application. + * Gets the first frame to the frame list of the UI application. * - * @since 2.0 + * @since 2.0 * - * @return A pointer to the IAppFrame interface of the frame, @n - * else @c null if it fails - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE The frame has not been properly initialized. - * @exception E_OBJ_NOT_FOUND The frame is not found. + * @return A pointer to the IAppFrame instance of the frame, @n + * else @c null if it fails + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_STATE The frame has not been initialized properly. + * @exception E_OBJ_NOT_FOUND The frame has not been found. */ IAppFrame* GetAppFrame(void) const; /** - * Adds the frame to the end of the list that is maintained by the UI application. + * Adds a frame to the end of the list that is maintained by the UI application. * * @since 2.0 * - * @return An error code + * @return An error code * @param[in] frame The frame that is added to the UI application * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. @@ -96,7 +96,7 @@ public: * * @since 2.0 * - * @return An error code + * @return An error code * @param[in] frame The frame to remove * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c frame cannot be found. @@ -108,10 +108,10 @@ public: /** * Gets the list of the frames of the UI application. * - * @since 2.0 + * @since 2.0 * - * @return A pointer to Tizen::Base::Collection::IList that contains Tizen::Ui::Frame instances, @n - * else @c null if it fails + * @return A pointer to the Tizen::Base::Collection::IList that contains the Tizen::Ui::Frame instances, @n + * else @c null if it fails * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The application is in an invalid state. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -121,10 +121,10 @@ public: /** * Gets the frame with the specified @c name. * - * @since 2.0 + * @since 2.0 * - * @return A pointer to the frame having the specified @c name, @n - * else @c null if it fails + * @return A pointer to the frame that contains the specified @c name, @n + * else @c null if it fails * @param[in] name The name of the frame * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c frame cannot be found. @@ -133,12 +133,12 @@ public: Tizen::Ui::Controls::Frame* GetFrame(const Tizen::Base::String& name) const; /** - * Gets the frame at the specified @c index of the list. + * Gets the frame at the specified @c index in the list. * - * @since 2.0 + * @since 2.0 * - * @return A pointer to the frame at the specified @c index, @n - * else @c null if it fails + * @return A pointer to the frame at the specified @c index, @n + * else @c null if it fails * @param[in] index The index of the frame * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the frame list. @@ -152,23 +152,23 @@ public: * @since 2.0 * * @return The UI state of the UI application - * @remarks Note that UiApp::OnBackground() is invoked when the UI state of a UI application changes - * from App::APP_UI_STATE_FOREGROUND to App::APP_UI_STATE_PARTIAL_BACKGROUND or App::APP_UI_STATE_BACKGROUND. + * @remarks Note that the UiApp::OnBackground() method is invoked when the UI state of the UI application changes + * from App::APP_UI_STATE_FOREGROUND to App::APP_UI_STATE_PARTIAL_BACKGROUND, or App::APP_UI_STATE_BACKGROUND. */ AppUiState GetAppUiState(void) const; /** - * Called when a UI application moves to the foreground. @n + * Called when the UI application moves to the foreground. @n * User interaction is enabled when the UI application moves to the foreground. @n * A UI application moves to the foreground when: * - * - A UI application is selected from the Task Switcher. - * - A UI application icon in the Launcher application is pressed when it is running in the background. - * - A UI application is to be launched while it is running in the background. - * - A system pop-up, such as an incoming call, notification (for example, SMS), or a low battery warning - * pop-up disappears. + * - The UI application is selected from the Task Switcher. + * - The UI application icon in the Launcher application is pressed when it is running in the background. + * - The UI application is to be launched while it is running in the background. + * - A system pop-up, such as an incoming call, a notification (for example, an SMS), or a low battery warning + * pop-up disappears. * - * When this method is invoked, the following actions are recommended: + * When the %OnForeground() method is invoked, the following actions are recommended: * * - Resume the graphic processing, such as 3D or animation, as the UI application now has the focus. * - Resume the operations that stopped when the UI application is last moved to the background. @@ -185,10 +185,10 @@ public: * A UI application moves to the background when: * * - A system pop-up, such as an incoming call or a low battery warning pop-up is displayed. - * - A device is locked. + * - The device is locked. * - The Home key is pressed. * - * Whenever this method is invoked, the following actions are recommended: + * When the %OnBackground() method is invoked, the following actions are recommended: * * - Stop the graphic processing, such as 3D or animation, as they will not be displayed. * - Release unnecessary resources. @@ -196,17 +196,16 @@ public: * * @since 2.0 * - * @remarks When notification (for example, SMS) pops up, this method is not called. - * When a system pop-up is displayed, a UI application becomes partially hidden - * (App::APP_UI_STATE_PARTIAL_BACKGROUND). - * If a UI application is partially hidden, it is recommended to hold the activated - * tasks or resources instead of stopping or releasing them. + * @remarks + * - When a notification (for example, an SMS) pops up, this method is not called. + * - When a system pop-up is displayed, the UI application becomes partially hidden (App::APP_UI_STATE_PARTIAL_BACKGROUND). + * - If the UI application is partially hidden, it is recommended to hold the activated tasks or resources instead of stopping or releasing them. * @see GetAppUiState() */ virtual void OnBackground(void); /** - * Gets the %UiApp instance's pointer. + * Gets a pointer to the %UiApp instance. * * @since 2.0 * @@ -217,17 +216,17 @@ public: /** * Executes an application implemented by inheriting this class. - * The %Execute() method must be called from the entry method - OspMain(), which is generated by IDE. + * The %Execute() method must be called from the entry method, that is, OspMain(), which is generated by IDE. * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] pUiAppFactory The factory method that creates this UiApp's instance - * @param[in] pArguments The launch arguments for %App + * @return An error code + * @param[in] pUiAppFactory The factory method that creates this UiApp instance + * @param[in] pArguments The launch arguments for the application * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INIT_FAILED The initialization failure during OnAppInitializing(). + * @exception E_INIT_FAILED A failure occurred while initializing using the OnAppInitializing() method. * @exception E_SYSTEM A system error has occurred. */ static result Execute(UiAppInstanceFactory pUiAppFactory, const Tizen::Base::Collection::IList* pArguments); diff --git a/inc/FBase.h b/inc/FBase.h index 98e5852..0918b77 100644 --- a/inc/FBase.h +++ b/inc/FBase.h @@ -15,8 +15,8 @@ // /** - * @file FBase.h - * @brief This is the header file for the %Base namespace. + * @file FBase.h + * @brief This is the header file for the %Base namespace. * * This header file contains the declarations and descriptions of the %Base namespace. */ @@ -73,15 +73,15 @@ * @since 2.0 * * @remarks @b Header @b %file: @b \#include @b @n - * @b Library : @b osp-appfw + * @b Library: @b osp-appfw * * The %Base namespace contains classes and interfaces around which the entire %Tizen platform is built. * The main features of the namespace include basic data types, collections, runtime libraries, and various utilities. * * For more information on the %Base namespace features, see Base Guide. * - * The following diagram illustrates the relationships between the classes belonging to the %Base namespace. - * @image html base_namespace_classdiagram.png + * The following diagram illustrates the relationships between the classes belonging to the %Base namespace. + * @image html base_namespace_classdiagram.png * * * diff --git a/inc/FBaseBoolean.h b/inc/FBaseBoolean.h index 7c51f03..7a40c06 100644 --- a/inc/FBaseBoolean.h +++ b/inc/FBaseBoolean.h @@ -35,7 +35,7 @@ namespace Tizen { namespace Base * * @since 2.0 * - * The %Boolean class wraps a bool type value. This enables passing a bool value to a method that only accepts an instance of the Object class. + * The %Boolean class wraps a boolean type value. This enables passing a boolean value to a method that only accepts an instance of the Object class. * It provides methods to convert %Boolean instances to String and %String instances to %Boolean. * * The following example demonstrates how to use the %Boolean class. @@ -68,11 +68,11 @@ class _OSP_EXPORT_ Boolean { public: /** - * Initializes this instance of the %Boolean class with the specified @c value. + * Initializes this instance of %Boolean with the specified @c value. * * @since 2.0 * - * @param[in] value The input @c bool value to initialize the %Boolean instance + * @param[in] value The @c bool value used to initialize %Boolean */ Boolean(bool value); @@ -81,14 +81,14 @@ public: * * @since 2.0 * - * @param[in] value An instance of the %Boolean class + * @param[in] value An instance of %Boolean */ Boolean(const Boolean& value); /** * Initializes this instance of %Boolean with the specified input string. @n - * If the input is "true" (ignoring case), the object is initialized to @c true, - * else @c false. + * If the input is "true" (ignoring cases), the object is initialized to @c true, + * otherwise to @c false. * * @since 2.0 * @@ -108,8 +108,8 @@ public: * * @since 2.0 * - * @return @c true if the values of the objects are equal, @n - * else @c false. + * @return @c true if the values of the objects are equal, @n + * else @c false * @param[in] rhs An instance of %Boolean to compare with the current instance */ bool operator ==(const Boolean& rhs) const; @@ -119,7 +119,7 @@ public: * * @since 2.0 * - * @return @c true if the values of the objects are not equal, @n + * @return @c true if the values of the objects are not equal, @n * else @c false * @param[in] rhs An instance of %Boolean to compare with the current instance */ @@ -135,14 +135,13 @@ public: Boolean& operator =(const Boolean& rhs); /** - * Converts an instance of the Object class to an instance of %Boolean and then - * compares it with the calling %Boolean instance. + * Compares the specified Object instance with the current %Boolean instance. * * @since 2.0 * - * @return @c true if the value of @c obj matches the value of the calling %Boolean instance, @n + * @return @c true if @c obj matches the current %Boolean instance, @n * else @c false - * @param[in] obj A reference to the Object instance to compare with the calling %Boolean instance + * @param[in] obj A reference to the Object instance to compare with the current %Boolean instance * @see Tizen::Base::Object::Equals() */ virtual bool Equals(const Object& obj) const; @@ -152,30 +151,30 @@ public: * * @since 2.0 * - * @return The hash value of the current instance - * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n - * the used hash function must generate a random distribution for all inputs. + * @return The hash value of the current instance + * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const; /** - * Converts a bool value to an instance of %Boolean and then - * compares it with the calling %Boolean instance. + * Converts a @c bool value to an instance of %Boolean and then + * compares it with the current %Boolean instance. * * @since 2.0 * - * @return @c true if the parameter matches the calling %Boolean instance, @n + * @return @c true if @c value matches the current %Boolean instance, @n * else @c false * @param[in] value The @c bool value to compare to this instance */ bool Equals(bool value) const; /** - * Returns the value of the calling object as @c bool. + * Returns the value of the current object as @c bool. * * @since 2.0 * - * @return The value of the %Boolean instance as bool + * @return The value of the %Boolean instance as @c bool */ bool ToBool(void) const; @@ -185,10 +184,9 @@ public: * @since 2.0 * * @return @c true if the value of the specified string is "true", @n - * else @c false + * else @c false * @param[in] s An instance of String - * @remarks This method is case sensitive. @n - * It only accepts lowercase strings. + * @remarks This method is case sensitive and accepts only lowercase strings. * * @code * bool b1 = Boolean::Parse(trueString); // trueString is L"true" @@ -204,11 +202,11 @@ public: * @since 2.0 * * @return @c true if the value of the specified string is "true", @n - * else @c false + * else @c false * @param[in] s An instance of String * @param[in] caseSensitive Set to @c true to perform a * case sensitive comparison of string @c s - * @remarks If @c caseSensitive is @c true, L"True" returns @c false, else @c true. + * @remarks If @c caseSensitive is @c true, L"True" returns @c false, else it returns @c true. * * @code * bool b1 = Boolean::Parse(L"True", false ); // Returns @c true @@ -218,11 +216,11 @@ public: static bool Parse(const String& s, bool caseSensitive); /** - * Converts the value of the calling instance from @c bool to String. + * Converts the value of the current instance from @c bool to String. * * @since 2.0 * - * @return @c true if this instance is @c true, @n + * @return @c true if this instance is @c true, @n * else @c false */ String ToString(void) const; @@ -234,9 +232,9 @@ public: * * @since 2.0 * - * @return @c true if the parameter is @c true, @n + * @return @c true if the parameter is @c true, @n * else @c false - * @param[in] value A @c bool value to convert to String + * @param[in] value The @c bool value to convert to String */ static String ToString(bool value); diff --git a/inc/FBaseBuffer.h b/inc/FBaseBuffer.h index a3476c8..f5eb717 100644 --- a/inc/FBaseBuffer.h +++ b/inc/FBaseBuffer.h @@ -18,7 +18,7 @@ * @file FBaseBuffer.h * @brief This is the header file for the %Buffer class. * - * This header file contains the declarations of the %Buffer classes. + * This header file contains the declarations of the %Buffer class. */ #ifndef _FBASE_BUFFER_H_ #define _FBASE_BUFFER_H_ @@ -42,7 +42,7 @@ class ByteBuffer; * * The %Buffer class represents a linear finite sequence of elements of the same type. * It is a means of defining an aggregation of the same type of objects, similar to an array. - * @n + * * For more information on the class features, see Buffer. * * @see Tizen::Base::BufferBase @@ -120,12 +120,10 @@ class _OSP_EXPORT_ Buffer public: /** - * This is the default constructor for this class. - * - * @since 2.0 + * This is the default constructor for this class. @n + * After creating an instance of the %Buffer class, one of the Construct() methods must be called explicitly to initialize this instance. * - * @remarks After creating an instance of the %Buffer class, one of the Construct() methods must be called explicitly to initialize this instance. - * @see Construct() + * @since 2.0 */ Buffer(void) { @@ -152,8 +150,9 @@ public: * * @param[in] buffer The other %Buffer instance * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the source buffer is not constructed. + * @exception E_INVALID_ARG Either of the following conditions has occured: + * - The specified input parameter is invalid. + * - The source buffer has not been constructed. * @see Buffer() */ result Construct(const Buffer< Type >& buffer) @@ -194,15 +193,18 @@ public: * @since 2.0 * * @return An error code - * @param[in] pBuffer The buffer which is shared + * @param[in] pBuffer The shared buffer * @param[in] index The starting index of the buffer from where the first @c byte value is read - * @param[in] length The number of bytes to read from the given buffer @n This is a limit of this instance. + * @param[in] length The number of bytes to read from the given buffer @n + * This is the limit of this instance. * @param[in] capacity The capacity of this instance * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c pBuffer is @c null. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the @c index is larger than the @c length. + * @exception E_INVALID_ARG Either of the following conditions has occured: + * - A specified input parameter is invalid. + * - The specified @c pBuffer is @c null. + * @exception E_OUT_OF_RANGE Either of the following conditions has occured: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the specified @c length. */ result Construct(const Type* pBuffer, int index, int length, int capacity) { @@ -236,13 +238,13 @@ public: } /** - * This subscript operator returns the reference to the element indicated by the given @c index. + * Returns a reference to the element indicated by the given @c index. * * @since 2.0 * * @return A reference to the indexed element * @param[in] index The index of the element @n - * It must be less than the limit. + * It must be less than the limit. */ Type& operator [](int index) const { @@ -253,15 +255,15 @@ public: } /** - * Overloaded equality operator to compare two %Buffer instances. + * Checks whether two %Buffer instances are equal. * * @since 2.0 * - * @return @c true if the buffers being compared are equal, @n + * @return @c true if the two %Buffer instances are equal, @n * else @c false - * @param[in] buffer The buffer to compare with the current instance of %Buffer - * @remarks This method returns @c true only if the two buffers have the same number of remaining elements @n - * and the two sequences of remaining elements are equal (considered independently of their starting positions). + * @param[in] buffer The buffer to compare with the current instance of %Buffer + * @remarks This method returns @c true only if the two buffers have the same number of remaining elements @n + * and the sequences of the remaining elements are equal (considered independent of their starting positions). * @see Equals() */ bool operator ==(const Buffer< Type >& buffer) const @@ -289,16 +291,16 @@ public: } /** - * Checks whether the two %Buffer instances are not equal. + * Checks whether two %Buffer instances are not equal. * * @since 2.0 * - * @return @c true if the buffers are not equal, @n + * @return @c true if the two %Buffer instances are not equal, @n * else @c false - * @param[in] buffer The buffer to compare with the current instance of %Buffer - * @remarks This method returns @c false only if the two buffers being compared have the same @n - * number of remaining elements and the two sequences of remaining elements are equal @n - * (considered independently of their starting positions). + * @param[in] buffer The buffer to compare with the current instance of %Buffer + * @remarks This method returns @c false only if the two buffers have the same @n + * number of remaining elements and the sequences of the remaining elements are equal @n + * (considered independent of their starting positions). * @see Equals() */ bool operator !=(const Buffer< Type >& buffer) const @@ -309,29 +311,30 @@ public: /** * Copies the remaining elements of the input %Buffer instance into the current * %Buffer instance. @n - * It returns E_OVERFLOW if the remaining part of the current instance is smaller + * It returns @c E_OVERFLOW if the remaining part of the current instance is smaller * than the remaining part of the input instance. * * @since 2.0 * * @return An error code - * @param[in] buffer The source buffer from which bytes are read @n - * It must not be the current instance of %Buffer. + * @param[in] buffer The source buffer from which bytes are read @n + * It must not be the current instance of %Buffer. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the source buffer is same as destination buffer, + * @exception E_INVALID_ARG Either of the following conditions has occured: + * - The specified input parameter is invalid. + * - The source buffer is same as destination buffer, * that is, the current instance of %Buffer. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow. @n - * The number of remaining bytes of the current buffer is less than - * the number of remaining bytes of the given buffer. + * @exception E_OVERFLOW Either of the following conditions has occured: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The number of remaining bytes in the current buffer is less than + * the number of remaining bytes in the given buffer. * @remarks After the copy operation, the current (destination) buffer's position and the given * (source) buffer's position are incremented by the number of elements copied (the number * of remaining elements of the given buffer). @n * If the remaining part of the current instance is not less than the remaining part of the input instance, - * the effect of this method and the ReadFrom() method is the same. But when the remaining part of the - * current instance is less, ReadFrom() method copies the number of remaining elements of the current - * instance while this method returns E_OVERFLOW and does not transfer. - * @see ReadFrom() + * the effect of this method and the ReadFrom() method is the same. @n + * But when the remaining part of the current instance is less, the ReadFrom() method copies the number of remaining + * elements of the current instance while this method returns @c E_OVERFLOW and does not transfer. * * The following example demonstrates how to use the %CopyFrom() method. * @@ -399,16 +402,17 @@ public: } /** - * Reads the value from the current position in the buffer, and then increments the position. @n - * Provides a way for relative indexing and reading. + * Reads the value of the current position in the buffer, and then increments the position. @n + * Provides a way to perform relative indexing and reading. * * @since 2.0 * * @return An error code - * @param[out] value The value at the current position + * @param[out] value The value at the current position * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow. @n - * The current position is greater than the limit. + * @exception E_UNDERFLOW Either of the following conditions has occured: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The current position is greater than the limit. * @see Set() */ result Get(Type& value) @@ -421,16 +425,18 @@ public: /** * Reads the value at the given @c index. @n - * Provides a way for absolute indexing and reading. + * Provides a way to preform absolute indexing and reading. * * @since 2.0 * * @return An error code - * @param[in] index The index into the buffer from where the value is read - * @param[out] value The value at the given index - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure. @n - * The @c index is greater than the limit or less than @c 0. + * @param[in] index The buffer index from where the value is read + * @param[out] value The value at the given index + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_RANGE Either of the following conditions has occured: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is greater than the limit. + * - The specified @c index is less than @c 0. * @see Set() */ result Get(int index, Type& value) const @@ -445,22 +451,25 @@ public: /** - * Copies the specified range of values from the calling buffer to the specified destination array as per the given @c index of the array. + * Copies the specified range of values from the calling buffer to the specified @c index of the destination array. * * @since 2.0 * * @return An error code - * @param[out] pArray A pointer to the array into which values are written - * @param[in] index The starting index in the array of the first value to write - * @param[in] length The number of values from the buffer to write to the array + * @param[out] pArray A pointer to the array into which the values are written + * @param[in] index The starting index in the array where the first value is written + * @param[in] length The number of values to write from the buffer to the array * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c pArray is @c null. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index or length is less than @c 0. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow. @n - * The remaining elements of this buffer are smaller than @c length. - * @remarks After the copy operation, the position is incremented by @c length. + * @exception E_INVALID_ARG Either of the following conditions has occured: + * - A specified input parameter is invalid. + * - The specified @c pArray is @c null. + * @exception E_OUT_OF_RANGE Either of the following conditions has occured: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index or @c length is less than @c 0. + * @exception E_UNDERFLOW Either of the following conditions has occured: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The remaining elements of this buffer are smaller than the specified @c length. + * @remarks After the copy operation, the position is incremented by @c length. * @see SetArray() */ result GetArray(Type* pArray, int index, int length) @@ -478,26 +487,27 @@ public: /** * Transfers bytes from the input buffer into the calling buffer. @n - * If the empty space in the calling buffer is larger than the remaining values from the input buffer, - * all the remaining elements from the input are copied to the destination. @n + * If the empty space in the calling buffer is larger than the remaining values of the input buffer, + * then all the remaining elements from the input are copied to the destination. @n * Otherwise, the number of bytes copied equals the number of elements remaining in the calling buffer. * * @since 2.0 * * @return An error code - * @param[in] buffer The source buffer from where the bytes are read @n - * It must not be this buffer. + * @param[in] buffer The source buffer from where the bytes are read @n + * It must not be this buffer. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. @n - * The given buffer is same as the current buffer instance. + * @exception E_INVALID_ARG Either of the following conditions has occured: + * - The specified input parameter is invalid. + * - The given buffer is same as the current buffer instance. * @remarks After the copy operation, the current (destination) buffer's position and the given - * (source) buffer's position are incremented by the number of elements copied (the smaller value + * (source) buffer's position are incremented by the number of elements copied (the smaller value * between the number of elements remaining in the calling buffer and the source buffer). @n - * If there are more elements remaining in the calling buffer than elements remaining in the input instance, - * this method is equivalent to CopyFrom() method. If there are less remaining elements in the - * calling buffer, the %CopyFrom() method returns @c E_OVERFLOW and does not transfer - * while this method copies the number of remaining elements of the current instance. - * @see CopyFrom() + * If there are more elements remaining in the calling buffer than the elements remaining in the input instance, + * then this method is equivalent to the CopyFrom() method. @n + * If there are less elements remaining in the calling buffer, then the %CopyFrom() method + * returns @c E_OVERFLOW and does not transfer, while this method copies the number of remaining elements + * of the current instance. * * The following example demonstrates how to use the %ReadFrom() method. * @@ -575,15 +585,16 @@ public: /** * Writes the specified @c value into the current buffer instance at the current position, * and then increments the position. @n - * Provides a way for relative indexing and writing. + * Provides a way to perform relative indexing and writing. * * @since 2.0 * * @return An error code - * @param[in] value The value to write to the calling %Buffer + * @param[in] value The value to write into the calling %Buffer * @exception E_SUCCESS The method is successful. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow. @n - * The current position is not smaller than the limit. + * @exception E_OVERFLOW Either of the following conditions has occured: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The current position is not smaller than the limit. * @see Get() */ result Set(Type value) @@ -595,17 +606,19 @@ public: } /** - * Writes the specified @c value into the current instance of buffer at the given @c index. @n - * Provides a way for absolute indexing and writing. + * Writes the specified @c value into the current instance of the buffer at the given @c index. @n + * Provides a way to perform absolute indexing and writing. * * @since 2.0 * * @return An error code - * @param[in] index The index at which the value is written - * @param[in] value The value to write + * @param[in] index The index at which the value is written + * @param[in] value The value to write * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is not smaller than the limit or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occured: + * - The specified index is outside the bounds of the data structure. + * - The specified @c index is not smaller than the limit. + * - The specified @c index is less than @c 0. * @see Get() */ result Set(int index, Type value) @@ -624,19 +637,21 @@ public: * @since 2.0 * * @return An error code - * @param[in] pArray A pointer to the array from where the values are read - * @param[in] index The starting index of the array - * @param[in] length The number of values read from the given array + * @param[in] pArray A pointer to the array from where the values are read + * @param[in] index The starting index of the array + * @param[in] length The number of values read from the given array * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c pArray is @c null. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index or length is less than @c 0. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow. @n - * The remainder of this buffer is smaller than @c length. - * @remarks This method copies @c length number of values from the source array, - * starting from the given @c index in the array, into the calling - * buffer, starting at the current position. + * @exception E_INVALID_ARG Either of the following conditions has occured: + * - A specified input parameter is invalid. + * - The specified @c pArray is @c null. + * @exception E_OUT_OF_RANGE Either of the following conditions has occured: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index or @c length is less than @c 0. + * @exception E_OVERFLOW Either of the following conditions has occured: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The remainder of this buffer is smaller than the specified @c length. + * @remarks This method copies @c length number of values starting from the given @c index of the source array, + * into the calling buffer, starting from the current position. @n * After the copy operation, the position is incremented by @c length. * @see GetArray() */ @@ -656,12 +671,12 @@ public: /** * Creates a new %Buffer instance. @n * Its content is a shared portion of - * the calling %Buffer instance that starts from the current position of calling %Buffer instance. + * the calling %Buffer instance that starts from the current position of the calling %Buffer instance. * * @since 2.0 * - * @return A pointer to the new buffer - * @remarks The content of the new buffer starts at the current position of this instance of %Buffer. + * @return A pointer to the new %Buffer instance + * @remarks The content of the new buffer starts at the current position of this %Buffer instance. @n * The new buffer's position is @c 0, its capacity and limit is * the number of bytes remaining in the current instance of %Buffer, * and it is marked as undefined. @@ -695,16 +710,16 @@ public: } /** - * Compares the Object instance with the calling %Buffer instance for equivalence. + * Compares the Object instance with the current %Buffer instance for equality. * * @since 2.0 * - * @return @c true if the input equals the calling %Buffer instance, @n + * @return @c true if the input equals the current %Buffer instance, @n * else @c false - * @param[in] obj The object to compare with the calling %Buffer - * @remarks This method returns @c true if and only if the specified object is also an instance of %Buffer class, + * @param[in] obj The object to compare with the current %Buffer instance + * @remarks This method returns @c true if and only if the specified object is also an instance of %Buffer, * the two buffers have the same number of remaining elements, and the two sequences of - * remaining elements are equal (considered independently of their starting positions). + * remaining elements are equal (considered independent of their starting positions). * @see Tizen::Base::BufferBase::GetHashCode() */ virtual bool Equals(const Tizen::Base::Object& obj) const @@ -724,7 +739,7 @@ public: * * @since 2.0 * - * @return The hash value of the current instance + * @return The hash value of the current instance * @remarks The hash code of a buffer depends only upon its remaining elements. */ virtual int GetHashCode(void) const diff --git a/inc/FBaseBufferBase.h b/inc/FBaseBufferBase.h index 6a07b8e..9858533 100644 --- a/inc/FBaseBufferBase.h +++ b/inc/FBaseBufferBase.h @@ -83,14 +83,15 @@ public: void Clear(void); /** - * Copies the elements between the current position and limit (that are also known as remaining + * Copies the elements between the current position and the limit (that are also known as the remaining * elements), to the beginning of the calling %BufferBase instance. * * @since 2.0 * * @remarks After copying, the position is set to the number of elements copied rather than to @c 0, * so that an invocation of this method can be followed immediately by an invocation - * of another relative set method. The limit is set to the capacity, and the mark is discarded. + * of another relative set method. @n + * The limit is set to the capacity, and the mark is discarded. */ void Compact(void); @@ -101,12 +102,13 @@ public: * * @since 2.0 * - * @param[in] to The value to set the buffer position @n + * @param[in] to The value of the buffer position to set @n * The parameter may contain @c POSITION_TO_ZERO or @c POSITION_TO_MARK. - * @remarks If @c to is POSITION_TO_ZERO (or unspecified), the position is set to @c 0 after setting a limit to + * @remarks If @c to is @c POSITION_TO_ZERO (or unspecified), the position is set to @c 0 after setting a limit to * the current position, and the mark is discarded. - * Otherwise, if @c to is POSITION_TO_MARK, the position is set to the mark and - * the mark is not discarded. If the mark is undefined, the position is set to @c 0. + * Otherwise, if @c to is @c POSITION_TO_MARK, the position is set to the mark and + * the mark is not discarded. @n + * If the mark is undefined, the position is set to @c 0. * * The following example demonstrates how to use the %Flip() method. * @@ -137,7 +139,7 @@ public: * @since 2.0 * * @return The hash value of the calling object - * @remarks The hash code of a buffer depends only upon its remaining elements. + * @remarks The hash code of a buffer depends only upon its remaining elements. * @see Tizen::Base::Object::Equals() */ virtual int GetHashCode(void) const; @@ -158,8 +160,9 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n - * The mark has not been set. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The mark has not been set. * @remarks Invoking this method neither changes nor discards the mark's value. */ result Reset(void); @@ -175,17 +178,20 @@ public: /** * Shifts the limit of the current instance of %BufferBase. @n - * The new limit is the current limit plus the given amount. + * The new limit is the current limit plus the given @c amount. * * @since 2.0 * * @return An error code - * @param[in] amount The quantity of shift needed + * @param[in] amount The quantity of the shift needed * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method. @n - * The @c amount is larger than the capacity or smaller than @c 0 starting from the current limit. - * @remarks If the position is larger than the new limit, it is set to the new limit. - * If the mark is defined and larger than the new limit, it is discarded. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The value of the argument is outside the valid range defined by the method. + * - The @c amount is larger than the capacity starting from the current limit. + * - The @c amount is smaller than @c 0. + * @remarks + * - If the position is larger than the new limit, it is set to the new limit. + * - If the mark is defined and is larger than the new limit, it is discarded. * @see SetLimit() */ result ShiftLimit(int amount); @@ -195,7 +201,7 @@ public: * * @since 2.0 * - * @return The capacity of the calling object + * @return The capacity of the calling %BufferBase instance */ int GetCapacity(void) const; @@ -205,7 +211,7 @@ public: * * @since 2.0 * - * @return The limit of the calling object + * @return The limit of the calling %BufferBase instance * @see SetLimit() */ int GetLimit(void) const; @@ -252,12 +258,15 @@ public: * @since 2.0 * * @return An error code - * @param[in] limit The new limit + * @param[in] limit The limit of the calling %BufferBase instance * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method. @n - * The @c limit is larger than the capacity or less than @c 0. - * @remarks If the position is larger than the new limit, it is set to the new limit. - * If the mark is defined and larger than the new limit, it is discarded. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The value of the argument is outside the valid range defined by the method. + * - The specified @c limit is larger than the capacity. + * - The specified @c limit is less than @c 0. + * @remarks + * - If the position is larger than the new limit, it is set to the new limit. + * - If the mark is defined and is larger than the new limit, it is discarded. * @see GetLimit() */ result SetLimit(int limit); @@ -265,9 +274,9 @@ public: /** * Sets the mark of the current instance of %BufferBase at the current position. @n - * If this method is called after InvalidateMark(), the mark is set to @c -1. + * If this method is called after the InvalidateMark() method , the mark is set to @c -1. * - * @since 2.0 + * @since 2.0 * * @see GetMark() */ @@ -280,36 +289,38 @@ public: * @since 2.0 * * @return An error code - * @param[in] position The new position + * @param[in] position The position of the calling %BufferBase instance * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method. @n - * The @c position is larger than the current limit or less than @c 0. - * @remarks If the mark is defined and larger than the new position then it is discarded. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The value of the argument is outside the valid range defined by the method. + * - The specified @c position is larger than the current limit. + * - The specified @c position is less than @c 0. + * @remarks If the mark is defined and is larger than the new position then it is discarded. * @see GetPosition() */ result SetPosition(int position); /** * Returns @c true if there is at least one element between the current position and - * the limit of the current instance of %BufferBase. Otherwise, it returns @c false. + * the limit of the current %BufferBase instance. Otherwise, it returns @c false. * * @since 2.0 * - * @return @c true if there is at least one element between the current position and the limit of the current instance of %BufferBase, @n + * @return @c true if there is at least one element between the current position and the limit of the current %BufferBase instance, @n * else @c false * @see GetRemaining() */ bool HasRemaining(void) const; /** - * Expands the capacity and the limit of the internal buffer with the specified capacity. + * Expands the capacity and the limit of the internal buffer with the specified @c newCapacity. * * @since 2.0 * * @return An error code * @param[in] newCapacity The new capacity of this instance * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c capacity is less than the current capacity. + * @exception E_INVALID_ARG The specified @c newCapacity is less than the current capacity. * @remarks After calling this method, the address of the internal buffer may be either the same or a new location. */ result ExpandCapacity(int newCapacity); @@ -386,7 +397,7 @@ protected: virtual ~_BufferData(void); // - // Gets the pointer to the byte array. + // Gets a pointer to the byte array. // // @since 2.0 // @return Pointer to the @c byte array diff --git a/inc/FBaseByteBuffer.h b/inc/FBaseByteBuffer.h index ad5d64d..594667c 100644 --- a/inc/FBaseByteBuffer.h +++ b/inc/FBaseByteBuffer.h @@ -36,7 +36,7 @@ namespace Tizen { namespace Base * * @since 2.0 * - * The %ByteBuffer class provides a means of encapsulating a sequence of bytes in memory. It defines + * The %ByteBuffer class provides a means of encapsulating a sequence of bytes in the memory. It defines * methods to read and write all primitive built-in types (except @c bool), to and from a sequence of * bytes. These methods read the size of primitive type bytes from a @c byte sequence and * convert it to the actual primitive type. @@ -131,13 +131,12 @@ class _OSP_EXPORT_ ByteBuffer public: /** - * The object is not fully constructed after this constructor is called. + * 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 After creating an instance of the %ByteBuffer class, one of the Construct() methods must be called explicitly to initialize this instance. - * @see Construct() + * @remarks After creating an instance of %ByteBuffer, one of the Construct() methods must be called explicitly to initialize this instance. */ ByteBuffer(void); @@ -149,15 +148,16 @@ public: virtual ~ByteBuffer(void); /** - * Initializes this instance of %ByteBuffer which is a view of the specified buffer. @n - * This is the copy constructor for the %ByteBuffer class. + * Initializes this instance of %ByteBuffer which is a view of the specified @c buffer. @n + * This is the copy constructor of the %ByteBuffer class. * * @since 2.0 * - * @param[in] buffer The %ByteBuffer instance used to initialize new object + * @param[in] buffer The %ByteBuffer instance used to initialize the new object * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the source buffer is not constructed. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The source buffer has not been constructed. * @see ByteBuffer() */ result Construct(const ByteBuffer& buffer); @@ -170,8 +170,9 @@ public: * @return An error code * @param[in] capacity The number of elements * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c capacity is negative. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c capacity is negative. * @see ByteBuffer() */ result Construct(int capacity); @@ -182,22 +183,25 @@ public: * @since 2.0 * * @return An error code - * @param[in] pBuffer The buffer which is shared + * @param[in] pBuffer The shared buffer * @param[in] index The starting index of the buffer from where the first @c byte value is read - * @param[in] length The number of bytes to read from the given buffer @n This is a limit of this instance. + * @param[in] length The number of bytes to read from the given buffer @n + * This is the limit of this instance. * @param[in] capacity The capacity of this instance * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c pBuffer is @c null. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the @c length. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c pBuffer is @c null. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than or equal to the specfied @c capacity. */ result Construct(const byte* pBuffer, int index, int length, int capacity); /** - * Gets the reference to the byte value at the specified index. + * Gets a reference to the @c byte value at the specified @c index. * - * @since 2.0 + * @since 2.0 * * @return A reference to the @c byte value * @param[in] index The index of the @c byte value in the calling %ByteBuffer instance @n @@ -206,42 +210,42 @@ public: byte& operator [](int index); /** - * Gets the byte value at the specified index of const object. + * Gets the @c byte value at the specified @c index of the constant object. * * @since 2.0 * - * @return A value to the @c byte value + * @return The @c byte value at the specified @c index * @param[in] index The index of the @c byte value in the calling %ByteBuffer instance @n * It must be less than the limit. */ byte operator [](int index) const; /** - * Compares the two %ByteBuffer instances. + * Compares two %ByteBuffer instances. * * @since 2.0 * * @return @c true if the input buffer is equal to the calling %ByteBuffer instance, @n * else @c false * @param[in] buffer The %ByteBuffer instance to compare with the current instance - * @remarks This method returns @c true only if the two buffers have the same number of - * remaining elements, and the two sequences of remaining elements are equal - * (considered independently, irrespective of their starting positions). + * @remarks This method returns @c true if the two buffers have the same number of + * remaining elements, and the sequences of the remaining elements are equal + * (considered independently, irrespective of their starting positions). * @see Equals() */ bool operator ==(const ByteBuffer& buffer) const; /** - * Checks whether the current instance and the specified instance of %ByteBuffer are not equal. + * Checks whether the current instance and the specfied %ByteBuffer instance are not equal. * * @since 2.0 * - * @return @c true if the two objects are not the same, @n + * @return @c true if the current instance and the specified %ByteBuffer instance are not equal, @n * else @c false - * @param[in] buffer The buffer to compare with the current instance - * @remarks This method returns @c false only if the two buffers being compared have the same - * number of remaining elements, and the two sequences of remaining elements are equal - * (considered independently, irrespective of their starting positions). + * @param[in] buffer The %ByteBuffer instance to compare with the current instance + * @remarks This method returns @c false if the two buffers have the same + * number of remaining elements, and the sequences of the remaining elements are equal + * (considered independently, irrespective of their starting positions). * @see Equals() */ bool operator !=(const ByteBuffer& buffer) const; @@ -251,11 +255,12 @@ public: * * @since 2.0 * - * @return DoubleBuffer A pointer to the current position of the calling object - * @remarks The content of the view buffer starts at the current position of the calling buffer. - * The new buffer's position is zero, the mark is undefined, and the capacity and limit - * are equal to the remaining part of this buffer divided by the size of @c double. - * Any change to the byte buffer content is visible in the @c double buffer view, and vice versa. + * @return DoubleBuffer A pointer to the current position of the calling object + * @remarks + * - The content of the view buffer starts at the current position of the calling buffer. + * - The new buffer's position is zero, the mark is undefined, and the capacity and limit + * are equal to the remaining part of the calling buffer divided by the size of the @c double value. + * - Any change to the byte buffer content is visible in the @c double buffer view, and vice versa. */ DoubleBuffer* AsDoubleBufferN(void) const; @@ -264,11 +269,12 @@ public: * * @since 2.0 * - * @return FloatBuffer A pointer to the current position of the calling buffer - * @remarks The content of the view buffer starts at the current position of the calling buffer. - * The new buffer's position is zero, the mark is undefined, and the capacity and limit - * are equal to the remaining part of the calling buffer divided by the size of @c float. - * Any change to the byte buffer content is visible in the @c float buffer view, and vice versa. + * @return FloatBuffer A pointer to the current position of the calling buffer + * @remarks + * - The content of the view buffer starts at the current position of the calling buffer. + * - The new buffer's position is zero, the mark is undefined, and the capacity and limit + * are equal to the remaining part of the calling buffer divided by the size of the @c float value. + * - Any change to the byte buffer content is visible in the @c float buffer view, and vice versa. */ FloatBuffer* AsFloatBufferN(void) const; @@ -277,11 +283,12 @@ public: * * @since 2.0 * - * @return IntBuffer A pointer to the current position of the calling buffer - * @remarks The content of the view buffer starts at the current position of the calling buffer. - * The new buffer's position is zero, the mark is undefined, and the capacity and limit - * are equal to the remaining part of calling buffer divided by the size of @c int. - * Any change to the byte buffer content is visible in the Int buffer view, and vice versa. + * @return IntBuffer A pointer to the current position of the calling buffer + * @remarks + * - The content of the view buffer starts at the current position of the calling buffer. + * - The new buffer's position is zero, the mark is undefined, and the capacity and limit + * are equal to the remaining part of the calling buffer divided by the size of the @c int value. + * - Any change to the byte buffer content is visible in the @c int buffer view, and vice versa. */ IntBuffer* AsIntBufferN(void) const; @@ -290,11 +297,12 @@ public: * * @since 2.0 * - * @return LongBuffer A pointer to the current position of the calling buffer - * @remarks The content of the view buffer starts at the current position of this buffer. - * The new buffer's position is zero, the mark is undefined, and the capacity and limit - * are equal to the remaining part of calling buffer divided by the size of @c long. - * Any change to the byte buffer content is visible in the @c long buffer view, and vice versa. + * @return LongBuffer A pointer to the current position of the calling buffer + * @remarks + * - The content of the view buffer starts at the current position of the calling buffer. + * - The new buffer's position is zero, the mark is undefined, and the capacity and limit + * are equal to the remaining part of the calling buffer divided by the size of the @c long value. + * - Any change to the byte buffer content is visible in the @c long buffer view, and vice versa. */ LongBuffer* AsLongBufferN(void) const; @@ -303,11 +311,12 @@ public: * * @since 2.0 * - * @return LongLongBuffer A pointer to the current position of the calling buffer - * @remarks The content of the view buffer starts at the current position of this buffer. - * The new buffer's position is zero, the mark is undefined, and the capacity and limit - * are equal to the remaining part of calling buffer divided by the size of @c long. - * Any change to the byte buffer content is visible in the @c long @c long buffer view, and vice versa. + * @return LongLongBuffer A pointer to the current position of the calling buffer + * @remarks + * - The content of the view buffer starts at the current position of the calling buffer. + * - The new buffer's position is zero, the mark is undefined, and the capacity and limit + * are equal to the remaining part of the calling buffer divided by the size of the @c long @c long value. + * - Any change to the byte buffer content is visible in the @c long @c long buffer view, and vice versa. */ LongLongBuffer* AsLongLongBufferN(void) const; @@ -315,31 +324,32 @@ public: * @if OSPDEPREC * Creates a new @c mchar buffer view of the underlying content of the byte buffer. * - * @brief [Deprecated] - * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. - * Instead of using this method, use the AsWcharBufferN() method. + * @brief [Deprecated] + * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. + * Instead of using this method, use the AsWcharBufferN() method. * @since 2.0 * - * @return McharBuffer A pointer to the current position of the calling buffer - * @remarks The content of the view buffer starts at the current position of this buffer. - * The new buffer's position is zero, the mark is undefined, and the capacity and limit - * are equal to the remaining part of the calling buffer divided by the size of @c long. - * Any change to the byte buffer content is visible in the @c mchar buffer view, and vice versa. + * @return McharBuffer A pointer to the current position of the calling buffer + * @remarks + * - The content of the view buffer starts at the current position of the calling buffer. + * - The new buffer's position is zero, the mark is undefined, and the capacity and limit + * are equal to the remaining part of the calling buffer divided by the size of the @c mchar value. + * - Any change to the byte buffer content is visible in the @c mchar buffer view, and vice versa. * @endif */ McharBuffer* AsMcharBufferN(void) const; /** - * Creates a new wchar Buffer view of the underlying content of the byte buffer. + * Creates a new @c wchar buffer view of the underlying content of the byte buffer. * * @since 2.0 * - * @return WcharBuffer pointer to the current position of the calling buffer - * @remarks The content of the view buffer start at the current position of this buffer. @n - * The new buffer's position is zero, the mark is undefined, and the capacity and limit - * are equal to the remaining part of the calling buffer divided by the size of @c long. @n - * Any changes to the calling buffer's content (that is, the content of %ByteBuffer instance) @n - * are visible in the WcharBuffer view, and vice versa. + * @return WcharBuffer A pointer to the current position of the calling buffer + * @remarks + * - The content of the view buffer start at the current position of the calling buffer. + * - The new buffer's position is zero, the mark is undefined, and the capacity and limit + * are equal to the remaining part of the calling buffer divided by the size of the @c wchar value. + * - Any change to the byte buffer content is visible in the @c wchar buffer view, and vice versa. */ WcharBuffer* AsWcharBufferN(void) const; @@ -348,39 +358,42 @@ public: * * @since 2.0 * - * @return ShortBuffer pointer to the current position of the calling buffer - * @remarks The content of the view buffer starts at the current position of this buffer. - * The new buffer's position is zero, the mark is undefined, and the capacity and limit - * are equal to the remaining part of calling buffer divided by the size of @c long. - * Any change to the byte buffer content is visible in the @c short buffer view, and vice versa. + * @return ShortBuffer A pointer to the current position of the calling buffer + * @remarks + * - The content of the view buffer starts at the current position of the calling buffer. + * - The new buffer's position is zero, the mark is undefined, and the capacity and limit + * are equal to the remaining part of the calling buffer divided by the size of the @c short value. + * - Any change to the byte buffer content is visible in the @c short buffer view, and vice versa. */ ShortBuffer* AsShortBufferN(void) const; /** * Copies the remaining bytes of the input %ByteBuffer instance into the calling %ByteBuffer object. @n - * It returns E_OVERFLOW if the remaining bytes in the current instance are less + * It returns @c E_OVERFLOW if the remaining bytes in the current instance are less * than the remaining bytes in the input instance. * * @since 2.0 * * @return An error code - * @param[in] buffer The source buffer from which bytes are read @n - * It must not be the calling object. + * @param[in] buffer The source buffer from which bytes are read @n + * It must not be the calling object. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. @n - * The source buffer is same as destination buffer, - * that is, the current instance of the buffer. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow. @n - * The number of remaining bytes of the current buffer is smaller than - * the number of remaining bytes of the input buffer. - * @remarks After the copy operation, the current (destination) buffer's position and the given + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The source buffer is same as the destination buffer, + * that is, the current instance of the buffer. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The number of remaining bytes in the current buffer is smaller than + * the number of remaining bytes in the input buffer. + * @remarks + * - After the copy operation, the current (destination) buffer's position and the given * (source) buffer's positions are incremented by the number of bytes copied (the number of - * remaining bytes of the given buffer). @n - * If the remaining part of the current instance is greater than or equal to the remaining part of the input instance, - * the effect of this method and the ReadFrom(%ByteBuffer) method is the same. But when the remaining part of the - * current instance is less, the ReadFrom() method copies the number of remaining elements of the current - * instance while this method returns E_OVERFLOW and does not copy. - * @see ReadFrom() + * remaining bytes in the given buffer). + * - If the remaining part of the current instance is greater than or equal to the remaining part of the input instance, + * the effect of this method and the ReadFrom() method is the same. @n + * If the remaining part of the current instance is less, the %ReadFrom() method + * copies the number of remaining elements of the current instance while this method returns @c E_OVERFLOW and does not copy. * * The following example demonstrates how to use the %CopyFrom() method. * @@ -439,18 +452,21 @@ public: * @since 2.0 * * @return An error code - * @param[out] pArray A pointer to the destination array into which the bytes are written - * @param[in] index The starting index in the array of the first byte to write - * @param[in] length The number of bytes to write to the given array + * @param[out] pArray A pointer to the destination array into which the bytes are written + * @param[in] index The starting index of the array where the first byte is written + * @param[in] length The number of bytes to write into the given array * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c pArray is @c null. - * @exception E_OUT_OF_RANGE A specified input parameter is invalid. @n - * The @c index or @c length is less than @c 0. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * the remaining bytes of this buffer are smaller than @c length. - * @remarks This method copies @c length bytes from the current instance of %ByteBuffer to the given array, - * starting at the current position and at the given index in the array. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c pArray is @c null. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c index or the specified @c length is less than @c 0. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The remaining bytes of this buffer are smaller than the specified @c length. + * @remarks This method copies @c length bytes from the current instance of %ByteBuffer into the given array, + * starting from the current position and the given index in the array. @n * After the copy operation, the position is incremented by @c length bytes. * @see SetArray() */ @@ -458,354 +474,381 @@ public: /** * Gets the @c byte value from the buffer at the current position, and then increments the position. @n - * Provides a way for relative indexing and reading. + * It provides a way to perform relative indexing and reading. * * @since 2.0 * * @return An error code * @param[out] value The @c byte value at the current position in the %ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * the current position is not smaller than the limit. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The current position is not smaller than the limit. * @see SetByte() */ result GetByte(byte& value); /** * Gets the @c byte value at the given index. @n - * Provides a way for absolute indexing and reading. + * It provides a way to perform absolute indexing and reading. * * @since 2.0 * * @return An error code - * @param[in] index The index of the current %ByteBuffer instance, from which the byte is read - * @param[out] value The @c byte value at the given @c index + * @param[in] index The index of the current %ByteBuffer instance, from which the byte is read + * @param[out] value The @c byte value at the given @c index * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is not smaller than the limit or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is not smaller than the limit. + * - The specified @c index is less than @c 0. * @see SetByte() */ result GetByte(int index, byte& value) const; /** - * Gets the size of @c double number of bytes from the buffer at the current position, converts + * Gets the size of the @c double number of bytes from the buffer at the current position, converts * it to the corresponding @c double equivalent, and then increments the position. @n - * Provides a way for relative indexing and reading. + * It provides a way to perform relative indexing and reading. * * @since 2.0 * * @return An error code * @param[out] value The @c double value at the current position in the %ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * the remaining bytes of this buffer are smaller than the size of @c double. - * @remarks This method reads the next size of @c double number of bytes at the current position, - * composing it into a @c double value, and then increments the position by the size of @c double. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The remaining bytes in this buffer are smaller than the size of the @c double value. + * @remarks This method reads the next size of the @c double number of bytes at the current position, + * converts it into a @c double value, and then increments the position by the size of the @c double value. * @see SetDouble() */ result GetDouble(double& value); /** - * Gets the size of @c double number of bytes at the given index and converts it to the equivalent @c double value. @n - * Provides a way for absolute indexing and reading. + * Gets the size of the @c double number of bytes at the given index and converts it to the equivalent @c double value. @n + * It provides a way to perform absolute indexing and reading. * * @since 2.0 * * @return An error code - * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read - * @param[out] value The @c double value at the given index + * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read + * @param[out] value The @c double value at the given @c index * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus size of @c double or less than @c 0. - * @remarks This method reads size of @c double number of bytes at the given index, - * composing them into a @c double value. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c double value. + * - The specified @c index is less than @c 0. + * @remarks This method reads the size of the @c double number of bytes at the given @c index + * and converts it into a @c double value. * @see SetDouble() */ result GetDouble(int index, double& value) const; /** - * Gets the size of @c float number of bytes from the buffer at the current position, converts + * Gets the size of the @c float number of bytes from the buffer at the current position, converts * it to the corresponding @c float equivalent, and then increments the position. @n - * Provides a way for relative indexing and reading. + * It provides a way to perform relative indexing and reading. * * @since 2.0 * * @return An error code * @param[out] value The @c float value at the current position in the %ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * the remaining bytes of this buffer are smaller than the size of @c float. - * @remarks This method reads the next size of @c float number of bytes at the current position, - * composing it into a @c float value, and then increments the position by the size of @c float. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The remaining bytes of this buffer are smaller than the size of the @c float value. + * @remarks This method reads the next size of the @c float number of bytes at the current position, + * converts it into a @c float value, and then increments the position by the size of the @c float value. * @see SetFloat() */ result GetFloat(float& value); /** - * Gets the size of @c float number of bytes at the given index and converts it to equivalent @c float value. @n - * Provides a way for absolute indexing and reading. + * Gets the size of the @c float number of bytes at the given index and converts it to an equivalent @c float value. @n + * It provides a way to perform absolute indexing and reading. * * @since 2.0 * * @return An error code - * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read - * @param[out] value The @c float value at the given index + * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read + * @param[out] value The @c float value at the given @c index * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus size of @c float or less than @c 0. - * @remarks This method reads the size of @c float number of bytes at the given index, - * composing it into a @c float value. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c float value. + * - The specified @c index is less than @c 0. + * @remarks This method reads the size of the @c float number of bytes at the given @c index + * and converts it into a @c float value. * @see SetFloat() */ result GetFloat(int index, float& value) const; /** - * Gets the size of @c int number of bytes from the buffer at the current position, converts + * Gets the size of the @c int number of bytes from the buffer at the current position, converts * it to the corresponding @c int equivalent, and then increments the position. @n - * Provides a way for relative indexing and reading. + * It provides a way to perform relative indexing and reading. * * @since 2.0 * * @return An error code * @param[out] value The @c int value at the current position in the %ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * the remaining bytes of this buffer are smaller than the size of @c int. - * @remarks This method reads the next size of @c int number of bytes at the current position, - * composing them into an @c int value, and then increments the position by the size of @c int. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The remaining bytes of this buffer are smaller than the size of the @c int value. + * @remarks This method reads the next size of the @c int number of bytes at the current position, + * converts them into an @c int value, and then increments the position by the size of the @c int value. * @see SetInt() */ result GetInt(int& value); /** - * Gets the size of @c int number of bytes at the given index and converts it to the equivalent @c int value. @n - * Provides a way for absolute indexing and reading. + * Gets the size of the @c int number of bytes at the given @c index and converts it to the equivalent @c int value. @n + * It provides a way to perform absolute indexing and reading. * * @since 2.0 * * @return An error code - * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read - * @param[out] value The @c int value at the given index + * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read + * @param[out] value The @c int value at the given @c index * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus size of @c int or negative. - * @remarks This method reads the size of @c int number of bytes at the given index, - * composing it into an @c int value. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c int. + * - The specified @c index is negative. + * @remarks This method reads the size of the @c int number of bytes at the given @c index + * and converts it into an @c int value. * @see SetInt() */ result GetInt(int index, int& value) const; /** - * Gets the size of @c long number of bytes from the buffer at the current position, converts + * Gets the size of the @c long number of bytes from the buffer at the current position, converts * it to the corresponding @c long equivalent, and then increments the position. @n - * Provides a way for relative indexing and reading. + * It provides a way to perform relative indexing and reading. * * @since 2.0 * * @return An error code * @param[out] value The @c long value at the current position in the %ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * the remaining bytes of this buffer are smaller than the size of @c long. - * @remarks This method reads the next size of @c long number of bytes at the current position, - * composing it into a @c long value, and then increments the position by the size of @c long. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The remaining bytes of this buffer are smaller than the size of the @c long value. + * @remarks This method reads the next size of the @c long number of bytes at the current position, + * converts it into a @c long value, and then increments the position by the size of the @c long value. * @see SetLong() */ result GetLong(long& value); /** - * Gets the size of @c long number of bytes at the given index and converts it to equivalent @c long value. @n - * Provides a way for absolute indexing and reading. + * Gets the size of the @c long number of bytes at the given @c index and converts it to the equivalent @c long value. @n + * It provides a way to perform absolute indexing and reading. * * @since 2.0 * * @return An error code - * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read - * @param[out] value The @c long value at the given index + * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read + * @param[out] value The @c long value at the given @c index * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus size of @c long or less than @c 0. - * @remarks This method reads the size of @c long number of bytes at the given index, - * composing it into a @c long value. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c long value. + * - The specified @c index is less than @c 0. + * @remarks This method reads the size of the @c long number of bytes at the given @c index + * and converts it into a @c long value. * @see SetLong() */ result GetLong(int index, long& value) const; /** - * Gets the size of @c long @c long number of bytes from the buffer at the current position, converts + * Gets the size of the @c long @c long number of bytes from the buffer at the current position, converts * it to the corresponding @c long @c long equivalent, and then increments the position. @n - * Provides a way for relative indexing and reading. + * It provides a way to perform relative indexing and reading. * * @since 2.0 * * @return An error code * @param[out] value The @c long @c long value at the current position in the %ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * the remaining bytes of this buffer are smaller than the size of @c long @c long. - * @remarks This method reads the next size of @c long @c long number of bytes at the current position, - * composing it into a @c long @c long value, and then increments the position by the size of @c long @c long. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The remaining bytes of this buffer are smaller than the size of the @c long @c long value. + * @remarks This method reads the next size of the @c long @c long number of bytes at the current position, + * converts it into a @c long @c long value, and then increments the position by the size of the @c long @c long value. * @see SetLongLong() */ result GetLongLong(long long& value); /** - * Gets the size of @c long @c long number of bytes at the given index and converts it to the equivalent @c long @c long value. @n - * Provides a way for absolute indexing and reading. + * Gets the size of the @c long @c long number of bytes at the given @c index and converts it to the equivalent @c long @c long value. @n + * It provides a way to perform absolute indexing and reading. * * @since 2.0 * * @return An error code - * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read - * @param[out] value The @c long @c long value at the given index + * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read + * @param[out] value The @c long @c long value at the given @c index * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus size of @c long @c long or less than @c 0. - * @remarks This method reads the size of @c long @c long number of bytes at the given index, - * composing it into a @c long @c long value. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c long @c long value. + * - The specified @c index is less than @c 0. + * @remarks This method reads the size of the @c long @c long number of bytes at the given @c index + * and converts it into a @c long @c long value. * @see SetLongLong() */ result GetLongLong(int index, long long& value) const; /** * @if OSPDEPREC - * Gets the size of @c wchar_t number of bytes from the buffer at the current position, converts + * Gets the size of the @c wchar_t number of bytes from the buffer at the current position, converts * it to the corresponding @c wchar_t equivalent, and then increments the position. @n - * Provides a way for relative indexing and reading. + * It provides a way to perform relative indexing and reading. * - * @brief [Deprecated] - * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. - * Instead of using this method, use the GetWchar(wchar_t& value) method. + * @brief [Deprecated] + * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. + * Instead of using this method, use the GetWchar(wchar_t& value) method. * @since 2.0 * * @return An error code * @param[out] value The @c wchar_t value at the current position in the %ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * the remaining bytes of this buffer are smaller than the size of @c wchar_t. - * @remarks This method reads the next size of @c wchar_t number of bytes at the current position, - * composing it into a @c wchar_t value, and then increments the position by the size of @c wchar_t. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The remaining bytes of this buffer are smaller than the size of the @c wchar_t value. + * @remarks This method reads the next size of the @c wchar_t number of bytes at the current position, + * converts it into a @c wchar_t value, and then increments the position by the size of the @c wchar_t value. * @see SetMchar() * @endif */ result GetMchar(wchar_t& value); /** - * Gets the size of @c wchar_t number of bytes from the buffer at the current position, converts + * Gets the size of the @c wchar_t number of bytes from the buffer at the current position, converts * it to the corresponding @c wchar_t equivalent, and then increments the position. @n - * Provides a way for relative indexing and reading. + * It provides a way to perform relative indexing and reading. * * @since 2.0 * * @return An error code * @param[out] value The @c wchar_t value at the current position in the %ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * the remaining bytes of this buffer are smaller than the size of @c wchar_t. - * @remarks This method reads the next size of @c wchar_t number of bytes at the current position, - * composing it into a @c wchar_t value, and then increments the position by the size of @c wchar_t. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The remaining bytes of this buffer are smaller than the size of the @c wchar_t value. + * @remarks This method reads the next size of the @c wchar_t number of bytes at the current position, + * converts it into a @c wchar_t value, and then increments the position by the size of the @c wchar_t value. * @see SetWchar() */ result GetWchar(wchar_t& value); /** * @if OSPDEPREC - * Provides a way for absolute indexing and reading. @n - * It reads the size of @c wchar_t number of bytes at the given index and converts it to equivalent @c wchar_t value. + * Provides a way to perform absolute indexing and reading. @n + * It reads the size of the @c wchar_t number of bytes at the given @c index and converts it to the equivalent @c wchar_t value. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. - * Instead of using this method, use the GetWchar(int index, wchar_t& value) method. + * Instead of using this method, use the GetWchar(int index, wchar_t& value) method. * @since 2.0 * * @return An error code - * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read - * @param[out] value The @c wchar_t value at the given index + * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read + * @param[out] value The @c wchar_t value at the given @c index * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus size of @c wchar_t or less than @c 0. - * @remarks This method reads the size of @c wchar_t number of bytes at the given index, - * composing it into a @c wchar_t value. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c wchar_t value. + * - The specified @c index is less than @c 0. + * @remarks This method reads the size of the @c wchar_t number of bytes at the given @c index + * and converts it into a @c wchar_t value. * @see SetMchar() * @endif */ result GetMchar(int index, wchar_t& value) const; /** - * Provides a way for absolute indexing and reading. @n - * It reads the size of @c wchar_t number of bytes at the given index and converts it to equivalent @c wchar_t value. + * Provides a way to perform absolute indexing and reading. @n + * It reads the size of the @c wchar_t number of bytes at the given @c index and converts it to the equivalent @c wchar_t value. * * @since 2.0 * * @return An error code * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read - * @param[out] value The @c wchar_t value at the given index + * @param[out] value The @c wchar_t value at the given @c index * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus size of @c wchar_t or less than @c 0. - * @remarks This method reads the size of @c wchar_t number of bytes at the given index, - * composing it into a @c wchar_t value. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c wchar_t value. + * - The specified @c index is less than @c 0. + * @remarks This method reads the size of the @c wchar_t number of bytes at the given @c index + * and converts it into a @c wchar_t value. * @see SetWchar() */ result GetWchar(int index, wchar_t& value) const; /** - * Gets the size of @c short number of bytes from the buffer at the current position, converts + * Gets the size of the @c short number of bytes from the buffer at the current position, converts * it to the corresponding @c short equivalent, and then increments the position. @n - * Provides a way for relative indexing and reading. + * Provides a way to perform relative indexing and reading. * * @since 2.0 * * @return An error code * @param[out] value The @c short value at the current position in the %ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * the remaining bytes of this buffer are smaller than the size of @c short. - * @remarks This method reads the next size of @c short number of bytes at the current position, - * composing it into a @c short value, and then increments the position by the size of @c short. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The remaining bytes of this buffer are smaller than the size of the @c short value. + * @remarks This method reads the next size of the @c short number of bytes at the current position, + * converts it into a @c short value, and then increments the position by the size of the @c short value. * @see SetShort() */ result GetShort(short& value); /** - * Gets the size of @c short number of bytes at the given index and converts it to the equivalent @c short value. @n - * Provides a way for absolute indexing and reading. + * Gets the size of the @c short number of bytes at the given @c index and converts it to the equivalent @c short value. @n + * Provides a way to perform absolute indexing and reading. * * @since 2.0 * * @return An error code - * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read - * @param[out] value The @c short value at the given index + * @param[in] index The index of the current %ByteBuffer instance, from which the bytes are read + * @param[out] value The @c short value at the given @c index * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus size of @c short or less than @c 0. - * @remarks This method reads the size of @c short number of bytes at the given index, - * composing it into a @c short value. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c short value. + * - The specified @c index is less than @c 0. + * @remarks This method reads the size of the @c short number of bytes at the given @c index + * and converts it into a @c short value. * @see SetShort() */ result GetShort(int index, short& value) const; /** - * Copies the remaining bytes of the input %ByteBuffer instance into the calling %ByteBuffer instance + * Copies the remaining bytes of the input %ByteBuffer instance into the calling %ByteBuffer instance, * if the remaining part of the current instance is greater than or equal to the remaining part of the input instance. @n * Otherwise, the number of bytes copied is equal to the number of remaining elements of the current instance. * * @since 2.0 * * @return An error code - * @param[in] buffer The source buffer from which bytes are read @n - * It must not be the calling %ByteBuffer instance. + * @param[in] buffer The source buffer from which bytes are read @n + * It must not be the calling %ByteBuffer instance. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * - * @remarks After the copy operation, the current (destination) buffer's position and the given - * (source) buffer's position are incremented by the number of elements copied (the lesser of - * the number of elements remaining in the current buffer and the given buffer). @n - * If the remaining part of the current instance is greater than or equal to the remaining part of the input instance, - * the effect of this method is the same as the CopyFrom() method. But when the remaining part of the - * current instance is less, the CopyFrom() method returns E_OVERFLOW and does not transfer; + * @remarks + * - After the copy operation, the current (destination) buffer's position and the given + * (source) buffer's position are incremented by the number of elements copied (the lesser of + * the number of elements remaining in the current buffer and the given buffer). + * - If the remaining part of the current instance is greater than or equal to the remaining part of the input instance, + * the effect of this method is the same as the CopyFrom() method. @n + * If the remaining part of the current instance is less, the %CopyFrom() method returns @c E_OVERFLOW and does not transfer; * whereas this method copies the number of remaining elements of the current instance. - * @see CopyFrom() * * The following example demonstrates how to use the %ReadFrom() method. * @@ -866,24 +909,27 @@ public: result ReadFrom(ByteBuffer& buffer); /** - * Sets the @c byte values on the specified array to the current instance of %ByteBuffer. + * Sets the @c byte values in the specified array to the current instance of %ByteBuffer. * * @since 2.0 * * @return An error code - * @param[in] pArray The array from which bytes are read - * @param[in] index The starting index of the array from where the first @c byte value is read - * @param[in] length The number of bytes to read from the given array + * @param[in] pArray The array from which the bytes are read + * @param[in] index The starting index of the array from where the first @c byte value is read + * @param[in] length The number of bytes to read from the given array * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c pArray is @c null. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index or length is less than @c 0. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or - * the remaining bytes are smaller than @c length. - * @remarks This method copies the specified number (@c length) of @c byte values into - * the calling object of buffer from the source array, - * starting from the current position, and at the given index in the array. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c pArray is @c null. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index or the specified @c length is less than @c 0. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The remaining bytes are smaller than the specified @c length. + * @remarks This method copies the specified number (@c length) of @c byte values from the source array + * into the calling object of the buffer, starting from the current position, + * and at the given index in the array. @n * After the copy operation, the position is incremented by @c length. * @see GetArray() */ @@ -892,31 +938,34 @@ public: /** * Sets the given @c byte value into the calling %ByteBuffer object * at the current position, and then increments the position. @n - * Provides a way for relative indexing and writing. + * It provides a way to perform relative indexing and writing. * * @since 2.0 * * @return An error code * @param[in] value The @c byte value to write to the current instance of %ByteBuffer * @exception E_SUCCESS The method is successful. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or - * the current position is not smaller than the limit. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The current position is not smaller than the limit. * @see GetByte() */ result SetByte(byte value); /** - * Sets the given @c byte value into the calling %ByteBuffer object at the specified index. @n - * Provides a way for absolute indexing and writing. + * Sets the given @c byte value into the calling %ByteBuffer object at the specified @c index. @n + * Provides a way to perform absolute indexing and writing. * * @since 2.0 * * @return An error code - * @param[in] index The index of the current instance of %ByteBuffer at which the byte is written - * @param[in] value The @c byte value to write + * @param[in] index The index of the current instance of %ByteBuffer at which the byte is written + * @param[in] value The @c byte value to write * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is not smaller than the limit or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is not smaller than the limit. + * - The specified @c index is less than @c 0. * @see GetByte() */ result SetByte(int index, byte value); @@ -924,17 +973,18 @@ public: /** * Sets the given @c double value into the calling %ByteBuffer object * at the current position, and then increments the position. @n - * Provides a way for relative indexing and writing. + * It provides a way to perform relative indexing and writing. * * @since 2.0 * * @return An error code * @param[in] value The @c double value to write * @exception E_SUCCESS The method is successful. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or - * the remaining bytes of this buffer are smaller than the size of @c double. - * @remarks This method writes the size of @c double number of bytes containing the given @c double value - * into the calling buffer, at the current position, and then increments the position by the size of @c double. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The remaining bytes of this buffer are smaller than the size of the @c double value. + * @remarks This method writes the size of the @c double number of bytes containing the given @c double value + * into the calling buffer, at the current position, and then increments the position by the size of the @c double value. * @see GetDouble() */ result SetDouble(double value); @@ -942,17 +992,18 @@ public: /** * Sets the given @c float value into the calling %ByteBuffer object * at the current position, and then increments the position. @n - * Provides a way for relative indexing and writing. + * It provides a way to perform relative indexing and writing. * * @since 2.0 * * @return An error code * @param[in] value The @c float value to write * @exception E_SUCCESS The method is successful. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or - * the remaining bytes of this buffer are smaller than the size of @c float. - * @remarks This method writes the size of @c float number of bytes containing the given @c float value - * into this buffer at the current position, and then increments the position by the size of @c float. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The remaining bytes of this buffer are smaller than the size of the @c float value. + * @remarks This method writes the size of the @c float number of bytes containing the given @c float value + * into the calling buffer, at the current position, and then increments the position by the size of the @c float value. * @see GetFloat() */ result SetFloat(float value); @@ -960,17 +1011,18 @@ public: /** * Sets the given @c int value into the calling %ByteBuffer instance at the current * position, and then increments the position. @n - * Provides a way for relative indexing and writing. + * It provides a way to perform relative indexing and writing. * * @since 2.0 * * @return An error code * @param[in] value The @c int value to write * @exception E_SUCCESS The method is successful. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or - * the remaining bytes of this buffer are smaller than the size of @c int. - * @remarks This method writes the size of @c int number of bytes containing the given @c int value - * into this buffer at the current position, and then increments the position by the size of @c int. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The remaining bytes of this buffer are smaller than the size of the @c int value. + * @remarks This method writes the size of the @c int number of bytes containing the given @c int value + * into the calling buffer, at the current position, and then increments the position by the size of the @c int value. * @see GetInt() */ result SetInt(int value); @@ -978,263 +1030,285 @@ public: /** * Sets the given @c long value into the calling %ByteBuffer instance at the current * position, and then increments the position. @n - * Provides a way for relative indexing and writing. + * It provides a way to perform relative indexing and writing. * * @since 2.0 * * @return An error code * @param[in] value The @c long value to write * @exception E_SUCCESS The method is successful. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or - * the remaining bytes of this buffer are smaller than size of @c long. - * @remarks This method writes the size of @c long number of bytes containing the given @c long value - * into this buffer at the current position, and then increments the position by the size of @c long. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The remaining bytes of this buffer are smaller than the size of the @c long value. + * @remarks This method writes the size of the @c long number of bytes containing the given @c long value + * into the calling buffer, at the current position, and then increments the position by the size of the @c long value. * @see GetLong() */ result SetLong(long value); /** - * Sets the given @c long @c long value into the calling %ByteBuffer object at the current + * Sets the given @c long @c long value into the calling %ByteBuffer instance at the current * position, and then increments the position. @n - * Provides a way for relative indexing and writing. + * It provides a way to perform relative indexing and writing. * * @since 2.0 * * @return An error code * @param[in] value The @c long @c long value to write * @exception E_SUCCESS The method is successful. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or - * the remaining bytes of this buffer are smaller than the size of @c long @c long. - * @remarks This method writes the size of @c long @c long number of bytes containing the given @c long @c long value - * into this buffer at the current position, and then increments the position by the size of @c long @c long. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The remaining bytes of this buffer are smaller than the size of the @c long @c long value. + * @remarks This method writes the size of the @c long @c long number of bytes containing the given @c long @c long value + * into the calling buffer, at the current position, and then increments the position by the size of the @c long @c long value. * @see GetLongLong() */ result SetLongLong(long long value); /** * @if OSPDEPREC - * Sets the given @c wchar_t value into the calling %ByteBuffer object at the current + * Sets the given @c wchar_t value into the calling %ByteBuffer instance at the current * position, and then increments the position. @n - * Provides a way for relative indexing and writing. + * It provides a way to perform relative indexing and writing. * - * @brief [Deprecated] - * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. - * Instead of using this method, use the SetWchar(wchar_t value) method. + * @brief [Deprecated] + * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. + * Instead of using this method, use the SetWchar(wchar_t value) method. * @since 2.0 * * @return An error code * @param[in] value The @c wchar_t value to write * @exception E_SUCCESS The method is successful. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or - * the remaining bytes of this buffer are smaller than size of @c wchar_t. - * @remarks This method writes the size of @c wchar_t number of bytes containing the given @c wchar_t value - * into this buffer at the current position, and then increments the position by the size of @c wchar_t. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The remaining bytes of this buffer are smaller than the size of the @c wchar_t value. + * @remarks This method writes the size of the @c wchar_t number of bytes containing the given @c wchar_t value + * into the calling buffer, at the current position, and then increments the position by the size of the @c wchar_t value. * @see GetMchar() * @endif */ result SetMchar(wchar_t value); /** - * Sets the given @c wchar_t value into the calling %ByteBuffer object at the current + * Sets the given @c wchar_t value into the calling %ByteBuffer instance at the current * position, and then increments the position. @n - * Provides a way for relative indexing and writing. + * It provides a way to perform relative indexing and writing. * * @since 2.0 * * @return An error code * @param[in] value The @c wchar_t value to write * @exception E_SUCCESS The method is successful. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or - * the remaining bytes of this buffer are smaller than size of @c wchar_t. - * @remarks This method writes the size of @c wchar_t number of bytes containing the given @c wchar_t value - * into this buffer at the current position, and then increments the position by the size of @c wchar_t. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The remaining bytes of this buffer are smaller than the size of the @c wchar_t value. + * @remarks This method writes the size of the @c wchar_t number of bytes containing the given @c wchar_t value + * into the calling buffer, at the current position, and then increments the position by the size of the @c wchar_t value. * @see GetWchar() */ result SetWchar(wchar_t value); /** - * Sets the given @c short value into the current instance of %ByteBuffer at the current + * Sets the given @c short value into the current %ByteBuffer instance at the current * position, and then increments the position. @n - * Provides a way for relative indexing and writing. + * Provides a way to perform relative indexing and writing. * * @since 2.0 * * @return An error code * @param[in] value The @c short value to write * @exception E_SUCCESS The method is successful. - * @exception E_OVERFLOW The operation (arithmetic/casting/conversion) has caused an overflow, or - * the remaining bytes of this buffer are smaller than the size of @c short. - * @remarks This method writes the size of @c short number of bytes containing the given @c short value - * into this buffer at the current position, and then increments the position by the size of @c short. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an overflow. + * - The remaining bytes of this buffer are smaller than the size of the @c short value. + * @remarks This method writes the size of the @c short number of bytes containing the given @c short value + * into the calling buffer, at the current position, and then increments the position by the size of the @c short value. * @see GetShort() */ result SetShort(short value); /** - * Sets a @c double value at the specified index of the current instance of %ByteBuffer. @n - * Provides a way for absolute indexing and writing. + * Sets a @c double value at the specified @c index of the current %ByteBuffer instance. @n + * It provides a way to perform absolute indexing and writing. * * @since 2.0 * * @return An error code - * @param[in] index The index of current instance of %ByteBuffer at which the bytes are written - * @param[in] value The @c double value to write + * @param[in] index The index of the current instance of %ByteBuffer at which the bytes are written + * @param[in] value The @c double value to write * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus the size of @c double or less than @c 0. - * @remarks This method writes the size of @c double number of bytes containing the given @c double value - * into this buffer at the given index. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c double value. + * - The specified @c index is less than @c 0. + * @remarks This method writes the size of the @c double number of bytes containing the given @c double value + * into the calling buffer, at the given @c index. * @see GetDouble() */ result SetDouble(int index, double value); /** - * Sets a @c float value at the specified index of the calling %ByteBuffer object. @n - * Provides a way for absolute indexing and writing. + * Sets a @c float value at the specified @c index of the calling %ByteBuffer instance. @n + * It provides a way to perform absolute indexing and writing. * * @since 2.0 * * @return An error code - * @param[in] index The index of current instance of %ByteBuffer at which the bytes are written - * @param[in] value The @c float value to write + * @param[in] index The index of the current instance of %ByteBuffer at which the bytes are written + * @param[in] value The @c float value to write * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus the size of @c float or less than @c 0. - * @remarks This method writes the size of @c float number of bytes containing the given @c float value - * into this buffer at the given index. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c float value. + * - The specified @c index is less than @c 0. + * @remarks This method writes the size of the @c float number of bytes containing the given @c float value + * into the calling buffer, at the given @c index. * @see GetFloat() */ result SetFloat(int index, float value); /** - * Sets a @c int value at the specified index of the calling %ByteBuffer object. @n - * Provides a way for absolute indexing and writing. + * Sets a @c int value at the specified @c index of the calling %ByteBuffer instance. @n + * It provides a way to perform absolute indexing and writing. * * @since 2.0 * * @return An error code - * @param[in] index The index of current instance of %ByteBuffer at which the bytes are written - * @param[in] value The @c int value to write - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus size of @c int or less than @c 0. - * @remarks This method writes the size of @c int number of bytes containing the given @c int value - * into this buffer at the given index. + * @param[in] index The index of the current instance of %ByteBuffer at which the bytes are written + * @param[in] value The @c int value to write + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c int value. + * - The specified @c index is less than @c 0 + * @remarks This method writes the size of the @c int number of bytes containing the given @c int value + * into the calling buffer, at the given @c index. * @see GetInt() */ result SetInt(int index, int value); /** - * Sets a @c long value at the specified index of the calling %ByteBuffer object. @n - * Provides a way for absolute indexing and writing. + * Sets a @c long value at the specified index of the calling %ByteBuffer instance. @n + * It provides a way to perform absolute indexing and writing. * * @since 2.0 * * @return An error code - * @param[in] index The index at which the bytes are written - * @param[in] value The @c long value to write + * @param[in] index The index at which the bytes are written + * @param[in] value The @c long value to write * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus the size of @c long or less than @c 0. - * @remarks This method writes size of @c long number of bytes containing the given @c long value - * into this buffer at the given index. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c long value. + * - The specified @c index is less than @c 0. + * @remarks This method writes the size of the @c long number of bytes containing the given @c long value + * into the calling buffer, at the given @c index. * @see GetLong() */ result SetLong(int index, long value); /** - * Sets a @c long @c long value at the specified index of the calling %ByteBuffer object. @n - * Provides a way for absolute indexing and writing. + * Sets a @c long @c long value at the specified @c index of the calling %ByteBuffer instance. @n + * It provides a way to perform absolute indexing and writing. * * @since 2.0 * * @return An error code - * @param[in] index The index at which the bytes will be written - * @param[in] value The @c long @c long value to write + * @param[in] index The index at which the bytes are written + * @param[in] value The @c long @c long value to write * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus the size of @c long @c long or less than @c 0. - * @remarks This method writes the size of @c long @c long number of bytes containing the given @c long @c long value - * into this buffer at the given index. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c long @c long value. + * - The specified @c index is less than @c 0. + * @remarks This method writes the size of the @c long @c long number of bytes containing the given @c long @c long value + * into the calling buffer, at the given @c index. * @see GetLongLong() */ result SetLongLong(int index, long long value); /** * @if OSPDEPREC - * Sets a @c wchar_t value at the specified index of the calling %ByteBuffer object. @n - * Provides a way for absolute indexing and writing. + * Sets a @c wchar_t value at the specified @c index of the calling %ByteBuffer instance. @n + * It provides a way to perform absolute indexing and writing. * - * @brief [Deprecated] - * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. - * Instead of using this method, use the SetWchar(int index, wchar_t value) method. + * @brief [Deprecated] + * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. + * Instead of using this method, use the SetWchar(int index, wchar_t value) method. * @since 2.0 * * @return An error code - * @param[in] index The index at which the bytes will be written - * @param[in] value The @c wchar_t value to write + * @param[in] index The index at which the bytes are written + * @param[in] value The @c wchar_t value to write * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus the size of @c wchar_t or less than @c 0. - * @remarks This method writes the size of @c wchar_t number of bytes containing the given @c wchar_t value - * into this buffer at the given index. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c wchar_t value. + * - The specified @c index is less than @c 0. + * @remarks This method writes the size of the @c wchar_t number of bytes containing the given @c wchar_t value + * into the calling buffer, at the given @c index. * @see GetMchar() * @endif */ result SetMchar(int index, wchar_t value); /** - * Sets a @c wchar_t value at the specified index of the calling %ByteBuffer object. @n - * Provides a way for absolute indexing and writing. + * Sets a @c wchar_t value at the specified @c index of the calling %ByteBuffer instance. @n + * It provides a way to perform absolute indexing and writing. * * @since 2.0 * * @return An error code - * @param[in] index The index at which the bytes will be written + * @param[in] index The index at which the bytes are written * @param[in] value The @c wchar_t value to write * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus the size of @c wchar_t or less than @c 0. - * @remarks This method writes the size of @c wchar_t number of bytes containing the given @c wchar_t value - * into this buffer at the given index. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c wchar_t value. + * - The specified @c index is less than @c 0. + * @remarks This method writes the size of the @c wchar_t number of bytes containing the given @c wchar_t value + * into the calling buffer, at the given @c index. * @see GetWchar() */ result SetWchar(int index, wchar_t value); /** - * Sets a @c short value at the specified index of the calling %ByteBuffer object. @n - * Provides a way for absolute indexing and writing. + * Sets a @c short value at the specified @c index of the calling %ByteBuffer instance. @n + * It provides a way to perform absolute indexing and writing. * * @since 2.0 * * @return An error code - * @param[in] index The index of at which the bytes are written - * @param[in] value The @c short value to write + * @param[in] index The index of at which the bytes are written + * @param[in] value The @c short value to write * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is larger than the limit minus the size of @c short or less than @c 0. - * @remarks This method writes the size of @c short number of bytes containing the given @c short value - * into this buffer at the given index. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is larger than the limit minus the size of the @c short value. + * - The specified @c index is less than @c 0. + * @remarks This method writes the size of the @c short number of bytes containing the given @c short value + * into the calling buffer, at the given @c index. * @see GetShort() */ result SetShort(int index, short value); /** * Creates a new %ByteBuffer whose content is a shared portion of - * the content of the calling %ByteBuffer object. + * the content of the calling %ByteBuffer instance. * * @since 2.0 * - * @return %ByteBuffer pointer to the current position of the calling object - * @remarks The content of the new buffer starts at the current position of the calling %ByteBuffer object. - * The new buffer's position is zero, its capacity and limit are - * the number of bytes remaining of the current instance of %ByteBuffer, + * @return A %ByteBuffer pointer to the current position of the calling object + * @remarks + * - The content of the new buffer starts at the current position of the calling %ByteBuffer object. + * - The new buffer's position is zero, its capacity and limit are + * the number of bytes remaining in the current instance of %ByteBuffer, * and its mark is undefined. */ ByteBuffer* SliceN(void) const; /** - * Gets the pointer to the raw array of the calling buffer. @n + * Gets a pointer to the raw array of the calling buffer. @n * If the capacity is zero, it returns @c null. * * @since 2.0 @@ -1244,12 +1318,12 @@ public: const byte* GetPointer(void) const; /** - * Gets the pointer to the raw array of the calling buffer. @n + * Gets a pointer to the raw array of the calling buffer. @n * If the capacity is zero, it returns @c null. * * @since 2.1 * - * @return A pointer(non-const) to the raw array of the calling buffer + * @return A pointer (non-constant) to the raw array of the calling buffer */ byte* GetPointer(void); @@ -1258,12 +1332,12 @@ public: * * @since 2.0 * - * @return @c true if the input object equals the calling %ByteBuffer instance, @n + * @return @c true if the input Object equals the calling %ByteBuffer instance, @n * else @c false - * @param[in] obj The object instance to compare with the calling object - * @remarks This method returns @c true only if the specified object is also an instance of - * the %ByteBuffer class, the two buffers have the same number of remaining elements, and the two - * sequences of remaining elements are equal (considered independent of their starting positions). + * @param[in] obj The Object instance to compare with the calling object + * @remarks This method returns @c true only if the specified object is also an instance of + * the %ByteBuffer class, the two buffers have the same number of remaining elements, and the + * sequences of the remaining elements are equal (considered independent of their starting positions). * @see Tizen::Base::BufferBase::GetHashCode() */ virtual bool Equals(const Tizen::Base::Object& obj) const; @@ -1273,7 +1347,7 @@ public: * * @since 2.0 * - * @return The hash value of the current instance + * @return The hash value of the current instance * @remarks The hash code of a buffer depends only upon its remaining elements. */ virtual int GetHashCode(void) const; diff --git a/inc/FBaseCharacter.h b/inc/FBaseCharacter.h index 483894e..479c00e 100644 --- a/inc/FBaseCharacter.h +++ b/inc/FBaseCharacter.h @@ -32,32 +32,32 @@ namespace Tizen { namespace Base /** * @enum UnicodeCategory * - * Defines the constants used to distinguish the categories of Unicode characters. + * Defines the constants used to distinguish the categories of the Unicode characters. * * @since 2.0 */ enum UnicodeCategory { - UNICODE_SURROGATE = 1, /**< The surrogate Unicode category */ - UNICODE_MODIFIER, /**< The spacing modifier Unicode category */ - UNICODE_ARROW, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif*/ - UNICODE_SPACE, /**< The space Unicode category */ - UNICODE_PUNCTUATION, /**< The punctuation Unicode category */ - UNICODE_CONTROL, /**< The control Unicode category */ - UNICODE_MATH, /**< The math Unicode category */ - UNICODE_DIGIT, /**< The digit Unicode category */ - UNICODE_HANGUL, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif*/ - UNICODE_HANJA, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif*/ - UNICODE_COMBINING, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif*/ - UNICODE_LANGUAGE, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif*/ - UNICODE_UPPERCASE, /**< The uppercase Unicode category*/ - UNICODE_LOWERCASE, /**< The lowercase Unicode category*/ - UNICODE_TITLECASE, /**< The titlecase Unicode category*/ - UNICODE_LETTER, /**< The letter Unicode category*/ - UNICODE_MARK, /**< The mark Unicode category*/ - UNICODE_CURRENCY, /**< The currency Unicode category*/ - UNICODE_SEPARATOR, /**< The separator Unicode category*/ - UNICODE_OTHER /**< The other Unicode category */ + UNICODE_SURROGATE = 1, /**< The surrogate Unicode category */ + UNICODE_MODIFIER, /**< The spacing modifier Unicode category */ + UNICODE_ARROW, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif */ + UNICODE_SPACE, /**< The space Unicode category */ + UNICODE_PUNCTUATION, /**< The punctuation Unicode category */ + UNICODE_CONTROL, /**< The control Unicode category */ + UNICODE_MATH, /**< The math Unicode category */ + UNICODE_DIGIT, /**< The digit Unicode category */ + UNICODE_HANGUL, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif */ + UNICODE_HANJA, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif */ + UNICODE_COMBINING, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif */ + UNICODE_LANGUAGE, /**< @if OSPDEPREC @deprecated This enum value is deprecated because this category is not valid anymore. @endif */ + UNICODE_UPPERCASE, /**< The uppercase Unicode category */ + UNICODE_LOWERCASE, /**< The lowercase Unicode category */ + UNICODE_TITLECASE, /**< The titlecase Unicode category */ + UNICODE_LETTER, /**< The letter Unicode category */ + UNICODE_MARK, /**< The mark Unicode category */ + UNICODE_CURRENCY, /**< The currency Unicode category */ + UNICODE_SEPARATOR, /**< The separator Unicode category */ + UNICODE_OTHER /**< The other Unicode category */ }; @@ -67,9 +67,9 @@ enum UnicodeCategory * * @since 2.0 * - * The %Character class wraps a value of the @c wchar_t type. It also provides + * The %Character class wraps the value of the @c wchar_t type. It also provides * several methods for determining a Unicode character's category, and for - * converting the case of intrinsic characters. The class is useful when + * converting the case of the intrinsic characters. This class is useful when * passing a Unicode character to a method expecting an instance of Object. * * The following example demonstrates how to use the %Character class. @@ -80,7 +80,7 @@ enum UnicodeCategory * * using namespace Tizen::Base; * - * // This method converts the first character of the given @c string to the upper case. + * // This method converts the first character of the given string to the upper case. * void * MyClass::CharacterSample(String& str) * { @@ -104,7 +104,7 @@ public: * * @since 2.0 * - * @param[in] value A multi-byte character used to initialize the %Character instance + * @param[in] value The multi-byte character used to initialize the %Character instance */ Character(wchar_t value); @@ -113,7 +113,7 @@ public: * * @since 2.0 * - * @param[in] value An instance of %Character + * @param[in] value An instance of %Character to copy */ Character(const Character& value); @@ -129,7 +129,7 @@ public: * * @since 2.0 * - * @param[in] rhs An instance of %Character + * @param[in] rhs An instance of %Character to copy */ Character& operator =(const Character& rhs); @@ -139,8 +139,8 @@ public: * * @since 2.0 * - * @return A 32-bit @c signed integer value - * @param[in] value The character instance to compare with + * @return The 32-bit @c signed integer value + * @param[in] value The %Character instance to compare with * * @code * @li < 0 if the value of the current instance is less than the value of the input instance @@ -152,14 +152,14 @@ public: int CompareTo(const Character& value) const; /** - * Checks whether the value of the Object parameter is equal - * to the value of the calling object. + * Checks whether the value of the input Object is equal + * to the value of the calling %Object. * * @since 2.0 * @return @c true if the input Object is equal to the calling %Object, @n * else @c false - * @param[in] obj The object to compare with the calling object - * @see Tizen::Base::Object::Equals() + * @param[in] obj The object to compare with the calling object + * @see Tizen::Base::Object::Equals() */ virtual bool Equals(const Object& obj) const; @@ -169,30 +169,28 @@ public: * @since 2.0 * * @return The hash value of the current instance - * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, - * the used hash function must generate a random distribution for all inputs. + * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n + * For better performance,the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const; /** - * Returns the value of the current instance as a - * @c wchar_t. + * Returns the value of the current instance as a @c wchar_t value. * * @since 2.0 * - * @return The value of this instance as - * a @c wchar_t + * @return The value of this instance as a @c wchar_t value */ wchar_t ToMchar(void) const; /** * @if OSPDEPREC * Converts the Unicode characters of the calling object to its equivalent lowercase. @n - * The Unicode characters other than English alphabets are not changed. + * Unicode characters other than the English alphabets are not changed. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated as a new method has been introduced. - * Instead of using this method, use the ToLowerCase() method that supports Unicode characters other than English alphabets. + * Instead of using this method, use the ToLowerCase() method that supports Unicode characters other than the English alphabets. * * @since 2.0 * @endif @@ -202,7 +200,7 @@ public: /** * Converts the Unicode characters of the calling object to its equivalent lowercase. @n - * The Unicode characters other than English alphabets are also supported. + * Unicode characters other than the English alphabets are also supported. * * @since 2.0 */ @@ -212,11 +210,11 @@ public: /** * @if OSPDEPREC * Converts the Unicode characters of the current object to its equivalent uppercase. @n - * The Unicode characters other than English alphabets are not changed. + * Unicode characters other than the English alphabets are not changed. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated as a new method has been introduced. - * Instead of using this method, use the ToUpperCase() method that supports the Unicode characters other than English alphabets. + * Instead of using this method, use the ToUpperCase() method that supports Unicode characters other than the English alphabets. * * @since 2.0 * @endif @@ -226,7 +224,7 @@ public: /** * Converts the Unicode characters of the current object to its equivalent uppercase. @n - * The Unicode characters other than English alphabets are also supported. + * Unicode characters other than English alphabets are also supported. * * @since 2.0 */ @@ -234,11 +232,11 @@ public: /** - * Returns a string representing the value of the calling %Character instance. + * Returns a string that represents the value of the calling %Character instance. * * @since 2.0 * - * @return An instance of String class that + * @return An instance of String that * contains a Unicode representation of the calling instance */ String ToString(void) const; @@ -249,7 +247,7 @@ public: * * @since 2.0 * - * @return An instance of the String class + * @return An instance of String * that contains the Unicode representation of the * input value * @param[in] value The Unicode character to convert @@ -257,12 +255,12 @@ public: static String ToString(wchar_t value); /** - * Categorizes a Unicode character into a group identified by + * Categorizes a Unicode character into a group that is identified by * one of the UnicodeCategory values. * * @since 2.0 * - * @return A value of type UnicodeCategory that identifies the group that contains the specified @c ch + * @return The value of type UnicodeCategory that identifies the group that contains the specified @c ch * @param[in] ch The Unicode character to categorize * */ @@ -271,14 +269,14 @@ public: /** * @if OSPDEPREC * Converts the input Unicode character to its equivalent lowercase. @n - * The Unicode characters other than English alphabets are not changed. + * Unicode characters other than the English alphabets are not changed. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated as a new method has been introduced. - * Instead of using this method, use the ToLowerCase(wchar_t ch) method that supports the Unicode characters other than English alphabets. + * Instead of using this method, use the ToLowerCase(wchar_t ch) method that supports Unicode characters other than the English alphabets. * * @since 2.0 - * @return An lowercase equivalent of the input Unicode character + * @return The lowercase equivalent of the input Unicode character * @param[in] ch The Unicode character to convert * @endif */ @@ -286,11 +284,11 @@ public: /** * Converts the input Unicode character to its equivalent lowercase. @n - * The Unicode characters other than English alphabets are also supported. + * Unicode characters other than the English alphabets are also supported. * * @since 2.0 * - * @return An lowercase equivalent of the input Unicode character + * @return The lowercase equivalent of the input Unicode character * @param[in] ch The Unicode character to convert */ static wchar_t ToLowerCase(wchar_t ch); @@ -298,14 +296,14 @@ public: /** * @if OSPDEPREC * Converts the input Unicode character to its equivalent uppercase. @n - * The Unicode characters other than English alphabets are not changed. + * Unicode characters other than the English alphabets are not changed. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated as a new method has been introduced. - * Instead of using this method, use the ToUpperCase(wchar_t ch) method that supports Unicode characters other than English alphabets. + * Instead of using this method, use the ToUpperCase(wchar_t ch) method that supports Unicode characters other than the English alphabets. * * @since 2.0 - * @return An uppercase equivalent of the input Unicode character + * @return The uppercase equivalent of the input Unicode character * @param[in] ch The Unicode character to convert * @endif */ @@ -313,18 +311,18 @@ public: /** * Converts the input Unicode character to its equivalent uppercase. @n - * The Unicode characters other than English alphabets are also supported. + * Unicode characters other than the English alphabets are also supported. * * @since 2.0 * - * @return An uppercase equivalent of the input Unicode character + * @return The uppercase equivalent of the input Unicode character * @param[in] ch The Unicode character to convert */ static wchar_t ToUpperCase(wchar_t ch); /** * Checks whether the input character is an alphanumeric character (letter or digit). @n - * A character is considered to be an alphanumeric character if either Character::isLetter(wchar_t ch) or Character::isDigit(wchar_t ch) returns true for the character + * A character is considered to be an alphanumeric character if either Character::isLetter(wchar_t ch) or Character::isDigit(wchar_t ch) returns @c true for the character * @if OSPCOMPAT * @brief [Compatibility] * @endif @@ -345,11 +343,11 @@ public: * @section CompCharacterIsAlphaNumericPageIssueSection Issues * Implementing this method in OSP compatible applications has the following issues: @n * - * -# The method returns true only if the character is alphabet character and cannot checks other Unicode character in Letter and digit category. + * -# The method returns @c true only if the character is an alphabet character, it cannot check other Unicode characters in the letter and digit category. * * @section CompCharacterIsAlphaNumericPageSolutionSection Resolutions * - * This issue has been resolved in Tizen. + * This issue mentioned above is resolved in %Tizen. * @endif */ @@ -387,11 +385,11 @@ public: * @section CompCharacterIsLetterPageIssueSection Issues * Implementing this method in OSP compatible applications has the following issues: @n * - * -# The method returns true only if the character is alphabet character and cannot checks other Unicode character in Letter category. + * -# The method returns @c true only if the character is an alphabet character, it cannot check other Unicode characters in the letter category. * * @section CompCharacterIsLetterPageSolutionSection Resolutions * - * This issue has been resolved in Tizen. + * This issue mentioned above is resolved in %Tizen. * @endif */ @@ -399,12 +397,12 @@ public: * @if OSPDEPREC * Checks whether the input character is a lowercase alphabet. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated as a new method has been introduced. - * Instead of using this method, use the IsLowerCase(wchar_t ch) method that supports Unicode characters. + * Instead of using this method, use the IsLowerCase(wchar_t ch) method that supports Unicode characters. * @since 2.0 * - * @return @c true if the input character is a lowercase English alphabet, @n + * @return @c true if the input character is a lowercase alphabet, @n * else @c false * @param[in] ch The Unicode character * @endif @@ -427,9 +425,9 @@ public: * @if OSPDEPREC * Checks whether the input character is an uppercase alphabet. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated as a new method has been introduced. - * Instead of using this method, use the IsUpperCase(wchar_t ch) method that also supports Unicode characters other than English alphabets. + * Instead of using this method, use the IsUpperCase(wchar_t ch) method that also supports Unicode characters other than the English alphabets. * @since 2.0 * * @return @c true if the input character is an uppercase alphabet, @n @@ -452,38 +450,39 @@ public: static bool IsUpperCase(wchar_t ch); /** - * Returns the value of the input character in the supplied radix. @n - * The value of radix must be between RADIX_MIN and RADIX_MAX. + * Returns the value of the input character in the supplied @c radix. @n + * The value of @c radix must be between Character::RADIX_MIN and Character::RADIX_MAX. * * @since 2.0 * - * @return A integer value of the input character in the supplied radix - * @param[in] ch The character to determine the value + * @return The integer value of the input character in the supplied @c radix + * @param[in] ch The character that determines the value * @param[in] radix The radix */ static int ToDigit(wchar_t ch, int radix); /** - * Returns the value which represents the input digit with specified radix. @n - * The value of radix must be between RADIX_MIN and RADIX_MAX. + * Returns the value which represents the input digit in the specified @c radix. @n + * The value of @c radix must be between Character::RADIX_MIN and Character::RADIX_MAX. * * @since 2.0 * - * @return A Unicode character of the input digit with specified @c radix @n - * else @c null character (U+0000) - * @param[in] digit The digit to determine the value + * @return The Unicode character of the input digit in the specified @c radix @n + * else a @c null character (U+0000) + * @param[in] digit The digit that determines the value * @param[in] radix The radix */ static wchar_t ForDigit(int digit, int radix); /** * Gets the numeric value of the input unicode character. @n - * This is used when some numeric values are fractions, negative, or too large for @c int value. + * This is used when some numeric values are fractions, negative, or too large for the @c int value. * * @since 2.0 * - * @return A @c double value @n NO_NUMERIC_VALUE for characters without any numeric values in the Unicode %Character. - * @param[in] ch A Unicode character + * @return The @c double value @n + * NO_NUMERIC_VALUE is returned for characters without any numeric values in the Unicode character. + * @param[in] ch The Unicode character */ static double GetNumericValue(wchar_t ch); @@ -494,7 +493,7 @@ public: * * @return @c true if the Unicode character is an assigned character, @n * else @c false - * @param[in] ch A Unicode character + * @param[in] ch The Unicode character */ static bool IsDefined(wchar_t ch); @@ -506,10 +505,10 @@ public: * * @return @c true if the Unicode character is a whitespace character, @n * else @c false - * @param[in] ch A Unicode character + * @param[in] ch The Unicode character * * @code - * It is a Unicode Separator character, but is not also a non-breaking space (U+00A0 NBSP or U+2007 Figure Space or U+202F Narrow NBSP). + * It is a Unicode Separator character, but is also not a non-breaking space (U+00A0 NBSP or U+2007 Figure Space or U+202F Narrow NBSP). * It is U+0009 HORIZONTAL TABULATION. * It is U+000A LINE FEED. * It is U+000B VERTICAL TABULATION. @@ -531,7 +530,7 @@ public: * * @return @c true if the Unicode character is a title character, @n * else @c false - * @param[in] ch A Unicode character + * @param[in] ch The Unicode character */ static bool IsTitleCase(wchar_t ch); @@ -540,19 +539,20 @@ public: * * @since 2.0 * - * @return A title case character equivalent for the input character @n The character itself is returned if none is defined. - * @param[in] ch A Unicode character + * @return The title case character equivalent for the input character @n + * The character itself is returned if no equivalent is defined. + * @param[in] ch The Unicode character */ static wchar_t ToTitleCase(wchar_t ch); /** - * Checks whether the input character is an ISO control code or not. + * Checks whether the input character is an ISO control code. * * @since 2.0 * * @return @c true if the Unicode character is an ISO control character, @n * else @c false - * @param[in] ch A Unicode character + * @param[in] ch The Unicode character */ static bool IsISOControl(wchar_t ch); @@ -565,57 +565,57 @@ public: static const wchar_t VALUE_MAX = 0x10FFFF; /** - * A constant holding the smallest value of type wchar_t, 0x0000. + * A constant holding the smallest value of type @c wchar_t, 0x0000. * * @since 2.0 */ static const wchar_t VALUE_MIN = 0x0000; /** - * The minimum radix available for conversion to and from strings. @n - * Same value as RADIX_BINARY. + * The minimum radix available for converting to and from strings. @n + * Same value as Character::RADIX_BINARY. * * @since 2.0 */ static const int RADIX_MIN = 2; /** - * The radix for binary number. + * The radix for a binary number. * * @since 2.0 */ static const int RADIX_BINARY = 2; /** - * The radix for decimal number. + * The radix for a decimal number. * * @since 2.0 */ static const int RADIX_DECIMAL = 10; /** - * The radix for octal number. + * The radix for an octal number. * * @since 2.0 */ static const int RADIX_OCTAL = 8; /** - * The radix for hexadecimal number. + * The radix for a hexadecimal number. * * @since 2.0 */ static const int RADIX_HEXADECIMAL = 16; /** - * The maximum radix available for conversion to and from strings. Same value as RADIX_HEXADECIMAL. + * The maximum radix available for converting to and from strings. Same value as Character::RADIX_HEXADECIMAL. * * @since 2.0 */ static const int RADIX_MAX = 36; /** - * Special value that is returned by GetNumericValue(wchar_t ch) when no numeric value is defined for the unicode character. + * The special value that is returned by the GetNumericValue(wchar_t ch) method when no numeric value is defined for the unicode character. * * @since 2.0 */ diff --git a/inc/FBaseCol.h b/inc/FBaseCol.h index 00bf0ac..692343e 100644 --- a/inc/FBaseCol.h +++ b/inc/FBaseCol.h @@ -54,12 +54,12 @@ * @since 2.0 * * @remarks @b Header @b %file: @b \#include @b @n - * @b Library : @b osp-appfw + * @b Library: @b osp-appfw * * The %Collection namespace contains classes and interfaces for various collections * (such as lists, maps, stacks, and queues), which are an aggregation of similar objects. * - * For more information on the %Base::Collection namespace features, see Collection. + * For more information on the %Collection namespace features, see Collection. * * The following diagrams illustrate the relationships between the classes belonging to the %Collection namespace. * diff --git a/inc/FBaseColAllElementsDeleter.h b/inc/FBaseColAllElementsDeleter.h index 9dfb600..dad0b70 100644 --- a/inc/FBaseColAllElementsDeleter.h +++ b/inc/FBaseColAllElementsDeleter.h @@ -27,9 +27,9 @@ namespace Tizen { namespace Base { namespace Collection { /** * @struct AllElementsDeleter - * @brief This function object provides a resource clean-up function for collection. + * @brief This function object provides a resource clean-up function for a collection. * - * The %AllElementsDeleter struct provides a resource clean-up function for collection. This can be used with unique_ptr as a custom deleter. + * The %AllElementsDeleter struct provides a resource clean-up function for a collection. This can be used with unique_ptr as a custom deleter. * * @since 2.0 */ @@ -41,7 +41,7 @@ struct AllElementsDeleter * @since 2.0 * * @param[in] c The collection to clean up - * @remarks The collection should be destructible and support the RemoveAll(bool) method. + * @remarks The collection should be destructible and should support the RemoveAll(bool) method. * IList, IMap, and IMultiMap support this concept. */ template< typename Collection > diff --git a/inc/FBaseColArrayList.h b/inc/FBaseColArrayList.h index a789693..5404c1f 100644 --- a/inc/FBaseColArrayList.h +++ b/inc/FBaseColArrayList.h @@ -113,11 +113,14 @@ public: * * @since 2.0 * - * @param[in] deleter The function pointer to type of the element deleter - * @remarks To create an owing collection, set the element deleter value as @c SingleObjectDeleter. This gives the collection the ownership of elements and the collection will destroy elements. @n - * On the other hand, to create a non-owning collection, you do not need to set the element deleter value, as @c NoOpDeleter is the default element deleter. - * It means that you do not transfer the ownership of elements to the collection. - * @remarks After creating an instance of the %ArrayList class, one of the Construct() methods must be called explicitly to initialize this instance. + * @param[in] deleter A function pointer to the type of the element deleter + * @remarks + * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection will destroy the elements. @n + * On the other hand, to create a non-owning collection, you do not need to set the element deleter value, + * as @c NoOpDeleter is the default element deleter. @n + * It means that you do not transfer the ownership of the elements to the collection. + * - After creating an instance of the %ArrayList class, one of the Construct() methods must be called explicitly to initialize this instance. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() @@ -138,13 +141,14 @@ public: * @since 2.0 * * @return An error code - * @param[in] capacity The number of elements @n - * The default capacity is @c 10. + * @param[in] capacity The number of elements @n + * The default capacity is @c 10. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c capacity is negative. - * @remarks If the number of elements added to the list reaches the current capacity, - * the capacity is automatically increased by memory reallocation. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c capacity is negative. + * @remarks If the number of elements added to the list reaches the current capacity, + * the capacity is automatically increased by memory reallocation. @n * Therefore, if the size of the list can be estimated, * specifying the initial capacity eliminates the need to perform a number of * resizing operations while adding elements to the list. @@ -161,11 +165,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection A collection to add + * @param[in] collection The collection to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. - * @remarks This method performs a shallow copy. It copies just the pointer; not the element itself. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. + * @remarks This method performs a shallow copy. It copies just the pointer and not the element itself. * @see ArrayList() */ result Construct(const ICollection& collection); @@ -176,10 +181,10 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj An pointer to object to add + * @param[in] pObj A pointer to the object to add * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself. + * @remarks This method performs a shallow copy. It copies just the pointer and not the element itself. * @see Remove() */ virtual result Add(Object* pObj); @@ -191,38 +196,39 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection A collection to add + * @param[in] collection The collection to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. - * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. + * @remarks This method performs a shallow copy. It copies just the pointer and not the element itself. * @see RemoveItems() */ virtual result AddItems(const ICollection& collection); /** - * Gets an enumerator (an instance of the IEnumerator-derived class) of this list. + * Gets the enumerator (an instance of the IEnumerator derived class) of this list. * * @since 2.0 * - * @return An instance of the IEnumerator-derived class, @n - * else @c null if some exception occurs + * @return An instance of the IEnumerator derived class, @n + * else @c null if an exception occurs * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual IEnumerator* GetEnumeratorN(void) const; /** - * Gets a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) of this list. + * Gets the bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) of this list. * * @since 2.0 * * @return An instance of the IBidirectionalEnumerator derived class, @n - * else @c null if some exception occurs - * @remarks Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) + * else @c null if an exception occurs + * @remarks + * - Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) * to iterate over a collection (an instance of the IList derived class). - * The specific error code can be accessed using GetLastResult() method. - * @see Tizen::Base::Collection::IBidirectionalEnumerator + * - The specific error code can be accessed using GetLastResult() method. */ virtual IBidirectionalEnumerator* GetBidirectionalEnumeratorN(void) const; @@ -232,11 +238,13 @@ public: * @since 2.0 * * @return The object at the specified @c index of this list, @n - * else @c null if the index is not valid - * @param[in] index The index of the object in the calling list to read + * else @c null if the @c index is not valid + * @param[in] index The index of the object to read in the calling list * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either equal to or greater than the number of elements. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetAt() */ @@ -249,103 +257,110 @@ public: * @since 2.0 * * @return The object at the specified @c index of this list, @n - * else @c null if the index is not valid - * @param[in] index The index of the object to read + * else @c null if the @c index is not valid + * @param[in] index The index of the object to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either equal to or greater than the number of elements. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetAt() */ virtual Object* GetAt(int index); /** - * Gets the IList within the specified range of this list. + * Gets an IList instance within the specified range of this list. * * @since 2.0 * * @return A pointer to IList, @n - * else @c null if some exception occurs - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read + * else @c null if an exception occurs + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n - * - The @c count is greater than the number of elements starting from @c startIndex - * or less than @c 0. - * @remarks The IList stores just the pointers to the elements in the list, not the elements themselves. - * The specific error code can be accessed using the GetLastResult() method. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified index is outside the bounds of the data structure. + * - The specified @c startIndex is either equal to or greater than the number of elements. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. + * @remarks + * - The IList stores only the pointers to the elements in the list, not the elements themselves. + * - The specific error code can be accessed using the GetLastResult() method. */ virtual IList* GetItemsN(int startIndex, int count) const; /** * Searches for an object in this list. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Object& obj, int& index) const; /** - * Searches for an object starting from the specified index. @n - * Gets the index of the object if found. + * Searches for an object starting from the specified @c startIndex. @n + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index for the search @n - * It must be less than the number of elements. - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index for the search @n + * It must be less than the number of elements. + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either equal to or greater than the number of elements. + * - The specified @c startIndex is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Object& obj, int startIndex, int& index) const; /** * Searches for an object within the specified range. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n - * - The @c count is greater than the number of elements starting from @c startIndex - * or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either equal to or greater than the number of elements. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Object& obj, int startIndex, int count, int& index) const; /** * Searches for the last occurrence of an object in this list. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the last occurrence of the specified object + * @param[in] obj The object to locate + * @param[out] index The index of the last occurrence of the specified object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see IndexOf() */ virtual result LastIndexOf(const Object& obj, int& index) const; @@ -356,16 +371,19 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj The pointer to object to insert - * @param[in] index The index at which the object must be inserted + * @param[in] pObj A pointer to the object to insert + * @param[in] index The index at which the object is inserted * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is greater than the number of elements or less than @c 0. - * @remarks The elements that follow the insertion point move down to accommodate the new element. - * If the @c index equals to the number of elements, then the new element + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is greater than the number of elements. + * - The specified @c index is less than @c 0. + * @remarks + * - The elements that follow the insertion point move down to accommodate the new element. + * - If the @c index is equal to the number of elements, then the new element * is added at the end of this list. - * This method performs a shallow copy. It inserts just the pointer; not the element itself. + * - This method performs a shallow copy. It inserts just the pointer and not the element itself. * @see Add() * @see RemoveAt() */ @@ -377,17 +395,21 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection The collection to insert - * @param[in] startIndex The starting index at which the collection must be inserted + * @param[in] collection The collection to insert + * @param[in] startIndex The starting index at which the collection is inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c startIndex is greater than the number of elements or less than @c 0. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. - * @remarks The elements that follow the insertion point move down to accommodate the new element. - * If the @c startIndex equals to the number of elements then the new elements + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified index is outside the bounds of the data structure. + * - The specified @c startIndex is greater than the number of elements. + * - The specified @c startIndex is less than @c 0. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. + * @remarks + * - The elements that follow the insertion point move down to accommodate the new element. + * - If the @c startIndex is equal to the number of elements then the new elements * are added at the end of this list. - * This method performs a shallow copy. It inserts just the pointer; not the element itself. + * - This method performs a shallow copy. It inserts just the pointer and not the element itself. * @see RemoveItems() * @see AddItems() */ @@ -399,9 +421,9 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj An object to remove + * @param[in] obj The object to remove * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see Add() * @see RemoveAt() * @see RemoveAll() @@ -414,10 +436,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] index The index at which the object must be removed + * @param[in] index The index at which the object is removed * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either equal to or greater than the number of elements. + * - The specified @c index is less than @c 0. * @remarks The elements that follow the deletion point move up to occupy the vacated spot. * @see InsertAt() * @see Remove() @@ -430,14 +454,15 @@ public: * @since 2.0 * * @return An error code - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n - * - The @c count is greater than the number of elements starting from @c startIndex - * or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified index is outside the bounds of the data structure. + * - The specified @c startIndex is either equal to or greater than the number of elements. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. * @remarks The elements that follow the deletion point move up to occupy the vacated spot. * @see AddItems() */ @@ -452,15 +477,16 @@ public: * @return An error code * @param[in] collection The collection to remove from this list * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. * @see Remove() * @see RemoveAt() */ virtual result RemoveItems(const ICollection& collection); /** - * Removes all of the object pointers in the collection and also removes all of the objects depending on the specified element deleter. + * Removes all the object pointers in the collection and also removes all the objects depending on the specified element deleter. * The %RemoveAll() can be called before the collection is deleted. * * @since 2.0 @@ -473,26 +499,29 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj An pointer to object to set - * @param[in] index The index at which the object must be set + * @param[in] pObj A pointer to the object to set + * @param[in] index The index at which the object is set * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements or less than @c 0. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either equal to or greater than the number of elements. + * - The specified @c index is less than @c 0. * @see GetAt() */ virtual result SetAt(Object* pObj, int index); /** - * Sets the capacity of this list to the specified value. + * Sets the capacity of this list at the specified value. * * @since 2.0 * * @return An error code - * @param[in] newCapacity The new capacity of this list + * @param[in] newCapacity The new capacity of this list * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the @c newCapacity is negative. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The specified @c newCapacity is negative. * @remarks When the new capacity is less than the current capacity, the elements * within the truncated memory are not destroyed. * @see Construct() @@ -502,7 +531,7 @@ public: virtual result SetCapacity(int newCapacity); /** - * Sorts the elements of this list using the comparer provided. + * Sorts the elements of this list using the @c comparer provided. * * @since 2.0 * @@ -540,13 +569,13 @@ public: virtual int GetCount(void) const; /** - * Checks whether a list contains the specified object. + * Checks whether the list contains the specified object. * * @since 2.0 * * @return @c true if the object is present in the list, @n * else @c false - * @param[in] obj The object to locate + * @param[in] obj The object to locate * @see ContainsAll() */ virtual bool Contains(const Object& obj) const; @@ -558,26 +587,28 @@ public: * * @return @c true if the list contains all the elements of the specified @c collection, @n * else @c false - * @param[in] collection The collection to check for in the list + * @param[in] collection The collection to check for in the list * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks If the given @c collection is empty, this method will return @c true. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - If the given @c collection is empty, this method will return @c true. * @see Contains() */ virtual bool ContainsAll(const ICollection& collection) const; /** - * Compares the specified Object instance with the calling %ArrayList instance. + * Compares the specified Tizen::Base::Object instance with the calling %ArrayList instance. * * @since 2.0 * - * @return @c true if the given object matches the calling List, @n + * @return @c true if the given Tizen::Base::Object matches the calling list, @n * else @c false * @param[in] obj The object to compare with the calling list - * @remarks This method returns @c true only if the specified object @c obj is also an instance of %ArrayList class, - * both lists have the same size, and all the corresponding pairs of the elements in the two lists are equal. + * @remarks This method returns @c true only if the specified @c obj is also an instance of %ArrayList, + * both lists have the same size, and all the corresponding pairs of the elements in the two lists are equal. @n * In other words, the two lists are equal if they contain the same elements in the same order. */ virtual bool Equals(const Object& obj) const; @@ -588,13 +619,13 @@ public: * @since 2.0 * * @return The hash value of the current instance - * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n - * the used hash function must generate a random distribution for all inputs. + * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const; /** - * Distinguish between %ArrayList and LinkedList. + * Checks whether the instance is an %ArrayList or a LinkedList. * * @since 2.0 * @return @c true if it is an %ArrayList, @n diff --git a/inc/FBaseColArrayListT.h b/inc/FBaseColArrayListT.h index a687295..425d42d 100644 --- a/inc/FBaseColArrayListT.h +++ b/inc/FBaseColArrayListT.h @@ -138,10 +138,11 @@ public: * @param[in] capacity The initial capacity of the class @n * The default capacity is @c 10. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c capacity is negative. - * @remarks If the number of elements added to the list reaches its current capacity, - * the capacity is automatically increased by memory reallocation. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The specified @c capacity is negative. + * @remarks If the number of elements added to the list reaches its current capacity, + * the capacity is automatically increased by memory reallocation. @n * Thus, if the size of the list can be estimated, * specifying the initial capacity eliminates the need to perform a number of * resizing operations while adding elements to the list. @@ -164,10 +165,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection A collection of elements to add + * @param[in] collection The collection of elements to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. * @see ArrayListT() */ result Construct(const ICollectionT< Type >& collection) @@ -185,12 +187,12 @@ CATCH: } /** - * Adds the specified object to the end of the list. + * Adds the specified @c obj to the end of the list. * * @since 2.0 * * @return An error code - * @param[in] obj An object to add to the list + * @param[in] obj The object to add to the list * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @see Remove() @@ -211,15 +213,16 @@ CATCH: } /** - * Adds the elements of the specified collection to the end of the list. + * Adds the elements of the specified @c collection to the end of the list. * * @since 2.0 * * @return An error code - * @param[in] collection A collection of elements to add to the list + * @param[in] collection The collection of elements to add to the list * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. * @see RemoveItems() */ virtual result AddItems(const ICollectionT< Type >& collection) @@ -263,16 +266,15 @@ CATCH: } /** - * Gets the elements of the list in an instance of the IEnumeratorT derived class. + * Gets the elements of the list through an instance of the IEnumeratorT derived class. * * @since 2.0 * - * @return An instance of the IEnumeratorT derived class if successful, @n + * @return An instance of the IEnumeratorT derived class, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see Tizen::Base::Collection::IEnumeratorT */ virtual IEnumeratorT< Type >* GetEnumeratorN(void) const { @@ -290,7 +292,7 @@ CATCH: } /** - * Gets a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) of this list. + * Gets the bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) of this list. * * @since 2.0 * @@ -298,10 +300,10 @@ CATCH: * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) + * @remarks + * - Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) * to iterate over a collection (an instance of the IListT derived class). - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see Tizen::Base::Collection::IBidirectionalEnumeratorT + * - The specific error code can be accessed using the GetLastResult() method. */ virtual IBidirectionalEnumeratorT< Type >* GetBidirectionalEnumeratorN(void) const { @@ -325,10 +327,12 @@ CATCH: * * @return An error code * @param[in] index The index of the object to read - * @param[out] obj An object to get from this list + * @param[out] obj The object to get from this list * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @see SetAt() */ virtual result GetAt(int index, Type& obj) const @@ -348,10 +352,12 @@ CATCH: * * @return An error code * @param[in] index The index of the object to read - * @param[out] obj An object to get from this list + * @param[out] obj The object to get from this list * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @see SetAt() */ virtual result GetAt(int index, Type& obj) @@ -365,20 +371,22 @@ CATCH: } /** - * Gets a list of a specified number of elements starting from a specified index. + * Gets a list of the specified number of elements starting from the specified index. * * @since 2.0 * * @return An instance of the IListT derived class within the specified range of the list, @n * else @c null if an exception occurs - * @param[in] startIndex The index to start reading elements from - * @param[in] count The number of elements to read + * @param[in] startIndex The index to start reading elements from + * @param[in] count The number of elements to read * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either greater than or equal to the number of elements or less than @c 0. @n - * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. * * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -416,15 +424,15 @@ CATCH: /** * Searches for an object in this list. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Type& obj, int& index) const @@ -434,19 +442,21 @@ CATCH: /** * Searches for an object starting from the specified @c index. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index for the search @n - * It must be less than the number of elements. - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index for the search @n + * It must be less than the number of elements. + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements. + * - The specified @c startIndex is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Type& obj, int startIndex, int& index) const @@ -460,21 +470,23 @@ CATCH: /** * Searches for an object within the specified range. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified @c index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either greater than or equal to the number of elements or less than @c 0. @n - * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Type& obj, int startIndex, int count, int& index) const @@ -501,18 +513,21 @@ CATCH: } /** - * Inserts an object at a specified location. + * Inserts an object at the specified location. * * @since 2.0 * * @return An error code - * @param[in] obj The object to insert - * @param[in] index The index at which the object must be inserted + * @param[in] obj The object to insert + * @param[in] index The index at which the object is inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the @c index is greater than the number of elements or less than @c 0. - * @remarks The elements that follow the insertion point move down to accommodate the new element. - * If the @c index equals the number of elements in the list, the new element + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is greater than the number of elements. + * - The specified @c index is less than @c 0. + * @remarks + * - The elements that follow the insertion point move down to accommodate the new element. + * - If the @c index is equal to the number of elements in the list, the new element * is added at the end of the list. * @see Add() * @see RemoveAt() @@ -544,20 +559,24 @@ CATCH: } /** - * Inserts the elements of a collection at a specified location. + * Inserts the elements of the collection from a specified location. * * @since 2.0 * * @return An error code - * @param[in] collection The collection to insert - * @param[in] startIndex The index from which the collection must be inserted + * @param[in] collection The collection to insert + * @param[in] startIndex The index from which the collection is inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c startIndex is greater than the number of elements or less than @c 0. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. - * @remarks The elements that follow the insertion point move down to accommodate the new elements. - * If the @c startIndex equals the number of elements in the list, the new elements + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is greater than the number of elements. + * - The specified @c startIndex is less than @c 0. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. + * @remarks + * - The elements that follow the insertion point move down to accommodate the new elements. + * - If the @c startIndex is equal to the number of elements in the list, the new elements * are added at the end of the list. * @see RemoveItems() * @see AddItems() @@ -616,15 +635,15 @@ CATCH: /** * Searches for the last occurrence of an object in this list. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the last occurrence of the specified object + * @param[in] obj The object to locate + * @param[out] index The index of the last occurrence of the specified object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see IndexOf() */ virtual result LastIndexOf(const Type& obj, int& index) const @@ -642,14 +661,14 @@ CATCH: } /** - * Removes the first occurrence of a specified object. + * Removes the first occurrence of the specified object. * * @since 2.0 * * @return An error code * @param[in] obj The object to remove * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see Add() * @see RemoveAt() * @see RemoveAll() @@ -669,15 +688,16 @@ CATCH: } /** - * Removes all the elements of a specified collection from the list. + * Removes all the elements of the specified collection from the list. * * @since 2.0 * * @return An error code * @param[in] collection The collection to remove from this list * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. * @see Remove() * @see RemoveAt() */ @@ -717,15 +737,17 @@ CATCH: } /** - * Removes an object from a specified location. + * Removes an object from the specified location. * * @since 2.0 * * @return An error code - * @param[in] index The index of the object that is to remove + * @param[in] index The index of the object to remove * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the specified @c index is greater than or equal to the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @remarks The elements that follow the deleted object move up the list to occupy the empty location. * @see InsertAt() * @see Remove() @@ -750,18 +772,20 @@ CATCH: } /** - * Removes all the elements within a specified range. + * Removes all the elements within the specified range. * * @since 2.0 * * @return An error code - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to remove + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to remove * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either greater than or equal to the number of elements or less than @c 0. @n - * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. * @remarks The elements that follow the deleted elements move up the list to occupy the empty locations. * @see AddItems() * @see InsertItemsFrom() @@ -801,7 +825,7 @@ CATCH: } /** - * Removes all elements in the list. + * Removes all the elements in the list. * * @since 2.0 */ @@ -821,16 +845,18 @@ CATCH: } /** - * Sets the object at a specified @c index of the current instance of ByteBuffer with the specified object. + * Sets the object at the specified @c index of the current instance of ByteBuffer. * * @since 2.0 * * @return An error code - * @param[in] obj The object to set - * @param[in] index The index at which the object must be set + * @param[in] obj The object to set + * @param[in] index The index at which the object must be set * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @see GetAt() */ virtual result SetAt(const Type& obj, int index) @@ -847,15 +873,16 @@ CATCH: } /** - * Sets the capacity of the list to a specified value. + * Sets the capacity of the list at the specified value. * * @since 2.0 * * @return An error code * @param[in] newCapacity The new capacity to set for the list * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c newCapacity is negative. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The specified @c newCapacity is negative. * @remarks If the new capacity is less than the current capacity, the memory * is truncated and the elements within the truncated memory are destroyed. * @see Construct() @@ -912,8 +939,9 @@ CATCH: * @return An error code * @param[in] comparer A pointer to IComparerT * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c comparer is not valid. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The specified @c comparer is invalid. */ virtual result Sort(const IComparerT< Type >& comparer) { @@ -934,13 +962,13 @@ CATCH: } /** - * Trims the capacity of a list to the actual number of elements in the list. + * Trims the capacity of the list to the actual number of elements in the list. * * @since 2.0 * * @return An error code - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetCapacity() */ @@ -984,13 +1012,13 @@ CATCH: } /** - * Checks whether a list contains the specified object. + * Checks whether the list contains the specified object. * * @since 2.0 * * @return @c true if the object is present in the list, @n * else @c false - * @param[in] obj The object to locate + * @param[in] obj The object to locate * @see ContainsAll() */ virtual bool Contains(const Type& obj) const @@ -1017,13 +1045,14 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] collection The collection to check for in the list - * @param[out] out @c true if the list contains all the elements of the specified @c collection, @n - * else @c false + * @param[in] collection The collection to check in the list + * @param[out] out @c true if the list contains all the elements of the specified @c collection, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. - * @remarks If the given @c collection is empty, the @c out parameter will be set to @c true. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. + * @remarks If the given @c collection is empty, then @c out is set to @c true. * @see Contains() */ virtual result ContainsAll(const ICollectionT< Type >& collection, bool& out) const @@ -1072,7 +1101,7 @@ CATCH: } /** - * Compares two instances of the %ArrayListT class. + * Compares two instances of %ArrayListT. * * @since 2.0 * @@ -1116,8 +1145,8 @@ CATCH: * @since 2.0 * * @return The hash value of the current instance - * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n - * the used hash function must generate a random distribution for all inputs. + * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const { diff --git a/inc/FBaseColHashMap.h b/inc/FBaseColHashMap.h index ef32231..cf1434d 100644 --- a/inc/FBaseColHashMap.h +++ b/inc/FBaseColHashMap.h @@ -43,7 +43,7 @@ class _HashMapEntry; * * For more information on the class features, see HashMap and MultiHashMap. * - * The following example demonstrates how to use the %HashMap class to create and initialize a %HashMap instance and to use its methods. + * The following example demonstrates how to use the %HashMap class to create and initialize a %HashMap instance and use its methods. * * @code * @@ -104,10 +104,11 @@ public: * * @since 2.0 * - * @param[in] deleter The function pointer to type of the element deleter - * @remarks To create an owing collection, set the element deleter value as @c SingleObjectDeleter. This gives the collection the ownership of elements and the collection will destroy elements. @n - * On the other hand, to create a non-owning collection, you do not need to set the element deleter value, as @c NoOpDeleter is the default element deleter. - * It means that you do not transfer the ownership of elements to the collection. + * @param[in] deleter A function pointer to the type of the element deleter + * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection, the ownership of the elements and the collection destroys the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, as @c NoOpDeleter is the default element deleter. + * It means that you do not transfer the ownership of the elements to the collection. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() @@ -122,7 +123,7 @@ public: virtual ~HashMap(void); /** - * Initializes an instance of an empty %HashMap class with the initial capacity and load factor. + * Initializes an instance of the empty %HashMap with the initial @c capacity and the load factor. * * @since 2.0 * @@ -130,34 +131,37 @@ public: * @param[in] capacity The initial capacity * @param[in] loadFactor The maximum ratio of elements to buckets * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, @n - * the @c capacity or the @c loadFactor is negative. - * @remarks The GetHashCode() method of key objects is used for hashing and - * the Equals() method of key objects is used for comparing keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c capacity or the specified @c loadFactor is negative. + * @remarks The GetHashCode() method of the key objects is used for hashing and + * the Equals() method of the key objects is used for comparing the keys. * @see HashMap() */ result Construct(int capacity = 16, float loadFactor = 0.75); /** - * Initializes an instance of a %HashMap class by copying the elements of the specified @c map. + * Initializes an instance of %HashMap by copying the elements of the specified @c map. * * @since 2.0 * * @return An error code - * @param[in] map The map to copy - * @param[in] loadFactor The maximum ratio of elements to buckets - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c loadFactor is negative. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c map is modified during the operation of this method. - * @remarks This method performs a shallow copy. It copies only the pointer; not the element itself. + * @param[in] map The map to copy + * @param[in] loadFactor The maximum ratio of elements to buckets + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c loadFactor is negative. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c map is modified during the operation of this method. + * @remarks This method performs a shallow copy. It copies just the pointer and not the element itself. * @see HashMap() */ result Construct(const IMap& map, float loadFactor = 0.75); /** - * Initializes an instance of an empty %HashMap class with the specified initial capacity, load factor, hash code provider, and comparer. + * Initializes an instance of the empty %HashMap with the specified initial capacity, load factor, hash code provider, and comparer. * * @since 2.0 * @@ -170,67 +174,71 @@ public: * @param[in] comparer An instance of the IComparer derived class to use when comparing the keys * * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c capacity or the @c loadFactor is negative. - * @remarks The instances of hash code provider and comparer will not be deallocated later from this map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c capacity or the specified @c loadFactor is negative. + * @remarks The instances of the hash code provider and the comparer are not deallocated later from this map. * @see HashMap() */ result Construct(int capacity, float loadFactor, const IHashCodeProvider& provider, const IComparer& comparer); /** - * Initializes an instance of a %HashMap class by copying the elements of the specified map with the specified load factor, hash code provider, and comparer. + * Initializes an instance of %HashMap by copying the elements of the specified map with the specified load factor, hash code provider, and comparer. * * @since 2.0 * * @return An error code - * @param[in] map The map to copy - * @param[in] loadFactor The maximum ratio of elements to buckets @n - * If it is @c 0, the default load factor(0.75) is used. - * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes for all keys in this map - * @param[in] comparer An instance of the IComparer derived class to use when comparing keys + * @param[in] map The map to copy + * @param[in] loadFactor The maximum ratio of elements to buckets @n + * If it is @c 0, the default load factor(0.75) is used. + * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes for all the keys in this map + * @param[in] comparer An instance of the IComparer derived class to use when comparing the keys * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c loadFactor is negative. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c map is modified during the operation of this method. - * @remarks This method performs a shallow copy. It copies only the pointer; not the element itself. - * @remarks The instances of hash code provider and comparer will not be deallocated later from this map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c loadFactor is negative. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c map is modified during the operation of this method. + * @remarks + * - This method performs a shallow copy. It copies just the pointer and not the element itself. + * - The instances of the hash code provider and the comparer are not deallocated later from this map. * @see HashMap() */ result Construct(const IMap& map, float loadFactor, const IHashCodeProvider& provider, const IComparer& comparer); /** - * Adds the specified key-value pair to a map. + * Adds the specified key-value pair to the map. * * @since 2.0 * * @return An error code - * @param[in] pKey The pointer to key of the value to add - * @param[in] pValue The pointer to value to add + * @param[in] pKey A pointer to the key of the value to add + * @param[in] pValue A pointer to the value to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @exception E_OBJ_ALREADY_EXIST The specified @c pKey already exists. - * @remarks This method performs a shallow copy. It adds only the pointer; not the element itself. + * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself. * @see Remove() */ virtual result Add(Object* pKey, Object* pValue); /** - * Gets an enumerator (an instance of the IMapEnumerator derived class) of this map. + * Gets the enumerator (an instance of the IMapEnumerator derived class) of this map. * * @since 2.0 * - * @return An instance of the IMapEnumerator derived class, if successful @n + * @return An instance of the IMapEnumerator derived class, @n * else @c null if an exception occurs * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Base::Collection::IEnumerator - * @see Tizen::Base::Collection::IMapEnumerator */ virtual IEnumerator* GetEnumeratorN(void) const; /** - * Gets the elements of the map in an instance of the IMapEnumerator derived class. + * Gets the elements of the map through an instance of the IMapEnumerator derived class. * * @since 2.0 * @@ -238,55 +246,56 @@ public: * else @c null if an exception occurs * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Base::Collection::IEnumerator - * @see Tizen::Base::Collection::IMapEnumerator */ virtual IMapEnumerator* GetMapEnumeratorN(void) const; /** - * Gets the value associated with the specified @c key. + * Gets the value associated to the specified @c key. * * @since 2.0 * - * @return The value associated with the key, @n + * @return The value associated to the key, @n * else @c null if an exception occurs - * @param[in] key The key to locate + * @param[in] key The key to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetValue() */ virtual const Object* GetValue(const Object& key) const; /** - * Gets the value associated with the specified @c key. + * Gets the value associated to the specified @c key. * * @since 2.0 * - * @return The value associated with the key, @n + * @return The value associated to the key, @n * else @c null if an exception occurs - * @param[in] key The key to locate + * @param[in] key The key to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetValue() */ virtual Object* GetValue(const Object& key); /** - * Gets a list of all the keys in a map. + * Gets the list of all the keys in the map. * * @since 2.0 * - * @return A pointer to an IList object containing all the keys in the map, @n + * @return A pointer to the IList object containing all the keys in the map, @n * else @c null if an exception occurs - * @remarks The order of the keys is the same as the corresponding values in the IList interface returned by the GetValuesN() method. - * The IList stores just the pointers to the elements in the map, not the elements themselves. - * The specific error code can be accessed using the GetLastResult() method. - * @see GetValuesN() + * @remarks + * - The order of the keys is the same as the corresponding values in the IList interface returned by the GetValuesN() method. + * - The IList stores just the pointers to the elements in the map and not the elements themselves. + * - The specific error code can be accessed using the GetLastResult() method. */ virtual IList* GetKeysN(void) const; @@ -295,25 +304,27 @@ public: * * @since 2.0 * - * @return A pointer to an IList object containing all the values in the map, @n + * @return A pointer to the IList object that contains all the values in the map, @n * else @c null if an exception occurs - * @remarks The IList stores just the pointers to the elements in the map, not the elements themselves. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - The IList stores just the pointers to the elements in the map and not the elements themselves. + * - The specific error code can be accessed using the GetLastResult() method. * @see GetKeysN() */ virtual IList* GetValuesN(void) const; /** - * Removes the values associated with the specified @c key. + * Removes the values associated to the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key to remove + * @param[in] key The key to remove * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the comparer has failed to compare keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see Add() */ virtual result Remove(const Object& key); @@ -327,19 +338,19 @@ public: virtual void RemoveAll(void); /** - * Sets the value associated with the specified @c key by allocating it a new value. + * Sets the value associated to the specified @c key by allocating a new value to it. * * @since 2.0 * * @return An error code - * @param[in] key The key whose value is to replace - * @param[in] pValue The pointer to new value to replace + * @param[in] key The key whose value is replaced + * @param[in] pValue A pointer to the new value to replace * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks To add a new key-value pair, use the Add() method. - * @see Add() * @see GetValue() */ virtual result SetValue(const Object& key, Object* pValue); @@ -360,10 +371,11 @@ public: * * @return @c true if the map contains the specified @c key, @n * else @c false - * @param[in] key The key to locate + * @param[in] key The key to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see ContainsValue() */ @@ -383,14 +395,14 @@ public: virtual bool ContainsValue(const Object& value) const; /** - * Compares two instances of the %HashMap class. + * Compares two instances of %HashMap. * * @since 2.0 * * @return @c true if the two instances match, @n * else @c false * @param[in] obj The object to compare with the current instance - * @remarks This method returns @c true if and only if the two instances contain the same number of elements and all the elements contained in each other. + * @remarks This method returns @c true if and only if the two instances contain the same number of elements and all the elements are present in both of them. */ virtual bool Equals(const Object& obj) const; @@ -400,8 +412,8 @@ public: * @since 2.0 * * @return The hash value of the current instance - * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n - * the used hash function must generate a random distribution for all inputs. + * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const; diff --git a/inc/FBaseColHashMapT.h b/inc/FBaseColHashMapT.h index e731325..35751e4 100644 --- a/inc/FBaseColHashMapT.h +++ b/inc/FBaseColHashMapT.h @@ -51,7 +51,7 @@ template< class KeyType > class __HashMapDefaultProviderT; * The %HashMapT class provides a template-based collection of associated keys and values * that are organized based on the hash code of the key. * It contains unique keys and each key maps to one single value. - * The key and value cannot be a null reference. Several methods in the %HashMapT class need assignment (=) operators of KeyType and ValueType. + * The key and value cannot be a @c null reference. Several methods in the %HashMapT class need the assignment (=) operators of the KeyType and the ValueType. * @n * For more information on the class features, see HashMap and MultiHashMap. * @@ -152,8 +152,9 @@ public: * @param[in] capacity The initial capacity * @param[in] loadFactor The maximum ratio of elements to buckets * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c capacity or the @c loadFactor is negative. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c capacity or the specified @c loadFactor is negative. * @remarks To work properly, the key type must be of a primitive number type. * @see HashMapT() */ @@ -217,13 +218,15 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] map The map to copy - * @param[in] loadFactor The maximum ratio of elements to buckets + * @param[in] map The map to copy + * @param[in] loadFactor The maximum ratio of elements to buckets * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c loadFactor is negative. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c map is modified during the operation of this method. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c loadFactor is negative. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c map is modified during the operation of this method. * @see HashMapT() */ result Construct(const IMapT< KeyType, ValueType >& map, float loadFactor = 0.75) @@ -264,24 +267,24 @@ CATCH: } /** - * Initializes this instance of an empty %HashMapT class, with the specified initial capacity, load factor, hash code provider, and comparer. + * Initializes this instance of the empty %HashMapT, with the specified initial capacity, load factor, hash code provider, and comparer. * * @since 2.0 * * @return An error code - * @param[in] capacity The initial capacity @n - * If it is @c 0, the default capacity (16) is used. - * @param[in] loadFactor The maximum ratio of the elements to buckets @n - * If it is @c 0, the default load factor (0.75) is used. - * @param[in] provider An instance of the IHashCodeProviderT-derived class that supplies the hash codes - * for all keys in this map - * @param[in] comparer An instance of the IComparerT-derived class to use when comparing keys + * @param[in] capacity The initial capacity @n + * If it is @c 0, the default capacity (16) is used. + * @param[in] loadFactor The maximum ratio of the elements to buckets @n + * If it is @c 0, the default load factor (0.75) is used. + * @param[in] provider An instance of the IHashCodeProviderT-derived class that supplies the hash codes + * for all the keys in this map + * @param[in] comparer An instance of the IComparerT-derived class to use when comparing the keys * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - A specified input parameter is invalid. @n - * - The specified @c capacity is negative. @n - * - The @c loadFactor is negative. - * @remarks The instances of hash code provider and comparer will not be deallocated later from this map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c capacity is negative. + * - The specified @c loadFactor is negative. + * @remarks The instances of the hash code provider and the comparer are not deallocated later from this map. * @see HashMapT() */ result Construct(int capacity, float loadFactor, const IHashCodeProviderT< KeyType >& provider, @@ -342,20 +345,21 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] map The map to copy - * @param[in] loadFactor The maximum ratio of elements to buckets @n - * If it is @c 0, the default load factor (0.75) is used. - * @param[in] provider An instance of the IHashCodeProviderT-derived class that supplies the hash codes - * for all keys in this map - * @param[in] comparer An instance of the IComparerT-derived class to use when comparing keys + * @param[in] map The map to copy + * @param[in] loadFactor The maximum ratio of elements to buckets @n + * If it is @c 0, the default load factor (0.75) is used. + * @param[in] provider An instance of the IHashCodeProviderT-derived class that supplies the hash codes + * for all the keys in this map + * @param[in] comparer An instance of the IComparerT-derived class to use when comparing the keys * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - A specified input parameter is invalid. @n - * - The @c loadFactor is negative. @n - * - The @c provider is a @c null or the @c comparer is a @c null. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c map is modified during the operation of this method. - * @remarks The instances of hash code provider and comparer will not be deallocated later from this map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c loadFactor is negative. + * - Either the specified @c provider or the specified @c comparer is @c null. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c map is modified during the operation of this method. + * @remarks The instances of the hash code provider and the comparer are not deallocated later from this map. * @see HashMapT() */ result Construct(const IMapT< KeyType, ValueType >& map, float loadFactor, const IHashCodeProviderT< KeyType >& provider, @@ -391,16 +395,17 @@ CATCH: } /** - * Adds the specified key-value pair to a map. + * Adds the specified key-value pair to the map. * * @since 2.0 * * @return An error code - * @param[in] key The key of the value to add - * @param[in] value The value to add + * @param[in] key The key of the value to add + * @param[in] value The value to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @exception E_OBJ_ALREADY_EXIST The specified @c key already exists. * @see Remove() */ @@ -433,11 +438,11 @@ CATCH: } /** - * Gets the elements of a map in an instance of the IMapEnumeratorT-derived class. + * Gets the elements of the map through an instance of the IMapEnumeratorT-derived class. * * @since 2.0 * - * @return An instance of the IMapEnumeratorT-derived class if successful, @n + * @return An instance of the IMapEnumeratorT-derived class, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -461,11 +466,11 @@ CATCH: } /** - * Gets the elements of a map in an instance of the IMapEnumeratorT class. + * Gets the elements of the map through an instance of the IMapEnumeratorT class. * * @since 2.0 * - * @return An instance of the IMapEnumeratorT class if successful, @n + * @return An instance of the IMapEnumeratorT class, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -485,12 +490,13 @@ CATCH: * * @return The value associated with the key, @n * else @c null if an exception occurs - * @param[in] key The key to locate - * @param[out] value The value associated with the key + * @param[in] key The key to locate + * @param[out] value The value associated with the @c key * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * The comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see SetValue() */ virtual result GetValue(const KeyType& key, ValueType& value) const @@ -526,12 +532,13 @@ CATCH: * * @return The value associated with the key, @n * else @c null if an exception occurs - * @param[in] key The key to locate - * @param[out] value The value associated with the key + * @param[in] key The key to locate + * @param[out] value The value associated with the @c key * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see SetValue() */ virtual result GetValue(const KeyType& key, ValueType& value) @@ -540,16 +547,17 @@ CATCH: } /** - * Gets a list of all the keys in a map. + * Gets the list of all the keys in the map. * * @since 2.0 * - * @return A pointer to an IListT object containing all the keys in the map, @n + * @return A pointer to the IListT object that contains all the keys in the map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks The order of the keys is the same as the corresponding values in the IListT interface returned by the GetValuesN() method. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - The order of the keys is the same as the corresponding values in the IListT interface returned by the GetValuesN() method. + * - The specific error code can be accessed using the GetLastResult() method. * @see GetValuesN() */ virtual IListT< KeyType >* GetKeysN(void) const @@ -582,11 +590,11 @@ CATCH: } /** - * Gets all the values in a map. + * Gets all the values in the map. * * @since 2.0 * - * @return A pointer to an IListT object containing all the values in the map, @n + * @return A pointer to the IListT object that contains all the values in the map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -623,16 +631,17 @@ CATCH: } /** - * Removes the value associated with the specified @c key. + * Removes the value associated to the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key to remove + * @param[in] key The key to remove * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see Add() */ virtual result Remove(const KeyType& key) @@ -675,7 +684,7 @@ CATCH: } /** - * Removes all key-value pairs in the map. + * Removes all the key-value pairs in the map. * * @since 2.0 */ @@ -695,14 +704,14 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] key The key for which the value is to replace - * @param[in] value The new value to replace + * @param[in] key The key whose value is replaced + * @param[in] value The new value to replace * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks Use the Add() method to add a new key-value pair. - * @see Add() * @see GetValue() */ virtual result SetValue(const KeyType& key, const ValueType& value) @@ -737,7 +746,7 @@ CATCH: } /** - * Gets the number of pairs currently stored in a map. + * Gets the number of pairs currently stored in the map. * * @since 2.0 * @@ -749,17 +758,18 @@ CATCH: } /** - * Checks whether a map contains the specified @c key. + * Checks whether the map contains the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key to locate - * @param[out] out Set to @c true if the map contains the specified @c key, @n - * else @c false + * @param[in] key The key to locate + * @param[out] out Set to @c true if the map contains the specified @c key, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @see ContainsValue() */ virtual result ContainsKey(const KeyType& key, bool& out) const @@ -790,7 +800,7 @@ CATCH: } /** - * Checks whether a map contains the specified @c value. + * Checks whether the map contains the specified @c value. * * @since 2.0 * @@ -817,14 +827,14 @@ CATCH: } /** - * Compares two instances of the %HashMapT class. + * Compares two instances of %HashMapT. * * @since 2.0 * * @return @c true if the two instances match, @n * else @c false * @param[in] obj The object to compare with the current instance - * @remarks This method returns @c true if and only if the two instances contain the same number of elements and all the elements of each other. + * @remarks This method returns @c true if and only if the two instances contain the same number of elements and all the elements are present in both of them. */ virtual bool Equals(const Object& obj) const { @@ -870,8 +880,8 @@ CATCH: * @since 2.0 * * @return The hash value of the current instance - * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n - * the used hash function must generate a random distribution for all inputs. + * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const { @@ -1065,7 +1075,7 @@ public: * @param[in] k The key to include in this entry * @param[in] v The value to include in this entry * @param[in] next A pointer to the next entry - * @param[in] h A hash value of the key + * @param[in] h The hash value of the key */ __HashMapEntryT(const KeyType& k, const ValueType& v, __HashMapEntryT< KeyType, ValueType >* next, int h) : key(k) @@ -1160,9 +1170,10 @@ public: * @return An error code * @param[out] obj The current object * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n - * This enumerator is currently positioned before the first element or - * past the last element or the map is modified after this enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - This enumerator is currently positioned before the first element or past the last element. + * - The map is modified after this enumerator is created. */ virtual result GetCurrent(MapEntryT< KeyType, ValueType >& obj) const { @@ -1175,17 +1186,17 @@ public: } /** - * Moves this enumerator to the next elements of the map. + * Moves this enumerator to the next element of the map. * When this enumerator is first created, or when the Reset() method is called, or when the %MoveNext() method is first called, the enumerator positions itself to the first element in the map. * * @since 2.0 * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the map is modified after this enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The map is modified after this enumerator is created. * @exception E_OUT_OF_RANGE The enumerator has passed the end of the map. - * @see Reset() */ virtual result MoveNext(void) { @@ -1213,14 +1224,15 @@ public: } /** - * Positions the enumerator before the first element in a map. + * Positions the enumerator before the first element in the map. * * @since 2.0 * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the map is modified after this enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The map is modified after this enumerator is created. */ virtual result Reset(void) { @@ -1233,16 +1245,17 @@ public: } /** - * Gets the current key in a map. + * Gets the current key in the map. * * @since 2.0 * * @return An error code * @param[out] key The current key * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n - * This enumerator is currently positioned before the first element or - * past the last element or the map is modified after this enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - This enumerator is currently positioned before the first element or past the last element. + * - The map is modified after this enumerator is created. */ virtual result GetKey(KeyType& key) const { @@ -1255,16 +1268,17 @@ public: } /** - * Gets the current value in a map. + * Gets the current value in the map. * * @since 2.0 * * @return An error code - * @param[out] value The current value + * @param[out] value The current value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n - * This enumerator is currently positioned before the first element or - * past the last element or the map is modified after the enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - This enumerator is currently positioned before the first element or past the last element + * - The map is modified after the enumerator is created. */ virtual result GetValue(ValueType& value) const { diff --git a/inc/FBaseColIBidirectionalEnumerator.h b/inc/FBaseColIBidirectionalEnumerator.h index 371ad85..05449db 100644 --- a/inc/FBaseColIBidirectionalEnumerator.h +++ b/inc/FBaseColIBidirectionalEnumerator.h @@ -36,13 +36,13 @@ namespace Tizen { namespace Base { namespace Collection * * @since 2.0 * - * @remarks - * An enumerator remains valid as long as the collection remains unchanged. - * If changes are made to the collection, such as adding, modifying, or - * deleting elements, the enumerator is irrecoverably invalidated. The next call to GetCurrent(), MoveNext(), MovePrevious(), Reset(), or ResetLast() fails (E_INVALID_OPERATION). + * @remarks An enumerator remains valid as long as the collection remains unchanged.@n + * If changes are made to the collection, such as adding, modifying, or + * deleting elements, the enumerator is irrecoverably invalidated. @n + * The next call to GetCurrent(), MoveNext(), MovePrevious(), Reset(), or ResetLast() fails (@c E_INVALID_OPERATION). * * The %IBidirectionalEnumerator interface supports a bidirectional iteration over a collection. - * One can only access the elements in a collection through %IBidirectionalEnumerator. The elements cannot be modified through this interface. + * One can only access the elements in a collection through %IBidirectionalEnumerator. The elements cannot be modified through this interface. */ class _OSP_EXPORT_ IBidirectionalEnumerator : public virtual IEnumerator @@ -58,17 +58,17 @@ public: /** * Moves %IBidirectionalEnumerator to the previous element of the collection. @n - * A call to the MovePrevious() method after the ResetLast() method positions the enumerator to the last element in the collection. + * A call to the %MovePrevious() method after the ResetLast() method, positions the enumerator to the last element in the collection. * * @since 2.0 * * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The enumerator has passed the front of the collection. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The collection is modified after the enumerator is created. * @see Tizen::Base::Collection::IEnumerator::MoveNext() - * @see ResetLast() */ virtual result MovePrevious(void) = 0; @@ -79,8 +79,9 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The collection is modified after the enumerator is created. * @see Tizen::Base::Collection::IEnumerator::Reset() * @see MovePrevious() */ diff --git a/inc/FBaseColIBidirectionalEnumeratorT.h b/inc/FBaseColIBidirectionalEnumeratorT.h index d12fe54..ae0c916 100644 --- a/inc/FBaseColIBidirectionalEnumeratorT.h +++ b/inc/FBaseColIBidirectionalEnumeratorT.h @@ -36,10 +36,10 @@ namespace Tizen { namespace Base { namespace Collection * * @since 2.0 * - * @remarks - * An enumerator remains valid as long as the collection remains unchanged. - * If changes are made to the collection, such as adding, modifying, or - * deleting elements, the enumerator is irrecoverably invalidated. The next call to GetCurrent(), MoveNext(), MovePrevious(), Reset(), or ResetLast() fails (E_INVALID_OPERATION). + * @remarks An enumerator remains valid as long as the collection remains unchanged.@n + * If changes are made to the collection, such as adding, modifying, or + * deleting elements, the enumerator is irrecoverably invalidated. @n + * The next call to GetCurrent(), MoveNext(), MovePrevious(), Reset(), or ResetLast() fails (@c E_INVALID_OPERATION). * * The %IBidirectionalEnumeratorT interface supports a bidirectional iteration over a collection. * One can only access the elements in a collection through %IBidirectionalEnumeratorT. The elements cannot be modified through this interface. @@ -67,10 +67,10 @@ public: * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The enumerator has passed the front of the collection. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation, or + * - The collection is modified after the enumerator is created. * @see Tizen::Base::Collection::IEnumeratorT< Type >::MoveNext() - * @see ResetLast() */ virtual result MovePrevious(void) = 0; @@ -81,8 +81,9 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The collection is modified after the enumerator is created. * @see Tizen::Base::Collection::IEnumeratorT< Type >::Reset() * @see MovePrevious() */ diff --git a/inc/FBaseColICollection.h b/inc/FBaseColICollection.h index e3cac90..058754f 100644 --- a/inc/FBaseColICollection.h +++ b/inc/FBaseColICollection.h @@ -42,11 +42,11 @@ namespace Tizen { namespace Base { namespace Collection /** * @interface ICollection * @brief This interface represents a collection of objects. @n - * It defines the size, enumerators, and the synchronization mechanism of a collection. + * It defines the size, the enumerators, and the synchronization mechanism of a collection. * * @since 2.0 * - * The %ICollection interface represents a collection of objects. It defines the size, enumerators, and the synchronization mechanism of a collection. + * The %ICollection interface represents a collection of objects. It defines the size, the enumerators, and the synchronization mechanism of a collection. * */ class _OSP_EXPORT_ ICollection @@ -65,24 +65,24 @@ public: * * @since 2.0 * - * @return An integer value indicating the number of objects currently stored in the collection + * @return The integer value that indicates the number of objects currently stored in the collection */ virtual int GetCount(void) const = 0; /** * Gets the enumerator of the %ICollection derived class, - * or returns @c null if some exception occurs. + * or returns @c null if an exception occurs. * * @since 2.0 * - * @return A pointer to an enumerator interface of the %ICollection derived class, @n + * @return A pointer to the enumerator interface of the %ICollection derived class, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks Use this method to obtain an enumerator (an instance of the IEnumerator derived class) + * @remarks + * - Use this method to obtain an enumerator (an instance of the IEnumerator derived class) * to iterate over a collection (an instance of the %ICollection derived class). - * @remarks The specific error code can be accessed using GetLastResult() method. - * @see Tizen::Base::Collection::IEnumerator + * - The specific error code can be accessed using GetLastResult() method. * */ virtual IEnumerator* GetEnumeratorN(void) const = 0; diff --git a/inc/FBaseColICollectionT.h b/inc/FBaseColICollectionT.h index 859d4bd..d0b5d21 100644 --- a/inc/FBaseColICollectionT.h +++ b/inc/FBaseColICollectionT.h @@ -35,12 +35,12 @@ namespace Tizen { namespace Base { namespace Collection /** * @interface ICollectionT * @brief This interface represents a template-based collection of objects. - * It defines the size, and enumerators. + * It defines the size, and the enumerators. * * @since 2.0 * * The %ICollectionT interface represents a template-based collection of objects. - * It defines the size, and enumerators. + * It defines the size, and the enumerators. */ template< class Type > class ICollectionT @@ -69,14 +69,14 @@ public: * * @since 2.0 * - * @return A pointer to an enumerator interface of the %ICollectionT derived class, @n + * @return A pointer to the enumerator interface of the %ICollectionT derived class, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks Use this method to obtain an enumerator (an instance of the IEnumeratorT derived class) + * @remarks + * - Use this method to obtain the enumerator (an instance of the IEnumeratorT derived class) * to iterate over a collection (an instance of the %ICollectionT derived class). - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see Tizen::Base::Collection::IEnumerator + * - The specific error code can be accessed using the GetLastResult() method. */ virtual IEnumeratorT< Type >* GetEnumeratorN(void) const = 0; diff --git a/inc/FBaseColIComparer.h b/inc/FBaseColIComparer.h index 689b1f2..a210d4e 100644 --- a/inc/FBaseColIComparer.h +++ b/inc/FBaseColIComparer.h @@ -30,11 +30,11 @@ namespace Tizen { namespace Base { namespace Collection { /** * @interface IComparer - * @brief This interface allows a derived class to compare 2 objects of the same type. + * @brief This interface allows a derived class to compare two objects of the same type. * * @since 2.0 * - * The %IComparer interface allows a derived class to compare 2 objects of the same type. + * The %IComparer interface allows a derived class to compare two objects of the same type. */ class _OSP_EXPORT_ IComparer { @@ -56,15 +56,15 @@ public: * @return An error code * @param[in] obj1 The first object to compare * @param[in] obj2 The second object to compare - * @param[out] cmp The result of comparison + * @param[out] cmp The result of the comparison * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified object instances are not of the expected type. * @remarks The value of @c cmp can be: * * @code - * < 0 if the value of @c obj1 is less than the value of @c obj2 - * == 0 if the value of @c obj1 is equal to the value of @c obj2 - * > 0 if the value of @c obj1 is greater than the value of @c obj2 + * < 0 if the value of obj1 is less than the value of obj2 + * == 0 if the value of obj1 is equal to the value of obj2 + * > 0 if the value of obj1 is greater than the value of obj2 * @endcode */ virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const = 0; diff --git a/inc/FBaseColIComparerT.h b/inc/FBaseColIComparerT.h index f1c6f42..a2667ee 100644 --- a/inc/FBaseColIComparerT.h +++ b/inc/FBaseColIComparerT.h @@ -29,11 +29,11 @@ namespace Tizen { namespace Base { namespace Collection { /** * @interface IComparerT - * @brief This interface allows derived classes to compare 2 template-based objects of the same type. + * @brief This interface allows derived classes to compare two template-based objects of the same type. * * @since 2.0 * - * The %IComparerT interface allows derived classes to compare 2 template-based objects of the + * The %IComparerT interface allows derived classes to compare two template-based objects of the * same type. */ template< class Type > @@ -57,15 +57,15 @@ public: * @return An error code * @param[in] obj1 The first object to compare * @param[in] obj2 The second object to compare - * @param[out] cmp The result of comparison + * @param[out] cmp The result of the comparison * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified object instances are not of the expected type. * @remarks The value of @c cmp can be: * * @code - * < 0 if the value of @c obj1 is less than the value of @c obj2 - * == 0 if the value of @c obj1 is equal to the value of @c obj2 - * > 0 if the value of @c obj1 is greater than the value of @c obj2 + * < 0 if the value of obj1 is less than the value of obj2 + * == 0 if the value of obj1 is equal to the value of obj2 + * > 0 if the value of obj1 is greater than the value of obj2 * @endcode */ virtual result Compare(const Type& obj1, const Type& obj2, int& cmp) const = 0; diff --git a/inc/FBaseColIEnumerator.h b/inc/FBaseColIEnumerator.h index 24c363b..ef2eaa2 100644 --- a/inc/FBaseColIEnumerator.h +++ b/inc/FBaseColIEnumerator.h @@ -40,11 +40,11 @@ namespace Tizen { namespace Base { namespace Collection * * @since 2.0 * - * @remarks - * An enumerator remains valid as long as the collection remains unchanged. - * If changes are made to the collection, such as adding, modifying, or - * deleting elements, the enumerator is irrecoverably invalidated. The next call to GetCurrent(), MoveNext(), or Reset() fails and returns - * E_INVALID_OPERATION. + * @remarks An enumerator remains valid as long as the collection remains unchanged. @n + * If changes are made to the collection, such as adding, modifying, or + * deleting elements, the enumerator is irrecoverably invalidated. @n + * The next call to GetCurrent(), MoveNext(), or Reset() fails and returns + * @c E_INVALID_OPERATION. * * The %IEnumerator interface supports simple iteration over a collection. * One can only access the elements in a collection through %IEnumerator. The elements cannot be modified through this interface. @@ -69,13 +69,12 @@ public: * @return The current object in the collection, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n - * - The current state of the instance prohibits the execution of the specified operation. @n + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. * - The enumerator is currently positioned before the first element - * or after the last element. @n + * or after the last element. * - The collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see GetLastResult() */ virtual Tizen::Base::Object* GetCurrent(void) const = 0; @@ -89,9 +88,9 @@ public: * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The enumerator has passed the end of the collection. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the enumerator is created. - * @see Reset() + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The collection is modified after the enumerator is created. */ virtual result MoveNext(void) = 0; @@ -102,8 +101,9 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The collection is modified after the enumerator is created. */ virtual result Reset(void) = 0; diff --git a/inc/FBaseColIEnumeratorT.h b/inc/FBaseColIEnumeratorT.h index d26de5f..45c07fb 100644 --- a/inc/FBaseColIEnumeratorT.h +++ b/inc/FBaseColIEnumeratorT.h @@ -36,11 +36,11 @@ namespace Tizen { namespace Base { namespace Collection * * @since 2.0 * - * @remarks - * An enumerator remains valid as long as the collection remains unchanged. - * If changes are made to the collection, such as adding, modifying, or - * deleting elements, the enumerator is irrecoverably invalidated. The next call to GetCurrent(), MoveNext(), or Reset() fails and returns - * E_INVALID_OPERATION. + * @remarks An enumerator remains valid as long as the collection remains unchanged. @n + * If changes are made to the collection, such as adding, modifying, or + * deleting elements, the enumerator is irrecoverably invalidated. @n + * The next call to GetCurrent(), MoveNext(), or Reset() fails and returns + * @c E_INVALID_OPERATION. * * The %IEnumeratorT interface supports simple iteration over a template-based collection. * One can only access the elements in a collection through %IEnumeratorT. The elements cannot be modified through this interface. @@ -64,11 +64,13 @@ public: * @since 2.0 * * @return An error code - * @param[out] obj A pointer to the current object + * @param[out] obj A pointer to the current object * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n - * The enumerator is currently positioned before the first element or - * after the last element or the collection is modified after the enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The enumerator is currently positioned before the first element or + * after the last element. + * - The collection is modified after the enumerator is created. */ virtual result GetCurrent(Type& obj) const = 0; @@ -82,9 +84,9 @@ public: * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The enumerator has passed the end of the collection. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the enumerator is created. - * @see Reset() + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The collection is modified after the enumerator is created. */ virtual result MoveNext(void) = 0; @@ -95,8 +97,9 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The collection is modified after the enumerator is created. */ virtual result Reset(void) = 0; diff --git a/inc/FBaseColIHashCodeProvider.h b/inc/FBaseColIHashCodeProvider.h index 9ccd9d1..3e527ac 100644 --- a/inc/FBaseColIHashCodeProvider.h +++ b/inc/FBaseColIHashCodeProvider.h @@ -33,11 +33,11 @@ namespace Tizen { namespace Base { namespace Collection /** * @interface IHashCodeProvider - * @brief This interface represents classes that can provide the hash code of a specific type of object. + * @brief This interface represents classes that provide the hash code of a specific type of object. * * @since 2.0 * - * The %IHashCodeProvider interface represents classes that can provide the hash code of a specific type of object. + * The %IHashCodeProvider interface represents classes that provide the hash code of a specific type of object. */ class _OSP_EXPORT_ IHashCodeProvider { @@ -56,10 +56,11 @@ public: * @since 2.0 * * @return The hash code of the specified object - * @param[in] obj A pointer to the object whose hash code is required - * @remarks The hash algorithm is usually specific to a type. - * Two equal instances must return the same hash value. - * For better performance, the used hash function must generate a random distribution for all inputs. + * @param[in] obj A pointer to the object whose hash code is required + * @remarks + * - The hash algorithm is usually of a specific type. + * - Two equal instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(const Tizen::Base::Object& obj) const = 0; diff --git a/inc/FBaseColIHashCodeProviderT.h b/inc/FBaseColIHashCodeProviderT.h index e691354..c3694dc 100644 --- a/inc/FBaseColIHashCodeProviderT.h +++ b/inc/FBaseColIHashCodeProviderT.h @@ -28,11 +28,11 @@ namespace Tizen { namespace Base { namespace Collection /** * @interface IHashCodeProviderT - * @brief This interface represents classes that can provide the hash code of a specific type of template-based object. + * @brief This interface represents classes that provide the hash code of a specific type of template-based object. * * @since 2.0 * - * The %IHashCodeProviderT interface represents classes that can provide the hash code of a specific type of template-based object. + * The %IHashCodeProviderT interface represents classes that provide the hash code of a specific type of template-based object. * */ template< class Type > @@ -53,10 +53,11 @@ public: * @since 2.0 * * @return The hash code of the specified object - * @param[in] obj A pointer to the object for which the hash code is required - * @remarks The hash algorithm is usually specific to a type. @n - * Two equal instances must return the same hash value. - * For better performance, the used hash function must generate a random distribution for all inputs. + * @param[in] obj A pointer to the object whose hash code is required + * @remarks + * - The hash algorithm is usually of a specific type. + * - Two equal instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(const Type& obj) const = 0; diff --git a/inc/FBaseColIList.h b/inc/FBaseColIList.h index 21811c1..7f9120f 100644 --- a/inc/FBaseColIList.h +++ b/inc/FBaseColIList.h @@ -58,7 +58,7 @@ public: * Adds the specified object to the list. * * @brief [Deprecated] - * @deprecated This method is deprecated because it has a problem of const reference argument. + * @deprecated This method is deprecated because it has a problem of constant reference argument. * Instead of using this method, use Add(Object* pObj). * @since 2.0 * @@ -66,12 +66,14 @@ public: * @param[in] obj The object to add * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks In a collection of contiguous elements, such as a list, the elements - * that follow the insertion point move down to accommodate the new element. + * @remarks + * - In a collection of contiguous elements, such as a list, the elements + * that follow the insertion point move down to accommodate the new element. @n * If the collection is indexed, the indexes of the elements that are moved - * are also updated. This behavior does not apply to collections where + * are also updated. @n + * This behavior does not apply to collections where * elements are conceptually grouped into buckets, such as a hashtable. - * This method performs a shallow copy. It adds the pointer only; not the element itself. + * - This method performs a shallow copy. It adds just the pointer only and not the element itself. * @see Remove() * @endif */ @@ -86,45 +88,48 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj The pointer to object to add + * @param[in] pObj A pointer to the object to add * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @remarks In a collection of contiguous elements, such as a list, the elements - * that follow the insertion point move down to accommodate the new element. + * @remarks + * - In a collection of contiguous elements, such as a list, the elements + * that follow the insertion point move down to accommodate the new element. @n * If the collection is indexed, the indexes of the elements that are moved - * are also updated. This behavior does not apply to collections where + * are also updated. @n + * This behavior does not apply to collections where * elements are conceptually grouped into buckets, such as a hashtable. - * This method performs a shallow copy. It adds the pointer only; not the element itself. + * - This method performs a shallow copy. It adds just the pointer only and not the element itself. * @see Remove() */ virtual result Add(Object* pObj) = 0; /** - * Adds the elements of the specified collection to the end of the list. + * Adds the elements of the specified @c collection to the end of the list. * * @since 2.0 * * @return An error code * @param[in] collection The collection to add to the list * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the specified @c collection is modified during the operation of this method. - * @remarks This method performs a shallow copy. It adds the pointer only; not the element itself. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. + * @remarks This method performs a shallow copy. It adds just the pointer only and not the element itself. * @see RemoveItems() */ virtual result AddItems(const ICollection& collection) = 0; /** * Searches for an object in this list. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. */ virtual result IndexOf(const Object& obj, int& index) const = 0; @@ -133,19 +138,22 @@ public: * Inserts an object at the specified location in the list. * * @brief [Deprecated] - * @deprecated This method is deprecated because it has a problem of const reference argument. + * @deprecated This method is deprecated because it has a problem of constant reference argument. * Instead of using this method, use InsertAt(const Object* pObj, int index). * @since 2.0 * * @return An error code - * @param[in] obj The object to insert - * @param[in] index The index at which the object must be inserted + * @param[in] obj The object to insert + * @param[in] index The index at which the object is inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is greater than the number of elements in the list or less than @c 0. - * @remarks If the @c index equals the number of elements in the list, the new element + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is greater than the number of elements in the list. + * - The specified @c index is less than @c 0. + * @remarks + * - If the @c index equals the number of elements in the list, the new element * is added at the end of the list. - * This method performs a shallow copy. It inserts the pointer only; not the element itself. + * - This method performs a shallow copy. It inserts just the pointer only and not the element itself. * @see Add(Object*) * @see RemoveAt() * @endif @@ -161,72 +169,78 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj The pointer to object to insert - * @param[in] index The index at which the object must be inserted + * @param[in] pObj A pointer to the object to insert + * @param[in] index The index at which the object is inserted * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is greater than the number of elements in the list or less than @c 0. - * @remarks If the @c index equals the number of elements in the list, the new element + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified index is outside the bounds of the data structure. + * - The specified @c index is greater than the number of elements in the list. + * - The specified @c index is less than @c 0. + * @remarks + * - If the @c index equals the number of elements in the list, the new element * is added at the end of the list. - * This method performs a shallow copy. It inserts the pointer only; not the element itself. + * - This method performs a shallow copy. It inserts just the pointer only and not the element itself. * @see Add(Object*) * @see RemoveAt() */ virtual result InsertAt(Object* pObj, int index) = 0; /** - * Searches for an object starting from the specified index. @n - * Gets the index of the object if found. + * Searches for an object starting from the specified @c index. @n + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index for the search @n - * It must be less than the number of elements. - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index for the search @n + * It must be less than the number of elements. + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Object& obj, int startIndex, int& index) const = 0; /** * Searches for an object within the specified range. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n - * - The @c count is greater than the number of elements starting from @c startIndex - * or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Object& obj, int startIndex, int count, int& index) const = 0; /** - * Searches for the last occurrence of an object in this list. @n - * Gets the index of the object if found. + * Searches for the last occurrence of an object in the list. @n + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the last occurrence of the specified object + * @param[in] obj The object to locate + * @param[out] index The index of the last occurrence of the specified object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see IndexOf() */ virtual result LastIndexOf(const Object& obj, int& index) const = 0; @@ -237,16 +251,20 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection The collection to insert - * @param[in] startIndex The starting index at which the collection must be inserted + * @param[in] collection The collection to insert + * @param[in] startIndex The starting index at which the collection is inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c startIndex is greater than the number of elements in the list or less than @c 0. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the specified @c collection is modified during the operation of this method. - * @remarks If the @c startIndex equals the number of elements in the list, the new elements + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is greater than the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. + * @remarks + * - If the @c startIndex is equal to the number of elements in the list, the new elements * are added at the end of the list. - * This method performs a shallow copy. It inserts just the pointer; not the element itself. + * - This method performs a shallow copy. It inserts just the pointer and not the element itself. * @see RemoveItems() * @see AddItems() */ @@ -258,11 +276,13 @@ public: * @since 2.0 * * @return The object at the specified location, @n - * else @c null if the @c index is not valid - * @param[in] index The index of the object to get + * else @c null if the @c index invalid + * @param[in] index The index of the object to get * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetAt() */ @@ -274,11 +294,13 @@ public: * @since 2.0 * * @return The object at the specified location, @n - * else @c null if the @c index is not valid + * else @c null if the @c index invalid * @param[in] index The index of the object to get * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetAt() */ @@ -289,18 +311,20 @@ public: * * @since 2.0 * - * @return A pointer to an %IList with elements lying within the specified range, @n + * @return A pointer to the %IList that contains elements lying within the specified range, @n * else @c null if an exception occurs - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n - * - The @c count is greater than the number of elements in the list starting from @c startIndex - * or less than @c 0. - * @remarks The %IList stores just the pointers to the elements in the list, not the elements themselves. - * The specific error code can be accessed using the GetLastResult() method. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements in the list starting from @c startIndex. + * - The specified @c count is less than @c 0. + * @remarks + * - The %IList stores just the pointers to the elements in the list and not the elements themselves. + * - The specific error code can be accessed using the GetLastResult() method. */ virtual IList* GetItemsN(int startIndex, int count) const = 0; @@ -310,15 +334,15 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj The object to remove + * @param[in] obj The object to remove * @param[in] forceDeletion Set to @c true to deallocate the object, @n * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @remarks - * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n - * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n + * If both the element deleter and the @c forceDeletion are set, the remove operation follows the @c forceDeletion setting. * - Remove(obj, @b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -362,7 +386,7 @@ public: * @return An error code * @param[in] obj The object to remove * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see Add(Object*) * @see RemoveAt() */ @@ -374,16 +398,18 @@ public: * @since 2.0 * * @return An error code - * @param[in] index The index at which the object must be removed - * @param[in] forceDeletion Set to @c true to deallocate the object, @n - * else @c false + * @param[in] index The index at which the object is removed + * @param[in] forceDeletion Set to @c true to deallocate the object, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks - * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n - * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n + * If both the element deleter and the @c forceDeletion are set, the remove operation follows the @c forceDeletion setting. * - RemoveAt(index, @b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -423,10 +449,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] index The index at which the object must be removed + * @param[in] index The index at which the object is removed * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. */ virtual result RemoveAt(int index) = 0; @@ -436,20 +464,21 @@ public: * @since 2.0 * * @return An error code - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements in the range - * @param[in] forceDeletion Set to @c true to deallocate the object, @n - * else @c false + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements in the range + * @param[in] forceDeletion Set to @c true to deallocate the object, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n - * - The @c count is greater than the number of elements starting from @c startIndex - * or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. * @remarks - * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n - * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n + * If both the element deleter and the @c forceDeleteion are set, the remove operation follows the @c forceDeletion setting. * - RemoveItems(startIndex, count, @b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -490,14 +519,15 @@ public: * @since 2.0 * * @return An error code - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements in the range + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements in the range * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n - * - The @c count is greater than the number of elements starting from @c startIndex - * or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. * @see AddItems() */ virtual result RemoveItems(int startIndex, int count) = 0; @@ -508,16 +538,17 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection The collection to be removed from this list + * @param[in] collection The collection to remove from this list * @param[in] forceDeletion Set to @c true to deallocate the object, @n * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the specified @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. * @remarks - * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n - * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n + * If both the element deleter and the @c forceDeleteion are set, the remove operation follows the @c forceDeletion setting. * - RemoveItems(collection, @b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -554,15 +585,16 @@ public: } /** - * Removes all the elements from the list that are common to the specified collection. + * Removes all the elements from the list that are common to the specified @c collection. * * @since 2.0 * * @return An error code * @param[in] collection The collection to remove from this list * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the specified @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. * @see Remove() * @see RemoveAt() */ @@ -570,7 +602,7 @@ public: /** * Removes all the object pointers in the collection. @n - * If the deallocate param is set to @c true, it removes all the objects in the collection. @n + * If @c forceDeletion is set to @c true, it removes all the objects from the collection. @n * This method can be called just before deleting the collection. * * @since 2.0 @@ -579,9 +611,9 @@ public: * @param[in] forceDeletion Set to @c true to deallocate all the objects, @n * else @c false * @remarks - * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n - * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n + * If both the element deleter and the @c forceDeleteion are set, the remove operation follows the @c forceDeletion setting. * - RemoveAll(@b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -615,7 +647,7 @@ public: } /** - * Removes all the object pointers in the collection. @n + * Removes all the object pointers from the collection. @n * This method can be called just before deleting the collection. * * @since 2.0 @@ -623,22 +655,24 @@ public: virtual void RemoveAll(void) = 0; /** - * Replaces the object at the specified index with the specified object. + * Replaces the object at the specified @c index with the specified object. * * @since 2.0 * * @return An error code - * @param[in] obj The new object - * @param[in] index The index at which the new object must be set - * @param[in] forceDeletion Set to @c true to deallocate the object, @n - * else @c false + * @param[in] obj The new object + * @param[in] index The index at which the new object is set + * @param[in] forceDeletion Set to @c true to deallocate the object, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks - * - Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the set method. @n - * If both an element deleter and forceDeleteion are set, the set operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the set operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the set method. @n + * If both the element deleter and the @c forceDeleteion are set, the set operation follows the @c forceDeletion setting. * - SetAt(obj, index, @b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -674,28 +708,30 @@ public: } /** - * Replaces the object at the specified index with the specified object. + * Replaces the object at the specified @c index with the specified object. * * @since 2.0 * * @return An error code - * @param[in] pObj The pointer to new object - * @param[in] index The index at which the new object must be set + * @param[in] pObj A pointer to the new object + * @param[in] index The index at which the new object is set * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @see GetAt() */ virtual result SetAt(Object* pObj, int index) = 0; /** - * Sorts the elements of this list using the comparer provided. + * Sorts the elements of the list using the @c comparer provided. * * @since 2.0 * * @return An error code - * @param[in] comparer The IComparer implementation to use when comparing elements + * @param[in] comparer The IComparer implementation to use when comparing the elements * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ @@ -714,22 +750,23 @@ public: /** * @if OSPDEPREC - * Checks whether the list contains all the elements of the specified collection. + * Checks whether the list contains all the elements of the specified @c collection. * * @brief [Deprecated] - * @deprecated This method is deprecated because it transfers a result of comparison in out-parameter form. - * The return type will be changed into boolean type and this method will return the result. + * @deprecated This method is deprecated because it transfers the result of the comparison in an out-parameter form. + * The return type is changed to boolean and this method returns the result. * Instead of using this method, use bool ContainsAll(const ICollection& collection). * @since 2.0 * * @return An error code - * @param[in] collection The collection to check for containment in this list - * @param[out] out Set to @c true if the list contains all the elements of the specified collection, @n - * else @c false + * @param[in] collection The collection to check for containment in this list + * @param[out] out Set to @c true if the list contains all the elements of the specified collection, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the specified @c collection is modified during the operation of this method. - * @remarks If the given @c collection is empty, the @c out parameter is set to @c true. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. + * @remarks If the given @c collection is empty, then @c out is set to @c true. * @see Contains() * @endif */ @@ -741,44 +778,45 @@ public: } /** - * Checks whether the list contains all the elements of the specified collection. + * Checks whether the list contains all the elements of the specified @c collection. * * @since 2.0 * * @return @c true if the list contains all the elements of the specified collection, @n - * else @c false + * else @c false * @param[in] collection The collection to check for containment in this list * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the specified @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. * @remarks * - The specific error code can be accessed using the GetLastResult() method. - * - If the given @c collection is empty, this method will return @c true. + * - If the given @c collection is empty, this method returns @c true. * @see Contains() */ virtual bool ContainsAll(const ICollection& collection) const = 0; /** - * Gets a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) of this list. + * Gets the bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) of this list. * * @since 2.0 * - * @return A pointer to a bidirectional enumerator interface of the %IList derived class, @n + * @return A pointer to the bidirectional enumerator interface of the %IList derived class, @n * else @c null if an exception occurs - * @remarks Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) + * @remarks + * - Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) * to iterate over a collection (an instance of the %IList derived class). - * The specific error code can be accessed using GetLastResult() method. - * @see Tizen::Base::Collection::IBidirectionalEnumerator + * - The specific error code can be accessed using GetLastResult() method. */ virtual IBidirectionalEnumerator* GetBidirectionalEnumeratorN(void) const = 0; /** - * This method is for distinguishing between ArrayList and LinkedList. + * Checks whether the instance is an ArrayList or a LinkedList. * * @since 2.0 * * @return @c true if it is an ArrayList, @n - * else @c false if it is a LinkedList. + * else @c false if it is a LinkedList */ virtual bool IsRandomAccessible(void) const { diff --git a/inc/FBaseColIListT.h b/inc/FBaseColIListT.h index b0109fd..6729b7d 100644 --- a/inc/FBaseColIListT.h +++ b/inc/FBaseColIListT.h @@ -78,78 +78,82 @@ public: * @return An error code * @param[in] collection The collection to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the specified @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. * @see RemoveItems() */ virtual result AddItems(const ICollectionT< Type >& collection) = 0; /** * Searches for an object in this list. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. */ virtual result IndexOf(const Type& obj, int& index) const = 0; /** - * Searches for an object starting from the specified index. @n - * Gets the index of the object if found. + * Searches for an object starting from the specified @c startIndex. @n + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index for the search @n - * It must be less than the number of elements. - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index for the search @n + * It must be less than the number of elements. + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Type& obj, int startIndex, int& index) const = 0; /** * Searches for an object within the specified range. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n - * - The @c count is greater than the number of elements starting from @c startIndex - * or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Type& obj, int startIndex, int count, int& index) const = 0; /** * Searches for the last occurrence of an object in this list. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the last occurrence of the specified object + * @param[in] obj The object to locate + * @param[out] index The index of the last occurrence of the specified object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see IndexOf() */ virtual result LastIndexOf(const Type& obj, int& index) const = 0; @@ -160,12 +164,14 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj The object to insert - * @param[in] index The index at which the object must be inserted + * @param[in] obj The object to insert + * @param[in] index The index at which the object is inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c index is greater than the number of elements in the list or less than @c 0. - * @remarks If the @c index equals the number of elements in the list, the new element + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is greater than the number of elements in the list. + * - The specified @c index is less than @c 0. + * @remarks If the @c index is equal to the number of elements in the list, the new element * is added at the end of the list. * @see Add() * @see RemoveAt() @@ -173,18 +179,21 @@ public: virtual result InsertAt(const Type& obj, int index) = 0; /** - * Inserts the elements of a collection in the list at the specified location. + * Inserts the elements of a collection at the specified location in the list. * * @since 2.0 * * @return An error code - * @param[in] collection The collection to insert - * @param[in] startIndex The starting index at which the collection must be inserted + * @param[in] collection The collection to insert + * @param[in] startIndex The starting index at which the collection is inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the @c startIndex is greater than the number of elements in the list or less than @c 0. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the specified @c collection is modified during the operation of this method. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is greater than the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. * @remarks If the @c startIndex equals the number of elements in the list, the new elements * are added at the end of the list. * @see RemoveItems() @@ -198,11 +207,13 @@ public: * @since 2.0 * * @return An error code - * @param[in] index The index of the object to get - * @param[out] obj The object obtained from the list + * @param[in] index The index of the object to get + * @param[out] obj The object obtained from the list * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @see SetAt() */ virtual result GetAt(int index, Type& obj) const = 0; @@ -213,11 +224,13 @@ public: * @since 2.0 * * @return An error code - * @param[in] index The index of the object to get - * @param[out] obj The object obtained from the list + * @param[in] index The index of the object to get + * @param[out] obj The object obtained from the list * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @see SetAt() */ virtual result GetAt(int index, Type& obj) = 0; @@ -227,16 +240,17 @@ public: * * @since 2.0 * - * @return A pointer to %IListT with elements lying within the specified range, @n + * @return A pointer to %IListT that contains the elements lying within the specified range, @n * else @c null if an exception occurs - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n - * - The @c count is greater than the number of elements in the list starting from @c startIndex - * or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements in the list starting from @c startIndex. + * - The specified @c count is less than @c 0. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual IListT< Type >* GetItemsN(int startIndex, int count) const = 0; @@ -249,7 +263,7 @@ public: * @return An error code * @param[in] obj The object to remove * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The object is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. */ virtual result Remove(const Type& obj) = 0; @@ -259,23 +273,26 @@ public: * @since 2.0 * * @return An error code - * @param[in] index The index at which the object must be removed + * @param[in] index The index at which the object is removed * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. */ virtual result RemoveAt(int index) = 0; /** - * Removes all the elements from the list that are common to the specified collection. + * Removes all the elements from the list that are common to the specified @c collection. * * @since 2.0 * * @return An error code * @param[in] collection The collection to remove from this list * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the specified @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. * @see Remove() * @see RemoveAt() */ @@ -287,48 +304,51 @@ public: * @since 2.0 * * @return An error code - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements in the range + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements in the range * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n - * - The @c count is greater than the number of elements starting from @c startIndex - * or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. * @see AddItems() * @see InsertItemsFrom() */ virtual result RemoveItems(int startIndex, int count) = 0; /** - * Removes all the elements in the list. + * Removes all the elements from the list. * * @since 2.0 */ virtual void RemoveAll(void) = 0; /** - * Sets the object at the specified index with the specified object. + * Sets the object at the specified @c index with the specified object. * * @since 2.0 * * @return An error code - * @param[in] obj The new object - * @param[in] index The index at which the new object must be set + * @param[in] obj The new object + * @param[in] index The index at which the new object is set * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is either equal to or greater than the number of elements in the list or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @see GetAt() */ virtual result SetAt(const Type& obj, int index) = 0; /** - * Sorts the elements of this list using the comparer provided. + * Sorts the elements of this list using the @c comparer provided. * * @since 2.0 * * @return An error code - * @param[in] comparer The IComparerT implementation to use when comparing elements + * @param[in] comparer The IComparerT implementation to use when comparing the elements * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ @@ -346,35 +366,36 @@ public: virtual bool Contains(const Type& obj) const = 0; /** - * Checks whether the list contains all the elements of the specified collection. + * Checks whether the list contains all the elements of the specified @c collection. * * @since 2.0 * * @return An error code - * @param[in] collection The collection to check for containment in this list - * @param[out] out Set to @c true if the list contains all the elements of the specified collection, @n - * else @c false + * @param[in] collection The collection to check for containment in this list + * @param[out] out Set to @c true if the list contains all the elements of the specified collection, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the specified @c collection is modified during the operation of this method. - * @remarks If the given @c collection is empty, the @c out parameter is set to @c true. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. + * @remarks If the given @c collection is empty, then @c out is set to @c true. * @see Contains() */ virtual result ContainsAll(const ICollectionT< Type >& collection, bool& out) const = 0; /** - * Gets a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) of this list. + * Gets the bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) of this list. * * @since 2.0 * - * @return A pointer to a bidirectional enumerator interface of the %IListT derived class, @n + * @return A pointer to the bidirectional enumerator interface of the %IListT derived class, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) - * to iterate over a collection (an instance of the %IListT derived class). - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see Tizen::Base::Collection::IBidirectionalEnumeratorT + * @remarks + * - Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) + * to iterate over a collection (an instance of the %IListT derived class). + * - The specific error code can be accessed using the GetLastResult() method. */ virtual IBidirectionalEnumeratorT< Type >* GetBidirectionalEnumeratorN(void) const = 0; diff --git a/inc/FBaseColIMap.h b/inc/FBaseColIMap.h index 01faca3..a24e53d 100644 --- a/inc/FBaseColIMap.h +++ b/inc/FBaseColIMap.h @@ -40,7 +40,7 @@ class MapEntry; * * @since 2.0 * - * The %IMap interface abstracts a collection of key-value pairs. An %IMap instance + * The %IMap interface represents a collection of key-value pairs. An %IMap instance * contains unique keys and each key maps to a single value. * The key and value cannot be a @c null reference. * @@ -63,18 +63,19 @@ public: * Adds the specified key-value pair to the map. * * @brief [Deprecated] - * @deprecated This method is deprecated because it has a problem of const reference argument. + * @deprecated This method is deprecated because it has a problem of constant reference argument. * Instead of using this method, use Add(Object* pKey, Object* pValue). * @since 2.0 * * @return An error code - * @param[in] key The key to add - * @param[in] value The corresponding value to add + * @param[in] key The key to add + * @param[in] value The corresponding value to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @exception E_OBJ_ALREADY_EXIST The specified @c key already exists. - * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself. + * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself. * @see Remove() * @endif */ @@ -89,29 +90,31 @@ public: * @since 2.0 * * @return An error code - * @param[in] pKey The pointer to key to add - * @param[in] pValue The pointer to corresponding value to add + * @param[in] pKey A pointer to the key to add + * @param[in] pValue A pointer to the corresponding value to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @exception E_OBJ_ALREADY_EXIST The specified @c pKey already exists. - * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself. + * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself. * @see Remove() */ virtual result Add(Object* pKey, Object* pValue) = 0; /** - * Checks if the key exists. If the key does not exist, Add() is called. Unless, SetValue() is called. + * Checks whether the key exists. If the key does not exist, the Add() method is called. Unless, the SetValue() method is called. * * @since 2.0 * * @return An error code - * @param[in] pKey The pointer to key to add - * @param[in] pValue The pointer to corresponding value to add + * @param[in] pKey A pointer to the key to add + * @param[in] pValue A pointer to the corresponding value to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself. * @see Add(Object*, Object*) * @see SetValue() */ @@ -128,34 +131,36 @@ public: } /** - * Gets the value associated with the specified key. + * Gets the value associated to the specified @c key. * * @since 2.0 * - * @return The value associated with the specified key, @n + * @return The value associated to the specified key, @n * else @c null if an exception occurs - * @param[in] key The key to find the associated value + * @param[in] key The key used to find the associated value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetValue() */ virtual const Object* GetValue(const Object& key) const = 0; /** - * Gets the value associated with the specified key. + * Gets the value associated to the specified @c key. * * @since 2.0 * - * @return The value associated with the specified key, @n + * @return The value associated to the specified key, @n * else @c null if an exception occurs - * @param[in] key The key to find the associated value + * @param[in] key The key used to find the associated value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetValue() */ @@ -166,47 +171,47 @@ public: * * @since 2.0 * - * @return A pointer to a list of all the keys in the map, @n + * @return A pointer to the list of all the keys in the map, @n * else @c null if an exception occurs * @remarks * - The order of the keys is the same as the corresponding values in the IList interface returned by the GetValuesN() method. - * - The %IList interface stores just the pointers to the elements in the map, not the elements themselves. + * - The %IList interface stores just the pointers to the elements in the map and not the elements themselves. * - The specific error code can be accessed using the GetLastResult() method. - * @see GetValuesN() */ virtual IList* GetKeysN(void) const = 0; /** - * Gets a list of all the values in the map. + * Gets the list of all the values in the map. * * @since 2.0 * - * @return A pointer to a list of all the values in the map, @n + * @return A pointer to the list of all the values in the map, @n * else @c null if an exception occurs * @remarks - * - The IList stores just the pointers to the elements in the map, not the elements themselves. + * - The IList interface stores just the pointers to the elements in the map and not the elements themselves. * - The specific error code can be accessed using the GetLastResult() method. * @see GetKeysN() */ virtual IList* GetValuesN(void) const = 0; /** - * Removes the value associated with the specified key. + * Removes the value associated to the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key to remove - * @param[in] forceDeletion Set to @c true to deallocate the object, @n - * else @c false + * @param[in] key The key to remove + * @param[in] forceDeletion Set to @c true to deallocate the object, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks - * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n - * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n + * If both the element deleter and the @c forceDeletion are set, the remove operation follows the @c forceDeletion setting. * - Remove(key, @b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -242,32 +247,33 @@ public: } /** - * Removes the value associated with the specified key. + * Removes the value associated to the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the value is to remove + * @param[in] key The key for which the value is removed * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see Add(Object*, Object*) */ virtual result Remove(const Object& key) = 0; /** * Removes all the object pointers in the collection. @n - * If the @c forceDeletion parameter is set to @c true, the method also removes all the objects. This method can be called before deleting the collection. + * If @c forceDeletion is set to @c true, the method also removes all the objects. The %RemoveAll() method can be called before deleting the collection. * * @since 2.0 * * @param[in] forceDeletion Set to @c true to deallocate all the objects, @n * else @c false * @remarks - * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n - * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n + * If both the element deleter and the @c forceDeletion are set, the remove operation follows the @c forceDeletion setting. * - RemoveAll(@b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -301,31 +307,32 @@ public: } /** - * Removes all the object pointers in the collection. @n + * Removes all the object pointers from the collection. @n * * @since 2.0 */ virtual void RemoveAll(void) = 0; /** - * Replaces the value associated with the specified key with the specified value. + * Replaces the value associated to the specified @c key with the specified @c value. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the value is to replace - * @param[in] value The new value + * @param[in] key The key for which the value is replaced + * @param[in] value The new value * @param[in] forceDeletion Set to @c true to deallocate the object, @n * else @c false - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks * - Use the Add(Object*, Object*) method to add a new key-value pair. - * - Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the set method. @n - * If both an element deleter and forceDeleteion are set, the set operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the set operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the set method. @n + * If both the element deleter and the @c forceDeletion are set, the set operation follows the @c forceDeletion setting. * - SetValue(key, value, @b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -361,17 +368,18 @@ public: } /** - * Replaces the value associated with the specified key with the specified value. + * Replaces the value associated to the specified @c key with the specified @c value. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the value is to replace - * @param[in] pValue The pointer to new value + * @param[in] key The key for which the value is replaced + * @param[in] pValue A pointer to the new value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks Use the Add(Object*, Object*) method to add a new key-value pair. * @see GetValue() */ @@ -379,21 +387,22 @@ public: /** * @if OSPDEPREC - * Checks whether the map contains the specified key. + * Checks whether the map contains the specified @c key. * * @brief [Deprecated] - * @deprecated This method is deprecated because it transfers a result of comparison in out-parameter form. - * The return type will be changed into boolean type and this method will return the result. + * @deprecated This method is deprecated because it transfers the result of the comparison in an out-parameter form. + * The return type is changed into boolean and this method returns the result. * Instead of using this method, use bool ContainsKey(const Object& key). * @since 2.0 * * @return An error code - * @param[in] key The key to locate - * @param[out] out Set to @c true if the map contains the specified key, @n - * else @c false + * @param[in] key The key to locate + * @param[out] out Set to @c true if the map contains the specified key, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @see ContainsValue() * @endif */ @@ -405,7 +414,7 @@ public: } /** - * Checks whether the map contains the specified key. + * Checks whether the map contains the specified @c key. * * @since 2.0 * @@ -413,15 +422,16 @@ public: * else @c false * @param[in] key The key to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see ContainsValue() */ virtual bool ContainsKey(const Object& key) const = 0; /** - * Checks whether the map contains the specified value. + * Checks whether the map contains the specified @c value. * * @since 2.0 * @@ -429,21 +439,20 @@ public: * else @c false * @param[in] value The value to locate * - * @see ContainsKey(const Object&) + * @see ContainsKey(const Object&) const */ virtual bool ContainsValue(const Object& value) const = 0; /** - * Gets an instance of the IMapEnumerator for the map. + * Gets an instance of IMapEnumerator for the map. * * @since 2.0 * - * @return IMapEnumerator object of this map, @n + * @return An instance of IMapEnumerator for this map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see IEnumerator - * @see IMapEnumerator */ virtual IMapEnumerator* GetMapEnumeratorN(void) const = 0; diff --git a/inc/FBaseColIMapEnumerator.h b/inc/FBaseColIMapEnumerator.h index ef95d93..91131b2 100644 --- a/inc/FBaseColIMapEnumerator.h +++ b/inc/FBaseColIMapEnumerator.h @@ -33,16 +33,16 @@ class MapEntry; /** * @interface IMapEnumerator - * @brief This interface supports simple iteration over a map. + * @brief This interface supports a simple iteration over a map. * * @since 2.0 * - * @remarks - * An enumerator remains valid as long as the map remains unchanged. - * If changes are made to the map, such as adding, modifying, or - * deleting elements, the enumerator is irrecoverably invalidated. The next call to any method returns an E_INVALID_OPERATION message. + * @remarks An enumerator remains valid as long as the map remains unchanged. @n + * If changes are made to the map, such as adding, modifying, or + * deleting elements, the enumerator is irrecoverably invalidated. @n + * The next call to any method returns @c E_INVALID_OPERATION. * - * The %IMapEnumerator interface supports simple iteration over a map. + * The %IMapEnumerator interface supports a simple iteration over a map. * One can only access the elements in a collection through %IMapEnumerator. The elements cannot be modified through this interface. * * For more information on the class features, see HashMap and MultiHashMap. @@ -61,16 +61,16 @@ public: virtual ~IMapEnumerator(void) {} /** - * Gets the current object from the collection. + * Gets the current object in the collection. * * @since 2.0 * * @return A pointer to the current object in the collection, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n - * - The current state of the instance prohibits the execution of the specified operation. @n - * - The enumerator is currently positioned before the first element or after the last element. @n + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The enumerator is currently positioned before the first element or after the last element. * - The collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -84,9 +84,9 @@ public: * @return A pointer to the current key in the map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n - * - The current state of the instance prohibits the execution of the specified operation. @n - * - The enumerator is currently positioned before the first element or after the last element. @n + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The enumerator is currently positioned before the first element or after the last element. * - The collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -100,9 +100,9 @@ public: * @return A pointer to the current value in the map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n - * - The current state of the instance prohibits the execution of the specified operation. @n - * - The enumerator is currently positioned before the first element or after the last element. @n + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The enumerator is currently positioned before the first element or after the last element. * - The collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using the GetLastResult() method. */ diff --git a/inc/FBaseColIMapEnumeratorT.h b/inc/FBaseColIMapEnumeratorT.h index c072465..8f22423 100644 --- a/inc/FBaseColIMapEnumeratorT.h +++ b/inc/FBaseColIMapEnumeratorT.h @@ -31,17 +31,17 @@ namespace Tizen { namespace Base { namespace Collection /** * @interface IMapEnumeratorT - * @brief This interface supports simple iteration over a template-based map. @n + * @brief This interface supports a simple iteration over a template-based map. @n * Using this method, you can only access the elements in the map. You cannot modify the elements. * * @since 2.0 * - * @remarks - * An enumerator remains valid as long as the map remains unchanged. - * If changes are made to the map, such as adding, modifying, or - * deleting elements, the enumerator is irrecoverably invalidated. The next call to any method returns an @c E_INVALID_OPERATION message. + * @remarks An enumerator remains valid as long as the map remains unchanged. @n + * If changes are made to the map, such as adding, modifying, or + * deleting elements, the enumerator is irrecoverably invalidated. @n + * The next call to any method returns @c E_INVALID_OPERATION. * - * The %IMapEnumeratorT interface supports simple iteration over a template-based map. + * The %IMapEnumeratorT interface supports a simple iteration over a template-based map. * Using this method, you can only access the elements in the map. You cannot modify the elements. * * For more information on the class features, see HashMap and MultiHashMap. @@ -67,8 +67,10 @@ public: * * @return An error code * @param[out] key The current key - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n - * The enumerator is currently positioned before the first element or after the last element or the collection is modified after the enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The enumerator is currently positioned before the first element or after the last element. + * - The collection is modified after the enumerator is created. * @exception E_SUCCESS The method is successful. */ virtual result GetKey(KeyType& key) const = 0; @@ -80,8 +82,10 @@ public: * * @return An error code * @param[out] value The current value - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation. @n - * The enumerator is currently positioned before the first element or after the last element or the collection is modified after the enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The enumerator is currently positioned before the first element or after the last element. + * - The collection is modified after the enumerator is created. * @exception E_SUCCESS The method is successful. */ virtual result GetValue(ValueType& value) const = 0; diff --git a/inc/FBaseColIMapT.h b/inc/FBaseColIMapT.h index 7d8ca4d..e74248b 100644 --- a/inc/FBaseColIMapT.h +++ b/inc/FBaseColIMapT.h @@ -34,11 +34,11 @@ template< class Type > class IListT; /** * @interface IMapT - * @brief This interface abstracts a template-based collection of key-value pairs. + * @brief This interface represents a template-based collection of key-value pairs. * * @since 2.0 * - * The %IMapT interface abstracts a template-based collection of key-value pairs. An %IMapT + * The %IMapT interface represents a template-based collection of key-value pairs. An %IMapT * contains unique keys and each key maps to a single value. * The key and value cannot be a @c null reference. * @@ -64,70 +64,73 @@ public: * @since 2.0 * * @return An error code - * @param[in] key The key to add - * @param[in] value The corresponding value to add + * @param[in] key The key to add + * @param[in] value The corresponding value to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @exception E_OBJ_ALREADY_EXIST The specified @c key already exists. * @see Remove() */ virtual result Add(const KeyType& key, const ValueType& value) = 0; /** - * Gets the value associated with the specified @c key. + * Gets the value associated to the specified @c key. * * @since 2.0 * - * @return The value associated with the specified @c key, @n + * @return The value associated to the specified key, @n * else @c null if an exception occurs - * @param[in] key The key to find the associated value - * @param[out] value The value associated with the key + * @param[in] key The key used to find the associated value + * @param[out] value The value associated to the key * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see SetValue() */ virtual result GetValue(const KeyType& key, ValueType& value) const = 0; /** - * Gets the value associated with the specified @c key. + * Gets the value associated to the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key to find the associated value - * @param[out] value The value associated with the key + * @param[in] key The key used to find the associated value + * @param[out] value The value associated to the key * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see SetValue() */ virtual result GetValue(const KeyType& key, ValueType& value) = 0; /** - * Gets a list of all the keys in the map. + * Gets the list of all the keys in the map. * * @since 2.0 * - * @return A pointer to a list of all the keys in the map, @n + * @return A pointer to the list of all the keys in the map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks The order of the keys is the same as the corresponding values in the IListT interface returned by the GetValuesN() method. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see GetValuesN() + * @remarks + * - The order of the keys is the same as the corresponding values in the IListT interface returned by the GetValuesN() method. + * - The specific error code can be accessed using the GetLastResult() method. */ virtual IListT< KeyType >* GetKeysN(void) const = 0; /** - * Gets a list of all the values in the map. + * Gets the list of all the values in the map. * * @since 2.0 * - * @return A pointer to a list of all values in the map, @n + * @return A pointer to the list of all values in the map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -137,41 +140,42 @@ public: virtual IListT< ValueType >* GetValuesN(void) const = 0; /** - * Removes the value associated with the specified @c key. + * Removes the value associated to the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the value is to remove + * @param[in] key The key for which the value is removed * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see Add() */ virtual result Remove(const KeyType& key) = 0; /** - * Removes all key-value pairs in the map. + * Removes all the key-value pairs in the map. * * @since 2.0 */ virtual void RemoveAll(void) = 0; /** - * Replaces the value associated with the specified @c key with the specified @c value. + * Replaces the value associated to the specified @c key with the specified @c value. * * @since 2.0 * * @return An error code - * @param[in] key The key whose value is to replace - * @param[in] value The new value + * @param[in] key The key whose value is replaced + * @param[in] value The new value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks Use the Add() method to add a new key-value pair. - * @see Add() * @see GetValue() */ virtual result SetValue(const KeyType& key, const ValueType& value) = 0; @@ -182,13 +186,14 @@ public: * @since 2.0 * * @return An error code - * @param[in] key The key to locate - * @param[out] out Set to @c true if the map contains the specified @c key, @n - * else @c false - * @exception E_SUCCESS The method is successful, or - * the map contains the specified @c key. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @param[in] key The key to locate + * @param[out] out The boolean value that indicates if the map contains the specified @c key + * @exception E_SUCCESS Either of the following conditions has occurred: + * - The method is successful. + * - The map contains the specified @c key. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @see ContainsValue() */ virtual result ContainsKey(const KeyType& key, bool& out) const = 0; @@ -198,7 +203,7 @@ public: * * @since 2.0 * - * @return @c true if the map contains the specified @c value, @n + * @return @c true if the map contains the specified value, @n * else @c false * @param[in] value The value to locate * @@ -207,11 +212,11 @@ public: virtual bool ContainsValue(const ValueType& value) const = 0; /** - * Gets an instance of the IMapEnumeratorT class for the map. + * Gets an instance of IMapEnumeratorT for the map. * * @since 2.0 * - * @return An object of this map, @n + * @return An instance of IMapEnumeratorT for this map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. diff --git a/inc/FBaseColIMultiMap.h b/inc/FBaseColIMultiMap.h index dd5b9e7..78c1803 100644 --- a/inc/FBaseColIMultiMap.h +++ b/inc/FBaseColIMultiMap.h @@ -40,8 +40,8 @@ class MapEntry; * * @since 2.0 * - * The %IMultiMap interface abstracts a collection of key-value pairs. - * There is no limit on the number of elements with the same key, but duplicated elements with the same key are not allowed. + * The %IMultiMap interface represents a collection of key-value pairs. + * There is no limit on the number of elements having the same key, but duplicate elements with the same key are not allowed. * The key and value cannot be a @c null reference. * @n * For more information on the class features, see HashMap and MultiHashMap. @@ -64,18 +64,19 @@ public: * Adds the specified key-value pair to the map. * * @brief [Deprecated] - * @deprecated This method is deprecated because it has a problem of const reference argument. + * @deprecated This method is deprecated because it has a problem of constant reference argument. * Instead of using this method, use Add(Object* pKey, Object* pValue). * @since 2.0 * * @return An error code - * @param[in] key The key to add - * @param[in] value The corresponding value to add + * @param[in] key The key to add + * @param[in] value The corresponding value to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @exception E_OBJ_ALREADY_EXIST The specified @c key and @c value already exist. - * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself. + * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself. * @see Remove() * @endif */ @@ -90,13 +91,14 @@ public: * @since 2.0 * * @return An error code - * @param[in] pKey The pointer to key to add - * @param[in] pValue The pointer to corresponding value to add + * @param[in] pKey A pointer to the key to add + * @param[in] pValue A pointer to the corresponding value to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @exception E_OBJ_ALREADY_EXIST The specified @c pKey and @c pValue already exist. - * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself. + * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself. * @see Remove() */ virtual result Add(Object* pKey, Object* pValue) = 0; @@ -111,81 +113,84 @@ public: virtual int GetCount(void) const = 0; /** - * Gets the number of values with keys matching the specified key. + * Gets the number of values with keys matching the specified @c key. * * @since 2.0 * * @return The number of values with keys matching the specified key - * @param[in] key The key to locate in the map - * @param[out] count The number of values with keys matching the specified key + * @param[in] key The key to locate in the map + * @param[out] count The number of values with keys matching the specified key * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. */ virtual result GetCount(const Object& key, int& count) const = 0; /** - * Gets an enumerator of the values associated with the specified key. + * Gets the enumerator of the values associated with the specified @c key. * * @since 2.0 * - * @return An instance of the IEnumerator derived class with the values associated with the specified key, @n + * @return An instance of the IEnumerator derived class that contains the values associated with the specified key, @n * else @c null if an exception occurs * @param[in] key The key to locate in the map * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual IEnumerator* GetValuesN(const Object& key) const = 0; /** - * Gets a list of all unique keys in the map. + * Gets the list of all the unique keys in the map. * * @since 2.0 * - * @return A pointer to a list of all unique keys in the map, @n + * @return A pointer to the list of all the unique keys in the map, @n * else @c null if an exception occurs * @remarks - * - The %IList stores just the pointers to the elements in the map, not the elements themselves. + * - The IList stores just the pointers to the elements in the map and not the elements themselves. * - The specific error code can be accessed using the GetLastResult() method. * @see GetValuesN() */ virtual IList* GetKeysN(void) const = 0; /** - * Gets a list of all the values in the map. + * Gets the list of all the values in the map. * * @since 2.0 * - * @return A pointer to a list of all the values in the map, @n + * @return A pointer to the list of all the values in the map, @n * else @c null if an exception occurs * @remarks - * - The IList stores just the pointers to the elements in the map, not the elements themselves. + * - The IList stores just the pointers to the elements in the map and not the elements themselves. * - The specific error code can be accessed using the GetLastResult() method. * @see SetValue() */ virtual IList* GetValuesN(void) const = 0; /** - * Removes all the values associated with the specified key. + * Removes all the values associated with the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the associated values need to remove + * @param[in] key The key for which the associated values are removed * @param[in] forceDeletion Set to @c true to deallocate the object, @n * else @c false - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks - * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n - * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n + * If both the element deleter and the @c forceDeleteion are set, the remove operation follows the @c forceDeletion setting. * - Remove(key, @b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -221,39 +226,41 @@ public: } /** - * Removes all the values associated with the specified key. + * Removes all the values associated with the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the associated values need to remove + * @param[in] key The key for which the associated values are removed * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see Add(Object*, Object*) */ virtual result Remove(const Object& key) = 0; /** - * Removes the specified value associated with the specified key. @n - * The key is also removed if there are no more values associated with it. + * Removes the specified @c value associated with the specified @c key. @n + * The @c key is also removed if there are no more values associated with it. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the mapping is to remove from the map - * @param[in] value The value to remove + * @param[in] key The key for which the mapping is removed from the map + * @param[in] value The value to remove * @param[in] forceDeletion Set to @c true to deallocate the object, @n * else @c false - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The @c key and @c value pair is not found in the map. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key and the specified @c value pair has not been found in the map. * @remarks - * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n - * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n + * - The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n + * - If both the element deleter and the @c forceDeleteion are set, the remove operation follows the @c forceDeletion setting. * - Remove(key, value, @b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -289,34 +296,35 @@ public: } /** - * Removes the specified value associated with the specified key. @n - * The key is also removed if there are no more values associated with it. + * Removes the specified @c value associated with the specified @c key. @n + * The @c key is also removed if there are no more values associated with it. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the mapping is to remove from the map - * @param[in] value The value to remove + * @param[in] key The key for which the mapping is removed from the map + * @param[in] value The value to remove * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The @c key and @c value pair is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key and the specified @c value pair has not been found in the map. * @see Add(Object*, Object*) */ virtual result Remove(const Object& key, const Object& value) = 0; /** * Removes all the object pointers in the collection. @n - * If the @c forceDeletion parameter is set to @c true, the method also removes all the objects. This method can be called before deleting the collection. + * If @c forceDeletion is set to @c true, the method also removes all the objects. This method can be called before deleting the collection. * * @since 2.0 * * @param[in] forceDeletion Set to @c true to deallocate all objects, @n * else @c false * @remarks - * - Based on the specified element deleter, the remove operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the remove method. @n - * If both an element deleter and forceDeleteion are set, the remove operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the remove operation not only gets rid of an element from the list, but also deletes its object instance. @n + * - The element deleter style is recommended rather than using @c forceDeletetion in the removing method. @n + * - If both the element deleter and the @c forceDeletion are set, the remove operation follows the @c forceDeletion setting. * - RemoveAll(@b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -351,32 +359,33 @@ public: /** * Removes all the object pointers in the collection. @n - * This method can be called before deleting the collection. + * The %RemoveAll() method can be called before deleting the collection. * * @since 2.0 */ virtual void RemoveAll(void) = 0; /** - * Replaces the specified value associated with the specified key with a new value. + * Replaces the specified @c value associated with the specified @c key with a @c newValue. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the associated value needs to replace - * @param[in] value The value associated with the key - * @param[in] newValue The new value - * @param[in] forceDeletion Set to @c true to deallocate the object, @n - * else @c false + * @param[in] key The key for which the associated value is replaced + * @param[in] value The value associated with the key + * @param[in] newValue The new value + * @param[in] forceDeletion Set to @c true to deallocate the object, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The key-value pair is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The key-value pair has not been found in the map. * @remarks * - Use the Add(Object*, Object*) method to add a new key-value pair. - * - Based on the specified element deleter, the set operation not only gets rid of an element from a list, but also deletes its object instance. @n - * The element deleter style is recommended rather than using the @c forceDeletetion argument in the set method. @n - * If both an element deleter and forceDeleteion are set, the set operation follows @c forceDeletion setting. + * - Based on the specified element deleter, the set operation not only gets rid of an element from the list, but also deletes its object instance. @n + * The element deleter style is recommended rather than using @c forceDeletetion in the set method. @n + * If both the element deleter and the @c forceDeleteion are set, the set operation follows the @c forceDeletion setting. * - SetValue(key, value, newValue, @b true) internally works as the below code: * @code * DeleterFunctionType deleter = GetDeleter(); @@ -412,18 +421,19 @@ public: } /** - * Replaces the specified value associated with the specified key with a new value. + * Replaces the specified @c value associated with the specified @c key with a @c pNewValue. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the associated value needs to replace - * @param[in] value The value associated with the key - * @param[in] pNewValue The pointer to new value + * @param[in] key The key for which the associated value is replaced + * @param[in] value The value associated with the key + * @param[in] pNewValue A pointer to the new value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The key-value pair is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The key-value pair has not been found in the map. * @remarks Use the Add(Object*, Object*) method to add a new key-value pair. * @see GetValuesN() */ @@ -434,19 +444,20 @@ public: * Checks whether the map contains the specified key-value pair. * * @brief [Deprecated] - * @deprecated This method is deprecated because it transfers a result of comparison in out-parameter form. - * The return type will be changed into boolean type and this method will return the result. + * @deprecated This method is deprecated because it transfers the result of the comparison in an out-parameter form. + * The return type is changed into boolean and this method returns the result. * Instead of using this method, use bool Contains(const Object& key, const Object& value). * @since 2.0 * * @return An error code - * @param[in] key The key to locate - * @param[in] value The value to locate - * @param[out] out Set to @c true if the map contains the specified key-value pair, @n - * else @c false + * @param[in] key The key to locate + * @param[in] value The value to locate + * @param[out] out Set to @c true if the map contains the specified key-value pair, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @see ContainsKey() * @see ContainsValue() * @endif @@ -465,11 +476,12 @@ public: * * @return @c true if the map contains the specified key-value pair, @n * else @c false - * @param[in] key The key to locate - * @param[in] value The value to locate + * @param[in] key The key to locate + * @param[in] value The value to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see ContainsKey(const Object&) const * @see ContainsValue() @@ -478,21 +490,22 @@ public: /** * @if OSPDEPREC - * Checks whether the map contains the specified key. + * Checks whether the map contains the specified @c key. * * @brief [Deprecated] - * @deprecated This method is deprecated because it transfers a result of comparison in out-parameter form. - * The return type will be changed into boolean type and this method will return the result. + * @deprecated This method is deprecated because it transfers the result of the comparison in an out-parameter form. + * The return type is changed into boolean and this method returns the result. * Instead of using this method, use bool ContainsKey(const Object& key). * @since 2.0 * * @return An error code - * @param[in] key The key to locate - * @param[out] out Set to @c true if the map contains the specified key, @n - * else @c false + * @param[in] key The key to locate + * @param[out] out Set to @c true if the map contains the specified key, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @see ContainsValue() * @see Contains(const Object&, const Object&) * @endif @@ -505,7 +518,7 @@ public: } /** - * Checks whether the map contains the specified key. + * Checks whether the map contains the specified @c key. * * @since 2.0 * @@ -513,8 +526,9 @@ public: * else @c false * @param[in] key The key to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see ContainsValue() * @see Contains(const Object&, const Object&) const @@ -522,7 +536,7 @@ public: virtual bool ContainsKey(const Object& key) const = 0; /** - * Checks whether the map contains the specified value. + * Checks whether the map contains the specified @c value. * * @since 2.0 * @@ -536,11 +550,11 @@ public: virtual bool ContainsValue(const Object& value) const = 0; /** - * Gets an enumerator of the map. + * Gets the enumerator of the map. * * @since 2.0 * - * @return An instance of the IMapEnumerator class for the map, @n + * @return An instance of IMapEnumerator for the map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @remarks @@ -548,7 +562,6 @@ public: * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... * - The specific error code can be accessed using the GetLastResult() method. * @see IEnumerator - * @see IMapEnumerator */ virtual IMapEnumerator* GetMapEnumeratorN(void) const = 0; diff --git a/inc/FBaseColIMultiMapT.h b/inc/FBaseColIMultiMapT.h index 1c2a8a4..41f8dea 100644 --- a/inc/FBaseColIMultiMapT.h +++ b/inc/FBaseColIMultiMapT.h @@ -38,8 +38,8 @@ template< class Type > class IListT; * * @since 2.0 * - * The %IMultiMapT interface abstracts a template-based collection of key-value pairs. - * There is no limit on the number of elements with the same key, but duplicated elements with the same key are not allowed. + * The %IMultiMapT interface represents a template-based collection of key-value pairs. + * There is no limit on the number of elements having the same key, but duplicate elements with the same key are not allowed. * The key and value cannot be a @c null reference. * @n * For more information on the class features, see HashMap and MultiHashMap. @@ -64,12 +64,13 @@ public: * @since 2.0 * * @return An error code - * @param[in] key The key to add - * @param[in] value The corresponding value to add + * @param[in] key The key to add + * @param[in] value The corresponding value to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_ALREADY_EXIST The specified @c key and @c value already exists. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_ALREADY_EXIST The specified @c key and the specified @c value already exists. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @see Remove() */ @@ -85,32 +86,34 @@ public: virtual int GetCount(void) const = 0; /** - * Gets the number of values whose key matches the specified key. + * Gets the number of values whose key matches the specified @c key. * * @since 2.0 * * @return The number of values whose key matches the specified key - * @param[in] key The key to locate in the map - * @param[out] count The number of values whose key matches the specified key + * @param[in] key The key to locate in the map + * @param[out] count The number of values whose key matches the specified key * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. */ virtual result GetCount(const KeyType& key, int& count) const = 0; /** - * Gets an enumerator of the values associated with the specified key. + * Gets the enumerator of the values associated with the specified @c key. * * @since 2.0 * - * @return An instance of the IEnumeratorT derived class with the values associated with the specified key, @n + * @return An instance of the IEnumeratorT derived class that contains the values associated with the specified key, @n * else @c null if an exception occurs * @param[in] key The key to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetValue() @@ -118,11 +121,11 @@ public: virtual IEnumeratorT< ValueType >* GetValuesN(const KeyType& key) const = 0; /** - * Gets a list of all unique keys in the map. + * Gets the list of all the unique keys in the map. * * @since 2.0 * - * @return A pointer to a list of all unique keys in the map, @n + * @return A pointer to the list of all the unique keys in the map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -132,11 +135,11 @@ public: virtual IListT< KeyType >* GetKeysN(void) const = 0; /** - * Gets a list of all the values in the map. + * Gets the list of all the values in the map. * * @since 2.0 * - * @return A pointer to a list of all the values in the map, @n + * @return A pointer to the list of all the values in the map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -146,16 +149,17 @@ public: virtual IListT< ValueType >* GetValuesN(void) const = 0; /** - * Removes all the values associated with the specified key. + * Removes all the values associated with the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key whose associated values need to remove + * @param[in] key The key whose associated values are removed * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see Add() */ virtual result Remove(const KeyType& key) = 0; @@ -167,12 +171,13 @@ public: * @since 2.0 * * @return An error code - * @param[in] key The key whose mapping is to remove from the map - * @param[in] value The value to remove + * @param[in] key The key whose mapping is removed from the map + * @param[in] value The value to remove * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key and the specified @c value pair has not been found in the map. * @see Add() */ virtual result Remove(const KeyType& key, const ValueType& value) = 0; @@ -185,18 +190,19 @@ public: virtual void RemoveAll(void) = 0; /** - * Replaces the specified value associated with the specified key with a new value. + * Replaces the specified @c value associated with the specified @c key with a @c newValue. * * @since 2.0 * * @return An error code - * @param[in] key The key whose associated value needs to replace - * @param[in] value The value associated with the key - * @param[in] newValue The new value + * @param[in] key The key whose associated value is replaced + * @param[in] value The value associated with the key + * @param[in] newValue The new value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key and the specified @c value pair has not been found in the map. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks Use the Add() method to add a new key-value pair. * @see Add() @@ -210,37 +216,39 @@ public: * @since 2.0 * * @return An error code - * @param[in] key The key to locate - * @param[in] value The value to locate - * @param[out] out Set to @c true if the map contains the specified key-value pair, @n - * else @c false - * @exception E_SUCCESS The method is successful. @n - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @param[in] key The key to locate + * @param[in] value The value to locate + * @param[out] out Set to @c true if the map contains the specified key-value pair, @n + * else @c false + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @see ContainsKey() * @see ContainsValue() */ virtual result Contains(const KeyType& key, const ValueType& value, bool& out) const = 0; /** - * Checks whether the map contains the specified key. + * Checks whether the map contains the specified @c key. * * @since 2.0 * * @return An error code - * @param[in] key The key to locate - * @param[out] out Set to @c true if the map contains the specified key, @n - * else @c false - * @exception E_SUCCESS The method is successful. @n - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @param[in] key The key to locate + * @param[out] out Set to @c true if the map contains the specified key, @n + * else @c false + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @see ContainsValue() * @see Contains() */ virtual result ContainsKey(const KeyType& key, bool& out) const = 0; /** - * Checks whether the map contains the specified value. + * Checks whether the map contains the specified @c value. * * @since 2.0 * @@ -254,17 +262,18 @@ public: virtual bool ContainsValue(const ValueType& value) const = 0; /** - * Gets an enumerator of the map. + * Gets the enumerator of the map. * * @since 2.0 * - * @return An instance of the IMapEnumeratorT class for the map, @n + * @return An instance of IMapEnumeratorT for the map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks If a key has multiple values, the enumeration proceeds as follows: @n - * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - If a key has multiple values, the enumeration proceeds as follows: @n + * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... + * - The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Base::Collection::IEnumerator * @see Tizen::Base::Collection::IMapEnumerator */ diff --git a/inc/FBaseColIteratorT.h b/inc/FBaseColIteratorT.h index 67ad607..b380468 100644 --- a/inc/FBaseColIteratorT.h +++ b/inc/FBaseColIteratorT.h @@ -36,12 +36,12 @@ namespace Tizen { namespace Base { namespace Collection /** * @class IteratorT * @brief This class provides an iterator that is used to convert %IList to STL containers. @n - * %StlConverter provides static methods to get this iterator from %IList. + * %StlConverter provides static methods to get this iterator from IList. * * @since 2.1 * - * @remarks The %IteratorT class satisfies only requirements of C++ standard library InputIterator concept due to limitations of %Tizen collection. - * So, this class can be used with C++ standard library algorithms which requires only InputIterator concept for their arguments. + * @remarks The %IteratorT class satisfies only the requirements of the C++ standard library InputIterator concept due to limitations of the %Tizen collection. @n + * This class can be used with the C++ standard library algorithms which require only the InputIterator concept for their arguments. * * The %IteratorT class provides an iterator that is used to convert IList to STL containers. * StlConverter provides static methods to get this iterator from IList. @@ -53,12 +53,12 @@ class IteratorT { public: /** - * Initializes an instance of %IteratorT class. + * Initializes an instance of %IteratorT. * * @since 2.1 * * @param[in] list A reference to the IList instance to convert - * @param[in] isPostEnd A boolean value to check the end of a list + * @param[in] isPostEnd The boolean value that checks the end of the list */ explicit IteratorT(const IList& list, bool isPostEnd = false) : __pList(&list) @@ -115,7 +115,7 @@ public: } /** - * This is an assignment operator of the %IteratorT class. + * This is the assignment operator of the %IteratorT class. * * @since 2.1 * @@ -130,7 +130,7 @@ public: } /** - * This is the indirection operator for the %IteratorT class. + * This is the indirection operator of the %IteratorT class. * * @since 2.1 * @@ -143,7 +143,7 @@ public: } /** - * This is a structure dereference operator for the %IteratorT class. + * This is the structure dereference operator of the %IteratorT class. * * @since 2.1 * @@ -162,8 +162,9 @@ public: * @return A reference to the %IteratorT type instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using GetLastResult() method. */ IteratorT< T >& operator ++(void) @@ -193,8 +194,9 @@ CATCH: * @return An %IteratorT instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using GetLastResult() method. */ IteratorT< T > operator ++(int) @@ -212,8 +214,9 @@ CATCH: * @return A reference to the %IteratorT type instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using GetLastResult() method. */ IteratorT< T >& operator --(void) @@ -245,8 +248,9 @@ CATCH: * @return An %IteratorT instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The iterator is outside the bounds of the list. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using GetLastResult() method. */ IteratorT< T > operator --(int) diff --git a/inc/FBaseColLinkedList.h b/inc/FBaseColLinkedList.h index 32afbd5..037b60e 100644 --- a/inc/FBaseColLinkedList.h +++ b/inc/FBaseColLinkedList.h @@ -33,11 +33,11 @@ class _ListNode; /** * @class LinkedList - * @brief This class represents a collection of objects that can be individually accessed by index. + * @brief This class represents a collection of objects that can be individually accessed by an index. * * @since 2.0 * - * The %LinkedList class represents a collection of objects that can be individually accessed by index. + * The %LinkedList class represents a collection of objects that can be individually accessed by an index. * * For more information on the class features, see ArrayList and LinkedList. * @@ -107,10 +107,11 @@ public: * * @since 2.0 * - * @param[in] deleter The function pointer to type of the element deleter - * @remarks To create an owing collection, set the element deleter value as @c SingleObjectDeleter. This gives the collection the ownership of elements and the collection will destroy elements. @n - * On the other hand, to create a non-owning collection, you do not need to set the element deleter value, as @c NoOpDeleter is the default element deleter. - * It means that you do not transfer the ownership of elements to the collection. + * @param[in] deleter A function pointer to the type of the element deleter + * @remarks To create an owing collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection destroys the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, as @c NoOpDeleter is the default element deleter. @n + * It means that you do not transfer the ownership of the elements to the collection. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() @@ -130,10 +131,10 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj An pointer to object to add + * @param[in] pObj A pointer to the object to add * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself. + * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself. * @see Remove() */ virtual result Add(Object* pObj); @@ -144,157 +145,168 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection A collection to add + * @param[in] collection The collection to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. - * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. + * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself. * @see RemoveItems() */ virtual result AddItems(const ICollection& collection); /** - * Gets an enumerator (an instance of the IEnumerator derived class) to the list. + * Gets the enumerator (an instance of the IEnumerator derived class) of the list. * * @since 2.0 * - * @return An enumerator of the calling list object, @n + * @return The enumerator of the calling list object, @n * else @c null if an exception occurs * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see Tizen::Base::Collection::IEnumerator */ virtual IEnumerator* GetEnumeratorN(void) const; /** - * Gets a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) of this list. + * Gets the bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) of the list. * * @since 2.0 * * @return An instance of the IBidirectionalEnumerator derived class, @n - * else @c null if some exception occurs - * @remarks Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) + * else @c null if an exception occurs + * @remarks + * - Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumerator derived class) * to iterate over a collection (an instance of the IList derived class). - * The specific error code can be accessed using GetLastResult() method. - * @see Tizen::Base::Collection::IBidirectionalEnumerator + * - The specific error code can be accessed using GetLastResult() method. */ virtual IBidirectionalEnumerator* GetBidirectionalEnumeratorN(void) const; /** - * Gets the object at the specified index of the calling list. + * Gets the object at the specified @c index of the calling list. * * @since 2.0 * * @return A pointer to the object at the specified index of the list, @n - * else @c null if the index is not valid + * else @c null if the index is invalid * @param[in] index The index of the object to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetAt() */ virtual const Object* GetAt(int index) const; /** - * Gets the object at the specified index of the calling list. + * Gets the object at the specified @c index of the calling list. * * @since 2.0 * * @return A pointer to the object at the specified index of the list, @n - * else @c null if the index is not valid + * else @c null if the index is invalid * @param[in] index The index of the object to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetAt() */ virtual Object* GetAt(int index); /** - * Gets an IList with the specified range from the calling list object. + * Gets the IList with the specified range from the calling list object. * * @since 2.0 * - * @return An IList pointer if successful, @n + * @return An IList pointer , @n * else @c null if an exception occurs - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n - * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0. - * @remarks The IList stores just the pointers to the elements in the list, not the elements themselves. - * The specific error code can be accessed using the GetLastResult() method. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is either greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. + * @remarks + * - The IList stores just the pointers to the elements in the list and not the elements themselves. + * - The specific error code can be accessed using the GetLastResult() method. */ virtual IList* GetItemsN(int startIndex, int count) const; /** * Searches for an object in this list. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. */ virtual result IndexOf(const Object& obj, int& index) const; /** - * Searches for an object starting from the specified index. @n - * Gets the index of the object if found. + * Searches for an object starting from the specified @c startIndex. @n + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index for the search @n - * It must be less than the number of elements. - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index for the search @n + * It must be less than the number of elements. + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Object& obj, int startIndex, int& index) const; /** * Searches for an object within the specified range. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n - * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Object& obj, int startIndex, int count, int& index) const; /** * Searches for the last occurrence of an object in this list. @n - * Gets the index of the object if found. + * Gets the @c index of the object if found. * * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the last occurrence of the specified object + * @param[in] obj The object to locate + * @param[out] index The index of the last occurrence of the specified object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see IndexOf() */ virtual result LastIndexOf(const Object& obj, int& index) const; @@ -305,15 +317,18 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj The pointer to object to insert - * @param[in] index The index at which the object must be inserted + * @param[in] pObj A pointer to the object to insert + * @param[in] index The index at which the object is inserted * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is greater than the number of elements or less than @c 0. - * @remarks If the @c index equals to the number of elements, then the new element + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is greater than the number of elements. + * - The specified @c index is less than @c 0. + * @remarks + * - If the @c index is equal to the number of elements, then the new elements * is added at the end of this list. - * This method performs a shallow copy. It inserts just the pointer; not the element itself. + * - This method performs a shallow copy. It inserts just the pointer and not the element itself. * @see Add() * @see RemoveAt() */ @@ -325,16 +340,20 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection The collection to insert elements from - * @param[in] startIndex The starting index at which the elements must be inserted + * @param[in] collection The collection to insert elements from + * @param[in] startIndex The starting index at which the elements are inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c startIndex is either greater than the number of elements or less than @c 0. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. - * @remarks If the @c startIndex equals to the number of elements then the new elements - * are added at the end of this list. - * This method performs a shallow copy. It inserts just the pointer; not the element itself. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified index is outside the bounds of the data structure. + * - The specified @c startIndex is greater than the number of elements. + * - The specified @c startIndex is less than @c 0. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. + * @remarks + * - If the specified @c startIndex is equal to the number of elements, then the new elements + * are added at the end of this list. + * - This method performs a shallow copy. It inserts just the pointer and not the element itself. * @see RemoveItems() * @see AddItems() */ @@ -346,9 +365,9 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj An object to remove + * @param[in] obj The object to remove * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see Add() * @see RemoveAt() */ @@ -360,27 +379,31 @@ public: * @since 2.0 * * @return An error code - * @param[in] index The index at which the object must be removed + * @param[in] index The index at which the object is removed * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * The specified @c index is equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @see InsertAt() */ virtual result RemoveAt(int index); /** - * Removes all elements within the specified range from the list. + * Removes all the elements within the specified range from the list. * * @since 2.0 * * @return An error code - * @param[in] startIndex The starting index of the range - * @param[in] count The number of element to remove + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to remove * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n - * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. * @see AddItems() * @see InsertItemsFrom() */ @@ -395,8 +418,9 @@ public: * @return An error code * @param[in] collection The collection to remove from this list * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. * @see Remove() * @see RemoveAt() */ @@ -404,7 +428,7 @@ public: /** - * Removes all of the object pointers in the collection and also removes all of the objects depending on the specified element deleter. + * Removes all of the object pointers in the collection and also removes all the objects depending on the specified element deleter. * This method can be called before deleting the objects in a collection. * * @since 2.0 @@ -413,31 +437,34 @@ public: virtual void RemoveAll(void); /** - * Replaces the object at the specified index with the given object. + * Replaces the object at the specified @c index with the given object. * * @since 2.0 * * @return An error code - * @param[in] pObj The pointer to object to set - * @param[in] index The index at which the object must be set + * @param[in] pObj A pointer to the object to set + * @param[in] index The index at which the object is set * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is equal to or greater than the number of elements or less than @c 0. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @see GetAt() */ virtual result SetAt(Object* pObj, int index); /** - * Sorts the elements of this list using the comparer provided. + * Sorts the elements of this list using the @c comparer provided. * * @since 2.0 * * @return An error code - * @param[in] comparer The IComparer implementation to use when comparing elements + * @param[in] comparer The IComparer implementation to use when comparing the elements * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the @c comparer is not valid. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The specified @c comparer is invalid. */ virtual result Sort(const IComparer& comparer); @@ -463,18 +490,20 @@ public: virtual bool Contains(const Object& obj) const; /** - * Checks whether the list contains all the elements of the specified collection. + * Checks whether the list contains all the elements of the specified @c collection. * * @since 2.0 * - * @return @c true if this list contains all of the elements in the specified collection, @n + * @return @c true if this list contains all the elements in the specified collection, @n * else @c false * @param[in] collection The collection to check for containment in this list * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks If the given @c collection is empty, this method will return @c true. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The @c collection is modified during the operation of this method. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - If the given @c collection is empty, this method returns @c true. * @see Contains() */ virtual bool ContainsAll(const ICollection& collection) const; @@ -487,9 +516,10 @@ public: * @return @c true if the specified instance equals the current instance, @n * else @c false * @param[in] obj The object to compare with the calling object - * @remarks This method returns @c true only if the specified object is also an instance of the %LinkedList class, + * @remarks + * - This method returns @c true only if the specified object is also an instance of the %LinkedList class, * both lists have the same size, and all corresponding pairs of elements in the two lists are equal. - * In other words, two lists are equal if they contain the same elements in the same order. + * - In other words, two lists are equal if they contain the same elements in the same order. */ virtual bool Equals(const Object& obj) const; @@ -499,8 +529,8 @@ public: * @since 2.0 * * @return The hash value of the current instance - * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n - * the used hash function must generate a random distribution for all inputs. + * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const; @@ -574,7 +604,7 @@ private: /** * Gets a node from Available node list. * - * @return A pointer to a new List Node if successful, @n + * @return A pointer to a new List Node, @n * else @c null if no node is available */ _ListNode* GetNewNode(void); diff --git a/inc/FBaseColLinkedListT.h b/inc/FBaseColLinkedListT.h index 01c1b71..417b67f 100644 --- a/inc/FBaseColLinkedListT.h +++ b/inc/FBaseColLinkedListT.h @@ -35,11 +35,11 @@ template< class Type > class __LinkedListNodeT; /** * @class LinkedListT - * @brief This class represents a template-based collection of objects that can be individually accessed by index. + * @brief This class represents a template-based collection of objects that can be individually accessed by an index. * * @since 2.0 * - * The %LinkedListT class represents a template-based collection of objects that can be individually accessed by index. + * The %LinkedListT class represents a template-based collection of objects that can be individually accessed by an index. * * For more information on the class features, see ArrayList and LinkedList. * @@ -130,7 +130,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj An object to add + * @param[in] obj The object to add * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @see Remove() @@ -161,10 +161,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] collection A collection to add + * @param[in] collection The collection to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the specified @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. * @see RemoveItems() */ virtual result AddItems(const ICollectionT< Type >& collection) @@ -179,16 +180,15 @@ public: } /** - * Gets an enumerator to this list. + * Gets the enumerator of this list. * * @since 2.0 * - * @return An enumerator (an instance of the IEnumeratorT derived class) of this list, @n + * @return The enumerator (an instance of the IEnumeratorT derived class) of this list, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see Tizen::Base::Collection::IEnumeratorT */ virtual IEnumeratorT< Type >* GetEnumeratorN(void) const { @@ -207,18 +207,18 @@ CATCH: } /** - * Gets a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) of this list. + * Gets the bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) of this list. * * @since 2.0 * - * @return An instance of the IBidirectionalEnumeratorT derived class if successful, @n + * @return An instance of the IBidirectionalEnumeratorT derived class, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) - * to iterate over a collection (an instance of the IListT derived class). - * The specific error code can be accessed using the GetLastResult() method. - * @see Tizen::Base::Collection::IBidirectionalEnumeratorT + * @remarks + * - Use this method to obtain a bidirectional enumerator (an instance of the IBidirectionalEnumeratorT derived class) + * to iterate over a collection (an instance of the IListT derived class). + * - The specific error code can be accessed using the GetLastResult() method. */ virtual IBidirectionalEnumeratorT< Type >* GetBidirectionalEnumeratorN(void) const { @@ -242,11 +242,13 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] index The index of the object to read - * @param[out] obj An object to get from this list + * @param[in] index The index of the object to read + * @param[out] obj The object to get from this list * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @see SetAt() */ virtual result GetAt(int index, Type& obj) const @@ -269,11 +271,13 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] index The index of the object to read - * @param[out] obj An object to get from this list + * @param[in] index The index of the object to read + * @param[out] obj The object to get from this list * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @see SetAt() */ virtual result GetAt(int index, Type& obj) @@ -296,14 +300,16 @@ CATCH: * @since 2.0 * * @return A pointer to the IListT derived instance, @n - * else @c null if an exception occurs. - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read + * else @c null if an exception occurs + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n - * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements. + * - The specified @c startIndex is less than @c 0. @n + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. * * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -363,10 +369,10 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. */ virtual result IndexOf(const Type& obj, int& index) const { @@ -390,14 +396,16 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index for the search @n - * It must be less than the number of elements. - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index for the search @n + * It must be less than the number of elements. + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Type& obj, int startIndex, int& index) const @@ -416,16 +424,18 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read - * @param[out] index The index of the object + * @param[in] obj The object to locate + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read + * @param[out] index The index of the object * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements in the list or less than @c 0. @n - * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements in the list. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see LastIndexOf() */ virtual result IndexOf(const Type& obj, int startIndex, int count, int& index) const @@ -464,12 +474,14 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj An object to insert - * @param[in] index The index at which the object must be inserted + * @param[in] obj The object to insert + * @param[in] index The index at which the object is inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is greater than the number of elements or less than @c 0. - * @remarks If the @c index equals to the number of elements then the new element + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is greater than the number of elements. + * - The specified @c index is less than @c 0. + * @remarks If the @c index is equal to the number of elements then the new elements * is added at the end of this list. * @see Add() * @see RemoveAt() @@ -510,19 +522,22 @@ CATCH: /** - * Inserts the elements of the @c collection at the location specified. + * Inserts the elements of the collection at the specified location. * * @since 2.0 * * @return An error code - * @param[in] collection The collection to insert - * @param[in] startIndex The starting index at which the collection must be inserted + * @param[in] collection The collection to insert + * @param[in] startIndex The starting index at which the collection is inserted * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c startIndex is either greater than the number of elements or less than @c 0. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the specified @c collection is modified during the operation of this method. - * @remarks If the @c startIndex equals to the number of elements then the new elements + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is greater than the number of elements. + * - The specified @c startIndex is less than @c 0. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. + * @remarks If the @c startIndex is equal to the number of elements then the new elements * are added at the end of this list. * @see RemoveItems() * @see AddItems() @@ -605,10 +620,10 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj The object to locate - * @param[out] index The index of the last occurrence of the specified object + * @param[in] obj The object to locate + * @param[out] index The index of the last occurrence of the specified object * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see IndexOf() */ virtual result LastIndexOf(const Type& obj, int& index) const @@ -635,9 +650,9 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj An object to remove + * @param[in] obj The object to remove * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c obj is not found. + * @exception E_OBJ_NOT_FOUND The specified @c obj has not been found. * @see Add() * @see RemoveAt() * @see RemoveAll() @@ -661,15 +676,16 @@ CATCH: } /** - * Removes all the elements in the specified @c collection. + * Removes all the elements from the specified collection. * * @since 2.0 * * @return An error code * @param[in] collection The collection to remove from this list * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the specified @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. * @see Remove() * @see RemoveAt() */ @@ -720,10 +736,12 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] index The index at which the object must be removed + * @param[in] index The index at which the object is removed * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is greater than the number of elements. + * - The specified @c index is less than @c 0. * @see InsertAt() */ virtual result RemoveAt(int index) @@ -737,18 +755,20 @@ CATCH: } /** - * Removes all elements within the specified range. + * Removes all the elements within the specified range. * * @since 2.0 * * @return An error code - * @param[in] startIndex The starting index of the range - * @param[in] count The number of elements to read + * @param[in] startIndex The starting index of the range + * @param[in] count The number of elements to read * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is outside the bounds of the data structure. @n - * - The specified @c startIndex is either equal to or greater than the number of elements or less than @c 0. @n - * - The specified @c count is either greater than the number of elements starting from @c startIndex or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c startIndex is either greater than or equal to the number of elements. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is greater than the number of elements starting from @c startIndex. + * - The specified @c count is less than @c 0. * @see AddItems() * @see InsertItemsFrom() */ @@ -809,11 +829,13 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] obj An object to set - * @param[in] index The index at which the object must be set + * @param[in] obj The object to set + * @param[in] index The index at which the object is set * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, or - * the specified @c index is equal to or greater than the number of elements or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements. + * - The specified @c index is less than @c 0. * @see GetAt() */ virtual result SetAt(const Type& obj, int index) @@ -840,8 +862,9 @@ CATCH: * @return An error code * @param[in] comparer The IComparerT implementation to use when comparing the elements * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c comparer is not valid. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The specified @c comparer is invalid. */ virtual result Sort(const IComparerT< Type >& comparer) { @@ -910,13 +933,14 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] collection The collection to check for containment in this list - * @param[out] out Set to @c true if this list contains all of the elements in the specified collection, @n - * else @c false + * @param[in] collection The collection to check for containment in this list + * @param[out] out Set to @c true if this list contains all of the elements in the specified collection, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the specified @c collection is modified during the operation of this method. - * @remarks If the given @c collection is empty, the @c out parameter is set to @c true. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. + * @remarks If the given @c collection is empty, then @c out is set to @c true. * @see Contains() */ virtual result ContainsAll(const ICollectionT< Type >& collection, bool& out) const @@ -977,12 +1001,12 @@ CATCH: * * @since 2.0 * - * @return @c true if the specified instance equals to the current instance, @n + * @return @c true if the specified instance equals the current instance, @n * else @c false * @param[in] obj The object to compare with the calling object - * @remarks This method returns @c true only if the specified object is also an instance of LinkedList class, - * both lists have the same size, and all corresponding pairs of elements in the two lists are equal. - * In other words, two lists are equal if they contain the same elements in the same order. + * @remarks This method returns @c true only if the specified object is also an instance of the LinkedList class, + * both lists have the same size, and all the corresponding pairs of elements in the two lists are equal. @n + * In other words, the two lists are equal if they contain the same elements in the same order. */ virtual bool Equals(const Object& obj) const { @@ -1026,8 +1050,8 @@ CATCH: * @since 2.0 * * @return The hash value of the current instance - * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n - * the used hash function must generate a random distribution for all inputs. + * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const { @@ -1326,7 +1350,7 @@ public: * * @since 2.0 * - * @param[in] obj An object to include in this node + * @param[in] obj The object to include in this node */ __LinkedListNodeT(const Type& obj) : pPrev(null) @@ -1374,7 +1398,7 @@ public: * * @since 2.0 * - * @param[in] list A list to enumerate + * @param[in] list The list to enumerate * @param[in] modCount The modification count to detect the change in the list */ __LinkedListEnumeratorT(const LinkedListT< Type >& list, int modCount) @@ -1401,13 +1425,13 @@ public: * @since 2.0 * * @return An error code - * @param[out] obj The current object - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n - * - The current state of the instance prohibits the execution of the specified operation. @n + * @param[out] obj The current object + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. * - This enumerator is currently positioned before the first element or - * past the last element. @n - - The list is modified after this enumerator is created. - * @exception E_SUCCESS The method is successful. + * past the last element. + * - The list is modified after this enumerator is created. + * @exception E_SUCCESS The method is successful. */ result GetCurrent(Type& obj) const { @@ -1423,15 +1447,16 @@ public: /** * Moves this enumerator to the next element of the list. @n - * When this enumerator is first created or after call to Reset(), + * When this enumerator is first created or after a call to Reset(), * the first call to MoveNext() positions this enumerator to the first element in the list. * * @since 2.0 * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the list is modified after this enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The list is modified after this enumerator is created. * @exception E_OUT_OF_RANGE The enumerator has passed the end of the list. * @see Reset() */ @@ -1464,14 +1489,15 @@ public: } /** - * Positions this enumerator before the first elements in the list. + * Positions this enumerator before the first element in the list. * * @since 2.0 * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the list is modified after this enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The list is modified after this enumerator is created. */ result Reset(void) { diff --git a/inc/FBaseColMapEntry.h b/inc/FBaseColMapEntry.h index 0b29a20..b8f8ff3 100644 --- a/inc/FBaseColMapEntry.h +++ b/inc/FBaseColMapEntry.h @@ -47,7 +47,7 @@ public: * * @since 2.0 * - * @param[in] key The key + * @param[in] key The key * @param[in] value The value */ MapEntry(const Object& key, const Object& value); @@ -100,7 +100,7 @@ public: virtual Object* GetValue(void); /** - * Compares the value of the given Object to the + * Compares the value of the given Tizen::Base::Object to the * value of the calling object. * * @since 2.0 @@ -108,7 +108,7 @@ public: * @return @c true if the values are equal, @n * else @c false * @param[in] obj The object to compare with the calling object - * @remarks Returns @c false if the given object is not a %MapEntry object. + * @remarks This method returns @c false if the given object is not a %MapEntry object. */ virtual bool Equals(const Object& obj) const; @@ -118,8 +118,8 @@ public: * @since 2.0 * * @return The hash value of the current instance - * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n - * the used hash function must generate a random distribution for all inputs. + * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const; diff --git a/inc/FBaseColMapEntryT.h b/inc/FBaseColMapEntryT.h index 5eb2b3e..677b1be 100644 --- a/inc/FBaseColMapEntryT.h +++ b/inc/FBaseColMapEntryT.h @@ -130,8 +130,8 @@ public: * @since 2.0 * * @return The hash value of the current instance - * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n - * the used hash function must generate a random distribution for all inputs. + * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const { diff --git a/inc/FBaseColMultiHashMap.h b/inc/FBaseColMultiHashMap.h index 25ac0d2..d14a82b 100644 --- a/inc/FBaseColMultiHashMap.h +++ b/inc/FBaseColMultiHashMap.h @@ -39,9 +39,9 @@ class _MultiHashMapEntry; * * @since 2.0 * - * The %MultiHashMap class represents a collection of associated keys and values that are organized based on the hash code of the key. - * There is no limit on the number of elements with the same key, but duplicated elements with the same key are not allowed. - * The key and value cannot be @c null. + * The %MultiHashMap class represents a collection of associated keys and values that are organized based on the hash code of the key. + * There is no limit on the number of elements having the same key, but duplicate elements with the same key are not allowed. + * The key and value cannot be a @c null. * @n * For more information on the class features, see HashMap and MultiHashMap. * @@ -114,10 +114,11 @@ public: * * @since 2.0 * - * @param[in] deleter The function pointer to type of the element deleter - * @remarks To create an owing collection, set the element deleter value as @c SingleObjectDeleter. This gives the collection the ownership of elements and the collection will destroy elements. @n - * On the other hand, to create a non-owning collection, you do not need to set the element deleter value, as @c NoOpDeleter is the default element deleter. - * It means that you do not transfer the ownership of elements to the collection. + * @param[in] deleter A function pointer to the type of the element deleter + * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection destroys the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, as @c NoOpDeleter is the default element deleter. @n + * It means that the ownership of the elements is not transferred to the collection. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() @@ -132,7 +133,7 @@ public: virtual ~MultiHashMap(void); /** - * Initializes a new instance of %MultiHashMap with the specified capacity and load factor. + * Initializes a new instance of %MultiHashMap with the specified @c capacity and @c loadFactor. * * @since 2.0 * @@ -140,8 +141,9 @@ public: * @param[in] capacity The initial capacity * @param[in] loadFactor The maximum ratio of elements to buckets * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c capacity or the @c loadFactor is negative. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c capacity or the specified @c loadFactor is negative. * @remarks The GetHashCode() method of the key object is used for hashing and the * Equals() method of the key object is used for comparing the keys. * @see MultiHashMap() @@ -149,19 +151,20 @@ public: result Construct(int capacity = 16, float loadFactor = 0.75); /** - * Initializes a new instance of %MultiHashMap by copying the elements of the given map. + * Initializes a new instance of %MultiHashMap by copying the elements of the given @c map. * * @since 2.0 * * @return An error code - * @param[in] map The map to copy - * @param[in] loadFactor The maximum ratio of elements to buckets @n - * If it is @c 0, the default load factor(0.75) is used. + * @param[in] map The map to copy + * @param[in] loadFactor The maximum ratio of elements to buckets @n + * If it is @c 0, the default load factor(0.75) is used. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c loadFactor is negative. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c map is modified during the operation of this method. - * @remarks This method performs a shallow copy. It copies just the pointer; not the element itself. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c map is modified during the operation of this method. + * @remarks This method performs a shallow copy. It copies just the pointer and not the element itself. * @see MultiHashMap() */ result Construct(const IMultiMap& map, float loadFactor = 0.75); @@ -173,17 +176,18 @@ public: * @since 2.0 * * @return An error code - * @param[in] capacity The initial capacity @n - * If it is @c 0, the default capacity (16) is used. - * @param[in] loadFactor The maximum ratio of elements to buckets @n - * If it is @c 0, the default load factor (0.75) is used. - * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes - * for all keys in this map - * @param[in] comparer An instance of the IComparer derived class to use when comparing keys + * @param[in] capacity The initial capacity @n + * If it is @c 0, the default capacity (16) is used. + * @param[in] loadFactor The maximum ratio of elements to buckets @n + * If it is @c 0, the default load factor (0.75) is used. + * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes + * for all the keys in this map + * @param[in] comparer An instance of the IComparer derived class to use when comparing the keys * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c capacity or the @c loadFactor is negative. - * @remarks The instances of hash code provider and comparer will not be deallocated later from this map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specfied @c capacity or the specified @c loadFactor is negative. + * @remarks The instances of the hash code provider and the comparer are not deallocated later from this map. * @see MultiHashMap() */ result Construct(int capacity, float loadFactor, const IHashCodeProvider& provider, const IComparer& comparer); @@ -195,19 +199,22 @@ public: * @since 2.0 * * @return An error code - * @param[in] map A map to copy - * @param[in] loadFactor The maximum ratio of elements to buckets @n - * If it is @c 0, the default load factor (0.75) is used. - * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes - * for all keys in this map - * @param[in] comparer An instance of the IComparer derived class to use when comparing keys + * @param[in] map A map to copy + * @param[in] loadFactor The maximum ratio of elements to buckets @n + * If it is @c 0, the default load factor (0.75) is used. + * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes + * for all the keys in this map + * @param[in] comparer An instance of the IComparer derived class to use when comparing the keys * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c loadFactor is negative. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c map is modified during the operation of this method. - * @remarks This method performs a shallow copy. It copies just the pointer; not the element itself. - * The instances of hash code provider and comparer will not be deallocated later from this map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c loadFactor is negative. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c map is modified during the operation of this method. + * @remarks + * - This method performs a shallow copy. It copies just the pointer and not the element itself. + * - The instances of the hash code provider and the comparer are not deallocated later from this map. * @see MultiHashMap() */ result Construct(const IMultiMap& map, float loadFactor, const IHashCodeProvider& provider, const IComparer& comparer); @@ -218,80 +225,88 @@ public: * @since 2.0 * * @return An error code - * @param[in] pKey The pointer to key to add - * @param[in] pValue The pointer to corresponding value to add + * @param[in] pKey A pointer to the key to add + * @param[in] pValue A pointer to the corresponding value to add * @exception E_SUCCESS The method is successful. * @exception E_OBJ_ALREADY_EXIST The specified pair of @c pKey and @c pValue already exists. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @remarks This method performs a shallow copy. It adds just the pointer; not the element itself. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @remarks This method performs a shallow copy. It adds just the pointer and not the element itself. * @see Remove() */ virtual result Add(Object* pKey, Object* pValue); /** - * Gets an enumerator of this map. + * Gets the enumerator of this map. * * @since 2.0 * - * @return An enumerator (an instance of the IEnumerator derived class) of this map, @n - * else @c null if some exception occurs - * @remarks If the key has multiple values, the enumeration proceeds as follows: {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... - * The specific error code can be accessed using the GetLastResult() method. + * @return The enumerator (an instance of the IEnumerator derived class) of this map, @n + * else @c null if an exception occurs + * @remarks + * - If the key has multiple values, the enumeration proceeds as follows: + * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... + * - The specific error code can be accessed using the GetLastResult() method. * @see IMapEnumerator */ virtual IEnumerator* GetEnumeratorN(void) const; /** - * Gets an enumerator of this map. + * Gets the enumerator of this map. * * @since 2.0 * - * @return An enumerator (an instance of the IMapEnumerator derived class) of this map, @n - * else @c null if some exception occurs - * @remarks If the key has multiple values, the enumeration proceeds as follows: {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... - * The specific error code can be accessed using the GetLastResult() method. + * @return The enumerator (an instance of the IMapEnumerator derived class) of this map, @n + * else @c null if an exception occurs + * @remarks + * - If the key has multiple values, the enumeration proceeds as follows: + * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... + * - The specific error code can be accessed using the GetLastResult() method. * @see IEnumerator */ virtual IMapEnumerator* GetMapEnumeratorN(void) const; /** - * Gets an enumerator of the values associated with the specified key. + * Gets the enumerator of the values associated with the specified key. * * @since 2.0 * - * @return An enumerator (an instance of the IEnumerator derived class) of the values associated with the specified key, @n - * else @c null if some exception occurs - * @param[in] key A key to locate + * @return The enumerator (an instance of the IEnumerator derived class) of the values associated with the specified key, @n + * else @c null if an exception occurs + * @param[in] key The key to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetValue() */ virtual IEnumerator* GetValuesN(const Object& key) const; /** - * Gets a list of all unique keys in this map. + * Gets a list of all the unique keys in this map. * * @since 2.0 * - * @return A list of all unique keys in this map - * @remarks The %IList stores just the pointers to the elements in the map, not the elements themselves. - * The specific error code can be accessed using the GetLastResult() method. + * @return The list of all the unique keys in this map + * @remarks + * - The IList stores just the pointers to the elements in the map and not the elements themselves. + * - The specific error code can be accessed using the GetLastResult() method. * @see GetValuesN() */ virtual IList* GetKeysN(void) const; /** - * Gets a list of all the values in this map. + * Gets the list of all the values in this map. * * @since 2.0 * - * @return A list of all the values in this map - * @remarks The IList stores just the pointers to the elements in the map, not the elements themselves. - * The specific error code can be accessed using the GetLastResult() method. + * @return The list of all the values in this map + * @remarks + * - The IList stores just the pointers to the elements in the map and not the elements themselves. + * - The specific error code can be accessed using the GetLastResult() method. * @see GetKeysN() */ virtual IList* GetValuesN(void) const; @@ -304,9 +319,10 @@ public: * @return An error code * @param[in] key The key to remove * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see Add() */ virtual result Remove(const Object& key); @@ -317,39 +333,41 @@ public: * @since 2.0 * * @return An error code - * @param[in] key The key whose mapping is to remove from the map - * @param[in] value The value to remove + * @param[in] key The key whose mapping is removed from the map + * @param[in] value The value to remove * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair has not been found in the map. * @remarks The specified key is also removed if there are no more values associated with it. * @see Add() */ virtual result Remove(const Object& key, const Object& value); /** - * Removes all the object pointers in the @c collection. @n + * Removes all the object pointers in the collection. @n * * @since 2.0 * - * @remarks This method can be called before deleting @c collection. + * @remarks This method can be called before deleting the collection. */ virtual void RemoveAll(void); /** - * Sets the value associated with the given key with a new value. + * Sets the value associated with the given key to a new value. * * @since 2.0 * * @return An error code - * @param[in] key The key for which the associated value needs to replace - * @param[in] value The value to replace - * @param[in] pNewValue The pointer to new value to replace the existing value + * @param[in] key The key for which the associated value is replaced + * @param[in] value The value to replace + * @param[in] pNewValue A pointer to the new value that replaces the existing value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair has not been found in the map. * @remarks To add a new key-value pair, use the Add() method. * @see Add() * @see GetValuesN() @@ -366,32 +384,34 @@ public: virtual int GetCount(void) const; /** - * Gets the number of values whose key matches the key. + * Gets the number of values whose key matches the given key. * * @since 2.0 * * @return An error code - * @param[in] key A key to locate - * @param[out] count The number of values whose key is the @c key + * @param[in] key A key to locate + * @param[out] count The number of values whose key matches the given key * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. */ virtual result GetCount(const Object& key, int& count) const; /** - * Checks whether the map contains the specified key and value. + * Checks whether the map contains the specified key and value pair. * * @since 2.0 * * @return @c true if the map contains the specified key and value pair, @n * else @c false - * @param[in] key The key to locate - * @param[in] value The value to locate + * @param[in] key The key to locate + * @param[in] value The value to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see ContainsKey() * @see ContainsValue() @@ -407,8 +427,9 @@ public: * else @c false * @param[in] key The key to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see ContainsValue() * @see Contains() @@ -437,8 +458,8 @@ public: * @return @c true if the two instances are equal, @n * @c false * @param[in] obj The object to compare with the current instance - * @remarks This method returns @c true only if the specified object is also an instance of %MultiHashMap class, - * both maps have the same number of elements, and both maps contain the same elements. + * @remarks This method returns @c true only if the specified object is also an instance of the %MultiHashMap class, + * both the maps have the same number of elements, and both the maps contain the same elements. */ virtual bool Equals(const Object& obj) const; @@ -448,8 +469,8 @@ public: * @since 2.0 * * @return The hash value of the current instance - * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n - * the used hash function must generate a random distribution for all inputs. + * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const; diff --git a/inc/FBaseColMultiHashMapT.h b/inc/FBaseColMultiHashMapT.h index 037a2bb..2e73c31 100644 --- a/inc/FBaseColMultiHashMapT.h +++ b/inc/FBaseColMultiHashMapT.h @@ -45,13 +45,13 @@ template< class ValueType > class __ValueNodeT; /** * @class MultiHashMapT - * @brief This class represents a template-based collection of associated keys and values that are organized based on the hash code of the key. + * @brief This class represents a template-based collection of associated keys and values that are organized based on the hash code of a key. * * @since 2.0 * - * The %MultiHashMapT class represents a template-based collection of associated keys and values that are organized based on the hash code of the key. - * There is no limit on the number of elements with the same key, but duplicated elements with the same key are not allowed. - * The key and value cannot be null. Several methods in the %MultiHashMapT class need an assignment(=) operator of KeyType, and assignment(=) and equivalent(==) operators of ValueType. + * The %MultiHashMapT class represents a template-based collection of associated keys and values that are organized based on the hash code of a key. + * There is no limit on the number of elements having the same key, but duplicate elements with the same key are not allowed. + * The key and value cannot be @c null. Several methods in the %MultiHashMapT class need an assignment(=) operator of KeyType, as well as assignment(=) and equivalent(==) operators of ValueType. * @n * For more information on the class features, see HashMap and MultiHashMap. * @@ -160,11 +160,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] capacity The initial capacity - * @param[in] loadFactor The maximum ratio of elements to buckets - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c capacity or the @c loadFactor is negative. + * @param[in] capacity The initial capacity + * @param[in] loadFactor The maximum ratio of elements to buckets + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c capacity or the specified @c loadFactor is negative. * @remarks The key type must be a primitive data type. * @see MultiHashMapT() */ @@ -233,14 +234,16 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] map A map to copy - * @param[in] loadFactor The maximum ratio of elements to buckets @n - * If it is @c 0, the default load factor(0.75) is used. + * @param[in] map The map to copy + * @param[in] loadFactor The maximum ratio of elements to buckets @n + * If it is @c 0, the default load factor(0.75) is used. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c loadFactor is negative. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c map is modified during the operation of this method. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid + * - The specified @c loadFactor is negative. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c map is modified during the operation of this method. * @see MultiHashMapT() */ result Construct(const IMultiMapT< KeyType, ValueType >& map, float loadFactor = 0.75) @@ -286,17 +289,18 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] capacity The initial capacity @n - * If it is @c 0, the default capacity(16) is used. - * @param[in] loadFactor The maximum ratio of elements to buckets @n - * If it is @c 0, the default load factor(0.75) is used. - * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes - * for all keys in this map - * @param[in] comparer An instance of the IComparer derived class to use when comparing keys + * @param[in] capacity The initial capacity @n + * If it is @c 0, the default capacity(16) is used. + * @param[in] loadFactor The maximum ratio of elements to buckets @n + * If it is @c 0, the default load factor(0.75) is used. + * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes + * for all the keys in this map + * @param[in] comparer An instance of the IComparer derived class to use when comparing the keys * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c capacity or the @c loadFactor is negative. - * @remarks The instances of hash code provider and comparer will not be deallocated later from this map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c capacity or the specified @c loadFactor is negative. + * @remarks The instances of hash code provider and the comparer are not deallocated later from this map. * @see MultiHashMapT() */ result Construct(int capacity, float loadFactor, const IHashCodeProviderT< KeyType >& provider, @@ -361,18 +365,20 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] map A map to copy - * @param[in] loadFactor The maximum ratio of elements to buckets @n - * If it is @c 0, the default load factor(0.75) is used. - * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes - * for all keys in this map - * @param[in] comparer An instance of the IComparer derived class to use when comparing keys + * @param[in] map The map to copy + * @param[in] loadFactor The maximum ratio of elements to buckets @n + * If it is @c 0, the default load factor(0.75) is used. + * @param[in] provider An instance of the IHashCodeProvider derived class that supplies the hash codes + * for all the keys in this map + * @param[in] comparer An instance of the IComparer derived class to use when comparing the keys * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c loadFactor is negative. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c map is modified during the operation of this method. - * @remarks The instances of hash code provider and comparer will not be deallocated later from this map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c loadFactor is negative. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c map is modified during the operation of this method. + * @remarks The instances of the hash code provider and the comparer are not deallocated later from this map. * @see MultiHashMapT() */ result Construct(const IMultiMapT< KeyType, ValueType >& map, float loadFactor, const IHashCodeProviderT< KeyType >& provider, @@ -415,14 +421,15 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] key A key of the value to add - * @param[in] value A value to add + * @param[in] key The key of the value to add + * @param[in] value The value to add * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_ALREADY_EXIST The specified pair of @c key and @c value already exists. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @remarks SetItem() can be used to set value to a key that does not already exist. - * However, setting a value to a key that already exists overwrites the value. + * @exception E_OBJ_ALREADY_EXIST The specified @c key and @c value pair already exists. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @remarks SetItem() can be used to set a value to a key that does not already exist. @n + * However, setting a value to a key that already exists overwrites this value. * @see Remove() * @see SetValue() */ @@ -497,16 +504,18 @@ CATCH: } /** - * Gets an enumerator of this map. + * Gets the enumerator of this map. * * @since 2.0 * - * @return An enumerator (an instance of the %IMapEnumeratorT derived class) of this map, @n + * @return The enumerator (an instance of the IMapEnumeratorT derived class) of this map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks If the key has multiple values, the Enumeration proceeds as follows: {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - If the key has multiple values, the enumeration proceeds as follows: @n + * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... + * - The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Base::Collection::IEnumerator * @see Tizen::Base::Collection::IMapEnumerator */ @@ -526,16 +535,18 @@ CATCH: } /** - * Gets an IMapEnumerator of this map. + * Gets the IMapEnumerator of this map. * * @since 2.0 * - * @return An enumerator (an instance of the %IMapEnumeratorT derived class) of this map, @n + * @return The enumerator (an instance of the IMapEnumeratorT derived class) of this map, @n * else @c null if an exception occurs - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks If the key has multiple values, the Enumeration proceeds like this: {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @remarks + * - If the key has multiple values, the enumeration proceeds like this: @n + * {A: a}, {B: b}, {B: c}, {B, d}, {C: e}, ... + * - The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Base::Collection::IEnumerator * @see Tizen::Base::Collection::IMapEnumerator */ @@ -545,17 +556,18 @@ CATCH: } /** - * Gets an enumerator of the values associated with the specified key. + * Gets the enumerator of the values associated with the specified key. * * @since 2.0 * - * @return An enumerator (an instance of the IEnumeratorT derived class) of the values associated with the specified key, @n + * @return The enumerator (an instance of the IEnumeratorT derived class) of the values associated with the specified key, @n * else @c null if an exception occurs - * @param[in] key A key to locate + * @param[in] key The key to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see SetValue() */ @@ -596,11 +608,11 @@ CATCH: } /** - * Gets a list of all unique keys in this map. + * Gets a list of all the unique keys in this map. * * @since 2.0 * - * @return A list of all unique keys in this map, @n + * @return The list of all the unique keys in this map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -642,7 +654,7 @@ CATCH: * * @since 2.0 * - * @return A list of all the values in this map, @n + * @return The list of all the values in this map, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -688,9 +700,10 @@ CATCH: * @return An error code * @param[in] key The key to remove * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the comparer has failed to compare the keys. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. + * @exception E_OBJ_NOT_FOUND The specified @c key has not been found in the map. * @see Add() */ virtual result Remove(const KeyType& key) @@ -748,11 +761,12 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] key The key whose mapping is to remove from the map - * @param[in] value The value to remove + * @param[in] key The key whose mapping is removed from the map + * @param[in] value The value to remove * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair is not found in the map. * @see Add() */ @@ -824,7 +838,7 @@ CATCH: } /** - * Removes all key-value pairs in this map. + * Removes all the key-value pairs in this map. * * @since 2.0 */ @@ -839,20 +853,20 @@ CATCH: } /** - * Replaces the value associated with the key with the specified @c newValue. + * Replaces the value associated with the key, with the specified @c newValue. * * @since 2.0 * * @return An error code - * @param[in] key A key - * @param[in] value A value to replace - * @param[in] newValue A new value to replace the existing value + * @param[in] key The key + * @param[in] value The value to replace + * @param[in] newValue The new value to replace the existing value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @exception E_OBJ_NOT_FOUND The specified @c key and @c value pair is not found in the map. * @remarks To add a new key-value pair, use the Add() method. - * @see Add() * @see GetValuesN() */ virtual result SetValue(const KeyType& key, const ValueType& value, const ValueType& newValue) @@ -925,11 +939,12 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] key A key to locate - * @param[out] count The number of values whose key is @c key + * @param[in] key The key to locate + * @param[out] count The number of values whose key is @c key * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @exception E_OBJ_NOT_FOUND The specified @c key is not found in the map. */ virtual result GetCount(const KeyType& key, int& count) const @@ -971,13 +986,14 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] key The key to locate - * @param[in] value The value to locate - * @param[out] out Set to @c true if the map contains the specified key and value pair, @n - * else @c false + * @param[in] key The key to locate + * @param[in] value The value to locate + * @param[out] out Set to @c true if the map contains the specified key and value pair, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The current state of the instance prohibits the execution of the specified operation, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The comparer has failed to compare the keys. * @see ContainsKey() * @see ContainsValue() */ @@ -1027,12 +1043,13 @@ CATCH: * @since 2.0 * * @return An error code - * @param[in] key The key to locate - * @param[out] out Set to @c true if the map contains the specified key, @n - * else @c false + * @param[in] key The key to locate + * @param[out] out Set to @c true if the map contains the specified key, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the comparer has failed to compare the keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The comparer has failed to compare the keys. * @see ContainsValue() * @see Contains() */ @@ -1114,7 +1131,7 @@ CATCH: * else @c false * @param[in] obj The object to compare with the current instance * @remarks This method returns @c true only if the specified object is also an instance of the %MultiHashMapT class, - * both maps have the same number of elements, and both maps contain the same elements. + * both the maps have the same number of elements, and both the maps contain the same elements. */ virtual bool Equals(const Object& obj) const { @@ -1165,8 +1182,8 @@ CATCH: * @since 2.0 * * @return The hash value of the current instance - * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n - * the used hash function must generate a random distribution for all inputs. + * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const { @@ -1375,7 +1392,7 @@ public: * * @since 2.0 * - * @param[in] v An object to include in this node + * @param[in] v The object to include in this node */ __ValueNodeT(const ValueType& v) : pNext(null) @@ -1423,11 +1440,11 @@ public: * * @since 2.0 * - * @param[in] keyType A key to include in this entry - * @param[in] list A list of values whose key is specified @n + * @param[in] keyType The key to include in this entry + * @param[in] list The list of values whose key is specified @n * It cannot be @c null. * @param[in] next A pointer to the next entry - * @param[in] h An hash value of the key + * @param[in] h The hash value of the key */ __MultiHashMapEntryT(const KeyType& keyType, __ValueNodeT< ValueType >* list, __MultiHashMapEntryT< KeyType, ValueType >* next, int h) : key(keyType) @@ -1502,7 +1519,7 @@ public: * * @since 2.0 * - * @param[in] map A map to enumerate + * @param[in] map The map to enumerate * @param[in] modCount The modification count to detect the change in the map */ __MultiHashMapEnumeratorT(const MultiHashMapT< KeyType, ValueType >& map, int modCount) @@ -1530,10 +1547,10 @@ public: * * @return An error code * @param[out] obj The current object - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: * - The current state of the instance prohibits the execution of the specified operation. @n * - This enumerator is currently positioned before the first element or - * past the last element. @n + * past the last element. * - The map is modified after this enumerator is created. * @exception E_SUCCESS The method is successful. */ @@ -1551,14 +1568,15 @@ public: /** * Moves this enumerator to the next element of the map. @n * After the enumerator is first created or reset using the Reset() method, - * the first call to this method positions the enumerator to the first element in the @c collection. + * the first call to this method positions the enumerator to the first element in the collection. * * @since 2.0 * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the map is modified after this enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The map is modified after this enumerator is created. * @exception E_OUT_OF_RANGE The enumerator has passed the end of the map. * @see Reset() */ @@ -1606,8 +1624,9 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the map is modified after this enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The map is modified after this enumerator is created. */ result Reset(void) { @@ -1627,11 +1646,11 @@ public: * * @return An error code * @param[out] key The current key - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: * - The current state of the instance prohibits the execution of the specified operation. @n * - This enumerator is currently positioned before the first element or - * past the last element. @n - * - The map is modified after this enumerator is created. + * past the last element. @n + * - The map is modified after this enumerator is created. * @exception E_SUCCESS The method is successful. */ result GetKey(KeyType& key) const @@ -1652,10 +1671,10 @@ public: * * @return An error code * @param[out] value The current value - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: * - The current state of the instance prohibits the execution of the specified operation. @n * - This enumerator is currently positioned before the first element or - * past the last element. @n + * past the last element. @n * - The map is modified after the enumerator is created. * @exception E_SUCCESS The method is successful. */ @@ -1695,7 +1714,7 @@ public: * * @since 2.0 * - * @param[in] entry An entry to enumerate + * @param[in] entry The entry to enumerate * @param[in] modCount The modification count to detect the change in the entry */ __EntryValueEnumeratorT(const __MultiHashMapEntryT< KeyType, ValueType >& entry, int modCount) @@ -1722,10 +1741,10 @@ public: * * @return An error code * @param[out] obj The current value - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: * - The current state of the instance prohibits the execution of the specified operation. @n * - This enumerator is currently positioned before the first element or - * past the last element. @n + * past the last element. * - The entry is modified after this enumerator is created. * @exception E_SUCCESS The method is successful. */ @@ -1748,8 +1767,9 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the entry is modified after this enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The entry is modified after this enumerator is created. * @exception E_OUT_OF_RANGE The enumerator has passed the end of the entry. * @see Reset() */ @@ -1784,8 +1804,9 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the entry is modified after this enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The entry is modified after this enumerator is created. */ result Reset(void) { diff --git a/inc/FBaseColPairIteratorT.h b/inc/FBaseColPairIteratorT.h index 037fa3e..1118e39 100644 --- a/inc/FBaseColPairIteratorT.h +++ b/inc/FBaseColPairIteratorT.h @@ -42,8 +42,8 @@ namespace Tizen { namespace Base { namespace Collection * * @since 2.1 * - * @remarks The %PairIteratorT class satisfies only requirements of C++ standard library InputIterator concept due to limitations of %Tizen Collection. - * So, this class can be used with C++ standard library algorithms which requires only InputIterator concept for their arguments. + * @remarks The %PairIteratorT class satisfies only requirements of the C++ standard library InputIterator concept due to the limitations of the %Tizen Collection. @n + * This class can be used with the C++ standard library algorithms which require only the InputIterator concept for their arguments. * * The %PairIteratorT class provides an iterator that is used to convert IMap or IMultiMap to STL containers. * StlConverter provides static methods to get this iterator from IMap or IMultiMap. @@ -55,12 +55,12 @@ class PairIteratorT { public: /** - * Initializes this instance of %PairIteratorT class. + * Initializes this instance of the %PairIteratorT class. * * @since 2.1 * * @param[in] map A reference to the IMap instance to convert - * @param[in] isPostEnd A boolean value to check the end + * @param[in] isPostEnd The boolean value to check the end of the @c map */ explicit PairIteratorT(const IMap& map, bool isPostEnd = false) : __pMap(&map) @@ -91,12 +91,12 @@ public: } /** - * Initializes this instance of %PairIteratorT class. + * Initializes this instance of the %PairIteratorT class. * * @since 2.1 * * @param[in] multiMap A reference to the IMultiMap instance to convert - * @param[in] isPostEnd A boolean value to check the end + * @param[in] isPostEnd The boolean value to check the end of the @c multiMap */ PairIteratorT(const IMultiMap& multiMap, bool isPostEnd = false) : __pMap(null) @@ -134,8 +134,9 @@ public: * @param[in] rhs A reference to the %PairIteratorT instance * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG Both @c __pMap and @c __pMultiMap are @c null. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using GetLastResult() method. */ PairIteratorT(const PairIteratorT< K, V >& rhs) @@ -166,7 +167,7 @@ public: } /** - * This is assignment operator of the %PairIteratorT class. + * This is the assignment operator of the %PairIteratorT class. * * @since 2.1 * @@ -174,8 +175,9 @@ public: * @param[in] rhs A reference to the %PairIteratorT instance on the right-hand side of the operator * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG Both @c __pMap and @c __pMultiMap are @c null. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using GetLastResult() method. */ PairIteratorT< K, V >& operator =(const PairIteratorT< K, V >& rhs) @@ -190,7 +192,7 @@ public: * * @since 2.1 * - * @return A std::pair type reference with K and V type + * @return A std::pair type reference with K and V types */ std::pair< K, V >& operator *(void) const { @@ -199,7 +201,7 @@ public: } /** - * This is the const version structure dereference operator for the %PairIteratorT class. + * This is the constant version structure dereference operator for the %PairIteratorT class. * * @since 2.1 * @@ -218,8 +220,9 @@ public: * @return A reference to the %PairIteratorT instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The enumerator has passed the end of the collection. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using GetLastResult() method. */ PairIteratorT< K, V >& operator ++(void) @@ -248,8 +251,9 @@ CATCH: * @return A %PairIteratorT instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The enumerator has passed the end of the collection. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the collection is modified after the enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The collection is modified after the enumerator is created. * @remarks The specific error code can be accessed using GetLastResult() method. */ PairIteratorT< K, V > operator ++(int) diff --git a/inc/FBaseColQueue.h b/inc/FBaseColQueue.h index 83f353a..cafe6d1 100644 --- a/inc/FBaseColQueue.h +++ b/inc/FBaseColQueue.h @@ -100,10 +100,11 @@ public: * @param[in] capacity The number of elements in the queue @n * The default capacity is @c 10. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the specified @c capacity is negative. - * @remarks If the number of elements added to the queue reaches the current capacity, - * the capacity is automatically increased by memory reallocation. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The specified @c capacity is negative. + * @remarks If the number of elements added to the queue reaches the current capacity, + * the capacity is automatically increased by memory reallocation. @n * Therefore, if the size of the queue can be estimated, * specifying the initial capacity eliminates the need to perform a number of * resizing operations while adding elements to the queue. @@ -120,9 +121,10 @@ public: * @return An error code * @param[in] collection The collection to copy elements from * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. - * @remarks This method performs a shallow copy. It copies just the pointer; not the element itself. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The @c collection is modified during the operation of this method. + * @remarks This method performs a shallow copy. It copies just the pointer and not the element itself. * @see Queue() */ result Construct(const ICollection& collection); @@ -135,8 +137,9 @@ public: * @return The element at the beginning of this queue, @n * else @c null if this queue is empty * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * this queue is empty. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The queue is empty. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Enqueue(Object*) */ @@ -147,7 +150,7 @@ public: * Inserts an object at the end of this queue. * * @brief [Deprecated] - * @deprecated This method is deprecated because it has a problem of const reference argument. + * @deprecated This method is deprecated because it has a problem of constant reference argument. * Instead of using this method, use Enqueue(Object* pObj). * @since 2.0 * @@ -155,7 +158,7 @@ public: * @param[in] obj The object to add to this queue * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks This method performs a shallow copy. It inserts just the pointer; not the element itself. + * @remarks This method performs a shallow copy. It inserts just the pointer and not the element itself. * @see Dequeue() * @endif */ @@ -170,42 +173,42 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj The pointer to object to add to this queue + * @param[in] pObj A pointer to the object to add to this queue * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @remarks This method performs a shallow copy. It inserts just the pointer; not the element itself. + * @remarks This method performs a shallow copy. It inserts just the pointer and not the element itself. * @see Dequeue() */ virtual result Enqueue(Object* pObj); /** - * Gets an enumerator of this queue. + * Gets the enumerator of this queue. * * @since 2.0 * - * @return An enumerator (an instance of the IEnumerator derived class) of this queue, @n + * @return The enumerator (an instance of the IEnumerator derived class) of this queue, @n * else @c null if an exception occurs * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see IEnumerator */ virtual IEnumerator* GetEnumeratorN(void) const; /** - * Gets the element at the front of this queue without removing it. + * Gets the element at the beginning of this queue without removing it. * * @since 2.0 * * @return The element at the beginning of this queue, @n * else @c null if this queue is empty * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * this queue is empty. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The queue is empty. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual const Object* Peek(void) const; /** - * Removes all objects and their pointers in collection, when the @c deallocate parameter is set to @c true. + * Removes all the objects and their pointers from the collection, when the @c deallocate parameter is set to @c true. * * @since 2.0 * @@ -240,18 +243,19 @@ public: * Checks whether this queue contains all the elements in the specified collection. * * @brief [Deprecated] - * @deprecated This method is deprecated because it transfers a result of comparison in out-parameter form. - * The return type will be changed into boolean type and this method will return the result. + * @deprecated This method is deprecated because it transfers the result of the comparison in an out-parameter form. + * The return type is changed to boolean and this method returns the result. * Instead of using this method, use bool ContainsAll(const ICollection& collection). * @since 2.0 * * @return An error code - * @param[in] collection The collection to locate - * @param[out] out Set to @c true if this queue contains all the elements in the specified collection, @n - * else @c false + * @param[in] collection The collection to locate + * @param[out] out Set to @c true if this queue contains all the elements in the specified collection, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The @c collection is modified during the operation of this method. * @endif */ result ContainsAll(const ICollection& collection, bool& out) const @@ -270,8 +274,9 @@ public: * else @c false * @param[in] collection The collection to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The @c collection is modified during the operation of this method. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual bool ContainsAll(const ICollection& collection) const; @@ -284,8 +289,8 @@ public: * @return @c true if the specified instance equals the current instance, @n * else @c false * @param[in] obj The object to compare with the current instance - * @remarks This method returns @c true if and only if the specified object is also an instance of %Queue class, - * both queues have the same size, and all corresponding pairs of elements in the two queues are equal. + * @remarks This method returns @c true if and only if the specified object is also an instance of the %Queue class, + * both queues have the same size, and all the corresponding pairs of elements in the two queues are equal. @n * In other words, two queues are equal if they contain the same elements in the same order. */ virtual bool Equals(const Object& obj) const; @@ -296,8 +301,8 @@ public: * @since 2.0 * * @return The hash value of the current instance - * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n - * the used hash function must generate a random distribution for all inputs. + * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const; diff --git a/inc/FBaseColQueueT.h b/inc/FBaseColQueueT.h index 42bfe86..a9929a8 100644 --- a/inc/FBaseColQueueT.h +++ b/inc/FBaseColQueueT.h @@ -35,7 +35,7 @@ template< class Type > class __QueueEnumeratorT; /** * @class QueueT - * @brief This represents a template-based queue (a first-in-first-out collection of objects). + * @brief This class represents a template-based queue (a first-in-first-out collection of objects). * * @since 2.0 * @@ -116,8 +116,9 @@ public: * The default capacity is @c 10. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the specified @c capacity is negative. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The specified @c capacity is negative. */ result Construct(int capacity = DEFAULT_CAPACITY) { @@ -143,8 +144,9 @@ public: * @param[in] collection The collection to copy the elements from * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. * @see QueueT() */ result Construct(const ICollectionT< Type >& collection) @@ -202,8 +204,9 @@ CATCH: * @return An error code * @param[out] obj The element at the beginning of this queue * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * this queue is empty. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The queue is empty. * @see Enqueue() */ virtual result Dequeue(Type& obj) @@ -264,7 +267,7 @@ CATCH: } /** - * Removes all the elements in this queue. + * Removes all the elements from this queue. * * @since 2.0 */ @@ -284,16 +287,15 @@ CATCH: } /** - * Gets an enumerator of this queue. + * Gets the enumerator of this queue. * * @since 2.0 * - * @return An enumerator (an instance of the IEnumeratorT derived class) of this queue, @n + * @return The enumerator (an instance of the IEnumeratorT derived class) of this queue, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see Tizen::Base::Collection::IEnumeratorT */ virtual IEnumeratorT< Type >* GetEnumeratorN(void) const { @@ -319,8 +321,9 @@ CATCH: * @return An error code * @param[out] obj The element at the beginning of this queue * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * this queue is empty. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The queue is empty. */ virtual result Peek(Type& obj) const { @@ -380,8 +383,9 @@ CATCH: * @param[out] out Set to @c true if this queue contains all of the elements in the specified collection, @n * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the specified @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. * @exception E_OUT_OF_MEMORY The memory is insufficient. */ virtual result ContainsAll(const ICollectionT< Type >& collection, bool& out) const @@ -437,8 +441,8 @@ CATCH: * @return @c true if the specified instance equals the current instance, @n * else @c false * @param[in] obj The object to compare with the current instance - * @remarks This method returns @c true if and only if the specified object is also an instance of %QueueT class, - * both queues have the same size, and all corresponding pairs of elements in the two queues are equal. + * @remarks This method returns @c true if and only if the specified object is also an instance of the %QueueT class, + * both queues have the same size, and all the corresponding pairs of elements in the two queues are equal. @n * In other words, two queues are equal if they contain the same elements in the same order. */ virtual bool Equals(const Object& obj) const @@ -479,8 +483,8 @@ CATCH: * @since 2.0 * * @return The hash value of the current instance - * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n - * the used hash function must generate a random distribution for all inputs. + * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const { @@ -538,7 +542,7 @@ public: * * @since 2.0 * - * @param[in] queue A queue to enumerate + * @param[in] queue The queue to enumerate * @param[in] modeCount The modification count to detect the change in the queue */ __QueueEnumeratorT(const QueueT< Type >& queue, int modeCount) @@ -564,10 +568,10 @@ public: * * @return An error code * @param[out] obj The current object - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: * - The current state of the instance prohibits the execution of the specified operation. @n * - This enumerator is currently positioned before the first element or - * past the last element. @n + * past the last element. * - The queue is modified after this enumerator is created. * @exception E_SUCCESS The method is successful. */ @@ -592,8 +596,9 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the queue is modified after this enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The queue is modified after this enumerator is created. * @exception E_OUT_OF_RANGE The enumerator has passed the end of the queue. * @see Reset() */ @@ -628,8 +633,9 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the queue is modified after this enumerator is created. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The queue is modified after this enumerator is created. */ result Reset(void) { diff --git a/inc/FBaseColRandomIteratorT.h b/inc/FBaseColRandomIteratorT.h index cdfae6d..ad9b725 100644 --- a/inc/FBaseColRandomIteratorT.h +++ b/inc/FBaseColRandomIteratorT.h @@ -35,12 +35,12 @@ namespace Tizen { namespace Base { namespace Collection /** * @class RandomIteratorT * @brief This class provides a random iterator that is used to convert %IList to STL containers. @n - * %StlConverter provides static methods to get this random iterator from %IList. + * %StlConverter provides static methods to get this random iterator from IList. * * @since 2.1 * - * @remarks The %RandomIteratorT class satisfies only requirements of C++ standard library InputIterator concept due to limitations of %Tizen collection. - * So, this class can be used with C++ standard library algorithms which requires only InputIterator concept for their arguments. + * @remarks The %RandomIteratorT class satisfies only the requirements of the C++ standard library InputIterator concept due to the limitations of the %Tizen collection. @n + * This class can be used with the C++ standard library algorithms which require only the InputIterator concept for their arguments. * * The %RandomIteratorT class provides a random iterator that is used to convert IList to STL containers. * StlConverter provides static methods to get this random iterator from IList. @@ -57,8 +57,8 @@ public: * @since 2.1 * * @param[in] list A reference to the IList instance to convert - * @param[in] index A start index - * @remarks %RandomIteratorT only supports random accessible collection for performance. + * @param[in] index The starting index + * @remarks %RandomIteratorT only supports random accessible collection for its performance. * @see Tizen::Base::Collection::IList::IsRandomAccessible() */ explicit RandomIteratorT(const IList& list, int index = 0) @@ -130,8 +130,10 @@ public: * * @return A reference to the %RandomIteratorT instance * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, - * or the specified index is either equal to or greater than the number of elements in the list or less than 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using GetLastResult() method. */ RandomIteratorT< T >& operator ++(void) @@ -151,8 +153,10 @@ public: * * @return A %RandomIteratorT instance * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, - * or the specified index is either equal to or greater than the number of elements in the list or less than 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using GetLastResult() method. */ RandomIteratorT< T > operator ++(int) @@ -163,14 +167,16 @@ public: } /** - * Decrease __index by 1. + * Decreases __index by 1. * * @since 2.1 * * @return A reference to the %RandomIteratorT instance * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, - * or the specified index is either equal to or greater than the number of elements in the list or less than 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using GetLastResult() method. */ RandomIteratorT< T >& operator --(void) @@ -184,14 +190,16 @@ public: } /** - * Decrease __index by 1 and returns the previous state. + * Decreases __index by 1 and returns the previous state. * * @since 2.1 * * @return A %RandomIteratorT instance * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, - * or the specified index is either equal to or greater than the number of elements in the list or less than 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using GetLastResult() method. */ RandomIteratorT< T > operator --(int) @@ -230,11 +238,11 @@ public: } /** - * Checks l-value is less than r-value. + * Checks whether the l-value is less than the r-value. * * @since 2.1 * - * @return @c true if l-value of the specified %RandomIteratorT instance is less than the calling instance's members, @n + * @return @c true if the l-value of the specified %RandomIteratorT instance is less than the calling instance's members, @n * else @c false * @param[in] rhs A reference to the %RandomIteratorT instance on the right-hand side of the operator */ @@ -244,11 +252,11 @@ public: } /** - * Checks whether l-value is greater than r-value. + * Checks whether the l-value is greater than the r-value. * * @since 2.1 * - * @return @c true if l-value of the specified %RandomIteratorT instance is greater than the calling instance's members, @n + * @return @c true if the l-value of the specified %RandomIteratorT instance is greater than the calling instance's members, @n * else @c false * @param[in] rhs A reference to the %RandomIteratorT instance on the right-hand side of the operator */ @@ -258,15 +266,17 @@ public: } /** - * Increases __index as specified by the diff parameter. + * Increases __index as specified by the @c diff parameter. * * @since 2.1 * * @return A %RandomIteratorT instance * @param[in] diff The length to move forward * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, - * or the specified index is either equal to or greater than the number of elements in the list or less than 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using GetLastResult() method. */ RandomIteratorT< T > operator +(int diff) @@ -281,15 +291,17 @@ public: } /** - * Decrease __index as specified by the diff parameter. + * Decreases __index as specified by the @c diff parameter. * * @since 2.1 * * @return A %RandomIteratorT instance * @param[in] diff The length to move backward * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, - * or the specified index is either equal to or greater than the number of elements in the list or less than 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using GetLastResult() method. */ RandomIteratorT< T > operator -(int diff) @@ -314,10 +326,12 @@ public: * @since 2.1 * * @return A reference to the T type instance - * @param[in] index An index to reach + * @param[in] index The index to reach * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is outside the bounds of the data structure, - * or the specified index is either equal to or greater than the number of elements in the list or less than 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is outside the bounds of the data structure. + * - The specified @c index is either greater than or equal to the number of elements in the list. + * - The specified @c index is less than @c 0. * @remarks The specific error code can be accessed using GetLastResult() method. */ T& operator [](int index) const @@ -329,7 +343,7 @@ public: } /** - * Swaps values of the two %RandomIteratorT instances. + * Swaps the values of the two %RandomIteratorT instances. * * @since 2.1 * diff --git a/inc/FBaseColStack.h b/inc/FBaseColStack.h index 15fb460..8b74c09 100644 --- a/inc/FBaseColStack.h +++ b/inc/FBaseColStack.h @@ -103,9 +103,10 @@ public: * @param[in] capacity The number of elements @n * The default capacity is @c 10. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the specified @c capacity is negative. - * @remarks If the number of elements added to the stack reaches the current capacity, + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The specified @c capacity is negative. + * @remarks If the number of elements added to the stack reaches the current capacity, * the capacity is automatically increased by memory reallocation. @n * Therefore, if the size of the stack can be estimated, * specifying the initial capacity eliminates the need to perform a number of @@ -123,22 +124,22 @@ public: * @return An error code * @param[in] collection The collection to copy elements from * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. - * @remarks This method performs a shallow copy. It copies just the pointer; not the element itself. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. + * @remarks This method performs a shallow copy. It copies just the pointer and not the element itself. * @see Stack() */ result Construct(const ICollection& collection); /** - * Gets an enumerator of this stack. + * Gets the enumerator of this stack. * * @since 2.0 * - * @return An enumerator (an instance of the IEnumerator derived class) of this stack, @n + * @return The enumerator (an instance of the IEnumerator derived class) of this stack, @n * else @c null if an exception occurs * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see IEnumerator */ virtual IEnumerator* GetEnumeratorN(void) const; @@ -150,8 +151,9 @@ public: * @return The element at the top of this stack, @n * else @c null if this stack is empty * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * this stack is empty. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The stack is empty. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual const Object* Peek(void) const; @@ -164,8 +166,9 @@ public: * @return The element at the top of this stack, @n * else @c null if this stack is empty * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * this stack is empty. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The stack is empty. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Push(Object*) */ @@ -176,7 +179,7 @@ public: * Pushes an object to the top of this stack. * * @brief [Deprecated] - * @deprecated This method is deprecated because it has a problem of const reference argument. + * @deprecated This method is deprecated because it has a problem of constant reference argument. * Instead of using this method, use Push(Object* pObj). * @since 2.0 * @@ -184,7 +187,7 @@ public: * @param[in] obj The object to add to this stack * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks This method performs a shallow copy. It inserts just the pointer; not the element itself. + * @remarks This method performs a shallow copy. It inserts just the pointer and not the element itself. * @see Pop() * @endif */ @@ -199,16 +202,16 @@ public: * @since 2.0 * * @return An error code - * @param[in] pObj The pointer to object to add to this stack + * @param[in] pObj A pointer to the object to add to this stack * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @remarks This method performs a shallow copy. It inserts just the pointer; not the element itself. + * @remarks This method performs a shallow copy. It inserts just the pointer and not the element itself. * @see Pop() */ virtual result Push(Object* pObj); /** - * Removes all objects and their pointers in collection, when the @c deallocate parameter is set to @c true. @n + * Removes all the objects and their pointers from the collection, when the @c deallocate parameter is set to @c true. @n * This method can be called before deleting the objects in a collection. * * @since 2.0 @@ -243,18 +246,19 @@ public: * Checks whether this stack contains all of the elements in the specified collection. * * @brief [Deprecated] - * @deprecated This method is deprecated because it transfers a result of comparison in out-parameter form. - * The return type will be changed into boolean type and this method will return the result. + * @deprecated This method is deprecated because it transfers the result of the comparison in an out-parameter form. + * The return type is changed to boolean and this method returns the result. * Instead of using this method, use bool Contains(const ICollection& collection). * @since 2.0 * * @return An error code - * @param[in] collection The collection to locate - * @param[out] out Set to @c true if this stack contains all the elements in the specified collection, @n - * else @c false + * @param[in] collection The collection to locate + * @param[out] out Set to @c true if this stack contains all the elements in the specified collection, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. * @endif */ result ContainsAll(const ICollection& collection, bool& out) const @@ -265,7 +269,7 @@ public: } /** - * Checks whether this stack contains all of the elements in the specified collection. + * Checks whether this stack contains all the elements in the specified collection. * * @since 2.0 * @@ -273,8 +277,9 @@ public: * else @c false * @param[in] collection The collection to locate * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual bool ContainsAll(const ICollection& collection) const; @@ -286,9 +291,9 @@ public: * * @return @c true if the specified instance equals the current instance, @n * else @c false - * @param[in] obj The object to compare with the current instance - * @remarks This method returns @c true only if the specified object is also an instance of %Stack class, - * both stacks have the same size, and all corresponding pairs of elements in the two stacks are equal. + * @param[in] obj The object to compare with the current instance + * @remarks This method returns @c true only if the specified object is also an instance of the %Stack class, + * both stacks have the same size, and all the corresponding pairs of the elements in the two stacks are equal. @n * In other words, two stacks are equal if they contain the same elements in the same order. */ virtual bool Equals(const Object& obj) const; @@ -299,8 +304,8 @@ public: * @since 2.0 * * @return The hash value of the current instance - * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n - * the used hash function must generate a random distribution for all inputs. + * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const; diff --git a/inc/FBaseColStackT.h b/inc/FBaseColStackT.h index fe62e83..4750096 100644 --- a/inc/FBaseColStackT.h +++ b/inc/FBaseColStackT.h @@ -114,8 +114,9 @@ public: * @param[in] capacity The number of elements @n * The default capacity is @c 10. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid, or - * the specified @c capacity is negative. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified input parameter is invalid. + * - The specified @c capacity is negative. */ result Construct(int capacity = DEFAULT_CAPACITY) { @@ -140,8 +141,9 @@ public: * @return An error code * @param[in] collection The collection to copy elements from * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the specified @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. * @see StackT() */ result Construct(const ICollectionT< Type >& collection) @@ -193,16 +195,15 @@ CATCH: } /** - * Gets an enumerator of this stack. + * Gets the enumerator of this stack. * * @since 2.0 * - * @return An enumerator (an instance of the IEnumeratorT derived class) of this stack, @n + * @return The enumerator (an instance of the IEnumeratorT derived class) of this stack, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see Tizen::Base::Collection::IEnumeratorT */ virtual IEnumeratorT< Type >* GetEnumeratorN(void) const { @@ -228,8 +229,9 @@ CATCH: * @return An error code * @param[out] obj The element at the beginning of this stack * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * this stack is empty. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The stack is empty. */ virtual result Peek(Type& obj) const { @@ -251,8 +253,9 @@ CATCH: * @return An error code * @param[out] obj The element at the beginning of this stack * @exception E_SUCCESS The method is successful. - * @exception E_UNDERFLOW The operation (arithmetic/casting/conversion) has caused an underflow, or - * this stack is empty. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - The operation (arithmetic/casting/conversion) has caused an underflow. + * - The stack is empty. * @see Push() */ virtual result Pop(Type& obj) @@ -272,7 +275,7 @@ CATCH: } /** - * Pushes an object at the top of this stack. + * Pushes an object to the top of this stack. * * @since 2.0 * @@ -317,7 +320,7 @@ CATCH: } /** - * Removes all elements in this stack. + * Removes all the elements from this stack. * * @since 2.0 */ @@ -376,17 +379,17 @@ CATCH: } /** - * Checks whether this stack contains all of the elements in the specified @c collection. + * Checks whether this stack contains all the elements in the specified @c collection. * * @since 2.0 * * @return An error code - * @param[in] collection The collection to locate - * @param[out] out Set to @c true if this stack contains all of the elements in the specified @c collection, @n - * else @c false + * @param[in] collection The collection to locate + * @param[out] out The boolean value that indicates if this stack contains all the elements in the specified @c collection * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION The current state of the instance prohibits the execution of the specified operation, or - * the specified @c collection is modified during the operation of this method. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. + * - The specified @c collection is modified during the operation of this method. */ virtual result ContainsAll(const ICollectionT< Type >& collection, bool& out) const { @@ -442,8 +445,8 @@ CATCH: * @return @c true if the specified instance equals the current instance, @n * else @c false * @param[in] obj The object to compare with the current instance - * @remarks This method returns @c true only if the specified object is also an instance of the Stack class, - * both stacks have the same size, and all the corresponding pairs of elements in the two stacks are equal. + * @remarks This method returns @c true only if the specified object is also an instance of the Stack class, + * both the stacks have the same size, and all the corresponding pairs of elements in the two stacks are equal. @n * In other words, two stacks are equal if they contain the same elements in the same order. */ virtual bool Equals(const Object& obj) const @@ -485,8 +488,8 @@ CATCH: * @since 2.0 * * @return The hash value of the current instance - * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value. For better performance, @n - * the used hash function must generate a random distribution for all inputs. + * @remarks The two Tizen::Base::Object::Equals() instances must return the same hash value.@n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const { @@ -569,10 +572,10 @@ public: * * @return An error code * @param[out] obj The current object - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n - * - The current state of the instance prohibits the execution of the specified operation. @n + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The current state of the instance prohibits the execution of the specified operation. * - This enumerator is currently positioned before the first element or - * past the last element. @n + * past the last element. * - The stack is modified after this enumerator is created. * @exception E_SUCCESS The method is successful. */ diff --git a/inc/FBaseColStlConverter.h b/inc/FBaseColStlConverter.h index 819b18b..5b65d1f 100644 --- a/inc/FBaseColStlConverter.h +++ b/inc/FBaseColStlConverter.h @@ -206,23 +206,24 @@ public: } /** - * Gets an ArrayList instance from the begin and end iterators of STL container. + * Gets an ArrayList instance from the begin and end iterators of the STL container. * * @since 2.1 * * @return A std::unique_ptr to the ArrayList instance, @n - * else @c std::unique_ptr< ArrayList >() if error occurs - * @param[in] begin begin() of STL container - * @param[in] end end() of STL container - * @param[in] deleter The function pointer to type of the element deleter + * else @c std::unique_ptr< ArrayList >() if an error occurs + * @param[in] begin begin() of the STL container + * @param[in] end end() of the STL container + * @param[in] deleter A function pointer to the type of the element deleter * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. - * This gives the collection the ownership of elements and the collection can destroy elements. @n - * On the other hand, to create a non-owning collection, you don't need to set the element deleter value, - * as @c NoOpDeleter is the default element deleter. - * That implies transfer of the ownership of elements to the collection is not required. - * @remarks The specific error code can be accessed using GetLastResult() method. + * @remarks + * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection can destroy the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, + * as @c NoOpDeleter is the default element deleter. @n + * This implies that the transfer of the ownership of the elements to the collection is not required. + * - The specific error code can be accessed using GetLastResult() method. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() @@ -250,23 +251,24 @@ public: } /** - * Gets a LinkedList instance from the begin and end iterators of STL container. + * Gets a LinkedList instance from the begin and end iterators of the STL container. * * @since 2.1 * * @return A std::unique_ptr to the LinkedList instance @n - * else @c std::unique_ptr< LinkedList >() if error occurs - * @param[in] begin begin() of STL container - * @param[in] end end() of STL container - * @param[in] deleter The function pointer to type of the element deleter + * else @c std::unique_ptr< LinkedList >() if an error occurs + * @param[in] begin begin() of the STL container + * @param[in] end end() of the STL container + * @param[in] deleter A function pointer to the type of the element deleter * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. - * This gives the collection the ownership of elements and the collection will destroy elements. @n - * On the other hand, to create a non-owning collection, you don't need to set the element deleter value, - * as @c NoOpDeleter is the default element deleter. - * That implies transfer of the ownership of elements to the collection is not required. - * @remarks The specific error code can be accessed using GetLastResult() method. + * @remarks + * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection can destroy the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, + * as @c NoOpDeleter is the default element deleter. @n + * This implies that the transfer of the ownership of the elements to the collection is not required. + * - The specific error code can be accessed using GetLastResult() method. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() @@ -291,23 +293,24 @@ public: } /** - * Gets a HashMap instance from the begin and end iterators of STL container. + * Gets a HashMap instance from the begin and end iterators of the STL container. * * @since 2.1 * * @return A std::unique_ptr to the HashMap instance @n - * else @c std::unique_ptr< HashMap >() if error occurs - * @param[in] begin begin() of STL container - * @param[in] end end() of STL container - * @param[in] deleter The function pointer to type of the element deleter + * else @c std::unique_ptr< HashMap >() if an error occurs + * @param[in] begin begin() of the STL container + * @param[in] end end() of the STL container + * @param[in] deleter A function pointer to the type of the element deleter * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. - * This gives the collection the ownership of elements and the collection will destroy elements. @n - * On the other hand, to create a non-owning collection, you don't need to set the element deleter value, - * as @c NoOpDeleter is the default element deleter. - * That implies transfer of the ownership of elements to the collection is not required. - * @remarks The specific error code can be accessed using GetLastResult() method. + * @remarks + * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection can destroy the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, + * as @c NoOpDeleter is the default element deleter. @n + * This implies that the transfer of the ownership of the elements to the collection is not required. + * - The specific error code can be accessed using GetLastResult() method. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() @@ -335,23 +338,24 @@ public: } /** - * Gets a MultiHashMap instance from the begin and end iterators of STL container. + * Gets a MultiHashMap instance from the begin and end iterators of the STL container. * * @since 2.1 * * @return A std::unique_ptr to the MultiHashMap instance @n - * else @c std::unique_ptr< MultiHashMap >() if error occurs - * @param[in] begin begin() of STL container - * @param[in] end end() of STL container - * @param[in] deleter The function pointer to type of the element deleter + * else @c std::unique_ptr< MultiHashMap >() if an error occurs + * @param[in] begin begin() of the STL container + * @param[in] end end() of the STL container + * @param[in] deleter A function pointer to the type of the element deleter * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks To create an owning collection, set the element deleter value as @c SingleObjectDeleter. - * This gives the collection the ownership of elements and the collection will destroy elements. @n - * On the other hand, to create a non-owning collection, you don't need to set the element deleter value, - * as @c NoOpDeleter is the default element deleter. - * That implies transfer of the ownership of elements to the collection is not required. - * @remarks The specific error code can be accessed using GetLastResult() method. + * @remarks + * - To create an owning collection, set the element deleter value as @c SingleObjectDeleter. @n + * This gives the collection the ownership of the elements and the collection can destroy the elements. @n + * On the other hand, to create a non-owning collection, do not set the element deleter value, + * as @c NoOpDeleter is the default element deleter. @n + * This implies that the transfer of the ownership of the elements to the collection is not required. + * - The specific error code can be accessed using GetLastResult() method. * @see NoOpDeleter() * @see SingleObjectDeleter() * @see ArrayDeleter() diff --git a/inc/FBaseColTypes.h b/inc/FBaseColTypes.h index 6df2832..24607d7 100644 --- a/inc/FBaseColTypes.h +++ b/inc/FBaseColTypes.h @@ -19,7 +19,7 @@ * @brief This is the header file for the element deleter. * * This header file contains the declarations of the element deleter. - * Depending on the element deleter, collection decides whether to remove the object or not. + * Depending on the element deleter, the collection decides whether to remove the object or not. */ #ifndef _FBASE_COL_TYPES_H_ #define _FBASE_COL_TYPES_H_ @@ -32,29 +32,29 @@ namespace Tizen { namespace Base { namespace Collection typedef void (*DeleterFunctionType)(Object* pObj); /** - * This function does not remove the object. + * Does not remove the object. * * @since 2.0 * - * @param[in] pObj The pointer to the object to remove + * @param[in] pObj A pointer to the object to remove */ _OSP_EXPORT_ void NoOpDeleter(Object* pObj); /** - * This function removes the single object. + * Removes the single object. * * @since 2.0 * - * @param[in] pObj The pointer to the object to remove + * @param[in] pObj A pointer to the object to remove */ _OSP_EXPORT_ void SingleObjectDeleter(Object* pObj); /** - * This function removes the array object. + * Removes the array object. * * @since 2.0 * - * @param[in] pObj The pointer to the object to remove + * @param[in] pObj A pointer to the object to remove */ _OSP_EXPORT_ void ArrayDeleter(Object* pObj); diff --git a/inc/FBaseComparerT.h b/inc/FBaseComparerT.h index cb597e1..176c3d3 100644 --- a/inc/FBaseComparerT.h +++ b/inc/FBaseComparerT.h @@ -31,10 +31,10 @@ namespace Tizen { namespace Base /** * @class ComparerT * - * @brief This class checks for equivalence between 2 values of the same primitive type. + * @brief This class checks for equivalence between two values of the same primitive type. * @since 2.0 * - * The %ComparerT class checks for equivalence between 2 values of the same primitive type. + * The %ComparerT class checks for equivalence between two values of the same primitive type. * * The following example demonstrates how to use the %ComparerT class. * @@ -88,16 +88,16 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj1 The first object to compare - * @param[in] obj2 The second object to compare - * @param[out] cmp The result of comparison + * @param[in] obj1 The first object to compare + * @param[in] obj2 The second object to compare + * @param[out] cmp The result of the comparison * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified objects are not of the expected type. * @remarks @c cmp can take one of the following values: * @code - * < 0 if the value of @c obj1 is less than the value of @c obj2 - * == 0 if the value of @c obj1 is equal to the value of @c obj2 - * > 0 if the value of @c obj1 is greater than the value of @c obj2 + * < 0 if the value of obj1 is less than the value of obj2 + * == 0 if the value of obj1 is equal to the value of obj2 + * > 0 if the value of obj1 is greater than the value of obj2 * @endcode */ virtual result Compare(const Type& obj1, const Type& obj2, int& cmp) const @@ -152,14 +152,14 @@ public: virtual ~ComparerT(void) { } /** - * Compare two String instances. + * Compares two String instances. * * @since 2.1 * - * @return Always returns E_SUCCESS + * @return Always returns @c E_SUCCESS * @param[in] str1 The String instance to compare * @param[in] str2 The String instance to compare - * @param[in] cmp An integer value for result + * @param[in] cmp The integer value for the result */ virtual result Compare(const Tizen::Base::String& str1, const Tizen::Base::String& str2, int& cmp) const { diff --git a/inc/FBaseDateTime.h b/inc/FBaseDateTime.h index 8112db6..046faba 100644 --- a/inc/FBaseDateTime.h +++ b/inc/FBaseDateTime.h @@ -104,11 +104,12 @@ public: * * @since 2.0 * - * @param[in] value An instance of TimeSpan + * @param[in] value An instance of TimeSpan * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n - * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n - * is less than the value returned by GetMinValue(). + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c value is outside the valid range defined by the method. + * - The resulting value of %DateTime is greater than the value returned by GetMaxValue(). + * - The resulting value of %DateTime is less than the value returned by GetMinValue(). */ result SetValue(const TimeSpan& value); @@ -122,7 +123,7 @@ public: void SetValue(const DateTime& value); /** - * Sets the current instance of %DateTime to the specified @c year, @c month, @c day, @c hour, @c minute, and @c second. + * Sets the current instance of %DateTime to the specified year, month, day, hour, minute, and second. * * @since 2.0 * @@ -134,16 +135,17 @@ public: * @param[in] minute The minute set * @param[in] second The second to set * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n - * Either the arguments are greater than the value returned by GetMaxValue() or - * are less than the value returned by GetMinValue(), or - * the arguments contain invalid values. - * For example, day is 31 when month is 2. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The value of the arguments is outside the valid range defined by the method. + * - Either the arguments are greater than the value returned by GetMaxValue() or + * less than the value returned by GetMinValue(). + * - The arguments contain invalid values, + * for example, @c day is @c 31 when @c month is @c 2. */ result SetValue(int year, int month, int day, int hour = 0, int minute = 0, int second = 0); /** - * Sets the current instance of %DateTime to the specified @c year, @c month, @c day, @c hour, @c minute, @c second, and @c millisecond. + * Sets the current instance of %DateTime to the specified year, month, day, hour, minute, second, and millisecond. * * @since 2.1 * @@ -156,28 +158,30 @@ public: * @param[in] second The second to set * @param[in] millisecond The millisecond to set * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n - * Either the arguments are greater than the value returned by GetMaxValue() or - * are less than the value returned by GetMinValue(), or - * the arguments contain invalid values. - * For example, day is 31 when month is 2. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The value of the arguments is outside the valid range defined by the method. + * - Either the arguments are greater than the value returned by GetMaxValue() or + * less than the value returned by GetMinValue(). + * - The arguments contain invalid values, + * for example, @c day is @c 31 when @c month is @c 2. */ result SetValue(int year, int month, int day, int hour, int minute, int second, int millisecond); /** - * Sets the current instance of %DateTime with the specified number of %ticks. + * Sets the current instance of %DateTime with the specified number of ticks. * The tick value of type @c long @c long represents dates and times ranging from January 1, 1 A.D. 00:00:00.000 am. * * @since 2.1 * * @return An error code - * @param[in] ticks The number of ticks + * @param[in] ticks The number of ticks * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. - * Either the arguments are greater than the value returned by GetMaxValue() or - * are less than the value returned by GetMinValue(), or - * the arguments contain invalid values. - * For example, day is 31 when month is 2. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The value of the arguments is outside the valid range defined by the method. + * - Either the arguments are greater than the value returned by GetMaxValue() or + * less than the value returned by GetMinValue(). + * - The arguments contain invalid values, + * for example, @c day is @c 31 when @c month is @c 2. */ result SetValue(long long ticks); @@ -187,7 +191,7 @@ public: * @since 2.0 * * @return A reference to the current object - * @param[in] rhs An instance of %DateTime + * @param[in] rhs An instance of %DateTime to copy */ DateTime& operator =(const DateTime& rhs); @@ -198,7 +202,7 @@ public: * * @return @c true if the current instance is equivalent to the specified instance, @n * else @c false - * @param[in] rhs An instance of %DateTime + * @param[in] rhs An instance of %DateTime to compare */ bool operator ==(const DateTime& rhs) const; @@ -209,7 +213,7 @@ public: * * @return @c true if the current instance is not equivalent to the specified instance, @n * else @c false - * @param[in] rhs An instance of %DateTime + * @param[in] rhs An instance of %DateTime to compare */ bool operator !=(const DateTime& rhs) const; @@ -220,7 +224,7 @@ public: * * @return @c true if the value of the current instance is less than the value of the specified instance, @n * else @c false - * @param[in] rhs An instance of %DateTime + * @param[in] rhs An instance of %DateTime to compare */ bool operator <(const DateTime& rhs) const; @@ -231,7 +235,7 @@ public: * * @return @c true if the value of the current instance is greater than the value of the specified instance, @n * else @c false - * @param[in] rhs An instance of %DateTime + * @param[in] rhs An instance of %DateTime to compare */ bool operator >(const DateTime& rhs) const; @@ -242,7 +246,7 @@ public: * * @return @c true if the value of the current instance is less than or equal to the value of the specified instance, @n * else @c false - * @param[in] rhs An instance of %DateTime + * @param[in] rhs An instance of %DateTime to compare */ bool operator <=(const DateTime& rhs) const; @@ -253,7 +257,7 @@ public: * * @return @c true if the value of the current instance is greater than or equal to the value of the specified instance, @n * else @c false - * @param[in] rhs An instance of %DateTime + * @param[in] rhs An instance of %DateTime to compare */ bool operator >=(const DateTime& rhs) const; @@ -265,9 +269,10 @@ public: * @return An error code * @param[in] t The time span to add * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n - * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n - * is less than the value returned by GetMinValue(). + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The value of the argument is outside the valid range defined by the method. + * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n + * less than the value returned by GetMinValue(). */ result Add(const TimeSpan& t); @@ -279,9 +284,10 @@ public: * @return An error code * @param[in] days The number of days to add * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n - * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n - * is less than the value returned by GetMinValue(). + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The value of the argument is outside the valid range defined by the method. + * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n + * less than the value returned by GetMinValue(). */ result AddDays(int days); @@ -293,9 +299,10 @@ public: * @return An error code * @param[in] hours The number of hours to add * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n - * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n - * is less than the value returned by GetMinValue(). + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The value of the argument is outside the valid range defined by the method. + * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n + * less than the value returned by GetMinValue(). */ result AddHours(int hours); @@ -307,9 +314,10 @@ public: * @return An error code * @param[in] minutes The number of minutes to add * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n - * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n - * is less than the value returned by GetMinValue(). + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The value of the argument is outside the valid range defined by the method. + * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n + * less than the value returned by GetMinValue(). */ result AddMinutes(int minutes); @@ -321,9 +329,10 @@ public: * @return An error code * @param[in] months The number of months to add * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n - * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n - * is less than the value returned by GetMinValue(). + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The value of the argument is outside the valid range defined by the method. + * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n + * or less than the value returned by GetMinValue(). */ result AddMonths(int months); @@ -335,37 +344,40 @@ public: * @return An error code * @param[in] seconds The number of seconds to add * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n - * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n - * is less than the value returned by GetMinValue(). + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The value of the argument is outside the valid range defined by the method. + * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n + * less than the value returned by GetMinValue(). */ result AddSeconds(int seconds); /** - * Adds a specified number of milliseconds to the instance of %DateTime. + * Adds the specified number of milliseconds to the instance of %DateTime. * * @since 2.1 * * @return An error code * @param[in] milliseconds The number of milliseconds to add * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n - * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n - * is less than the value returned by GetMinValue(). + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The value of the argument is outside the valid range defined by the method. + * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n + * less than the value returned by GetMinValue(). */ result AddMilliseconds(long long milliseconds); /** - * Adds a specified number of ticks to the instance of %DateTime. + * Adds the specified number of ticks to the instance of %DateTime. * * @since 2.1 * * @return An error code * @param[in] ticks The number of ticks to add * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n - * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n - * is less than the value returned by GetMinValue(). + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The value of the argument is outside the valid range defined by the method. + * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n + * less than the value returned by GetMinValue(). */ result AddTicks(long long ticks); @@ -377,9 +389,10 @@ public: * @return An error code * @param[in] years The number of years to add * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n - * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n - * is less than the value returned by GetMinValue(). + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The value of the argument is outside the valid range defined by the method. + * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n + * less than the value returned by GetMinValue(). */ result AddYears(int years); @@ -389,11 +402,11 @@ public: * * @since 2.0 * - * @return A 32-bit @c signed integer value + * @return The 32-bit @c signed integer value * @code - * < 0 if the value of @c dt1 is less than the value of @c dt2 - * == 0 if the value of @c dt1 is equal to the value of @c dt2 - * > 0 if the value of @c dt1 is greater than the value of @c dt2 + * < 0 if the value of dt1 is less than the value of dt2 + * == 0 if the value of dt1 is equal to the value of dt2 + * > 0 if the value of dt1 is greater than the value of dt2 * @endcode * @param[in] dt1 An instance of %DateTime * @param[in] dt2 An instance of %DateTime @@ -405,7 +418,7 @@ public: * * @since 2.0 * - * @return A 32-bit @c signed integer value + * @return The 32-bit @c signed integer value * @code * < 0 if the value of the current instance is less than value of the specified instance * == 0 if the value of the current instance is equal to value of the specified instance @@ -448,7 +461,7 @@ public: TimeSpan GetTimeOfDay(void) const; /** - * Gets the number of @c days in the specified @c month of the specified @c year. + * Gets the number of days in the specified month of the specified year. * * @since 2.0 * @@ -457,8 +470,9 @@ public: * @param[in] month The month * @param[out] days The number of days * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n - * @c year must be a value between @c 1 and @c 9999 and @c month must be a value between @c 1 and @c 12. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The value of the argument is outside the valid range defined by the method. + * - The specified @c year must be a value between @c 1 and @c 9999 and @c month must be a value between @c 1 and @c 12. */ static result GetDaysInMonth(int year, int month, int& days); @@ -468,11 +482,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] t The time span to deduct + * @param[in] t The time span to subtract * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The value of the argument is outside the valid range defined by the method. @n - * The resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n - * is less than the value returned by GetMinValue(). + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The value of the argument is outside the valid range defined by the method. + * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() or @n + * less than the value returned by GetMinValue(). */ result Subtract(const TimeSpan& t); @@ -481,9 +496,10 @@ public: * * @since 2.0 * - * @return A string containing Unicode representation of the value of the current instance of %DateTime - * @remarks The format of the String representation is "mm/dd/yyyy hh:mm:ss". - * @remarks Use the Tizen::Locale namespace for a string of the locale-specific representation. + * @return The string that contains the Unicode representation of the value of the current instance of %DateTime + * @remarks + * - The format of the String representation is "mm/dd/yyyy hh:mm:ss". + * - Use the Tizen::Locale namespace for a string of the locale-specific representation. * */ String ToString(void) const; @@ -494,18 +510,19 @@ public: * @since 2.0 * * @return An error code - * @param[in] str A String representation of a date and time value - * @param[out] dt The result of the method + * @param[in] str The String representation of the date and time value + * @param[out] dt The result of the method * @exception E_SUCCESS The method is successful. * @exception E_INVALID_FORMAT The specified string is in an invalid format. - * @exception E_OUT_OF_RANGE The specified string contains an invalid value. @n - * 1) The resulting value of %DateTime is greater than the value returned by GetMaxValue() - * or is less than the value returned by GetMinValue(). @n - * 2) The specified string contains an invalid value. - * For example, day is 31 when the month is 2. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified string contains an invalid value. + * - Either the resulting value of %DateTime is greater than the value returned by GetMaxValue() + * or less than the value returned by GetMinValue(). + * - The specified string contains an invalid value, + * for example, @c day is @c 31 when the @c month is @c 2. * @remarks * - The format of the string is "mm/dd/yyyy hh:mm:ss". - * - This method guarantees that the original value of out-parameter is not changed when the method returns error. + * - This method guarantees that the original value of the out-parameter is not changed when the method returns an error. */ static result Parse(const String& str, DateTime& dt); @@ -514,7 +531,7 @@ public: * * @since 2.0 * - * @return An integer value indicating the year of the current instance of %DateTime + * @return The integer value that indicates the year of the current instance of %DateTime */ int GetYear(void) const; @@ -523,7 +540,7 @@ public: * * @since 2.0 * - * @return An integer value indicating the month of the current instance of %DateTime + * @return The integer value that indicates the month of the current instance of %DateTime */ int GetMonth(void) const; @@ -532,7 +549,7 @@ public: * * @since 2.0 * - * @return An integer value indicating the day of the current instance of %DateTime + * @return The integer value that indicates the day of the current instance of %DateTime */ int GetDay(void) const; @@ -541,7 +558,7 @@ public: * * @since 2.0 * - * @return An integer value indicating the hour of the current instance of %DateTime + * @return The integer value that indicates the hour of the current instance of %DateTime */ int GetHour(void) const; @@ -550,7 +567,7 @@ public: * * @since 2.0 * - * @return An integer value indicating the minute of the current instance of %DateTime + * @return The integer value that indicates the minute of the current instance of %DateTime */ int GetMinute(void) const; @@ -559,7 +576,7 @@ public: * * @since 2.0 * - * @return An integer value indicating the second of the current instance of %DateTime + * @return The integer value that indicates the second of the current instance of %DateTime */ int GetSecond(void) const; @@ -568,16 +585,16 @@ public: * * @since 2.1 * - * @return An integer value indicating the millisecond of the current instance of %DateTime + * @return The integer value that indicates the millisecond of the current instance of %DateTime */ int GetMillisecond(void) const; /** - * Gets the number of ticks in 1 second. + * Gets the number of ticks in one second. * * @since 2.1 * - * @return The number of ticks in 1 second. + * @return The number of ticks in one second. */ static int GetTicksPerSecond(void); @@ -587,7 +604,7 @@ public: * * @since 2.1 * - * @return A @c long @c long value indicating the tick of the current instance of %DateTime + * @return The @c long @c long value that indicates the tick of the current instance of %DateTime */ long long GetTicks(void) const; @@ -630,7 +647,7 @@ public: bool IsLeapYear(void) const; /** - * Checks whether the specified @c year is a leap year. + * Checks whether the specified year is a leap year. * * @since 2.0 * @@ -711,4 +728,4 @@ private: }; // DateTime }} // Tizen::Base -#endif // _FBASE_DATE_TIME_H_ \ No newline at end of file +#endif // _FBASE_DATE_TIME_H_ diff --git a/inc/FBaseDouble.h b/inc/FBaseDouble.h index a636438..f4c0ce8 100644 --- a/inc/FBaseDouble.h +++ b/inc/FBaseDouble.h @@ -18,9 +18,9 @@ * @file FBaseDouble.h * @brief This is the header file for the %Double class. * - * @see Tizen::Base::Number - * * This header file contains the declarations of the %Double class. + * + * @see Tizen::Base::Number */ #ifndef _FBASE_DOUBLE_H_ #define _FBASE_DOUBLE_H_ @@ -41,7 +41,7 @@ namespace Tizen { namespace Base * 1.79769313486232e308 to positive 1.79769313486232e308. This class is useful when passing a @c double * value to a method expecting an instance of Object, such as Tizen::Base::Collection::Queue or * Tizen::Base::Collection::Stack. Furthermore, this class provides methods for converting - * %Double (and @c double) to String, and String to %Double (and @c double). + * %Double (and @c double) to String, and %String to %Double (and @c double). * * The following example demonstrates how to use the %Double class. * @@ -84,7 +84,7 @@ public: * * @since 2.0 * - * @param[in] value A @c double value + * @param[in] value The @c double value */ Double(double value = 0.0L); @@ -93,7 +93,7 @@ public: * * @since 2.0 * - * @param[in] value An instance of %Double + * @param[in] value An instance of %Double to copy */ Double(const Double& value); @@ -109,7 +109,7 @@ public: * * @since 2.0 * - * @param[in] rhs An instance of %Double + * @param[in] rhs An instance of %Double to copy */ Double& operator =(const Double& rhs); @@ -118,11 +118,11 @@ public: * * @since 2.0 * - * @return A 32-bit @c signed integer value + * @return The 32-bit @c signed integer value * @code - * < 0 if the value of @c d1 is less than the value of @c d2 - * == 0 if the value of @c d1 is equal to the value of @c d2 - * > 0 if the value of @c d1 is greater than the value of @c d2 + * < 0 if the value of d1 is less than the value of d2 + * == 0 if the value of d1 is equal to the value of d2 + * > 0 if the value of d1 is greater than the value of d2 * @endcode * @param[in] d1 The first @c double value to compare * @param[in] d2 The second @c double value to compare @@ -134,11 +134,11 @@ public: * * @since 2.0 * - * @return A 32-bit @c signed integer value + * @return The 32-bit @c signed integer value * @code - * < 0 if the value of the current instance is less than the specified @c signed @c double - * == 0 if the value of the current instance is equal to the specified @c signed @c double - * > 0 if the value of the current instance is greater than the specified @c signed @c double + * < 0 if the value of the current instance is less than the specified signed double + * == 0 if the value of the current instance is equal to the specified signed double + * > 0 if the value of the current instance is greater than the specified signed double * @endcode * @param[in] value A @c signed @c double value */ @@ -149,7 +149,7 @@ public: * * @since 2.0 * - * @return A 32-bit @c signed integer value + * @return The 32-bit @c signed integer value * @code * < 0 if the value of the current instance is less than the value of the specified instance * == 0 if the value of the current instance is equal to the value of the specified instance @@ -164,10 +164,10 @@ public: * * @since 2.0 * - * @return @c true if the value of the specified instance of %Object is equal to the value of the current instance of %Double, @n + * @return @c true if the value of the specified instance of Object is equal to the value of the current instance of %Double, @n * else @c false * @param[in] obj An instance of Object to compare - * @see Tizen::Base::Object::Equals + * @see Tizen::Base::Object::Equals() */ virtual bool Equals(const Object& obj) const; @@ -176,35 +176,36 @@ public: * * @since 2.0 * - * @return An integer value indicating the hash value of the current instance of %Double - * @remarks Two equal instances must return the same hash value. For better performance, - * the used hash function must generate a random distribution for all inputs. @n - * The default implementation of this method returns the value of the current instance. + * @return The integer value that indicates the hash value of the current instance of %Double + * @remarks + * - Two equal instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. + * - The default implementation of this method returns the value of the current instance. */ virtual int GetHashCode(void) const; /** - * Gets the hash value of the specified @c double value. - * - * @since 2.0 - * - * @return An integer value indicating the hash value of the specified @c double value - * @param[in] val A @c double value to get the hash value - */ + * Gets the hash value of the specified @c double value. + * + * @since 2.0 + * + * @return The integer value that indicates the hash value of the specified @c double value + * @param[in] val The @c double value to get the hash value + */ static int GetHashCode(double val); /** - * Parses the specified string representing a numeric value and returns the value as @c signed @c double (as out parameter). + * Parses the specified string that represents a numeric value and returns the value as @c signed @c double (as out parameter). * * @since 2.0 * * @return An error code - * @param[in] s A unicode representation of @c signed @c double value + * @param[in] s The unicode representation of @c signed @c double value * @param[out] ret The converted numeric value * @exception E_SUCCESS The method is successful. * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed. * @remarks - * - This method guarantees that the original value of out-parameter is not changed when the method returns error. + * - This method guarantees that the original value of the out-parameter is not changed when the method returns an error. * - The behavior of this method is dependent on the system default locale setting. */ static result Parse(const String& s, double& ret); @@ -214,7 +215,7 @@ public: * * @since 2.0 * - * @return A @c signed @c char equivalent of the current instance + * @return The @c signed @c char equivalent of the current instance */ virtual char ToChar(void) const; @@ -223,7 +224,7 @@ public: * * @since 2.0 * - * @return A @c signed @c short equivalent of the current instance + * @return The @c signed @c short equivalent of the current instance */ virtual short ToShort(void) const; @@ -232,7 +233,7 @@ public: * * @since 2.0 * - * @return A @c signed @c int equivalent of the current instance + * @return The @c signed @c int equivalent of the current instance */ virtual int ToInt(void) const; @@ -241,7 +242,7 @@ public: * * @since 2.0 * - * @return A @c signed @c long equivalent of the current instance + * @return The @c signed @c long equivalent of the current instance */ virtual long ToLong(void) const; @@ -250,7 +251,7 @@ public: * * @since 2.0 * - * @return A @c signed @c long @c long equivalent of the current instance + * @return The @c signed @c long @c long equivalent of the current instance */ virtual long long ToLongLong(void) const; @@ -259,7 +260,7 @@ public: * * @since 2.0 * - * @return A @c signed @c float equivalent of the current instance + * @return The @c signed @c float equivalent of the current instance */ virtual float ToFloat(void) const; @@ -268,16 +269,16 @@ public: * * @since 2.0 * - * @return A @c signed @c double equivalent of the current instance + * @return The @c signed @c double equivalent of the current instance */ virtual double ToDouble(void) const; /** - * Gets the string representing the value of the current instance of %Double. + * Gets the string that represents the value of the current instance of %Double. * * @since 2.0 * - * @return A string containing a Unicode representation of the value of the current instance + * @return The string that contains the Unicode representation of the value of the current instance * @remarks * - If the value of the current instance is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity * produces the result "Infinity". @n @@ -287,12 +288,12 @@ public: virtual String ToString(void) const; /** - * Gets the string representing the specified @c double value. + * Gets the string that represents the specified @c double value. * * @since 2.0 * - * @return A string containing a Unicode representation of the specified @c double value - * @param[in] value A @c double value to convert + * @return The string that contains the Unicode representation of the specified @c double value + * @param[in] value The @c double value to convert * @remarks * - If the input value is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity * produces the result "Infinity". @n @@ -307,7 +308,7 @@ public: * @since 2.0 * * @return The bits that represent the floating-point number in the IEEE 754 floating-point "double format" bit layout - * @param[in] value A @c double value to convert + * @param[in] value The @c double value to convert */ static long long ToBits(double value); @@ -322,23 +323,23 @@ public: static double ToDoubleFromBits(long long value); /** - * Checks whether the current value of %Double is equal to negative or positive infinity. + * Checks whether the current value of %Double is equal to the negative or positive infinity. * * @since 2.0 * - * @return @c true if the current value equals negative or positive infinity, @n + * @return @c true if the current value equals the negative or positive infinity, @n * else @c false */ bool IsInfinity(void) const; /** - * Checks whether the specified @c double value is equal to negative or positive infinity. + * Checks whether the specified @c double value is equal to the negative or positive infinity. * * @since 2.0 * - * @return @c true if the specified value equals negative or positive infinity, @n + * @return @c true if the specified value equals the negative or positive infinity, @n * else @c false - * @param[in] value A @c double value to check + * @param[in] value The @c double value to check */ static bool IsInfinity(double value); @@ -359,32 +360,32 @@ public: * * @return @c true if the specified value is Not-a-Number, @n * else @c false - * @param[in] value A @c double value to check + * @param[in] value The @c double value to check */ static bool IsNaN(double value); /** - * Gets a constant holding the largest positive finite value of type @c double. @n + * Gets the constant holding the largest positive finite value of type @c double. @n * This is equal to the value defined in Limit.h of the C library. * * @since 2.0 * - * @return A constant holding the largest positive finite value of type @c double + * @return The constant holding the largest positive finite value of type @c double */ static double GetMaxValue(void); /** - * Gets a constant holding the smallest positive non-zero value of type @c double. @n + * Gets the constant holding the smallest positive non-zero value of type @c double. @n * This is equal to the value defined in Limit.h of the C library. * * @since 2.0 * - * @return A constant holding the smallest possible non-zero value of type @c double + * @return The constant holding the smallest possible non-zero value of type @c double */ static double GetMinValue(void); /** - * A @c double value of this instance. + * The @c double value of this instance. * * @since 2.0 */ @@ -409,4 +410,4 @@ private: }; // Double }} // Tizen::Base -#endif //_FBASE_DOUBLE_H_ \ No newline at end of file +#endif //_FBASE_DOUBLE_H_ diff --git a/inc/FBaseDoubleComparer.h b/inc/FBaseDoubleComparer.h index 1a7aa44..e029247 100644 --- a/inc/FBaseDoubleComparer.h +++ b/inc/FBaseDoubleComparer.h @@ -18,9 +18,10 @@ * @file FBaseDoubleComparer.h * @brief This is the header file for the %DoubleComparer class. * - * @see Double and Tizen::Base::Collection::IComparer - * * This header file contains the declarations of the %DoubleComparer class. + * + * @see Tizen::Base::Double + * @see Tizen::Base::Collection::IComparer */ #ifndef _FBASE_DOUBLE_COMPARER_H_ #define _FBASE_DOUBLE_COMPARER_H_ @@ -32,11 +33,11 @@ namespace Tizen { namespace Base { /** * @class DoubleComparer - * @brief This class checks for equivalence between 2 instances of the %Double type. + * @brief This class checks for equivalence between two instances of the %Double type. * * @since 2.0 * - * The %DoubleComparer class checks for equivalence between 2 instances of the Double type. + * The %DoubleComparer class checks for equivalence between two instances of the Double type. * * For more information on the class features, see Collection Comparisons. * @@ -90,17 +91,17 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj1 The first instance of type Double - * @param[in] obj2 The second instance of type Double - * @param[out] cmp The result of comparison + * @param[in] obj1 The first instance of type Double + * @param[in] obj2 The second instance of type Double + * @param[out] cmp The result of the comparison * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified object instances are not of the expected type. * @remarks The value of @c cmp can be: * * @code - * < 0 if the value of @c obj1 is less than the value of @c obj2 - * == 0 if the value of @c obj1 is equal to the value of @c obj2 - * > 0 if the value of @c obj1 is greater than the value of @c obj2 + * < 0 if the value of obj1 is less than the value of obj2 + * == 0 if the value of obj1 is equal to the value of obj2 + * > 0 if the value of obj1 is greater than the value of obj2 * @endcode */ virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const; @@ -121,4 +122,4 @@ private: }; // DoubleComparer }} // Tizen::Base -#endif // _FBASE_DOUBLE_COMPARER_H_ \ No newline at end of file +#endif // _FBASE_DOUBLE_COMPARER_H_ diff --git a/inc/FBaseDoubleMatrix.h b/inc/FBaseDoubleMatrix.h index 35d035c..04f65b9 100644 --- a/inc/FBaseDoubleMatrix.h +++ b/inc/FBaseDoubleMatrix.h @@ -36,7 +36,7 @@ namespace Tizen { namespace Base * * @since 2.0 * - * The %DoubleMatrix class provides a @c double precision, two-dimensional matrix class. + * The %DoubleMatrix class provides a @c double precision, two-dimensional matrix. * */ class _OSP_EXPORT_ DoubleMatrix @@ -48,12 +48,12 @@ public: * * @since 2.0 * - * @param[in] rhs An instance of %DoubleMatrix + * @param[in] rhs An instance of %DoubleMatrix to copy */ DoubleMatrix(const DoubleMatrix& rhs); /** - * Constructs a row by column null matrix in which all elements are zero. + * Constructs a row by column null matrix in which all the elements are zero. * * @since 2.0 * @@ -69,7 +69,8 @@ public: * * @param[in] rowCount The number of rows in the current instance * @param[in] columnCount The number of columns in the current instance - * @param[in] pArray A one-dimensional array @n The array must be at least row * column in length. + * @param[in] pArray The one-dimensional array @n + * The array must be at least row * column in length. * @param[in] rowMajor Set to @c true to copy the array in row-major order, @n * else @c copy in column-major order */ @@ -82,7 +83,8 @@ public: * * @param[in] rowCount The number of rows in the current instance * @param[in] columnCount The number of columns in the current instance - * @param[in] pArray[] A two-dimensional array @n The array must be at least row * column in length. + * @param[in] pArray[] The two-dimensional array @n + * The array must be at least row * column in length. */ DoubleMatrix(int rowCount, int columnCount, const double* pArray[]); @@ -99,7 +101,7 @@ public: * * @since 2.0 * - * @return @c true if all matrix members of the current instance are equal to the corresponding matrix members in the specified instance, @n + * @return @c true if all the matrix members of the current instance are equal to the corresponding matrix members in the specified instance, @n * else @c false * @param[in] rhs An instance of %DoubleMatrix */ @@ -121,12 +123,13 @@ public: * * @since 2.0 * - * @return The reference to this instance - * @param[in] rhs An instance of %DoubleMatrix - * @exception E_INVALID_ARG Either row or column count of the current instance is not same with that of the specified instance. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks If either row or column count of the current instance is not same with that of the specified instance, - * return the reference to this instance without assigning. + * @return A reference to this instance + * @param[in] rhs An instance of %DoubleMatrix + * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - If either the row or the column count of the current instance is not same as that of the specified instance, + * this method returns the reference to this instance without assigning. */ DoubleMatrix& operator =(const DoubleMatrix& rhs); @@ -135,10 +138,12 @@ public: * * @since 2.0 * - * @return @c true if the values of the current instance are equal to the value of the specified instance, @n + * @return @c true if the values of the current instance are equal to the values of the specified instance, @n * else @c false * @param[in] obj An instance of %DoubleMatrix - * @remarks This method overrides Tizen::Base::Object::Equals(). This method uses the values of the Matrix components to compare the two instances. + * @remarks + * - This method overrides Tizen::Base::Object::Equals(). + * - This method uses the values of the Matrix components to compare the two instances. */ virtual bool Equals(const Tizen::Base::Object& obj) const; @@ -148,8 +153,8 @@ public: * @since 2.0 * * @return The hash value of the current instance - * @remarks Two equal instances must return the same hash value. For better performance, - * the used hash function must generate a random distribution for all inputs. + * @remarks Two equal instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const; @@ -159,27 +164,27 @@ public: * @since 2.0 * * @return An error code - * @param[in] matrix An instance of %DoubleMatrix - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either row or column count of the current instance is not same with that of the specified instance. + * @param[in] matrix An instance of %DoubleMatrix + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance. */ result Add(const DoubleMatrix& matrix); /** - * Adds the value to each matrix members of the current instance of %DoubleMatrix. + * Adds the value to each matrix member of the current instance of %DoubleMatrix. * * @since 2.0 * - * @param[in] value A @c double value to add + * @param[in] value The @c double value to add */ void AddToEachElement(double value); /** - * Gets the number of column in the current instance of %DoubleMatrix. + * Gets the number of columns in the current instance of %DoubleMatrix. * * @since 2.0 * - * @return The number of column in the current instance + * @return The number of columns in the current instance */ int GetColumnCount(void) const; @@ -188,8 +193,8 @@ public: * * @since 2.0 * - * @return A pointer to @c double array - * @param[in] columnIndex The target column number in the current instance + * @return A pointer to the @c double array + * @param[in] columnIndex The target column number in the current instance * @exception E_INVALID_ARG The @c columnIndex is larger than the column count of the current instance. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -201,9 +206,10 @@ public: * @since 2.0 * * @return The determinant value of the current instance - * @exception E_INVALID_OPERATION The current instance is not a square matrix. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks If the current instance is not a square matrix, return zero. + * @exception E_INVALID_OPERATION The current instance is not a square matrix. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - If the current instance is not a square matrix, this method returns zero. */ double GetDeterminant(void) const; @@ -213,9 +219,9 @@ public: * @since 2.0 * * @return The value at the specified row and column of the current instance - * @param[in] rowIndex The target row number in the current instance - * @param[in] columnIndex The target column number in the current instance - * @exception E_INVALID_ARG The @c columnIndex or @c rowIndex is larger than that of the current instance. + * @param[in] rowIndex The target row number in the current instance + * @param[in] columnIndex The target column number in the current instance + * @exception E_INVALID_ARG The @c columnIndex or @c rowIndex is larger than that of the current instance. * @remarks The specific error code can be accessed using the GetLastResult() method. */ double GetElement(int rowIndex, int columnIndex) const; @@ -225,18 +231,18 @@ public: * * @since 2.0 * - * @return A pointer to the instance of %DoubleMatrix containing the resulting value of the operation - * @exception E_INVALID_OPERATION The current instance is not a square matrix. + * @return A pointer to the instance of %DoubleMatrix that contains the resulting value of the operation + * @exception E_INVALID_OPERATION The current instance is not a square matrix. * @remarks The specific error code can be accessed using the GetLastResult() method. */ DoubleMatrix* GetInverseN(void) const; /** - * Gets the number of row in the current instance of %DoubleMatrix. + * Gets the number of rows in the current instance of %DoubleMatrix. * * @since 2.0 * - * @return The number of row in the current instance + * @return The number of rows in the current instance */ int GetRowCount(void) const; @@ -245,8 +251,8 @@ public: * * @since 2.0 * - * @return A pointer to @c double array - * @param[in] rowIndex The target row number in the current instance + * @return A pointer to the @c double array + * @param[in] rowIndex The target row number in the current instance * @exception E_INVALID_ARG The @c rowIndex is larger than the row count of the current instance. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -258,8 +264,8 @@ public: * @since 2.0 * * @return An error code - * @param[out] value A @c double value - * @exception E_SUCCESS The method is successful. + * @param[out] value The @c double value + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current instance is not a square matrix. */ result GetTrace(double& value) const; @@ -269,8 +275,8 @@ public: * * @since 2.0 * - * @return A pointer to the instance of %DoubleMatrix containing the resulting value of the operation - * @exception E_INVALID_OPERATION The current instance is not a square matrix. + * @return A pointer to the %DoubleMatrix instance that contains the resulting value of the operation + * @exception E_INVALID_OPERATION The current instance is not a square matrix. * @remarks The specific error code can be accessed using the GetLastResult() method. */ DoubleMatrix* GetTransposeN(void) const; @@ -301,18 +307,18 @@ public: * @since 2.0 * * @return An error code - * @param[in] matrix An instance of %DoubleMatrix - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The column count of the current instance is not same with the row count of the specified instance. + * @param[in] matrix An instance of %DoubleMatrix + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The column count of the current instance is not same as the row count of the specified instance. */ result Multiply(const DoubleMatrix& matrix); /** - * Multiplies the value with each matrix members of the current instance of %DoubleMatrix. + * Multiplies the value with each matrix member of the current instance of %DoubleMatrix. * * @since 2.0 * - * @param[in] value A @c double value to multiply + * @param[in] value The @c double value to multiply */ void Multiply(double value); @@ -329,7 +335,7 @@ public: * @since 2.0 * * @return An error code - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current instance is not a square matrix. */ result SetAsIdentity(void); @@ -340,7 +346,7 @@ public: * @since 2.0 * * @return An error code - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current instance is not a square matrix. */ result Invert(void); @@ -351,7 +357,7 @@ public: * @since 2.0 * * @return An error code - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current instance is not a square matrix. */ result Transpose(void); @@ -362,10 +368,13 @@ public: * @since 2.0 * * @return An error code - * @param[in] columnIndex The target column number in the current instance - * @param[in] pArray An array which includes the values @n The array must be at least row in length. - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The @c pArray is @c null, or the @c columnIndex is larger than the column count of the current instance. + * @param[in] columnIndex The target column number in the current instance + * @param[in] pArray The array which includes the values @n + * The array must be at least row in length. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c pArray is @c null. + * - The specified @c columnIndex is larger than the column count of the current instance. */ result SetColumn(int columnIndex, const double* pArray); @@ -375,10 +384,13 @@ public: * @since 2.0 * * @return An error code - * @param[in] rowIndex The target row number in the current instance - * @param[in] pArray An array which includes the values @n The array must be at least column in length. - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The @c pArray is @c null, or the @c rowIndex is larger than the row count of the current instance. + * @param[in] rowIndex The target row number in the current instance + * @param[in] pArray The array which includes the values @n + * The array must be at least column in length. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c pArray is @c null. + * - The specified @c rowIndex is larger than the row count of the current instance. */ result SetRow(int rowIndex, const double* pArray); @@ -388,31 +400,34 @@ public: * @since 2.0 * * @return An error code - * @param[in] rowIndex The target row number in the current instance - * @param[in] columnIndex The target column number in the current instance - * @param[in] value A @c double value - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The pArray is @c null, or the @c rowIndex is larger than the row count of the current instance, - * or the @c columnIndex is larger than the column count of the current instance. + * @param[in] rowIndex The target row number in the current instance + * @param[in] columnIndex The target column number in the current instance + * @param[in] value The @c double value + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c pArray is @c null. + * - The specified @c rowIndex is larger than the row count of the current instance. + * - The specified @c columnIndex is larger than the column count of the current instance. */ result SetElement(int rowIndex, int columnIndex, double value); /** - * Sets the values to the current instance of %DoubleMatrix in either the row-major or column-major order. + * Sets the values to the current instance of %DoubleMatrix in either the row-major or the column-major order. * * @since 2.0 * * @return An error code - * @param[in] pArray A one-dimensional array @n The array must be at least row * column in length. - * @param[in] rowMajor Set to @c true to copy the array in row-major order, @n - * else @c copy in column-major order - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The @c pArray is @c null. + * @param[in] pArray The one-dimensional array @n + * The array must be at least row * column in length. + * @param[in] rowMajor Set to @c true to copy the array in row-major order, @n + * else @c copy in column-major order + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified @c pArray is @c null. */ result SetValue(const double* pArray, bool rowMajor = true); /** - * Sets the matrix members of current instance of %DoubleMatrix to zero. + * Sets the matrix members of the current instance of %DoubleMatrix to zero. * * @since 2.0 */ @@ -424,18 +439,18 @@ public: * @since 2.0 * * @return An error code - * @param[in] matrix An instance of %DoubleMatrix - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either row or column count of the current instance is not same with that of the specified instance. + * @param[in] matrix An instance of %DoubleMatrix + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance. */ result Subtract(const DoubleMatrix& matrix); /** - * Subtracts the value from each matrix members of the current instance of %DoubleMatrix. + * Subtracts the value from each matrix member of the current instance of %DoubleMatrix. * * @since 2.0 * - * @param[in] value A @c double value to subtract + * @param[in] value The @c double value to subtract */ void SubtractToEachElement(double value); @@ -460,4 +475,4 @@ private: }; // DoubleMatrix }} // Tizen::Base -#endif //_FBASE_DOUBLE_MATRIX_H_ \ No newline at end of file +#endif //_FBASE_DOUBLE_MATRIX_H_ diff --git a/inc/FBaseDoubleMatrix3.h b/inc/FBaseDoubleMatrix3.h index 4a4f81f..86d99f2 100644 --- a/inc/FBaseDoubleMatrix3.h +++ b/inc/FBaseDoubleMatrix3.h @@ -36,7 +36,7 @@ namespace Tizen { namespace Base * * @since 2.0 * - * The %DoubleMatrix3 class provides a @c double precision, two-dimensional matrix class. + * The %DoubleMatrix3 class provides a @c double precision, two-dimensional matrix. * */ class _OSP_EXPORT_ DoubleMatrix3 @@ -45,7 +45,7 @@ class _OSP_EXPORT_ DoubleMatrix3 public: /** * This is the default constructor for this class. @n - * Constructs a 3 X 3 null matrix in which all elements are zero. + * Constructs a 3 X 3 null matrix in which all the elements are zero. * * @since 2.0 */ @@ -56,7 +56,7 @@ public: * * @since 2.0 * - * @param[in] rhs An instance of %DoubleMatrix3 + * @param[in] rhs An instance of %DoubleMatrix3 to copy */ DoubleMatrix3(const DoubleMatrix3& rhs); @@ -81,7 +81,7 @@ public: * * @since 2.0 * - * @return @c true if all matrix members of the current instance are equal to the corresponding matrix members in the specified instance, @n + * @return @c true if all the matrix members of the current instance are equal to the corresponding matrix members in the specified instance, @n * else @c false * @param[in] rhs An instance of %DoubleMatrix3 */ @@ -92,7 +92,7 @@ public: * * @since 2.0 * - * @return @c true if all matrix members of the current instance are not equal to the corresponding matrix members in the specified instance, @n + * @return @c true if all the matrix members of the current instance are not equal to the corresponding matrix members in the specified instance, @n * else @c false * @param[in] rhs An instance of %DoubleMatrix3 */ @@ -103,7 +103,7 @@ public: * * @since 2.0 * - * @return The reference to this instance + * @return A reference to this instance * @param[in] rhs An instance of %DoubleMatrix3 */ DoubleMatrix3& operator =(const DoubleMatrix3& rhs); @@ -113,8 +113,8 @@ public: * * @since 2.0 * - * @return The reference to this instance - * @param[in] value A @c double value to assign + * @return A reference to this instance + * @param[in] value The @c double value to assign */ DoubleMatrix3& operator =(double value); @@ -123,38 +123,38 @@ public: * * @since 2.0 * - * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation + * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation * @param[in] rhs An instance of %DoubleMatrix3 */ DoubleMatrix3 operator *(const DoubleMatrix3& rhs) const; /** - * Multiplies the value to each matrix members of current instance of %DoubleMatrix3. + * Multiplies the value to each matrix member of the current instance of %DoubleMatrix3. * * @since 2.0 * - * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation - * @param[in] value A @c double value to multiply + * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation + * @param[in] value The @c double value to multiply */ DoubleMatrix3 operator *(double value) const; /** - * Adds the value of the specified instance and the current instance of %DoubleMatrix3. + * Adds the value of the specified instance to the current instance of %DoubleMatrix3. * * @since 2.0 * - * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation + * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation * @param[in] rhs An instance of %DoubleMatrix3 */ DoubleMatrix3 operator +(const DoubleMatrix3& rhs) const; /** - * Adds the value to each matrix members of current instance of %DoubleMatrix3. + * Adds the value to each matrix member of the current instance of %DoubleMatrix3. * * @since 2.0 * - * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation - * @param[in] value A @c double value to add + * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation + * @param[in] value The @c double value to add */ DoubleMatrix3 operator +(double value) const; @@ -163,38 +163,38 @@ public: * * @since 2.0 * - * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation + * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation * @param[in] rhs An instance of %DoubleMatrix3 */ DoubleMatrix3 operator -(const DoubleMatrix3& rhs) const; /** - * Subtracts the value from each matrix members of current instance of %DoubleMatrix3. + * Subtracts the value from each matrix member of the current instance of %DoubleMatrix3. * * @since 2.0 * - * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation - * @param[in] value A @c double value to subtract + * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation + * @param[in] value The @c double value to subtract */ DoubleMatrix3 operator -(double value) const; /** - * Multiplies the value of the specified instance and the current instance of %DoubleMatrix3. + * Multiplies the value of the specified instance with the current instance of %DoubleMatrix3. * * @since 2.0 * - * @return The reference to %DoubleMatrix3 containing the resulting value of the operation + * @return A reference to %DoubleMatrix3 that contains the resulting value of the operation * @param[in] rhs An instance of %DoubleMatrix3 */ DoubleMatrix3& operator *=(const DoubleMatrix3& rhs); /** - * Multiplies the value to each matrix members of current instance of %DoubleMatrix3. + * Multiplies the value to each matrix member of the current instance of %DoubleMatrix3. * * @since 2.0 * - * @return The reference to %DoubleMatrix3 containing the resulting value of the operation - * @param[in] value A @c double value to multiply + * @return A reference to %DoubleMatrix3 that contains the resulting value of the operation + * @param[in] value The @c double value to multiply */ DoubleMatrix3& operator *=(double value); @@ -203,18 +203,18 @@ public: * * @since 2.0 * - * @return The reference to %DoubleMatrix3 containing the resulting value of the operation + * @return A reference to %DoubleMatrix3 that contains the resulting value of the operation * @param[in] rhs An instance of %DoubleMatrix3 */ DoubleMatrix3& operator +=(const DoubleMatrix3& rhs); /** - * Adds the value to each matrix members of current instance of %DoubleMatrix3. + * Adds the value to each matrix member of the current instance of %DoubleMatrix3. * * @since 2.0 * - * @return The reference to %DoubleMatrix3 containing the resulting value of the operation - * @param[in] value A @c double value to add + * @return A reference to %DoubleMatrix3 that contains the resulting value of the operation + * @param[in] value The @c double value to add */ DoubleMatrix3& operator +=(double value); @@ -223,51 +223,51 @@ public: * * @since 2.0 * - * @return The reference to %DoubleMatrix3 containing the resulting value of the operation + * @return A reference to %DoubleMatrix3 that contains the resulting value of the operation * @param[in] rhs An instance of %DoubleMatrix3 */ DoubleMatrix3& operator -=(const DoubleMatrix3& rhs); /** - * Subtracts the value from each matrix members of current instance of %DoubleMatrix3. + * Subtracts the value from each matrix member of the current instance of %DoubleMatrix3. * * @since 2.0 * - * @return The reference to %DoubleMatrix3 containing the resulting value of the operation - * @param[in] value A @c double value to subtract + * @return A reference to %DoubleMatrix3 that contains the resulting value of the operation + * @param[in] value The @c double value to subtract */ DoubleMatrix3& operator -=(double value); /** - * Gets the instance of %DoubleMatrix3 resulting from the sum of the value and the specified instance of %DoubleMatrix3. + * Gets an instance of %DoubleMatrix3 resulting from the sum of the value and the specified instance of %DoubleMatrix3. * * @since 2.0 * - * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation - * @param[in] value A @c double value to add - * @param[in] rhs An instance of %DoubleMatrix3 + * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation + * @param[in] value The @c double value to add + * @param[in] rhs An instance of %DoubleMatrix3 */ _OSP_EXPORT_ friend DoubleMatrix3 operator +(const double& value, const DoubleMatrix3& rhs); /** - * Gets the instance of %DoubleMatrix3 resulting from the product of the value and the specified instance of %DoubleMatrix3. + * Gets an instance of %DoubleMatrix3 resulting from the product of the value and the specified instance of %DoubleMatrix3. * * @since 2.0 * - * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation - * @param[in] value A @c double value to multiply - * @param[in] rhs An instance of %DoubleMatrix3 + * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation + * @param[in] value The @c double value to multiply + * @param[in] rhs An instance of %DoubleMatrix3 */ _OSP_EXPORT_ friend DoubleMatrix3 operator *(const double& value, const DoubleMatrix3& rhs); /** - * Gets the instance of %DoubleMatrix3 resulting from the difference between the value and the specified instance of %DoubleMatrix3. + * Gets an instance of %DoubleMatrix3 resulting from the difference between the value and the specified instance of %DoubleMatrix3. * * @since 2.0 * - * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation - * @param[in] value A @c double value to subtract - * @param[in] rhs An instance of %DoubleMatrix3 + * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation + * @param[in] value The @c double value to subtract + * @param[in] rhs An instance of %DoubleMatrix3 */ _OSP_EXPORT_ friend DoubleMatrix3 operator -(const double& value, const DoubleMatrix3& rhs); @@ -279,7 +279,9 @@ public: * @return @c true if the values of the current instance is equal to the value of the specified instance, @n * else @c false * @param[in] obj An instance of %DoubleMatrix3 - * @remarks This method overrides Tizen::Base::Object::Equals(). This method uses the values of the Matrix components to compare the two instances. + * @remarks + * - This method overrides Tizen::Base::Object::Equals(). + * - This method uses the values of the Matrix components to compare the two instances. */ virtual bool Equals(const Tizen::Base::Object& obj) const; @@ -289,8 +291,8 @@ public: * @since 2.0 * * @return The hash value of the current instance - * @remarks Two equal instances must return the same hash value. For better performance, - * the used hash function must generate a random distribution for all inputs. + * @remarks Two equal instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const; @@ -308,8 +310,8 @@ public: * * @since 2.0 * - * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation - * @remarks This function must be called after checking whether the matrix is invertible or not. + * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation + * @remarks This method must be called after checking whether the matrix is invertible or not. */ DoubleMatrix3 GetInverse(void) const; @@ -327,7 +329,7 @@ public: * * @since 2.0 * - * @return A new instance of %DoubleMatrix3 containing the resulting value of the operation + * @return A new instance of %DoubleMatrix3 that contains the resulting value of the operation */ DoubleMatrix3 GetTranspose(void) const; @@ -352,7 +354,7 @@ public: bool IsInvertible(void) const; /** - * Negates the matrix members of current instance of %DoubleMatrix3. + * Negates the matrix members of the current instance of %DoubleMatrix3. * * @since 2.0 */ @@ -371,20 +373,20 @@ public: * @since 2.0 * * @return An error code - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current instance is not invertible. */ result Invert(void); /** - * Sets the transposed matrix to the current instance of %DoubleMatrix3. + * Sets the transposed matrix of the current instance of %DoubleMatrix3. * * @since 2.0 */ void Transpose(void); /** - * Sets the matrix members of current instance of %DoubleMatrix3 to zero. + * Sets the matrix members of the current instance of %DoubleMatrix3 to zero. * * @since 2.0 */ @@ -405,4 +407,4 @@ private: }; // DoubleMatrix3 }} // Tizen::Base -#endif //_FBASE_DOUBLE_MATRIX3_H_ \ No newline at end of file +#endif //_FBASE_DOUBLE_MATRIX3_H_ diff --git a/inc/FBaseDoubleMatrix4.h b/inc/FBaseDoubleMatrix4.h index 8dccc11..98298bd 100644 --- a/inc/FBaseDoubleMatrix4.h +++ b/inc/FBaseDoubleMatrix4.h @@ -45,7 +45,7 @@ class _OSP_EXPORT_ DoubleMatrix4 public: /** * This is the default constructor for this class. @n - * Constructs a 4 X 4 null matrix in which all elements are zero. + * Constructs a 4 X 4 null matrix in which all the elements are zero. * * @since 2.0 */ @@ -56,7 +56,7 @@ public: * * @since 2.0 * - * @param[in] rhs An instance of %DoubleMatrix4 + * @param[in] rhs An instance of %DoubleMatrix4 to copy */ DoubleMatrix4(const DoubleMatrix4& rhs); @@ -81,7 +81,7 @@ public: * * @since 2.0 * - * @return @c true if all matrix members of the current instance are equal to the corresponding matrix members in the specified instance, @n + * @return @c true if all the matrix members of the current instance are equal to the corresponding matrix members in the specified instance, @n * else @c false * @param[in] rhs An instance of %DoubleMatrix4 */ @@ -92,7 +92,7 @@ public: * * @since 2.0 * - * @return @c true if all matrix members of the current instance are not equal to the corresponding matrix members in the specified instance, @n + * @return @c true if all the matrix members of the current instance are not equal to the corresponding matrix members in the specified instance, @n * else @c false * @param[in] rhs An instance of %DoubleMatrix4 */ @@ -103,7 +103,7 @@ public: * * @since 2.0 * - * @return The reference to this instance + * @return A reference to this instance * @param[in] rhs An instance of %DoubleMatrix4 */ DoubleMatrix4& operator =(const DoubleMatrix4& rhs); @@ -113,8 +113,8 @@ public: * * @since 2.0 * - * @return The reference to this instance - * @param[in] value A @c double value to assign + * @return A reference to this instance + * @param[in] value The @c double value to assign */ DoubleMatrix4& operator =(double value); @@ -123,58 +123,58 @@ public: * * @since 2.0 * - * @return A new instance of %DoubleMatrix4 containing the resulting value of the operation + * @return A new instance of %DoubleMatrix4 that contains the resulting value of the operation * @param[in] rhs An instance of %DoubleMatrix4 */ DoubleMatrix4 operator *(const DoubleMatrix4& rhs) const; /** - * Multiplies the value to each matrix members of current instance of %DoubleMatrix4. + * Multiplies the value to each matrix member of current instance of %DoubleMatrix4. * * @since 2.0 * - * @return A new instance of %DoubleMatrix4 containing the resulting value of the operation - * @param[in] value A @c double value to multiply + * @return A new instance of %DoubleMatrix4 that contains the resulting value of the operation + * @param[in] value The @c double value to multiply */ DoubleMatrix4 operator *(double value) const; /** - * Adds the value of the specified instance and the current instance of %DoubleMatrix4. + * Adds the value of the specified instance to the current instance of %DoubleMatrix4. * * @since 2.0 * - * @return A new instance of %DoubleMatrix4 containing the resulting value of the operation + * @return A new instance of %DoubleMatrix4 that contains the resulting value of the operation * @param[in] rhs An instance of %DoubleMatrix4 */ DoubleMatrix4 operator +(const DoubleMatrix4& rhs) const; /** - * Adds the value to each matrix members of current instance of %DoubleMatrix4. + * Adds the value to each matrix member of the current instance of %DoubleMatrix4. * * @since 2.0 * - * @return A new instance of %DoubleMatrix4 containing the resulting value of the operation - * @param[in] value A @c double value to add + * @return A new instance of %DoubleMatrix4 that contains the resulting value of the operation + * @param[in] value The @c double value to add */ DoubleMatrix4 operator +(double value) const; /** - * Subtracts the value of the specified instance and the current instance of %DoubleMatrix4. + * Subtracts the value of the specified instance from the current instance of %DoubleMatrix4. * * @since 2.0 * - * @return A new instance of %DoubleMatrix4 containing the resulting value of the operation + * @return A new instance of %DoubleMatrix4 that contains the resulting value of the operation * @param[in] rhs An instance of %DoubleMatrix4 */ DoubleMatrix4 operator -(const DoubleMatrix4& rhs) const; /** - * Subtracts the value from each matrix members of current instance of %DoubleMatrix4. + * Subtracts the value from each matrix member of the current instance of %DoubleMatrix4. * * @since 2.0 * - * @return A new instance of %DoubleMatrix4 containing the resulting value of the operation - * @param[in] value A @c double value to subtract + * @return A new instance of %DoubleMatrix4 that contains the resulting value of the operation + * @param[in] value The @c double value to subtract */ DoubleMatrix4 operator -(double value) const; @@ -183,18 +183,18 @@ public: * * @since 2.0 * - * @return The reference to %DoubleMatrix4 containing the resulting value of the operation + * @return The reference to %DoubleMatrix4 that contains the resulting value of the operation * @param[in] rhs An instance of %DoubleMatrix4 */ DoubleMatrix4& operator *=(const DoubleMatrix4& rhs); /** - * Multiplies the value to each matrix members of current instance of %DoubleMatrix4. + * Multiplies the value to each matrix member of the current instance of %DoubleMatrix4. * * @since 2.0 * - * @return The reference to %DoubleMatrix4 containing the resulting value of the operation - * @param[in] value A @c double value to multiply + * @return A reference to %DoubleMatrix4 that contains the resulting value of the operation + * @param[in] value The @c double value to multiply */ DoubleMatrix4& operator *=(double value); @@ -203,18 +203,18 @@ public: * * @since 2.0 * - * @return The reference to %DoubleMatrix4 containing the resulting value of the operation + * @return A reference to %DoubleMatrix4 that contains the resulting value of the operation * @param[in] rhs An instance of %DoubleMatrix4 */ DoubleMatrix4& operator +=(const DoubleMatrix4& rhs); /** - * Adds the value to each matrix members of current instance of %DoubleMatrix4. + * Adds the value to each matrix member of the current instance of %DoubleMatrix4. * * @since 2.0 * - * @return The reference to %DoubleMatrix4 containing the resulting value of the operation - * @param[in] value A @c double value to add + * @return A reference to %DoubleMatrix4 that contains the resulting value of the operation + * @param[in] value The @c double value to add */ DoubleMatrix4& operator +=(double value); @@ -223,51 +223,51 @@ public: * * @since 2.0 * - * @return The reference to %DoubleMatrix4 containing the resulting value of the operation + * @return A reference to %DoubleMatrix4 cthat contains the resulting value of the operation * @param[in] rhs An instance of %DoubleMatrix4 */ DoubleMatrix4& operator -=(const DoubleMatrix4& rhs); /** - * Subtracts the value from each matrix members of current instance of %DoubleMatrix4. + * Subtracts the value from each matrix member of the current instance of %DoubleMatrix4. * * @since 2.0 * - * @return The reference to %DoubleMatrix4 containing the resulting value of the operation - * @param[in] value A @c double value to subtract + * @return A reference to %DoubleMatrix4 that contains the resulting value of the operation + * @param[in] value The @c double value to subtract */ DoubleMatrix4& operator -=(double value); /** - * Gets the instance of %DoubleMatrix4 resulting from the sum of the value and the specified instance of %DoubleMatrix4. + * Gets an instance of %DoubleMatrix4 resulting from the sum of the value and the specified instance of %DoubleMatrix4. * * @since 2.0 * - * @return A new instance of %DoubleMatrix4 containing the resulting value of the operation - * @param[in] value A @c double value to add + * @return A new instance of %DoubleMatrix4 that contains the resulting value of the operation + * @param[in] value The @c double value to add * @param[in] rhs An instance of %DoubleMatrix4 */ _OSP_EXPORT_ friend DoubleMatrix4 operator +(const double& value, const DoubleMatrix4& rhs); /** - * Gets the instance of %DoubleMatrix4 resulting from the product of the value and the specified instance of %DoubleMatrix4. + * Gets an instance of %DoubleMatrix4 resulting from the product of the value and the specified instance of %DoubleMatrix4. * * @since 2.0 * - * @return A new instance of %DoubleMatrix4 containing the resulting value of the operation - * @param[in] value A @c double value to multiply - * @param[in] rhs An instance of %DoubleMatrix4 + * @return A new instance of %DoubleMatrix4 that contains the resulting value of the operation + * @param[in] value The @c double value to multiply + * @param[in] rhs An instance of %DoubleMatrix4 */ _OSP_EXPORT_ friend DoubleMatrix4 operator *(const double& value, const DoubleMatrix4& rhs); /** - * Gets the instance of %DoubleMatrix4 resulting from the difference between the value and the specified instance of %DoubleMatrix4. + * Gets an instance of %DoubleMatrix4 resulting from the difference between the value and the specified instance of %DoubleMatrix4. * * @since 2.0 * - * @return A new instance of %DoubleMatrix4 containing the resulting value of the operation - * @param[in] value A @c double value to subtract - * @param[in] rhs An instance of %DoubleMatrix4 + * @return A new instance of %DoubleMatrix4 that contains the resulting value of the operation + * @param[in] value The @c double value to subtract + * @param[in] rhs An instance of %DoubleMatrix4 */ _OSP_EXPORT_ friend DoubleMatrix4 operator -(const double& value, const DoubleMatrix4& rhs); @@ -279,7 +279,9 @@ public: * @return @c true if the values of the current instance is equal to the value of the specified instance, @n * else @c false * @param[in] obj An instance of %DoubleMatrix4 - * @remarks This method overrides Tizen::Base::Object::Equals(). This method uses the values of the Matrix components to compare the two instances. + * @remarks + * - This method overrides Tizen::Base::Object::Equals(). + * - This method uses the values of the Matrix components to compare the two instances. */ virtual bool Equals(const Tizen::Base::Object& obj) const; @@ -289,8 +291,8 @@ public: * @since 2.0 * * @return The hash value of the current instance - * @remarks Two equal instances must return the same hash value. For better performance, - * the used hash function must generate a random distribution for all inputs. + * @remarks Two equal instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const; @@ -308,8 +310,8 @@ public: * * @since 2.0 * - * @return A new instance of %DoubleMatrix4 containing the resulting value of the operation - * @remarks This function must be called after checking whether the matrix is invertible or not. + * @return A new instance of %DoubleMatrix4 that contains the resulting value of the operation + * @remarks This method must be called after checking whether the matrix is invertible or not. */ DoubleMatrix4 GetInverse(void) const; @@ -327,7 +329,7 @@ public: * * @since 2.0 * - * @return A new instance of %DoubleMatrix4 containing the resulting value of the operation + * @return A new instance of %DoubleMatrix4 that contains the resulting value of the operation */ DoubleMatrix4 GetTranspose(void) const; @@ -352,7 +354,7 @@ public: bool IsInvertible(void) const; /** - * Negates the matrix members of current instance of %DoubleMatrix4. + * Negates the matrix members of the current instance of %DoubleMatrix4. * * @since 2.0 */ @@ -371,7 +373,7 @@ public: * @since 2.0 * * @return An error code - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current instance is not invertible. */ result Invert(void); @@ -384,7 +386,7 @@ public: void Transpose(void); /** - * Sets the matrix members of current instance of %DoubleMatrix4 to zero. + * Sets the matrix members of the current instance of %DoubleMatrix4 to zero. * * @since 2.0 */ @@ -405,4 +407,4 @@ private: }; // DoubleMatrix4 }} // Tizen::Base -#endif //_FBASE_DOUBLE_MATRIX4_H_ \ No newline at end of file +#endif //_FBASE_DOUBLE_MATRIX4_H_ diff --git a/inc/FBaseErrorDefine.h b/inc/FBaseErrorDefine.h index af22460..e91643b 100644 --- a/inc/FBaseErrorDefine.h +++ b/inc/FBaseErrorDefine.h @@ -16,9 +16,9 @@ /** * @file FBaseErrorDefine.h - * @brief This header file defines common error codes. + * @brief This header file defines the common error codes. * - * This header file contains the definitions of error codes. + * This header file contains the definitions of the common error codes. */ #ifndef _FBASE_ERROR_DEFINE_H_ #define _FBASE_ERROR_DEFINE_H_ diff --git a/inc/FBaseErrors.h b/inc/FBaseErrors.h index 1381e77..e2ebf58 100644 --- a/inc/FBaseErrors.h +++ b/inc/FBaseErrors.h @@ -16,9 +16,9 @@ /** * @file FBaseErrors.h - * @brief This header file defines error codes. + * @brief This is the header file that defines the error codes. * - * This header file contains the definitions of error codes. + * This header file contains the definitions of the error codes. */ #ifndef _FBASE_ERRORS_H_ #define _FBASE_ERRORS_H_ @@ -26,7 +26,7 @@ #include //----------------------------------------------------------------------------A -/** (specialized) Thrown when network address is changed externally. */ +/** (specialized) Thrown when the network address is changed externally. */ #define E_ADDRESS_CHANGED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1100)) /** Thrown when the target is bounded to another source. */ @@ -44,13 +44,13 @@ /** Thrown when the required application is not installed. */ #define E_APP_NOT_INSTALLED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1105)) -/** Thrown when the specified instance is already set to other values, instances or resources. */ +/** Thrown when the specified instance is already set to other values, instances, or resources. */ #define E_ALREADY_SET (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1106)) -/** Thrown when a specified account already exists. */ +/** Thrown when the specified account already exists. */ #define E_ACCOUNT_ALREADY_EXIST (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1107)) -/** Thrown when a required account does not exist. */ +/** Thrown when the required account does not exist. */ #define E_ACCOUNT_NOT_FOUND (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1108)) //----------------------------------------------------------------------------B @@ -59,20 +59,20 @@ /** (specialized) ... */ #define E_CHUNKED_TRANSACTION (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1300)) -/** Thrown when the connection is busy, so cannot process the new request. */ +/** Thrown when the connection is busy, so it cannot process the new request. */ #define E_CONNECTION_BUSY (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1301)) -/** Thrown when the connection to the specific destination fails. */ +/** Thrown when the connection to a specific destination fails. */ #define E_CONNECTION_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1302)) /** Thrown when the connection is reset while the other thread is still - * working on it. */ + * working on it. */ #define E_CONNECTION_RESET (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1303)) -/** Thrown when the token is expired. */ +/** Thrown when the token has expired. */ #define E_CREDENTIAL_EXPIRED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1304)) -/** The server certificate verification has failed. */ +/** Thrown when the server certificate verification has failed. */ #define E_CERTIFICATE_VERIFICATION_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1305)) /** Thrown when the context data is not available. */ @@ -82,23 +82,23 @@ /** Thrown when the requested data does not exist. */ #define E_DATA_NOT_FOUND (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1400)) -/** Thrown when underlying database system raises exception. */ +/** Thrown when the underlying database system raises an exception. */ #define E_DATABASE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1401)) -/** Thrown when decoding operation fails. */ +/** Thrown when the decoding operation fails. */ #define E_DECODING_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1402)) -/** Thrown when the device is processing the previous task, so cannot process - * the new one. */ +/** Thrown when the device is processing the previous task, so it cannot process + * the new one. */ #define E_DEVICE_BUSY (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1403)) -/** Thrown when the device fails with unknown reason. */ +/** Thrown when the device fails due to an unknown reason. */ #define E_DEVICE_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1404)) /** Thrown when the device does not support the specific request. */ #define E_DEVICE_INCOMPATIBLE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1405)) -/** Thrown when the device is not installed, or not answering at all. */ +/** Thrown when the device is not installed, or is not answering at all. */ #define E_DEVICE_UNAVAILABLE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1406)) /** General DHCP exception. */ @@ -110,7 +110,7 @@ /** General DNS exception. */ #define E_DNS (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1409)) -/** Thrown when DNS cannot resolve the requested address. */ +/** Thrown when the DNS cannot resolve the requested address. */ #define E_DNS_NOT_FOUND (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1410)) /** Thrown when the data is not enough to generate the processing result. */ @@ -120,52 +120,52 @@ #define E_DISPLAY_RIGHT_VIOLATED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1412)) //----------------------------------------------------------------------------E -/** Thrown when effects being played on the current haptic device are disabled. */ +/** Thrown when the effects being played on the current haptic device are disabled. */ #define E_EFFECTS_DISABLED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1500)) /** Thrown when a body is empty. */ #define E_EMPTY_BODY (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1501)) -/** Thrown when encoding operation fails. */ +/** Thrown when the encoding operation fails. */ #define E_ENCODING_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1502)) -/** Thrown when an end of the file or an end of the stream is reached unexpectedly - * during an input operation. */ +/** Thrown when the end of the file or the end of the stream is reached unexpectedly + * during an input operation. */ #define E_END_OF_FILE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1503)) //----------------------------------------------------------------------------F -/** (specialized) Thrown when application tries to call with a number which is - * not allowed in FDN mode, while the FDN mode is enabled. */ +/** (specialized) Thrown when the application tries to call a number which is + * not allowed in the FDN mode, while the FDN mode is enabled. */ #define E_FDN_MODE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1600)) -/** Thrown when an attempt to create the file denoted by a specified pathname - * fails. */ +/** Thrown when an attempt to create the file denoted by the specified pathname + * fails. */ #define E_FILE_ALREADY_EXIST (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1601)) -/** Thrown when an attempt to open the file denoted by a specified pathname +/** Thrown when an attempt to open the file denoted by the specified pathname * fails. */ #define E_FILE_NOT_FOUND (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1602)) //----------------------------------------------------------------------------G -/** Thrown when a required group does not exist. */ +/** Thrown when the required group does not exist. */ #define E_GROUP_NOT_FOUND (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1700)) //----------------------------------------------------------------------------H -/** Thrown the destination host is not found. */ +/** Thrown when the destination host is not found. */ #define E_HOST_NOT_FOUND (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1800)) /** Thrown when the destination host is unreachable. */ #define E_HOST_UNREACHABLE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1801)) -/** Thrown the Http transaction is canceled by user. */ +/** Thrown when the HTTP transaction is cancelled by the user. */ #define E_HTTP_USER (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1802)) //----------------------------------------------------------------------------I /** Thrown when the user does not have proper permissions. */ #define E_ILLEGAL_ACCESS (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1900)) -/** Thrown when the application requests an operation which is in progress. */ +/** Thrown when the application requests for an operation which is in progress. */ #define E_IN_PROGRESS (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1901)) /** Thrown when the return type is supposed to be a file path, but the path is not accessible by the application. */ @@ -174,70 +174,70 @@ /** Thrown when initialization fails. */ #define E_INIT_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1903)) -/** Thrown when an instantiation fails by certain reason. */ +/** Thrown when an instantiation fails due to a certain reason. */ #define E_INSTANTIATION_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1904)) /** Thrown when the haptic device priority is lower than that of the current * effects being played, belonging to another device instance. */ #define E_INSUFFICIENT_PRIORITY (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1905)) -/** Thrown when a requested operation cannot perform any further due to an - * interruption from other thread. */ +/** Thrown when the requested operation cannot perform any further due to an + * interruption from another thread. */ #define E_INTERRUPTED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1906)) -/** Thrown when an account configuration is invalid. */ +/** Thrown when the account configuration is invalid. */ #define E_INVALID_ACCOUNT (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1907)) -/** Thrown when a given address is invalid or not suitable for a requested - * operation. */ +/** Thrown when a given address is invalid or not suitable for the requested + * operation. */ #define E_INVALID_ADDRESS (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1908)) /** Thrown when a combination of passed information is not proper for performing - * the requested operation. */ + * the requested operation. */ #define E_INVALID_ARG (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1909)) /** Thrown when a combination of passed information is not proper for performing - * the requested operation. */ + * the requested operation. */ #define E_INVALID_CONDITION (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1910)) -/** Thrown when an operation requests for invalid connection. */ +/** Thrown when an operation requests for an invalid connection. */ #define E_INVALID_CONNECTION (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1911)) -/** Thrown when content is invalid. */ +/** Thrown when the content is invalid. */ #define E_INVALID_CONTENT (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1912)) -/** Thrown when context is invalid. */ +/** Thrown when the context is invalid. */ #define E_INVALID_CONTEXT (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1913)) /** Thrown when the requested (given or referenced) data is invalid. */ #define E_INVALID_DATA (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1914)) /** (specialized) Thrown when the requested (given or referenced) domain is - * invalid. */ + * invalid. */ #define E_INVALID_DOMAIN (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1915)) -/** Thrown when an indicated string contains code pointing outside of bounds by the - * specified character encoding scheme. */ +/** Thrown when an indicated string contains a code pointing outside the bounds of the + * specified character encoding scheme. */ #define E_INVALID_ENCODING_RANGE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1916)) -/** Thrown when the specified input has invalid format. */ +/** Thrown when the specified input has an invalid format. */ #define E_INVALID_FORMAT (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1917)) -/** (specialized) Thrown when */ +/** (specialized) Thrown when the specified input has an invalid format. */ #define E_INVALID_HEADER (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1918)) -/** Thrown when the specified input has invalid format. */ +/** Thrown when the specified input has an invalid format. */ #define E_INVALID_KEY (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1919)) -/** Thrown when current state of the instance prohibits the execution of the - * specified operation. */ +/** Thrown when the current state of the instance prohibits the execution of the + * specified operation. */ #define E_INVALID_OPERATION (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1920)) /** (specialized) Thrown when the proxy address is invalid. */ #define E_INVALID_PROXY (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1921)) -/** (specialized) Thrown when the SIM is not in proper state for processing the - * requested operation. */ +/** (specialized) Thrown when the SIM is not in a proper state for processing the + * requested operation. */ #define E_INVALID_SIM_STATE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1922)) /** (specialized) Thrown when the DNS request goes to an invalid DNS server. */ @@ -247,10 +247,10 @@ #define E_INVALID_SESSION (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1924)) /** Thrown when the socket which is responsible for the application's request - * is invalid. */ + * is invalid. */ #define E_INVALID_SOCKET (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1925)) -/** Thrown when an instance is not in valid state. */ +/** Thrown when an instance is not in a valid state. */ #define E_INVALID_STATE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1926)) /** Thrown when the relevant transaction is invalid. */ @@ -263,33 +263,33 @@ /** Thrown when the client has not joined the domain controller. */ #define E_NOT_JOINED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1929)) -/** The server certificate verification has failed on client. */ +/** Thrown when the server certificate verification has failed on the client's side. */ #define E_INVALID_CERTIFICATE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1930)) -/** Thrown when a given url is invalid or not suitable for a requested -* operation. */ +/** Thrown when a given url is invalid or not suitable for the requested + * operation. */ #define E_INVALID_URL (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1931)) -/** Thrown when the specified user id has invalid format. */ +/** Thrown when the specified user ID has an invalid format. */ #define E_INVALID_USER_ID (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1932)) -/** Thrown when the specified password has invalid format. */ +/** Thrown when the specified password has an invalid format. */ #define E_INVALID_PASSWORD (ERR_SRC_FRAMEWORK + SET_E_CAUSE(1933)) //----------------------------------------------------------------------------J //----------------------------------------------------------------------------K -/** Thrown when a specified key already exists. */ +/** Thrown when the specified key already exists. */ #define E_KEY_ALREADY_EXIST (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2100)) -/** Thrown when a required key does not exist. */ +/** Thrown when the required key does not exist. */ #define E_KEY_NOT_FOUND (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2101)) //----------------------------------------------------------------------------L -/** Thrown when an error related to handling landmark occurs. */ +/** Thrown when an error related to handling landmarks occurs. */ #define E_LANDMARK (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2200)) -/** Thrown when a specified library does not exists. */ +/** Thrown when a specified library does not exist. */ #define E_LIBRARY_NOT_FOUND (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2201)) /** Thrown when a specified library is not loaded. */ @@ -305,8 +305,8 @@ * occurred. */ #define E_LOCATION_SERVICE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2205)) -/** Thrown when locking (or unlocking) fails inside the logic. So cannot - * guarantee synchronous operation. */ +/** Thrown when locking (or unlocking) fails inside the logic. So it cannot + * guarantee a synchronous operation. */ #define E_LOCK_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2206)) /** Thrown when the language is not set yet. */ @@ -319,7 +319,7 @@ /** Thrown when the defined limit exceeds. */ #define E_MAX_EXCEEDED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2300)) -/** Thrown when one or more of the required input is not provided. */ +/** Thrown when one or more of the required inputs are not provided. */ #define E_MISSING_INPUT (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2301)) /** (specialized) ... */ @@ -338,11 +338,11 @@ /** Thrown when the network is not enabled. */ #define E_NETWORK_UNAVAILABLE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2401)) -/** Thrown the client certificate is required to connect to the server. */ +/** Thrown when the client certificate is required to connect to the server. */ #define E_NO_CERTIFICATE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2402)) -/** Thrown when the operation is permitted only for members, but the current - * user is not. */ +/** Thrown when the operation is permitted only for members and not for the current + * user. */ #define E_NOT_A_MEMBER (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2403)) /** (specialized) Thrown when Bluetooth pairing is not established. */ @@ -351,7 +351,7 @@ /** Thrown when the target is not responding. */ #define E_NOT_RESPONDING (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2405)) -/** Thrown when the specified string does not represent valid number. */ +/** Thrown when the specified string does not represent a valid number. */ #define E_NUM_FORMAT (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2406)) //----------------------------------------------------------------------------O @@ -368,35 +368,35 @@ * initializing. */ #define E_ON_INITIALIZING (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2503)) -/** Thrown when the operation is canceled explicitly. */ +/** Thrown when the operation is cancelled explicitly. */ #define E_OPERATION_CANCELED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2504)) -/** Thrown when the operation fails due to certain reason. */ +/** Thrown when the operation fails due to a certain reason. */ #define E_OPERATION_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2505)) /** Thrown when the memory is not sufficient to perform the requested - * operation. */ + * operation. */ #define E_OUT_OF_MEMORY (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2506)) /** Thrown when the internal state of the current instance reaches the - * valid range. */ + * valid range. */ #define E_OUT_OF_RANGE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2507)) /** Thrown when the operation has caused an overflow. */ #define E_OVERFLOW (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2508)) -/** Thrown when OpenGL operation failed. */ +/** Thrown when the OpenGL operation failed. */ #define E_OPENGL_ERROR (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2509)) /** Thrown when the application does not register the log scope or - * registered log scope is not matched with query condition (log type or log provider) specified in Query() API. */ + * the registered log scope does not match the query condition (log type or log provider) specified in the Query() API. */ #define E_OBJ_NOT_REGISTERED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2510)) //----------------------------------------------------------------------------P /** (specialized) Thrown when the requested Bluetooth pairing fails. */ #define E_PAIRING_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2600)) -/** Thrown when the parsing fails due to any reason. */ +/** Thrown when the parsing fails due to some reason. */ #define E_PARSING_FAILED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2601)) /** Thrown when an application invokes an API without a proper privilege. */ @@ -408,11 +408,11 @@ //----------------------------------------------------------------------------Q //----------------------------------------------------------------------------R -/** Thrown when a write operation is requested for an instance in read only +/** Thrown when a write operation is requested for an instance in the read only * mode. */ #define E_READ_ONLY (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2800)) -/** Thrown when the operation is rejected by remote site. */ +/** Thrown when the operation is rejected by the remote site. */ #define E_REJECTED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2801)) /** (not used) */ @@ -440,15 +440,15 @@ /** Thrown when the required section does not exist. */ #define E_SECTION_NOT_FOUND (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2901)) -/** Thrown when a server tells the device that operation failed due to some - * reason. Detailed message will be followed by - error code and an error message. */ +/** Thrown when the server tells the device that the operation failed due to some + * reason. The detailed message is followed by an error code and an error message. */ #define E_SERVER (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2902)) /** Thrown when the dedicated service module is too busy to handle another - * request. */ + * request. */ #define E_SERVICE_BUSY (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2903)) -/** Thrown when the specific service is restricted by policy. */ +/** Thrown when the specific service is restricted by the policy. */ #define E_SERVICE_LIMITED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2904)) /** Thrown when a service is locked. */ @@ -457,7 +457,7 @@ /** Thrown when the dedicated service is not available. */ #define E_SERVICE_UNAVAILABLE (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2906)) -/** Thrown when the base session is deactivated while it's still being used. */ +/** Thrown when the base session is deactivated while it is still being used. */ #define E_SESSION_DEACTIVATED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2907)) /** (not used) */ @@ -466,7 +466,7 @@ /** (not used) */ #define E_SIZE_MISMATCH (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2909)) -/** The socket connection closed by user. */ +/** Thrown when the socket connection is closed by the user. */ #define E_SOCKET_USER (ERR_SRC_FRAMEWORK + SET_E_CAUSE(2910)) /** Thrown when the storage is full. */ @@ -488,7 +488,7 @@ /** (specialized) Thrown then the specified table does not exist. */ #define E_TABLE_NOT_FOUND (ERR_SRC_FRAMEWORK + SET_E_CAUSE(3000)) -/** Thrown when the operation can not be completed within the specified time +/** Thrown when the operation cannot be completed within the specified time * period. */ #define E_TIMEOUT (ERR_SRC_FRAMEWORK + SET_E_CAUSE(3001)) @@ -534,7 +534,7 @@ /** Thrown when the URL is changed. */ #define E_URL_CHANGED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(3111)) -/** (specialized) used by HTTP transaction. */ +/** (specialized) Used by the HTTP transaction. */ #define E_USER_AGENT_NOT_ALLOWED (ERR_SRC_FRAMEWORK + SET_E_CAUSE(3112)) /** Thrown when a user is already registered to the device. */ @@ -561,11 +561,11 @@ //----------------------------------------------------------------------------V //----------------------------------------------------------------------------W -/** (specialized) Thrown when non-blocking socket operation could not be +/** (specialized) Thrown when the non-blocking socket operation is not * completed immediately. */ #define E_WOULD_BLOCK (ERR_SRC_FRAMEWORK + SET_E_CAUSE(3300)) -/** Thrown when the specified object would cause a deadlock. */ +/** Thrown when the specified object causes a deadlock. */ #define E_WOULD_DEADLOCK (ERR_SRC_FRAMEWORK + SET_E_CAUSE(3301)) //----------------------------------------------------------------------------X diff --git a/inc/FBaseFloat.h b/inc/FBaseFloat.h index b10d4e0..07e7f6c 100644 --- a/inc/FBaseFloat.h +++ b/inc/FBaseFloat.h @@ -18,9 +18,9 @@ * @file FBaseFloat.h * @brief This is the header file for the %Float class. * - * @see Tizen::Base::Number - * * This header file contains the declarations of the %Float class. + * + * @see Tizen::Base::Number */ #ifndef _FBASE_FLOAT_H_ #define _FBASE_FLOAT_H_ @@ -86,7 +86,7 @@ public: * * @since 2.0 * - * @param[in] value A @c float value + * @param[in] value The @c float value */ Float(float value = 0.0); @@ -96,7 +96,7 @@ public: * * @since 2.0 * - * @param[in] value An instance of %Float + * @param[in] value An instance of %Float to copy */ Float(const Float& value); @@ -112,7 +112,7 @@ public: * * @since 2.0 * - * @param[in] rhs An instance of %Float + * @param[in] rhs An instance of %Float to copy */ Float& operator =(const Float& rhs); @@ -121,11 +121,11 @@ public: * * @since 2.0 * - * @return A 32-bit @c signed integer value + * @return The 32-bit @c signed integer value * @code - * < 0 if the value of @c f1 is less than the value of @c f2 - * == 0 if the value of @c f1 is equal to the value of @c f2 - * > 0 if the value of @c f1 is greater than the value of @c f2 + * < 0 if the value of f1 is less than the value of f2 + * == 0 if the value of f1 is equal to the value of f2 + * > 0 if the value of f1 is greater than the value of f2 * @endcode * @param[in] f1 The first @c float value to compare * @param[in] f2 The second @c float value to compare @@ -133,11 +133,11 @@ public: static int Compare(float f1, float f2); /** - * Compares the value of the current instance with the value of the specified instance of the %Float class. + * Compares the value of the current instance with the value of the specified instance of %Float. * * @since 2.0 * - * @return A 32-bit @c signed integer value + * @return The 32-bit @c signed integer value * @code * @li < 0 if the value of the current instance is less than the value of the specified instance * @li == 0 if the value of the current instance is equal to the value of the specified instance @@ -152,7 +152,7 @@ public: * * @since 2.0 * - * @return @c true if the value of the specified instance of Object is equal to the value of the current instance of %Float, @n + * @return @c true if the value of the specified instance of :Object is equal to the value of the current instance of %Float, @n * else @c false * @param[in] obj An instance of Object to compare * @see Tizen::Base::Object::Equals() @@ -165,128 +165,129 @@ public: * * @since 2.0 * - * @return An integer value indicating the hash value of the current instance of %Float - * @remarks Two equal instances must return the same hash value. For better performance, - * the used hash function must generate a random distribution for all inputs. @n - * The default implementation of this method returns the value of the current instance. + * @return The integer value that indicates the hash value of the current instance of %Float + * @remarks + * - Two equal instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. @n + * - The default implementation of this method returns the value of the current instance. */ virtual int GetHashCode(void) const; /** - * Gets the hash value of the specified @c float value. - * - * @since 2.0 - * - * @return An integer value indicating the hash value of the specified @c float value - * @param[in] val A @c float value to get the hash value - */ + * Gets the hash value of the specified @c float value. + * + * @since 2.0 + * + * @return The integer value that indicates the hash value of the specified @c float value + * @param[in] val The @c float value used to get the hash value + */ static int GetHashCode(float val); /** - * Parses the specified string representing a numeric value and returns the value as @c signed @c float (as out parameter). + * Parses the specified string that represents a numeric value and returns the value as @c signed @c float (as out parameter). * * @since 2.0 * - * @return An error code - * @param[in] s A unicode string representing a @c signed @c float value - * @param[out] ret The numeric representation of the string + * @return An error code + * @param[in] s The unicode string that represents the @c signed @c float value + * @param[out] ret The numeric representation of the string * @exception E_SUCCESS The method is successful. * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed. * @remarks - * - This method guarantees that the original value of out-parameter is not changed when the method returns error. + * - This method guarantees that the original value of the out-parameter is not changed when the method returns an error. * - The behavior of this method is dependent on the system default locale setting. * @see Tizen::Base::Double::Parse() */ static result Parse(const String& s, float& ret); /** - * Gets the @c signed @c char equivalent of the current instance of the %Float class. + * Gets the @c signed @c char equivalent of the current instance of %Float. * * @since 2.0 * - * @return A @c signed @c char equivalent of the current instance + * @return The @c signed @c char equivalent of the current instance */ virtual char ToChar(void) const; /** - * Gets the @c signed @c short equivalent of the current instance of the %Float class. + * Gets the @c signed @c short equivalent of the current instance of %Float. * * @since 2.0 * - * @return A @c signed @c short equivalent of the current instance + * @return The @c signed @c short equivalent of the current instance */ virtual short ToShort(void) const; /** - * Gets the @c signed @c int equivalent of the current instance of the %Float class. + * Gets the @c signed @c int equivalent of the current instance of %Float. * * @since 2.0 * - * @return A @c signed @c int equivalent of the current instance + * @return The @c signed @c int equivalent of the current instance */ virtual int ToInt(void) const; /** - * Gets the @c signed @c long equivalent of the current instance of the %Float class. + * Gets the @c signed @c long equivalent of the current instance of %Float. * * @since 2.0 * - * @return A @c signed @c long equivalent of the current instance + * @return The @c signed @c long equivalent of the current instance */ virtual long ToLong(void) const; /** - * Gets the @c signed @c long @c long equivalent of the current instance of the %Float class. + * Gets the @c signed @c long @c long equivalent of the current instance of %Float * * @since 2.0 * - * @return A @c signed @c long @c long equivalent of the current instance + * @return The @c signed @c long @c long equivalent of the current instance */ virtual long long ToLongLong(void) const; /** - * Gets the @c signed @c float equivalent of the current instance of the %Float class. + * Gets the @c signed @c float equivalent of the current instance of %Float. * * @since 2.0 * - * @return A @c signed @c float equivalent of the current instance + * @return The @c signed @c float equivalent of the current instance */ virtual float ToFloat(void) const; /** - * Gets the @c signed @c double equivalent of the current instance of the %Float class. + * Gets the @c signed @c double equivalent of the current instance of %Float. * * @since 2.0 * - * @return A @c signed @c double equivalent of the current instance + * @return The @c signed @c double equivalent of the current instance */ virtual double ToDouble(void) const; /** - * Gets the string representing the value of the current instance of %Float. + * Gets the string that represents the value of the current instance of %Float. * * @since 2.0 * - * @return A string containing a Unicode representation of the value of the current instance + * @return The string that contains the Unicode representation of the value of the current instance * @remarks * - If the value is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity * produces the result "Infinity". @n - * 6 digits are given for the precision of this method. Use String::Format() to set the specific precision. + * 6 digits are given for the precision of this method. Use String::Format() to set a specific precision. * - The behavior of this method is dependent on the system default locale setting. */ virtual String ToString(void) const; /** - * Gets the string representing the specified @c float value. + * Gets the string that represents the specified @c float value. * * @since 2.0 * - * @return A string containing a Unicode representation of the specified @c float value - * @param[in] value A @c float value to convert + * @return The string that contains the Unicode representation of the specified @c float value + * @param[in] value The @c float value to convert * @remarks * - If the value is Not-a-Number (NaN), the result is the string "NaN". Furthermore, infinity * produces the result "Infinity". @n - * 6 digits are given for the precision of this method. Use String::Format() to set the specific precision. + * 6 digits are given for the precision of this method. Use String::Format() to set a specific precision. * - The behavior of this method is dependent on the system default locale setting. */ static String ToString(float value); @@ -297,7 +298,7 @@ public: * @since 2.0 * * @return The bits that represent the floating-point number in the IEEE 754 floating-point "single format" bit layout - * @param[in] value A @c float value to convert + * @param[in] value The @c float value to convert * @see Tizen::Base::Double::Parse() */ static int ToBits(float value); @@ -308,29 +309,29 @@ public: * @since 2.0 * * @return The @c float floating-point value with the same bit pattern - * @param[in] value A floating-point value in the IEEE 754 floating-point "single format" bit layout + * @param[in] value The floating-point value in the IEEE 754 floating-point "single format" bit layout * @see Tizen::Base::Double::Parse() */ static float ToFloatFromBits(int value); /** - * Checks whether the current value of %Float is equal to negative or positive infinity. + * Checks whether the current value of %Float is equal to the negative or positive infinity. * * @since 2.0 * - * @return @c true if the current value equals negative or positive infinity, @n + * @return @c true if the current value equals the negative or positive infinity, @n * else @c false */ bool IsInfinity(void) const; /** - * Checks whether the specified @c float value is equal to negative or positive infinity. + * Checks whether the specified @c float value is equal to the negative or positive infinity. * * @since 2.0 * - * @return @c true if the specified value equals negative or positive infinity, @n + * @return @c true if the specified value equals the negative or positive infinity, @n * else @c false - * @param[in] value A @c float value to check + * @param[in] value The @c float value to check */ static bool IsInfinity(float value); @@ -351,32 +352,32 @@ public: * * @return @c true if the specified value is Not-a-Number, @n * else @c false - * @param[in] value A @c float value to check + * @param[in] value The @c float value to check */ static bool IsNaN(float value); /** - * Gets a constant holding the largest positive finite value of type @c float. @n + * Gets the constant holding the largest positive finite value of type @c float. @n * This is equal to the value defined in Limit.h of the C library. * * @since 2.0 * - * @return A constant holding the largest positive finite value of type @c float + * @return The constant holding the largest positive finite value of type @c float */ static float GetMaxValue(void); /** - * Gets a constant holding the smallest positive non-zero value of type @c float. @n + * Gets the constant holding the smallest positive non-zero value of type @c float. @n * This is equal to the value defined in Limit.h of the C library. * * @since 2.0 * - * @return A constant holding the smallest possible non-zero value of type @c float + * @return The constant holding the smallest possible non-zero value of type @c float */ static float GetMinValue(void); /** - * A @c float value of this instance. + * The @c float value of this instance. * * @since 2.0 */ diff --git a/inc/FBaseFloatComparer.h b/inc/FBaseFloatComparer.h index 54e6e43..ff6a31d 100644 --- a/inc/FBaseFloatComparer.h +++ b/inc/FBaseFloatComparer.h @@ -18,9 +18,11 @@ * @file FBaseFloatComparer.h * @brief This is the header file for the %FloatComparer class. * - * @see Float and Tizen::Base::Collection::IComparer * * This header file contains the declarations of the %FloatComparer class. + * + * @see Float + * @see Tizen::Base::Collection::IComparer */ #ifndef _FBASE_FLOAT_COMPARER_H_ #define _FBASE_FLOAT_COMPARER_H_ @@ -32,11 +34,11 @@ namespace Tizen { namespace Base { /** * @class FloatComparer - * @brief This class checks for equivalence between 2 instances of the %Float type. + * @brief This class checks for equivalence between two instances of the %Float type. * * @since 2.0 * - * The %FloatComparer class checks for equivalence between 2 instances of the Float type. + * The %FloatComparer class checks for equivalence between two instances of the Float type. * * For more information on the class features, see Collection Comparisons. * @@ -90,17 +92,17 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj1 The first instance of type Float - * @param[in] obj2 The second instance of type Float - * @param[out] cmp The result of comparison + * @param[in] obj1 The first instance of type Float + * @param[in] obj2 The second instance of type Float + * @param[out] cmp The result of the comparison * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified object instances are not of the expected type. * @remarks The value of @c cmp can be: * * @code - * < 0 if the value of @c obj1 is less than the value of @c obj2 - * == 0 if the value of @c obj1 is equal to the value of @c obj2 - * > 0 if the value of @c obj1 is greater than the value of @c obj2 + * < 0 if the value of obj1 is less than the value of obj2 + * == 0 if the value of obj1 is equal to the value of obj2 + * > 0 if the value of obj1 is greater than the value of obj2 * @endcode */ virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const; diff --git a/inc/FBaseFloatMatrix.h b/inc/FBaseFloatMatrix.h index 558f2d7..d82170b 100644 --- a/inc/FBaseFloatMatrix.h +++ b/inc/FBaseFloatMatrix.h @@ -36,7 +36,7 @@ namespace Tizen { namespace Base * * @since 2.0 * - * The %FloatMatrix class provides a @c float precision, two-dimensional matrix class. + * The %FloatMatrix class provides a @c float precision, two-dimensional matrix. * */ class _OSP_EXPORT_ FloatMatrix @@ -48,12 +48,12 @@ public: * * @since 2.0 * - * @param[in] rhs An instance of %FloatMatrix + * @param[in] rhs An instance of %FloatMatrix to copy */ FloatMatrix(const FloatMatrix& rhs); /** - * Constructs a row by column null matrix in which all elements are zero. + * Constructs a row by column null matrix in which all the elements are zero. * * @since 2.0 * @@ -69,7 +69,8 @@ public: * * @param[in] rowCount The number of rows in the current instance * @param[in] columnCount The number of columns in the current instance - * @param[in] pArray A one-dimensional array @n The array must be at least row * column in length. + * @param[in] pArray The one-dimensional array @n + * The array must be at least row * column in length. * @param[in] rowMajor Set to @c true to copy the array in row-major order, @n * else @c copy in column-major order */ @@ -82,7 +83,8 @@ public: * * @param[in] rowCount The number of rows in the current instance * @param[in] columnCount The number of columns in the current instance - * @param[in] pArray[] A two-dimensional array @n The array must be at least row * column in length. + * @param[in] pArray[] The two-dimensional array @n + * The array must be at least row * column in length. */ FloatMatrix(int rowCount, int columnCount, const float* pArray[]); @@ -98,7 +100,7 @@ public: * * @since 2.0 * - * @return @c true if all matrix members of the current instance are equal to the corresponding matrix members in the specified instance, @n + * @return @c true if all the matrix members of the current instance are equal to the corresponding matrix members in the specified instance, @n * else @c false * @param[in] rhs An instance of %FloatMatrix */ @@ -109,8 +111,8 @@ public: * * @since 2.0 * - * @return @c true if all matrix members of the current instance are not equal to the corresponding matrix members in the specified instance, @n - * else @c false + * @return @c true if all the matrix members of the current instance are not equal to the corresponding matrix members in the specified instance, @n + * else @c false * @param[in] rhs An instance of %FloatMatrix */ bool operator !=(const FloatMatrix& rhs) const; @@ -120,12 +122,13 @@ public: * * @since 2.0 * - * @return The reference to this instance + * @return A reference to this instance * @param[in] rhs An instance of %FloatMatrix - * @exception E_INVALID_ARG Either row or column count of the current instance is not same with that of the specified instance. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks If either row or column count of the current instance is not same with that of the specified instance, - * return the reference to this instance without assigning. + * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - If either the row or the column count of the current instance is not same as that of the specified instance, + * this method returns the reference to this instance without assigning. */ FloatMatrix& operator =(const FloatMatrix& rhs); @@ -134,10 +137,12 @@ public: * * @since 2.0 * - * @return @c true if the values of the current instance are equal to the value of the specified instance, @n - * else @c false + * @return @c true if the values of the current instance are equal to the value of the specified instance, @n + * else @c false * @param[in] obj An instance of %FloatMatrix - * @remarks This method overrides Tizen::Base::Object::Equals(). This method uses the values of the Matrix components to compare the two instances. + * @remarks + * - This method overrides Tizen::Base::Object::Equals(). + * - This method uses the values of the Matrix components to compare the two instances. */ virtual bool Equals(const Tizen::Base::Object& obj) const; @@ -147,8 +152,8 @@ public: * @since 2.0 * * @return The hash value of the current instance - * @remarks Two equal instances must return the same hash value. For better performance, - * the used hash function must generate a random distribution for all inputs. + * @remarks Two equal instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const; @@ -160,25 +165,25 @@ public: * @return An error code * @param[in] matrix An instance of %FloatMatrix * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either row or column count of the current instance is not same with that of the specified instance. + * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance. */ result Add(const FloatMatrix& matrix); /** - * Adds the value to each matrix members of current instance of %FloatMatrix. + * Adds the value to each matrix member of the current instance of %FloatMatrix. * * @since 2.0 * - * @param[in] value A @c float value to add + * @param[in] value The @c float value to add */ void AddToEachElement(float value); /** - * Gets the number of column in the current instance of %FloatMatrix. + * Gets the number of columns in the current instance of %FloatMatrix. * * @since 2.0 * - * @return The number of column in the current instance + * @return The number of columns in the current instance */ int GetColumnCount(void) const; @@ -187,9 +192,9 @@ public: * * @since 2.0 * - * @return A pointer to float array + * @return A pointer to the float array * @param[in] columnIndex The target column number in the current instance - * @exception E_INVALID_ARG The @c columnIndex is larger than the column count of the current instance. + * @exception E_INVALID_ARG The specified @c columnIndex is larger than the column count of the current instance. * @remarks The specific error code can be accessed using the GetLastResult() method. */ float* GetColumnN(int columnIndex) const; @@ -200,9 +205,10 @@ public: * @since 2.0 * * @return The determinant value of the current instance - * @exception E_INVALID_OPERATION The current instance is not a square matrix. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks If the current instance is not a square matrix, return zero. + * @exception E_INVALID_OPERATION The current instance is not a square matrix. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - If the current instance is not a square matrix, it returns zero. */ float GetDeterminant(void) const; @@ -211,10 +217,10 @@ public: * * @since 2.0 * - * @return The value at the specified row and column of the current instance + * @return The value at the specified row and column of the current instance * @param[in] rowIndex The target row number in the current instance * @param[in] columnIndex The target column number in the current instance - * @exception E_INVALID_ARG The @c columnIndex or @c rowIndex is larger than that of the current instance. + * @exception E_INVALID_ARG The specified @c columnIndex or the specified @c rowIndex is larger than that of the current instance. * @remarks The specific error code can be accessed using the GetLastResult() method. */ float GetElement(int rowIndex, int columnIndex) const; @@ -224,18 +230,18 @@ public: * * @since 2.0 * - * @return A pointer to the instance of %FloatMatrix containing the resulting value of the operation + * @return A pointer to the instance of %FloatMatrix that contains the resulting value of the operation * @exception E_INVALID_OPERATION The current instance is not a square matrix. * @remarks The specific error code can be accessed using the GetLastResult() method. */ FloatMatrix* GetInverseN(void) const; /** - * Gets the number of row in the current instance of %FloatMatrix. + * Gets the number of rows in the current instance of %FloatMatrix. * * @since 2.0 * - * @return The number of row in the current instance + * @return The number of rows in the current instance */ int GetRowCount(void) const; @@ -244,9 +250,9 @@ public: * * @since 2.0 * - * @return A pointer to @c float array + * @return A pointer to the @c float array * @param[in] rowIndex The target row number in the current instance - * @exception E_INVALID_ARG The @c rowIndex is larger than the row count of the current instance. + * @exception E_INVALID_ARG The specified @c rowIndex is larger than the row count of the current instance. * @remarks The specific error code can be accessed using the GetLastResult() method. */ float* GetRowN(int rowIndex) const; @@ -257,8 +263,8 @@ public: * @since 2.0 * * @return An error code - * @param[out] value A @c float value - * @exception E_SUCCESS The method is successful. + * @param[out] value The @c float value + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current instance is not a square matrix. */ result GetTrace(float& value) const; @@ -268,8 +274,8 @@ public: * * @since 2.0 * - * @return A pointer to the instance of %FloatMatrix containing the resulting value of the operation - * @exception E_INVALID_OPERATION The current instance is not a square matrix. + * @return A pointer to the instance of %FloatMatrix that contains the resulting value of the operation + * @exception E_INVALID_OPERATION The current instance is not a square matrix. * @remarks The specific error code can be accessed using the GetLastResult() method. */ FloatMatrix* GetTransposeN(void) const; @@ -302,21 +308,21 @@ public: * @return An error code * @param[in] matrix An instance of %FloatMatrix * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The column count of the current instance is not same with the row count of the specified instance. + * @exception E_INVALID_ARG The column count of the current instance is not same as the row count of the specified instance. */ result Multiply(const FloatMatrix& matrix); /** - * Multiplies the value to each matrix members of current instance of %FloatMatrix. + * Multiplies the value to each matrix member of the current instance of %FloatMatrix. * * @since 2.0 * - * @param[in] value A @c float value to multiply + * @param[in] value The @c float value to multiply */ void Multiply(float value); /** - * Negates the matrix members of current instance of %FloatMatrix. + * Negates the matrix members of the current instance of %FloatMatrix. * * @since 2.0 */ @@ -362,9 +368,12 @@ public: * * @return An error code * @param[in] columnIndex The target column number in the current instance - * @param[in] pArray An array which includes the values @n The array must be at least row in length. + * @param[in] pArray The array which includes the values @n + * The array must be at least row in length. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The @c pArray is @c null, or the @c columnIndex is larger than the column count of the current instance. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c pArray is @c null. + * - The specified @c columnIndex is larger than the column count of the current instance. */ result SetColumn(int columnIndex, const float* pArray); @@ -374,10 +383,13 @@ public: * @since 2.0 * * @return An error code - * @param[in] rowIndex The target row number in the current instance - * @param[in] pArray An array which includes the values @n The array must be at least column in length. + * @param[in] rowIndex The target row number in the current instance + * @param[in] pArray The array which includes the values @n + * The array must be at least column in length. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The @c pArray is @c null, or the @c rowIndex is larger than the row count of the current instance. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c pArray is @c null. + * - The specified @c rowIndex is larger than the row count of the current instance. */ result SetRow(int rowIndex, const float* pArray); @@ -387,12 +399,14 @@ public: * @since 2.0 * * @return An error code - * @param[in] rowIndex The target row number in the current instance - * @param[in] columnIndex The target column number in the current instance - * @param[in] value A @c float value - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The pArray is @c null, or the @c rowIndex is larger than the row count of the current instance, - * or the @c columnIndex is larger than the column count of the current instance. + * @param[in] rowIndex The target row number in the current instance + * @param[in] columnIndex The target column number in the current instance + * @param[in] value The @c float value + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c pArray is @c null. + * - The specified @c rowIndex is larger than the row count of the current instance. + * - The specified @c columnIndex is larger than the column count of the current instance. */ result SetElement(int rowIndex, int columnIndex, float value); @@ -402,16 +416,17 @@ public: * @since 2.0 * * @return An error code - * @param[in] pArray A one-dimensional array @n The array must be at least row * column in length. - * @param[in] rowMajor Set to @c true to copy the array in row-major order, @n - * else @c false to copy in column-major order + * @param[in] pArray The one-dimensional array @n + * The array must be at least row * column in length. + * @param[in] rowMajor Set to @c true to copy the array in row-major order, @n + * else @c false to copy in column-major order * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The pArray is @c null. + * @exception E_INVALID_ARG The specified @c pArray is @c null. */ result SetValue(const float* pArray, bool rowMajor = true); /** - * Sets the matrix members of current instance of %FloatMatrix to zero. + * Sets the matrix members of the current instance of %FloatMatrix to zero. * * @since 2.0 */ @@ -425,16 +440,16 @@ public: * @return An error code * @param[in] matrix An instance of %FloatMatrix * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either row or column count of the current instance is not same with that of the specified instance. + * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance. */ result Subtract(const FloatMatrix& matrix); /** - * Subtracts the value from each matrix members of current instance of %FloatMatrix. + * Subtracts the value from each matrix member of the current instance of %FloatMatrix. * * @since 2.0 * - * @param[in] value A @c float value to subtract + * @param[in] value The @c float value to subtract */ void SubtractToEachElement(float value); diff --git a/inc/FBaseFloatMatrix3.h b/inc/FBaseFloatMatrix3.h index ed340f7..afa0785 100644 --- a/inc/FBaseFloatMatrix3.h +++ b/inc/FBaseFloatMatrix3.h @@ -36,7 +36,7 @@ namespace Tizen { namespace Base * * @since 2.0 * - * The %FloatMatrix3 class provides a @c float precision, two-dimensional matrix class. + * The %FloatMatrix3 class provides a @c float precision, two-dimensional matrix. * */ class _OSP_EXPORT_ FloatMatrix3 @@ -45,7 +45,7 @@ class _OSP_EXPORT_ FloatMatrix3 public: /** * This is the default constructor for this class. @n - * Constructs a 3 X 3 null matrix in which all elements are zero. + * Constructs a 3 X 3 null matrix in which all the elements are zero. * * @since 2.0 */ @@ -56,7 +56,7 @@ public: * * @since 2.0 * - * @param[in] rhs An instance of %FloatMatrix3 + * @param[in] rhs An instance of %FloatMatrix3 to copy */ FloatMatrix3(const FloatMatrix3& rhs); @@ -81,7 +81,7 @@ public: * * @since 2.0 * - * @return @c true if all matrix members of the current instance are equal to the corresponding matrix members in the specified instance, @n + * @return @c true if all the matrix members of the current instance are equal to the corresponding matrix members in the specified instance, @n * else @c false * @param[in] rhs An instance of %FloatMatrix3 */ @@ -92,7 +92,7 @@ public: * * @since 2.0 * - * @return @c true if all matrix members of the current instance are not equal to the corresponding matrix members in the specified instance, @n + * @return @c true if all the matrix members of the current instance are not equal to the corresponding matrix members in the specified instance, @n * else @c false * @param[in] rhs An instance of %FloatMatrix3 */ @@ -103,8 +103,8 @@ public: * * @since 2.0 * - * @return The reference to this instance - * @param[in] rhs An instance of %FloatMatrix3 + * @return A reference to this instance + * @param[in] rhs An instance of %FloatMatrix3 to copy */ FloatMatrix3& operator =(const FloatMatrix3& rhs); @@ -113,8 +113,8 @@ public: * * @since 2.0 * - * @return The reference to this instance - * @param[in] value A @c float value to assign + * @return A reference to this instance + * @param[in] value The @c float value to assign */ FloatMatrix3& operator =(float value); @@ -123,38 +123,38 @@ public: * * @since 2.0 * - * @return A new instance of %FloatMatrix3 containing the resulting value of the operation + * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation * @param[in] rhs An instance of %FloatMatrix3 */ FloatMatrix3 operator *(const FloatMatrix3& rhs) const; /** - * Multiplies the value to each matrix members of current instance of %FloatMatrix3. + * Multiplies the value to each matrix member of the current instance of %FloatMatrix3. * * @since 2.0 * - * @return A new instance of %FloatMatrix3 containing the resulting value of the operation - * @param[in] value A @c float value to multiply + * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation + * @param[in] value The @c float value to multiply */ FloatMatrix3 operator *(float value) const; /** - * Adds the value of the specified instance and the current instance of %FloatMatrix3. + * Adds the value of the specified instance to the current instance of %FloatMatrix3. * * @since 2.0 * - * @return A new instance of %FloatMatrix3 containing the resulting value of the operation + * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation * @param[in] rhs An instance of %FloatMatrix3 */ FloatMatrix3 operator +(const FloatMatrix3& rhs) const; /** - * Adds the value to each matrix members of current instance of %FloatMatrix3. + * Adds the value to each matrix member of the current instance of %FloatMatrix3. * * @since 2.0 * - * @return A new instance of %FloatMatrix3 containing the resulting value of the operation - * @param[in] value A @c float value to add + * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation + * @param[in] value The @c float value to add */ FloatMatrix3 operator +(float value) const; @@ -163,18 +163,18 @@ public: * * @since 2.0 * - * @return A new instance of %FloatMatrix3 containing the resulting value of the operation + * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation * @param[in] rhs An instance of %FloatMatrix3 */ FloatMatrix3 operator -(const FloatMatrix3& rhs) const; /** - * Subtracts the value from each matrix members of current instance of %FloatMatrix3. + * Subtracts the value from each matrix member of the current instance of %FloatMatrix3. * * @since 2.0 * - * @return A new instance of %FloatMatrix3 containing the resulting value of the operation - * @param[in] value A @c float value to subtract + * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation + * @param[in] value The @c float value to subtract */ FloatMatrix3 operator -(float value) const; @@ -183,18 +183,18 @@ public: * * @since 2.0 * - * @return The reference to %FloatMatrix3 containing the resulting value of the operation + * @return A reference to %FloatMatrix3 that contains the resulting value of the operation * @param[in] rhs An instance of %FloatMatrix3 */ FloatMatrix3& operator *=(const FloatMatrix3& rhs); /** - * Multiplies the value to each matrix members of current instance of %FloatMatrix3. + * Multiplies the value to each matrix member of the current instance of %FloatMatrix3. * * @since 2.0 * - * @return The reference to %FloatMatrix3 containing the resulting value of the operation - * @param[in] value A @c float value to multiply + * @return A reference to %FloatMatrix3 that contains the resulting value of the operation + * @param[in] value The @c float value to multiply */ FloatMatrix3& operator *=(float value); @@ -203,18 +203,18 @@ public: * * @since 2.0 * - * @return The reference to %FloatMatrix3 containing the resulting value of the operation + * @return A reference to %FloatMatrix3 that contains the resulting value of the operation * @param[in] rhs An instance of %FloatMatrix3 */ FloatMatrix3& operator +=(const FloatMatrix3& rhs); /** - * Adds the value to each matrix members of current instance of %FloatMatrix3. + * Adds the value to each matrix member of the current instance of %FloatMatrix3. * * @since 2.0 * - * @return The reference to %FloatMatrix3 containing the resulting value of the operation - * @param[in] value A @c float value to add + * @return A reference to %FloatMatrix3 that contains the resulting value of the operation + * @param[in] value The @c float value to add */ FloatMatrix3& operator +=(float value); @@ -223,51 +223,51 @@ public: * * @since 2.0 * - * @return The reference to %FloatMatrix3 containing the resulting value of the operation + * @return A reference to %FloatMatrix3 that contains the resulting value of the operation * @param[in] rhs An instance of %FloatMatrix3 */ FloatMatrix3& operator -=(const FloatMatrix3& rhs); /** - * Subtracts the value from each matrix members of current instance of %FloatMatrix3. + * Subtracts the value from each matrix member of the current instance of %FloatMatrix3. * * @since 2.0 * - * @return The reference to %FloatMatrix3 containing the resulting value of the operation - * @param[in] value A @c float value to subtract + * @return A reference to %FloatMatrix3 that contains the resulting value of the operation + * @param[in] value The @c float value to subtract */ FloatMatrix3& operator -=(float value); /** - * Gets the instance of %FloatMatrix3 resulting from the sum of the value and the specified instance of %FloatMatrix3. + * Gets an instance of %FloatMatrix3 resulting from the sum of the value and the specified instance of %FloatMatrix3. * * @since 2.0 * - * @return A new instance of %FloatMatrix3 containing the resulting value of the operation - * @param[in] value A @c float value to add - * @param[in] rhs An instance of %FloatMatrix3 + * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation + * @param[in] value The @c float value to add + * @param[in] rhs An instance of %FloatMatrix3 */ _OSP_EXPORT_ friend FloatMatrix3 operator +(const float& value, const FloatMatrix3& rhs); /** - * Gets the instance of %FloatMatrix3 resulting from the product of the value and the specified instance of %FloatMatrix3. + * Gets an instance of %FloatMatrix3 resulting from the product of the value and the specified instance of %FloatMatrix3. * * @since 2.0 * - * @return A new instance of %FloatMatrix3 containing the resulting value of the operation - * @param[in] value A @c float value to multiply - * @param[in] rhs An instance of %FloatMatrix3 + * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation + * @param[in] value The @c float value to multiply + * @param[in] rhs An instance of %FloatMatrix3 */ _OSP_EXPORT_ friend FloatMatrix3 operator *(const float& value, const FloatMatrix3& rhs); /** - * Gets the instance of %FloatMatrix3 resulting from the difference between the value and the specified instance of %FloatMatrix3. + * Gets an instance of %FloatMatrix3 resulting from the difference between the value and the specified instance of %FloatMatrix3. * * @since 2.0 * - * @return A new instance of %FloatMatrix3 containing the resulting value of the operation - * @param[in] value A @c float value to subtract - * @param[in] rhs An instance of %FloatMatrix3 + * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation + * @param[in] value The @c float value to subtract + * @param[in] rhs An instance of %FloatMatrix3 */ _OSP_EXPORT_ friend FloatMatrix3 operator -(const float& value, const FloatMatrix3& rhs); @@ -276,10 +276,12 @@ public: * * @since 2.0 * - * @return @c true if the values of the current instance is equal to the value of the specified instance, @n - * else @c false + * @return @c true if the values of the current instance is equal to the value of the specified instance, @n + * else @c false * @param[in] obj An instance of %FloatMatrix3 - * @remarks This method overrides Tizen::Base::Object::Equals(). This method uses the values of the Matrix components to compare the two instances. + * @remarks + * - This method overrides Tizen::Base::Object::Equals(). + * - This method uses the values of the Matrix components to compare the two instances. */ virtual bool Equals(const Tizen::Base::Object& obj) const; @@ -289,8 +291,8 @@ public: * @since 2.0 * * @return The hash value of the current instance - * @remarks Two equal instances must return the same hash value. For better performance, - * the used hash function must generate a random distribution for all inputs. + * @remarks Two equal instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const; @@ -308,7 +310,7 @@ public: * * @since 2.0 * - * @return A new instance of %FloatMatrix3 containing the resulting value of the operation + * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation * @remarks This function must be called after checking whether the matrix is invertible or not. */ FloatMatrix3 GetInverse(void) const; @@ -327,7 +329,7 @@ public: * * @since 2.0 * - * @return A new instance of %FloatMatrix3 containing the resulting value of the operation + * @return A new instance of %FloatMatrix3 that contains the resulting value of the operation */ FloatMatrix3 GetTranspose(void) const; @@ -352,7 +354,7 @@ public: bool IsInvertible(void) const; /** - * Negates the matrix members of current instance of %FloatMatrix3. + * Negates the matrix members of the current instance of %FloatMatrix3. * * @since 2.0 */ @@ -371,7 +373,7 @@ public: * @since 2.0 * * @return An error code - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current instance is not invertible. */ result Invert(void); @@ -384,7 +386,7 @@ public: void Transpose(void); /** - * Sets the matrix members of current instance of %FloatMatrix3 to zero. + * Sets the matrix members of the current instance of %FloatMatrix3 to zero. * * @since 2.0 */ diff --git a/inc/FBaseFloatMatrix4.h b/inc/FBaseFloatMatrix4.h index 18120fe..d2ed6ef 100644 --- a/inc/FBaseFloatMatrix4.h +++ b/inc/FBaseFloatMatrix4.h @@ -36,7 +36,7 @@ namespace Tizen { namespace Base * * @since 2.0 * - * The %FloatMatrix4 class provides a @c float precision, two-dimensional matrix class. + * The %FloatMatrix4 class provides a @c float precision, two-dimensional matrix. * */ class _OSP_EXPORT_ FloatMatrix4 @@ -45,7 +45,7 @@ class _OSP_EXPORT_ FloatMatrix4 public: /** * This is the default constructor for this class. @n - * Constructs a 4 X 4 null matrix in which all elements are zero. + * Constructs a 4 X 4 null matrix in which all the elements are zero. * * @since 2.0 */ @@ -56,7 +56,7 @@ public: * * @since 2.0 * - * @param[in] rhs An instance of %FloatMatrix4 + * @param[in] rhs An instance of %FloatMatrix4 to copy */ FloatMatrix4(const FloatMatrix4& rhs); @@ -70,7 +70,7 @@ public: FloatMatrix4(const float matrix[4][4]); /** - * TThis destructor overrides Tizen::Base::Object::~Object(). + * This destructor overrides Tizen::Base::Object::~Object(). * * @since 2.0 */ @@ -81,7 +81,7 @@ public: * * @since 2.0 * - * @return @c true if all matrix members of the current instance are equal to the corresponding matrix members in the specified instance, @n + * @return @c true if all the matrix members of the current instance are equal to the corresponding matrix members in the specified instance, @n * else @c false * @param[in] rhs An instance of %FloatMatrix4 */ @@ -92,7 +92,7 @@ public: * * @since 2.0 * - * @return @c true if all matrix members of the current instance are not equal to the corresponding matrix members in the specified instance, @n + * @return @c true if all the matrix members of the current instance are not equal to the corresponding matrix members in the specified instance, @n * else @c false * @param[in] rhs An instance of %FloatMatrix4 */ @@ -103,8 +103,8 @@ public: * * @since 2.0 * - * @return The reference to this instance - * @param[in] rhs An instance of %FloatMatrix4 + * @return A reference to this instance + * @param[in] rhs An instance of %FloatMatrix4 to copy */ FloatMatrix4& operator =(const FloatMatrix4& rhs); @@ -113,8 +113,8 @@ public: * * @since 2.0 * - * @return The reference to this instance - * @param[in] value A @c float value to assign + * @return A reference to this instance + * @param[in] value The @c float value to assign */ FloatMatrix4& operator =(float value); @@ -123,78 +123,78 @@ public: * * @since 2.0 * - * @return A new instance of %FloatMatrix4 containing the resulting value of the operation + * @return A new instance of %FloatMatrix4 that contains the resulting value of the operation * @param[in] rhs An instance of %FloatMatrix4 */ FloatMatrix4 operator *(const FloatMatrix4& rhs) const; /** - * Multiplies the value to each matrix members of current instance of %FloatMatrix4. + * Multiplies the value to each matrix member of the current instance of %FloatMatrix4. * * @since 2.0 * - * @return A new instance of %FloatMatrix4 containing the resulting value of the operation - * @param[in] value A @c float value to multiply + * @return A new instance of %FloatMatrix4 that contains the resulting value of the operation + * @param[in] value The @c float value to multiply */ FloatMatrix4 operator *(float value) const; /** - * Adds the value of the specified instance and the current instance of %FloatMatrix4. + * Adds the value of the specified instance to the current instance of %FloatMatrix4. * * @since 2.0 * - * @return A new instance of %FloatMatrix4 containing the resulting value of the operation + * @return A new instance of %FloatMatrix4 that contains the resulting value of the operation * @param[in] rhs An instance of %FloatMatrix4 */ FloatMatrix4 operator +(const FloatMatrix4& rhs) const; /** - * Adds the value to each matrix members of current instance of %FloatMatrix4. + * Adds the value to each matrix member of the current instance of %FloatMatrix4. * * @since 2.0 * - * @return A new instance of %FloatMatrix4 containing the resulting value of the operation - * @param[in] value A @c float value to add + * @return A new instance of %FloatMatrix4 that contains the resulting value of the operation + * @param[in] value The @c float value to add */ FloatMatrix4 operator +(float value) const; /** - * Subtracts the value of the specified instance and the current instance of %FloatMatrix4. + * Subtracts the value of the specified instance from the current instance of %FloatMatrix4. * * @since 2.0 * - * @return A new instance of %FloatMatrix4 containing the resulting value of the operation + * @return A new instance of %FloatMatrix4 that contains the resulting value of the operation * @param[in] rhs An instance of %FloatMatrix4 */ FloatMatrix4 operator -(const FloatMatrix4& rhs) const; /** - * Subtracts the value from each matrix members of current instance of %FloatMatrix4. + * Subtracts the value from each matrix member of the current instance of %FloatMatrix4. * * @since 2.0 * - * @return A new instance of %FloatMatrix4 containing the resulting value of the operation - * @param[in] value A @c float value to subtract + * @return A new instance of %FloatMatrix4 that contains the resulting value of the operation + * @param[in] value The @c float value to subtract */ FloatMatrix4 operator -(float value) const; /** - * Multiplies the value of the specified instance and the current instance of %FloatMatrix4. + * Multiplies the value of the specified instance with the current instance of %FloatMatrix4. * * @since 2.0 * - * @return The reference to %FloatMatrix4 containing the resulting value of the operation + * @return A reference to %FloatMatrix4 that contains the resulting value of the operation * @param[in] rhs An instance of %FloatMatrix4 */ FloatMatrix4& operator *=(const FloatMatrix4& rhs); /** - * Multiplies the value to each matrix members of current instance of %FloatMatrix4. + * Multiplies the value to each matrix member of the current instance of %FloatMatrix4. * * @since 2.0 * - * @return The reference to %FloatMatrix4 containing the resulting value of the operation - * @param[in] value A @c float value to multiply + * @return A reference to %FloatMatrix4 that contains the resulting value of the operation + * @param[in] value The @c float value to multiply */ FloatMatrix4& operator *=(float value); @@ -203,18 +203,18 @@ public: * * @since 2.0 * - * @return The reference to %FloatMatrix4 containing the resulting value of the operation + * @return A reference to %FloatMatrix4 that contains the resulting value of the operation * @param[in] rhs An instance of %FloatMatrix4 */ FloatMatrix4& operator +=(const FloatMatrix4& rhs); /** - * Adds the value to each matrix members of current instance of %FloatMatrix4. + * Adds the value to each matrix member of the current instance of %FloatMatrix4. * * @since 2.0 * - * @return The reference to %FloatMatrix4 containing the resulting value of the operation - * @param[in] value A @c float value to add + * @return A reference to %FloatMatrix4 that contains the resulting value of the operation + * @param[in] value The @c float value to add */ FloatMatrix4& operator +=(float value); @@ -223,50 +223,50 @@ public: * * @since 2.0 * - * @return The reference to %FloatMatrix4 containing the resulting value of the operation + * @return A reference to %FloatMatrix4 that contains the resulting value of the operation * @param[in] rhs An instance of %FloatMatrix4 */ FloatMatrix4& operator -=(const FloatMatrix4& rhs); /** - * Subtracts the value from each matrix members of current instance of %FloatMatrix4. + * Subtracts the value from each matrix member of the current instance of %FloatMatrix4. * * @since 2.0 * - * @return The reference to %FloatMatrix4 containing the resulting value of the operation - * @param[in] value A @c float value to subtract + * @return A reference to %FloatMatrix4 that contains the resulting value of the operation + * @param[in] value The @c float value to subtract */ FloatMatrix4& operator -=(float value); /** - * Gets the instance of %FloatMatrix4 resulting from the sum of the value and the specified instance of %FloatMatrix4. + * Gets an instance of %FloatMatrix4 resulting from the sum of the value and the specified instance of %FloatMatrix4. * * @since 2.0 * - * @return A new instance of %FloatMatrix4 containing the resulting value of the operation - * @param[in] value A @c float value to add + * @return A new instance of %FloatMatrix4 that contains the resulting value of the operation + * @param[in] value The @c float value to add * @param[in] rhs An instance of %FloatMatrix4 */ _OSP_EXPORT_ friend FloatMatrix4 operator +(const float& value, const FloatMatrix4& rhs); /** - * Gets the instance of %FloatMatrix4 resulting from the product of the value and the specified instance of %FloatMatrix4. + * Gets an instance of %FloatMatrix4 resulting from the product of the value and the specified instance of %FloatMatrix4. * * @since 2.0 * - * @return A new instance of %FloatMatrix4 containing the resulting value of the operation - * @param[in] value A @c float value to multiply + * @return A new instance of %FloatMatrix4 that contains the resulting value of the operation + * @param[in] value The @c float value to multiply * @param[in] rhs An instance of %FloatMatrix4 */ _OSP_EXPORT_ friend FloatMatrix4 operator *(const float& value, const FloatMatrix4& rhs); /** - * Gets the instance of %FloatMatrix4 resulting from the difference between the value and the specified instance of %FloatMatrix4. + * Gets an instance of %FloatMatrix4 resulting from the difference between the value and the specified instance of %FloatMatrix4. * * @since 2.0 * - * @return A new instance of %FloatMatrix4 containing the resulting value of the operation - * @param[in] value A @c float value to subtract + * @return A new instance of %FloatMatrix4 that containsg the resulting value of the operation + * @param[in] value The @c float value to subtract * @param[in] rhs An instance of %FloatMatrix4 */ _OSP_EXPORT_ friend FloatMatrix4 operator -(const float& value, const FloatMatrix4& rhs); @@ -279,7 +279,9 @@ public: * @return @c true if the values of the current instance is equal to the value of the specified instance, @n * else @c false * @param[in] obj An instance of %FloatMatrix4 - * @remarks This method overrides Tizen::Base::Object::Equals(). This method uses the values of the Matrix components to compare the two instances. + * @remarks + * - This method overrides Tizen::Base::Object::Equals(). + * - This method uses the values of the Matrix components to compare the two instances. */ virtual bool Equals(const Tizen::Base::Object& obj) const; @@ -289,8 +291,8 @@ public: * @since 2.0 * * @return The hash value of the current instance - * @remarks Two equal instances must return the same hash value. For better performance, - * the used hash function must generate a random distribution for all inputs. + * @remarks Two equal instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const; @@ -308,7 +310,7 @@ public: * * @since 2.0 * - * @return A new instance of %FloatMatrix4 containing the resulting value of the operation + * @return A new instance of %FloatMatrix4 that contains the resulting value of the operation * @remarks This function must be called after checking whether the matrix is invertible or not. */ FloatMatrix4 GetInverse(void) const; @@ -327,7 +329,7 @@ public: * * @since 2.0 * - * @return A new instance of %FloatMatrix4 containing the resulting value of the operation + * @return A new instance of %FloatMatrix4 that contains the resulting value of the operation */ FloatMatrix4 GetTranspose(void) const; @@ -352,7 +354,7 @@ public: bool IsInvertible(void) const; /** - * Negates the matrix members of current instance of %FloatMatrix4. + * Negates the matrix members of the current instance of %FloatMatrix4. * * @since 2.0 */ @@ -384,7 +386,7 @@ public: void Transpose(void); /** - * Sets the matrix members of current instance of %FloatMatrix4 to zero. + * Sets the matrix members of the current instance of %FloatMatrix4 to zero. * * @since 2.0 */ diff --git a/inc/FBaseInt8.h b/inc/FBaseInt8.h index 30cfdfe..c6fd40a 100644 --- a/inc/FBaseInt8.h +++ b/inc/FBaseInt8.h @@ -18,9 +18,9 @@ * @file FBaseInt8.h * @brief This is the header file for the %Int8 class. * - * @see Tizen::Base::Number - * * This header file contains the declarations of the %Int8 class. + * + * @see Tizen::Base::Number */ #ifndef _FBASE_INT8_H_ #define _FBASE_INT8_H_ @@ -79,7 +79,7 @@ public: * * @since 2.0 * - * @param[in] value A @c char value + * @param[in] value The @c char value */ Int8(char value = 0); @@ -88,7 +88,7 @@ public: * * @since 2.0 * - * @param[in] value An instance of %Int8 + * @param[in] value An instance of %Int8 to copy */ Int8(const Int8& value); @@ -104,7 +104,7 @@ public: * * @since 2.0 * - * @param[in] rhs An instance of %Int8 + * @param[in] rhs An instance of %Int8 to copy */ Int8& operator =(const Int8& rhs); @@ -113,7 +113,7 @@ public: * * @since 2.0 * - * @return A 32-bit @c signed integer value + * @return The 32-bit @c signed integer value * @code * < 0 if the value of ch1 is less than the value of ch2 * == 0 if the value of ch1 is equal to the value of ch2 @@ -125,17 +125,17 @@ public: static int Compare(char ch1, char ch2); /** - * Compares the value of the current instance with the value of the specified instance of the %Int8 class. + * Compares the value of the current instance with the value of the specified instance of %Int8. * * @since 2.0 * - * @return A 32-bit @c signed integer value + * @return The 32-bit @c signed integer value * @code * < 0 if the value of the current instance is less than the value of the specified instance * == 0 if the value of the current instance is equal to the value of the specified instance * > 0 if the value of the current instance is greater than the value of the specified instance * @endcode - * @param[in] value An instance of the %Int8 class to compare + * @param[in] value An instance of %Int8 to compare */ int CompareTo(const Int8& value) const; @@ -146,7 +146,7 @@ public: * * @return @c true if the value of the specified instance is equal to the value of the current instance, @n * else @c false - * @param[in] obj An instance of Object to compare + * @param[in] obj An instance of Tizen::Base::Object to compare * @see Tizen::Base::Object::Equals() */ virtual bool Equals(const Object& obj) const; @@ -156,10 +156,11 @@ public: * * @since 2.0 * - * @return An integer value indicating the hash value of the current instance of %Int8 - * @remarks Two equal instances must return the same hash value. For better performance, - * the used hash function must generate a random distribution for all inputs. @n - * The default implementation of this method returns the value of the current instance. + * @return The integer value that indicates the hash value of the current instance of %Int8 + * @remarks + * - Two equal instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. @n + * - The default implementation of this method returns the value of the current instance. */ virtual int GetHashCode(void) const; @@ -168,8 +169,8 @@ public: * * @since 2.0 * - * @return An integer value indicating the hash value of the specified @c char value - * @param[in] val A @c char value to get the hash value + * @return The integer value that indicates the hash value of the specified @c char value + * @param[in] val The @c char value to get the hash value */ static int GetHashCode(char val); @@ -179,8 +180,8 @@ public: * @since 2.0 * * @return An error code - * @param[in] s A string representing a numeric value - * @param[out] ret The result of the operation + * @param[in] s The string that represents the numeric value + * @param[out] ret The result of the operation * @exception E_SUCCESS The method is successful. * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed. * @remarks This method accepts decimal, hexadecimal, and octal numbers given by the @@ -195,8 +196,8 @@ public: * - Sign: * '-' * @endcode - * @remarks This method has portability issue. @n - * When the specified string is nagative number in the ARM architecture, type casting is needed like following code. + * @remarks This method has portability issues. @n + * When the specified string is a negative number in the ARM architecture, type casting is needed like the following code. * @code * char ret; * Int8::Decode(L"-0X20", ret); @@ -206,36 +207,36 @@ public: static result Decode(const String& s, char& ret); /** - * Parses the @c signed @c char equivalent of the specified string representing a numeric value. + * Parses the @c signed @c char equivalent of the specified string that represents a numeric value. * * @since 2.0 * * @return An error code - * @param[in] s A string representing a numeric value - * @param[out] ret The result of the operation + * @param[in] s The string that represents a numeric value + * @param[out] ret The result of the operation * @exception E_SUCCESS The method is successful. * @exception E_NUM_FORMAT The specified string does not contain a byte that can be parsed. * @remarks - * - This method assumes that the string representing the numeric value uses a radix 10. - * - This method guarantees that the original value of out-parameter is not changed when the method returns error. + * - This method assumes that the string representing the numeric value uses a radix @c 10. + * - This method guarantees that the original value of the out-parameter is not changed when the method returns an error. */ static result Parse(const String& s, char& ret); /** - * Parses the specified string representing a numeric value and + * Parses the specified string that represents a numeric value and * returns the value as @c signed @c char (as out parameter). * * @since 2.0 * - * @return The @c signed @c char equivalent of the specified string representing the numeric value using the specified index - * @param[in] s A string representing a numeric value - * @param[in] radix The radix of the string representing a numeric value @n - * It must either be 2, 8, 10, or 16. - * @param[out] ret The result of the operation - * @exception E_SUCCESS The method is successful. - * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed. - * @exception E_OUT_OF_RANGE The specified @c radix is invalid. - * @remarks This method guarantees that the original value of out-parameter is not changed when the method returns error. + * @return The @c signed @c char equivalent of the specified string that represents the numeric value using the specified index + * @param[in] s The string that represents the numeric value + * @param[in] radix The radix of the string that represents the numeric value @n + * It must either be 2, 8, 10, or 16. + * @param[out] ret The result of the operation + * @exception E_SUCCESS The method is successful. + * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed. + * @exception E_OUT_OF_RANGE The specified @c radix is invalid. + * @remarks This method guarantees that the original value of the out-parameter is not changed when the method returns an error. */ static result Parse(const String& s, int radix, char& ret); @@ -303,26 +304,26 @@ public: virtual double ToDouble(void) const; /** - * Gets the string representing the value of the current instance of %Int8. + * Gets the string that represents the value of the current instance of %Int8. * * @since 2.0 * - * @return A string representing the value of the current instance + * @return The string that represents the value of the current instance */ virtual String ToString(void) const; /** - * Gets the string representing the specified @c signed @c char value using radix @c 10. + * Gets the string that represents the specified @c signed @c char value using radix @c 10. * * @since 2.0 * - * @return A string containing a Unicode representation of the specified @c char value using radix 10 - * @param[in] value A @c char value + * @return The string that contains the Unicode representation of the specified @c char value using radix @c 10 + * @param[in] value The @c char value */ static String ToString(char value); /** - * A constant holding the maximum value of type @c char. @n + * The constant holding the maximum value of type @c char. @n * A @c short character can hold a value of upto 2^7-1. * * @since 2.0 @@ -330,7 +331,7 @@ public: static const char VALUE_MAX = (signed char) 0x7F; /** - * A constant holding the minimum value of type @c char. @n + * The constant holding the minimum value of type @c char. @n * A @c short character can hold a value of upto -2^7. * * @since 2.0 @@ -338,7 +339,7 @@ public: static const char VALUE_MIN = (signed char) 0x80; /** - * A @c signed @c char value of this instance. + * The @c signed @c char value of this instance. * * @since 2.0 */ diff --git a/inc/FBaseInt8Comparer.h b/inc/FBaseInt8Comparer.h index e76551d..842d8a2 100644 --- a/inc/FBaseInt8Comparer.h +++ b/inc/FBaseInt8Comparer.h @@ -18,9 +18,10 @@ * @file FBaseInt8Comparer.h * @brief This is the header file for the %Int8Comparer class. * - * @see Int8 and Tizen::Base::Collection::IComparer - * * This header file contains the declarations of the %Int8Comparer class. + * + * @see Int8 + * @see Tizen::Base::Collection::IComparer */ #ifndef _FBASE_INT8_COMPARER_H_ #define _FBASE_INT8_COMPARER_H_ @@ -33,11 +34,11 @@ namespace Tizen { namespace Base { /** * @class Int8Comparer - * @brief This class checks for equivalence between 2 instances of the %Int8 type. + * @brief This class checks for equivalence between two instances of the %Int8 type. * * @since 2.0 * - * The %Int8Comparer class checks for equivalence between 2 instances of the Int8 type. + * The %Int8Comparer class checks for equivalence between two instances of the Int8 type. * * For more information on the class features, see Collection Comparisons. * @@ -91,17 +92,17 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj1 The first instance of type Int8 - * @param[in] obj2 The second instance of type Int8 - * @param[out] cmp The result of comparison + * @param[in] obj1 The first instance of type Int8 + * @param[in] obj2 The second instance of type Int8 + * @param[out] cmp The result of the comparison * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified object instances are not of the expected type. * @remarks The value of @c cmp can be: * * @code - * < 0 if the value of @c obj1 is less than the value of @c obj2 - * == 0 if the value of @c obj1 is equal to the value of @c obj2 - * > 0 if the value of @c obj1 is greater than the value of @c obj2 + * < 0 if the value of obj1 is less than the value of obj2 + * == 0 if the value of obj1 is equal to the value of obj2 + * > 0 if the value of obj1 is greater than the value of obj2 * @endcode */ virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const; diff --git a/inc/FBaseIntMatrix.h b/inc/FBaseIntMatrix.h index fde7ef0..3383ce9 100644 --- a/inc/FBaseIntMatrix.h +++ b/inc/FBaseIntMatrix.h @@ -37,7 +37,7 @@ namespace Tizen { namespace Base * * @since 2.0 * - * The %IntMatrix class provides a int precision, two-dimensional matrix class. + * The %IntMatrix class provides a @c int precision, two-dimensional matrix. * */ class _OSP_EXPORT_ IntMatrix @@ -49,12 +49,12 @@ public: * * @since 2.0 * - * @param[in] rhs An instance of %IntMatrix + * @param[in] rhs An instance of %IntMatrix to copy */ IntMatrix(const IntMatrix& rhs); /* - * Constructs a row by column null matrix in which all elements are zero. + * Constructs a row by column null matrix in which all the elements are zero. * * @since 2.0 * @@ -70,7 +70,8 @@ public: * * @param[in] rowCount The number of rows in the current instance * @param[in] columnCount The number of columns in the current instance - * @param[in] pArray A one-dimensional array @n The array must be at least row * column in length. + * @param[in] pArray The one-dimensional array @n + * The array must be at least row * column in length. * @param[in] rowMajor Set to @c true to copy the array in row-major order, @n * else @c copy in column-major order */ @@ -83,7 +84,8 @@ public: * * @param[in] rowCount The number of rows in the current instance * @param[in] columnCount The number of columns in the current instance - * @param[in] pArray[] A two-dimensional array @n The array must be at least row * column in length. + * @param[in] pArray[] The two-dimensional array @n + * The array must be at least row * column in length. */ IntMatrix(int rowCount, int columnCount, const int* pArray[]); @@ -99,7 +101,7 @@ public: * * @since 2.0 * - * @return @c true if all matrix members of the current instance are equal to the corresponding matrix members in the specified instance, @n + * @return @c true if all the matrix members of the current instance are equal to the corresponding matrix members in the specified instance, @n * else @c false * @param[in] rhs An instance of %IntMatrix */ @@ -110,7 +112,7 @@ public: * * @since 2.0 * - * @return @c true if all matrix members of the current instance are not equal to the corresponding matrix members in the specified instance, @n + * @return @c true if all the matrix members of the current instance are not equal to the corresponding matrix members in the specified instance, @n * else @c false * @param[in] rhs An instance of %IntMatrix */ @@ -121,11 +123,11 @@ public: * * @since 2.0 * - * @return The reference to this instance + * @return A reference to this instance * @param[in] rhs An instance of %IntMatrix - * @exception E_INVALID_ARG Either row or column count of the current instance is not same with that of the specified instance. - * @remarks If either row or column count of the current instance is not same with that of the specified instance, - * return the reference to this instance without assigning. + * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance. + * @remarks If either the row or the column count of the current instance is not same as that of the specified instance, + * this method returns the reference to this instance without assigning. */ IntMatrix& operator =(const IntMatrix& rhs); @@ -137,7 +139,9 @@ public: * @return @c true if the values of the current instance are equal to the value of the specified instance, @n * else @c false * @param[in] obj An instance of %IntMatrix - * @remarks This method overrides Tizen::Base::Object::Equals(). This method uses the values of the Matrix components to compare the two instances. + * @remarks + * - This method overrides Tizen::Base::Object::Equals(). + * - This method uses the values of the Matrix components to compare the two instances. */ virtual bool Equals(const Tizen::Base::Object& obj) const; @@ -147,8 +151,8 @@ public: * @since 2.0 * * @return The hash value of the current instance - * @remarks Two equal instances must return the same hash value. For better performance, - * the used hash function must generate a random distribution for all inputs. + * @remarks Two equal instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const; @@ -160,25 +164,25 @@ public: * @return An error code * @param[in] matrix An instance of %IntMatrix * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either row or column count of the current instance is not same with that of the specified instance. + * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance. */ result Add(const IntMatrix& matrix); /* - * Adds the value to each matrix members of current instance of %IntMatrix. + * Adds the value to each matrix member of the current instance of %IntMatrix. * * @since 2.0 * - * @param[in] value A @c int value to add + * @param[in] value The @c int value to add */ void AddToEachElement(int value); /* - * Gets the number of column in the current instance of %IntMatrix. + * Gets the number of columns in the current instance of %IntMatrix. * * @since 2.0 * - * @return The number of column in the current instance + * @return The number of columns in the current instance */ int GetColumnCount(void) const; @@ -187,9 +191,9 @@ public: * * @since 2.0 * - * @return A pointer to @c int array + * @return A pointer to the @c int array * @param[in] columnIndex The target column number in the current instance - * @exception E_INVALID_ARG The @c columnIndex is larger than the column count of the current instance. + * @exception E_INVALID_ARG The specified @c columnIndex is larger than the column count of the current instance. */ int* GetColumnN(int columnIndex) const; @@ -198,9 +202,9 @@ public: * * @since 2.0 * - * @return The determinant value of the current instance + * @return The determinant value of the current instance * @exception E_INVALID_OPERATION The current instance is not a square matrix. - * @remarks If the current instance is not a square matrix, return zero. + * @remarks If the current instance is not a square matrix, it returns zero. */ int GetDeterminant(void) const; @@ -209,10 +213,10 @@ public: * * @since 2.0 * - * @return The value at the specified row and column of the current instance - * @param[in] rowIndex The target row number in the current instance - * @param[in] columnIndex The target column number in the current instance - * @exception E_INVALID_ARG The @c columnIndex or @c rowIndex is larger than that of the current instance. + * @return The value at the specified row and column of the current instance + * @param[in] rowIndex The target row number in the current instance + * @param[in] columnIndex The target column number in the current instance + * @exception E_INVALID_ARG The specified @c columnIndex or the specified @c rowIndex is larger than that of the current instance. */ int GetElement(int rowIndex, int columnIndex) const; @@ -227,11 +231,11 @@ public: IntMatrix* GetInverseN(void) const; /* - * Gets the number of row in the current instance of %IntMatrix. + * Gets the number of rows in the current instance of %IntMatrix. * * @since 2.0 * - * @return The number of row in the current instance + * @return The number of rows in the current instance */ int GetRowCount(void) const; @@ -240,9 +244,9 @@ public: * * @since 2.0 * - * @return A pointer to @c int array + * @return A pointer to the @c int array * @param[in] rowIndex The target row number in the current instance - * @exception E_INVALID_ARG The @c rowIndex is larger than the row count of the current instance. + * @exception E_INVALID_ARG The specified @c rowIndex is larger than the row count of the current instance. */ int* GetRowN(int rowIndex) const; @@ -252,7 +256,7 @@ public: * @since 2.0 * * @return An error code - * @param[out] value A @c int value + * @param[out] value The @c int value * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The current instance is not a square matrix. */ @@ -263,7 +267,7 @@ public: * * @since 2.0 * - * @return A pointer to the instance of %IntMatrix containing the resulting value of the operation + * @return A pointer to the %IntMatrix instance that contains the resulting value of the operation * @exception E_INVALID_OPERATION The current instance is not a square matrix. */ IntMatrix* GetTransposeN(void) const; @@ -296,21 +300,21 @@ public: * @return An error code * @param[in] matrix An instance of %IntMatrix * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The column count of the current instance is not same with the row count of the specified instance. + * @exception E_INVALID_ARG The column count of the current instance is not same as the row count of the specified instance. */ result Multiply(const IntMatrix& matrix); /* - * Multiplies the value to each matrix members of current instance of %IntMatrix. + * Multiplies the value to each matrix member of the current instance of %IntMatrix. * * @since 2.0 * - * @param[in] value A @c int value to multiply + * @param[in] value The @c int value to multiply */ void Multiply(int value); /* - * Negates the matrix members of current instance of %IntMatrix. + * Negates the matrix members of the current instance of %IntMatrix. * * @since 2.0 */ @@ -356,9 +360,12 @@ public: * * @return An error code * @param[in] columnIndex The target column number in the current instance - * @param[in] pArray An array which includes the values @n The array must be at least row in length. + * @param[in] pArray The array which includes the values @n + * The array must be at least row in length. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The @c pArray is @c null, or the @c columnIndex is larger than the column count of the current instance. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c pArray is @c null. + * - The specified @c columnIndex is larger than the column count of the current instance. */ result SetColumn(int columnIndex, const int* pArray); @@ -369,9 +376,12 @@ public: * * @return An error code * @param[in] rowIndex The target row number in the current instance - * @param[in] pArray An array which includes the values @n The array must be at least column in length. + * @param[in] pArray The array which includes the values @n + * The array must be at least column in length. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The @c pArray is @c null, or the @c rowIndex is larger than the row count of the current instance. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c pArray is @c null. + * - The specified @c rowIndex is larger than the row count of the current instance. */ result SetRow(int rowIndex, const int* pArray); @@ -381,12 +391,14 @@ public: * @since 2.0 * * @return An error code - * @param[in] rowIndex The target row number in the current instance - * @param[in] columnIndex The target column number in the current instance - * @param[in] value A @c int value + * @param[in] rowIndex The target row number in the current instance + * @param[in] columnIndex The target column number in the current instance + * @param[in] value The @c int value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The pArray is @c null, or the @c rowIndex is larger than the row count of the current instance, - * or the @c columnIndex is larger than the column count of the current instance. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c pArray is @c null. + * - The specified @c rowIndex is larger than the row count of the current instance. + * - The specified @c columnIndex is larger than the column count of the current instance. */ result SetElement(int rowIndex, int columnIndex, int value); @@ -396,16 +408,17 @@ public: * @since 2.0 * * @return An error code - * @param[in] pArray A one-dimensional array @n The array must be at least row * column in length. - * @param[in] rowMajor Set to @c true to copy the array in row-major order, @n - * else @c false to copy in column-major order + * @param[in] pArray The one-dimensional array @n + * The array must be at least row * column in length. + * @param[in] rowMajor Set to @c true to copy the array in row-major order, @n + * else @c false to copy in column-major order * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The pArray is @c null. + * @exception E_INVALID_ARG The specified @c pArray is @c null. */ result SetValue(const int* pArray, bool rowMajor = true); /* - * Sets the matrix members of current instance of %IntMatrix to zero. + * Sets the matrix members of the current instance of %IntMatrix to zero. * * @since 2.0 */ @@ -417,18 +430,18 @@ public: * @since 2.0 * * @return An error code - * @param[in] matrix An instance of %IntMatrix + * @param[in] matrix An instance of %IntMatrix * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either row or column count of the current instance is not same with that of the specified instance. + * @exception E_INVALID_ARG Either the row or the column count of the current instance is not same as that of the specified instance. */ result Subtract(const IntMatrix& matrix); /* - * Subtracts the value from each matrix members of current instance of %IntMatrix. + * Subtracts the value from each matrix member of the current instance of %IntMatrix. * * @since 2.0 * - * @param[in] value A @c int value to subtract + * @param[in] value The @c int value to subtract */ void SubtractToEachElement(int value); diff --git a/inc/FBaseInteger.h b/inc/FBaseInteger.h index 85af846..464a140 100644 --- a/inc/FBaseInteger.h +++ b/inc/FBaseInteger.h @@ -18,9 +18,9 @@ * @file FBaseInteger.h * @brief This is the header file for the %Integer class. * - * @see Number() class() - * * This header file contains the declarations of the %Integer class. + * + * @see Tizen::Base::Number */ #ifndef _FBASE_INTEGER_H_ #define _FBASE_INTEGER_H_ @@ -82,7 +82,7 @@ public: * * @since 2.0 * - * @param[in] value An integer value + * @param[in] value The integer value */ Integer(int value = 0); @@ -91,7 +91,7 @@ public: * * @since 2.0 * - * @param[in] value An instance of %Integer + * @param[in] value An instance of %Integer to copy */ Integer(const Integer& value); @@ -107,7 +107,7 @@ public: * * @since 2.0 * - * @param[in] rhs An instance of %Integer + * @param[in] rhs An instance of %Integer to copy */ Integer& operator =(const Integer& rhs); @@ -116,11 +116,11 @@ public: * * @since 2.0 * - * @return A 32-bit @c signed integer value + * @return The 32-bit @c signed integer value * @code - * < 0 if the value of @c i1 is less than the value of @c i2 - * == 0 if the value of @c i1 is equal to the value of @c i2 - * > 0 if the value of @c i1 is greater than the value of @c i2 + * < 0 if the value of i1 is less than the value of i2 + * == 0 if the value of i1 is equal to the value of i2 + * > 0 if the value of i1 is greater than the value of i2 * @endcode * @param[in] i1 The first @c int value to compare * @param[in] i2 The second @c int value to compare @@ -128,18 +128,18 @@ public: static int Compare(int i1, int i2); /** - * Compares the value of the current instance with the value of the specified instance of the %Integer class. + * Compares the value of the current instance with the value of the specified instance of %Integer. * * @since 2.0 * - * @return A 32-bit @c signed integer value + * @return The 32-bit @c signed integer value * * @code * < 0 if the value of the current instance is less than the value of the specified instance * == 0 if the value of the current instance is equal to the value of the specified instance * > 0 if the value of the current instance is greater than the value of the specified instance * @endcode - * @param[in] value An instance of the %Integer class to compare + * @param[in] value An instance of %Integer to compare */ int CompareTo(const Integer& value) const; @@ -161,10 +161,10 @@ public: * @since 2.0 * * @return An error code - * @param[in] s A string representing the numeric value - * @param[out] ret The result of the operation - * @exception E_SUCCESS The method is successful. - * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed. + * @param[in] s The string that represents the numeric value + * @param[out] ret The result of the operation + * @exception E_SUCCESS The method is successful. + * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed. * @remarks This method accepts decimal, hexadecimal, and octal numbers given by the * following grammar: * @code @@ -185,140 +185,141 @@ public: * * @since 2.0 * - * @return An integer value indicating the hash value of the current instance of %Integer - * @remarks Two equal instances must return the same hash value. For better performance, - * the used hash function must generate a random distribution for all inputs. @n - * The default implementation of this method returns the value of the current instance. + * @return The integer value that indicates the hash value of the current instance of %Integer + * @remarks + * - Two equal instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. @n + * - The default implementation of this method returns the value of the current instance. */ virtual int GetHashCode(void) const; /** - * Gets the hash value of the specified @c int value. - * - * @since 2.0 - * - * @return An integer value indicating the hash value of the specified @c int value - * @param[in] val A @c int value to get the hash value - */ + * Gets the hash value of the specified @c int value. + * + * @since 2.0 + * + * @return The integer value that indicates the hash value of the specified @c int value + * @param[in] val The @c int value used to get the hash value + */ static int GetHashCode(int val); /** - * Parses the @c signed @c int equivalent of the specified string representing a numeric value. + * Parses the @c signed @c int equivalent of the specified string that represents a numeric value. * * @since 2.0 * * @return An error code - * @param[in] s A string representing a numeric value + * @param[in] s The string that represents the numeric value * @param[out] ret The result of the operation * @exception E_SUCCESS The method is successful. * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed. * @remarks - * - This method assumes that the string representing the numeric value uses a radix 10. - * - This method guarantees that the original value of out-parameter is not changed when the method returns error. + * - This method assumes that the string that represents the numeric value that uses the radix @c 10. + * - This method guarantees that the original value of the out-parameter is not changed when the method returns an error. */ static result Parse(const String& s, int& ret); /** - * Parses the @c signed @c int equivalent of the specified string representing a numeric value using the specified radix. + * Parses the @c signed @c int equivalent of the specified string that represents a numeric value using the specified radix. * * @since 2.0 * * @return An error code - * @param[in] s A string representing a numeric value - * @param[in] radix The radix of the string representing the numeric value @n + * @param[in] s The string that represents the numeric value + * @param[in] radix The radix of the string that represents the numeric value @n * It must either be 2, 8, 10, or 16. * @param[out] ret The result of the operation * @exception E_SUCCESS The method is successful. * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed. * @exception E_OUT_OF_RANGE The specified @c radix is invalid. - * @remarks This method guarantees that the original value of out-parameter is not changed when the method returns error. + * @remarks This method guarantees that the original value of the out-parameter is not changed when the method returns an error. */ static result Parse(const String& s, int radix, int& ret); /** - * Gets the @c signed @c char equivalent of the current instance of the %Integer class. + * Gets the @c signed @c char equivalent of the current instance of %Integer. * * @since 2.0 * - * @return A @c signed @c char equivalent of the current instance + * @return The @c signed @c char equivalent of the current instance */ virtual char ToChar(void) const; /** - * Gets the @c signed @c short equivalent of the current instance of the %Integer class. + * Gets the @c signed @c short equivalent of the current instance of %Integer. * * @since 2.0 * - * @return A @c signed @c short equivalent of the current instance + * @return The @c signed @c short equivalent of the current instance */ virtual short ToShort(void) const; /** - * Gets the @c signed @c int equivalent of the current instance of the %Integer class. + * Gets the @c signed @c int equivalent of the current instance of %Integer. * * @since 2.0 * - * @return A @c signed @c int equivalent of the current instance + * @return The @c signed @c int equivalent of the current instance */ virtual int ToInt(void) const; /** - * Gets the @c signed @c long equivalent of the current instance of the %Integer class. + * Gets the @c signed @c long equivalent of the current instance of %Integer. * * @since 2.0 * - * @return A @c signed @c long equivalent of the current instance + * @return The @c signed @c long equivalent of the current instance */ virtual long ToLong(void) const; /** - * Gets the @c signed @c long @c long equivalent of the current instance of the %Integer class. + * Gets the @c signed @c long @c long equivalent of the current instance of %Integer. * * @since 2.0 * - * @return A @c signed @c long @c long equivalent of the current instance + * @return The @c signed @c long @c long equivalent of the current instance */ virtual long long ToLongLong(void) const; /** - * Gets the @c signed @c float equivalent of the current instance of the %Integer class. + * Gets the @c signed @c float equivalent of the current instance of %Integer. * * @since 2.0 * - * @return A @c signed @c float equivalent of the current instance + * @return The @c signed @c float equivalent of the current instance */ virtual float ToFloat(void) const; /** - * Gets the @c signed @c double equivalent of the current instance of the %Integer class. + * Gets the @c signed @c double equivalent of the current instance of %Integer. * * @since 2.0 * - * @return A @c signed @c double equivalent of the current instance + * @return The @c signed @c double equivalent of the current instance */ virtual double ToDouble(void) const; /** - * Gets the string representing the value of the current instance of the %Integer class. + * Gets the string that represents the value of the current instance of %Integer. * * @since 2.0 * - * @return A string representing the value of the current instance + * @return The string that represents the value of the current instance */ virtual String ToString(void) const; /** - * Gets the string representing the specified @c signed @c int value. + * Gets the string that represents the specified @c signed @c int value. * * @since 2.0 * - * @return A string containing a Unicode representation of the specified @c signed @c int value - * @param[in] value A @c signed @c int value to convert + * @return The string that contains the Unicode representation of the specified @c signed @c int value + * @param[in] value The @c signed @c int value to convert */ static String ToString(int value); /** - * A constant holding the maximum value of type @c int. @n + * The constant holding the maximum value of type @c int. @n * A @c short integer can hold a value of upto 2^31-1. * * @since 2.0 @@ -326,7 +327,7 @@ public: static const int VALUE_MAX = (int) 0x7FFFFFFF; /** - * A constant holding the minimum value of type @c int. @n + * The constant holding the minimum value of type @c int. @n * A @c short integer can hold a value of upto -2^31. * * @since 2.0 @@ -334,7 +335,7 @@ public: static const int VALUE_MIN = (int) 0x80000000; /** - * An integer value of this instance. + * The integer value of this instance. * * @since 2.0 */ diff --git a/inc/FBaseIntegerComparer.h b/inc/FBaseIntegerComparer.h index 5a1c86b..4e34c8c 100644 --- a/inc/FBaseIntegerComparer.h +++ b/inc/FBaseIntegerComparer.h @@ -18,9 +18,10 @@ * @file FBaseIntegerComparer.h * @brief This is the header file for the %IntegerComparer class. * - * @see Integer and Tizen::Base::Collection::IComparer - * * This header file contains the declarations of the %IntegerComparer class. + * + * @see Tizen::Base::Integer + * @see Tizen::Base::Collection::IComparer */ #ifndef _FBASE_INTEGER_COMPARER_H_ #define _FBASE_INTEGER_COMPARER_H_ @@ -33,11 +34,11 @@ namespace Tizen { namespace Base { /** * @class IntegerComparer - * @brief This class checks for equivalence between 2 instances of the Integer type. + * @brief This class checks for equivalence between two instances of the %Integer type. * * @since 2.0 * - * The %IntegerComparer class checks for equivalence between 2 instances of the Integer type. + * The %IntegerComparer class checks for equivalence between two instances of the Integer type. * * For more information on the class features, see Collection Comparisons. * @@ -90,17 +91,17 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj1 The first instance of type %Integer - * @param[in] obj2 The second instance of type %Integer - * @param[out] cmp The result of comparison + * @param[in] obj1 The first instance of type Integer + * @param[in] obj2 The second instance of type Integer + * @param[out] cmp The result of the comparison * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified object instances are not of the expected type. * @remarks The value of @c cmp can be: * * @code - * < 0 if the value of @c obj1 is less than the value of @c obj2 - * == 0 if the value of @c obj1 is equal to the value of @c obj2 - * > 0 if the value of @c obj1 is greater than the value of @c obj2 + * < 0 if the value of obj1 is less than the value of obj2 + * == 0 if the value of obj1 is equal to the value of obj2 + * > 0 if the value of obj1 is greater than the value of obj2 * @endcode */ virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const; diff --git a/inc/FBaseLog.h b/inc/FBaseLog.h index b2e251b..fbbb6d9 100644 --- a/inc/FBaseLog.h +++ b/inc/FBaseLog.h @@ -34,7 +34,7 @@ extern "C" { /** * @defgroup GroupMacros Debugging Macros * - * This page describes Tizen debugging macros. + * This page describes the Tizen debugging macros. * * @since 2.0 */ @@ -88,7 +88,7 @@ extern "C" { * @{ */ /** - * This macro allows display of arbitrary messages for future examination. + * This macro allows the display of arbitrary messages for future examination. * * @since 2.0 * @@ -388,7 +388,7 @@ extern "C" { * @since 2.0 * * @param[in] condition The condition that is expected to be true - * @param[in] expr Expressions that are evaluated before going to CATCH label + * @param[in] expr Expressions that are evaluated before going to the CATCH label * @param[in] ... The message to display * * The following example demonstrates how to use the Try macro. @@ -432,7 +432,7 @@ extern "C" { * @since 2.0 * * @param[in] condition The condition that is expected to be true - * @param[in] expr Expressions that are evaluated before going to CATCH label + * @param[in] expr Expressions that are evaluated before going to the CATCH label * @param[in] r The last result to set * @param[in] ... The message to display * @hideinitializer @@ -448,13 +448,13 @@ extern "C" { /** * If the condition is @c false, it prints a message, sets the last result, evaluates a cleanup expression -* and goes to label. +* and goes to the catch label. * * @since 2.1 * * @param[in] condition The condition that is expected to be true -* @param[in] expr Expressions that are evaluated before going to catchLabel -* @param[in] catchLabel The label for goto operation +* @param[in] expr Expressions that are evaluated before going to the CATCH label +* @param[in] catchLabel The label for the goto operation * @param[in] r The last result to set * @param[in] ... The message to display * @hideinitializer @@ -469,7 +469,7 @@ extern "C" { else {;} /** - * If the condition is @c false, the message is printed and a value is returned. + * If the condition is @c false, a message is printed and a value is returned. * * @since 2.0 * @@ -486,14 +486,14 @@ extern "C" { else {;} /** - * If the condition is @c false, the message is printed, sets the last result and a value is returned. + * If the condition is @c false, a message is printed, the last result is set and a value is returned. * * @since 2.0 * * @param[in] condition The condition that is expected to be true * @param[in] returnValue The value to return when the condition is @c false - * @param[in] r The last result to set - * @param[in] ... The message to display + * @param[in] r The last result to set + * @param[in] ... The message to display * @hideinitializer */ #define TryReturnResult(condition, returnValue, r, ...) \ @@ -505,7 +505,7 @@ extern "C" { else {;} /** - * If the condition is @c false, the message is printed, sets the last result and no value is returned. + * If the condition is @c false, a message is printed, the last result is set and no value is returned. * * @since 2.0 * @@ -523,7 +523,7 @@ extern "C" { else {;} /** - * If the condition is @c false, the message is printed and no value is returned. + * If the condition is @c false, a message is printed and no value is returned. * * @since 2.0 * @@ -539,7 +539,7 @@ extern "C" { else {;} /** - * If the condition is @c false, the message is printed. + * If the condition is @c false, a message is printed. * * @since 2.0 * @@ -554,7 +554,7 @@ extern "C" { else {;} /** -* If the condition is @c false, the informative log message is printed and a value is returned. +* If the condition is @c false, an informative log message is printed and a value is returned. * * @since 2.1 * @@ -578,9 +578,9 @@ extern "C" { * * @since 2.0 * - * @param[in] tag Used to identify the source of a log message + * @param[in] tag Used to identify the source of the log message * @param[in] condition The condition that is expected to be true - * @param[in] expr Expressions that are evaluated before going to CATCH label + * @param[in] expr Expressions that are evaluated before going to the CATCH label * @param[in] ... The message to display * @hideinitializer */ @@ -598,9 +598,9 @@ extern "C" { * * @since 2.0 * - * @param[in] tag Used to identify the source of a log message + * @param[in] tag Used to identify the source of the log message * @param[in] condition The condition that is expected to be true - * @param[in] expr Expressions that are evaluated before going to CATCH label + * @param[in] expr Expressions that are evaluated before going to the CATCH label * @param[in] r The last result to set * @param[in] ... The message to display * @hideinitializer @@ -616,14 +616,14 @@ extern "C" { /** * If the condition is @c false, it prints a message with a tag, sets the last result, evaluates a cleanup expression -* and goes to label. +* and goes to the catch label. * * @since 2.1 * -* @param[in] tag Used to identify the source of a log message +* @param[in] tag Used to identify the source of the log message * @param[in] condition The condition that is expected to be true -* @param[in] expr Expressions that are evaluated before going to catchLabel -* @param[in] catchLabel The label for goto operation +* @param[in] expr Expressions that are evaluated before going to the CATCH label +* @param[in] catchLabel The label for the goto operation * @param[in] r The last result to set * @param[in] ... The message to display * @hideinitializer @@ -638,11 +638,11 @@ extern "C" { else {;} /** - * If the condition is @c false, the message is printed with a tag and a value is returned. + * If the condition is @c false, a message is printed with a tag and a value is returned. * * @since 2.0 * - * @param[in] tag Used to identify the source of a log message + * @param[in] tag Used to identify the source of the log message * @param[in] condition The condition that is expected to be true * @param[in] returnValue The value to return when the condition is @c false * @param[in] ... The message to display @@ -656,11 +656,11 @@ extern "C" { else {;} /** - * If the condition is @c false, the message is printed with a tag, sets the last result and a value is returned. + * If the condition is @c false, it prints a message with a tag, sets the last result and returns a value. * * @since 2.0 * - * @param[in] tag Used to identify the source of a log message + * @param[in] tag Used to identify the source of the log message * @param[in] condition The condition that is expected to be true * @param[in] returnValue The value to return when the condition is @c false * @param[in] r The last result to set @@ -676,11 +676,11 @@ extern "C" { else {;} /** - * If the condition is @c false, the message is printed with a tag, sets the last result and no value is returned. + * If the condition is @c false, it prints a message with a tag, sets the last result and does not return any value. * * @since 2.0 * - * @param[in] tag Used to identify the source of a log message + * @param[in] tag Used to identify the source of the log message * @param[in] condition The condition that is expected to be true * @param[in] r The last result to set * @param[in] ... The message to display @@ -695,11 +695,11 @@ extern "C" { else {;} /** - * If the condition is @c false, the message is printed with a tag and no value is returned. + * If the condition is @c false, a message is printed with a tag and no value is returned. * * @since 2.0 * - * @param[in] tag Used to identify the source of a log message + * @param[in] tag Used to identify the source of the log message * @param[in] condition The condition that is expected to be true * @param[in] ... The message to display * @hideinitializer @@ -712,11 +712,11 @@ extern "C" { else {;} /** - * If the condition is @c false, the message is printed with a tag. + * If the condition is @c false, a message is printed with a tag. * * @since 2.0 * - * @param[in] tag Used to identify the source of a log message + * @param[in] tag Used to identify the source of the log message * @param[in] condition The condition that is expected to be true * @param[in] ... The message to display * @hideinitializer @@ -728,11 +728,11 @@ extern "C" { else {;} /** -* If the condition is @c false, the informative log message is printed with a tag and a value is returned. +* If the condition is @c false, an informative log message is printed with a tag and a value is returned. * * @since 2.1 * -* @param[in] tag Used to identify the source of a log message +* @param[in] tag Used to identify the source of the log message * @param[in] condition The condition that is expected to be true * @param[in] returnValue The value to return when the condition is @c false * @param[in] ... The message to display @@ -767,9 +767,9 @@ extern "C" { #else /** - * This macro is to protect informative log messages which needs to keep security. - * It allows display of informative log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, it will be removed in the compile time. + * This macro is used to protect informative log messages which need security. + * It allows the display of informative log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, it is removed in the compile time. * * @since 2.1 * @@ -791,9 +791,9 @@ extern "C" { #define AppSecureLog(...) /** - * This macro is to protect debug log messages which needs to keep security. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, it will be removed in the compile time. + * This macro is used to protect debug log messages which need security. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, it is removed in the compile time. * * @since 2.1 * @@ -822,9 +822,9 @@ extern "C" { #define AppSecureLogDebug(...) /** - * This macro is to protect exception log messages which needs to keep security. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, it will be removed in the compile time. + * This macro is used to protect exception log messages which need security. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, it is removed in the compile time. * * @since 2.1 * @@ -853,9 +853,9 @@ extern "C" { #define AppSecureLogException(...) /** - * This macro is to protect informative log messages which needs to keep security, with a tag. - * It allows display of informative log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, it will be removed in the compile time. + * This macro is used to protect informative log messages which need security, with a tag. + * It allows the display of informative log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, it is removed in the compile time. * * @since 2.1 * @@ -878,9 +878,9 @@ extern "C" { #define AppSecureLogTag(tag, ...) /** - * This macro is to protect debug log messages which needs to keep security, with a tag. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, it will be removed in the compile time. + * This macro is used to protect debug log messages which need security, with a tag. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, it is removed in the compile time. * * @since 2.1 * @@ -903,9 +903,9 @@ extern "C" { #define AppSecureLogDebugTag(tag, ...) /** - * This macro is to protect exception log messages which needs to keep security, with a tag. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, it will be removed in the compile time. + * This macro is used to protect exception log messages which need security, with a tag. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, it is removed in the compile time. * * @since 2.1 * @@ -932,13 +932,13 @@ extern "C" { /** * If the condition is @c false, it prints a message, evaluates a cleanup expression, * and goes to CATCH. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * * @since 2.1 * * @param[in] condition The condition that is expected to be true - * @param[in] expr Expressions that are evaluated before going to CATCH label + * @param[in] expr Expressions that are evaluated before going to the CATCH label * @param[in] ... The message to display * * The following example demonstrates how to use the SecureTry macro. @@ -979,13 +979,13 @@ extern "C" { /** * If the condition is @c false, it prints a message, sets the last result, evaluates a cleanup expression * and goes to CATCH. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * It allows the display of exception log messages if compiled with "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * * @since 2.1 * * @param[in] condition The condition that is expected to be true - * @param[in] expr Expressions that are evaluated before going to CATCH label + * @param[in] expr Expressions that are evaluated before going to the CATCH label * @param[in] r The last result to set * @param[in] ... The message to display * @hideinitializer @@ -1001,15 +1001,15 @@ extern "C" { /** * If the condition is @c false, it prints a message, sets the last result, evaluates a cleanup expression - * and goes to label. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * and goes to the catch label. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * * @since 2.1 * * @param[in] condition The condition that is expected to be true - * @param[in] expr Expressions that are evaluated before going to catchLabel - * @param[in] catchLabel The label for goto operation + * @param[in] expr Expressions that are evaluated before going to the CATCH label + * @param[in] catchLabel The label for the goto operation * @param[in] r The last result to set * @param[in] ... The message to display * @hideinitializer @@ -1024,9 +1024,9 @@ extern "C" { else {;} /** - * If the condition is @c false, the message is printed and a value is returned. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * If the condition is @c false, a message is printed and a value is returned. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * * @since 2.1 * @@ -1043,9 +1043,9 @@ extern "C" { else {;} /** - * If the condition is @c false, the message is printed, sets the last result and a value is returned. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * If the condition is @c false, it prints a message, sets the last result and returns a value. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * * @since 2.1 * @@ -1064,9 +1064,9 @@ extern "C" { else {;} /** - * If the condition is @c false, the message is printed, sets the last result and no value is returned. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * If the condition is @c false, a message is printed, the last result is set and no value is returned. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * * @since 2.1 * @@ -1084,9 +1084,9 @@ extern "C" { else {;} /** - * If the condition is @c false, the message is printed and no value is returned. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * If the condition is @c false, a message is printed and no value is returned. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * * @since 2.1 * @@ -1102,9 +1102,9 @@ extern "C" { else {;} /** - * If the condition is @c false, the message is printed. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * If the condition is @c false, a message is printed. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * * @since 2.1 * @@ -1119,9 +1119,9 @@ extern "C" { else {;} /** - * If the condition is @c false, the informative log message is printed and a value is returned. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * If the condition is @c false, an informative log message is printed and a value is returned. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * * @since 2.1 * @@ -1142,14 +1142,14 @@ extern "C" { /** * If the condition is @c false, it prints a message with a tag, evaluates a cleanup expression * and goes to CATCH. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * * @since 2.1 * - * @param[in] tag Used to identify the source of a log message + * @param[in] tag Used to identify the source of the log message * @param[in] condition The condition that is expected to be true - * @param[in] expr Expressions that are evaluated before going to CATCH label + * @param[in] expr Expressions that are evaluated before going to the CATCH label * @param[in] ... The message to display * @hideinitializer */ @@ -1164,14 +1164,14 @@ extern "C" { /** * If the condition is @c false, it prints a message with a tag, sets the last result, evaluates a cleanup expression, * and goes to CATCH. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * * @since 2.1 * - * @param[in] tag Used to identify the source of a log message + * @param[in] tag Used to identify the source of the log message * @param[in] condition The condition that is expected to be true - * @param[in] expr Expressions that are evaluated before going to CATCH label + * @param[in] expr Expressions that are evaluated before going to the CATCH label * @param[in] r The last result to set * @param[in] ... The message to display * @hideinitializer @@ -1187,16 +1187,16 @@ extern "C" { /** * If the condition is @c false, it prints a message with a tag, sets the last result, evaluates a cleanup expression - * and goes to label. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * and goes to the catch label. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * * @since 2.1 * - * @param[in] tag Used to identify the source of a log message + * @param[in] tag Used to identify the source of the log message * @param[in] condition The condition that is expected to be true - * @param[in] expr Expressions that are evaluated before going to catchLabel - * @param[in] catchLabel The label for goto operation + * @param[in] expr Expressions that are evaluated before going to the CATCH label + * @param[in] catchLabel The label for the goto operation * @param[in] r The last result to set * @param[in] ... The message to display * @hideinitializer @@ -1211,13 +1211,13 @@ extern "C" { else {;} /** - * If the condition is @c false, the message is printed with a tag and a value is returned. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * If the condition is @c false, a message is printed with a tag and a value is returned. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * * @since 2.1 * - * @param[in] tag Used to identify the source of a log message + * @param[in] tag Used to identify the source of the log message * @param[in] condition The condition that is expected to be true * @param[in] returnValue The value to return when the condition is @c false * @param[in] ... The message to display @@ -1231,13 +1231,13 @@ extern "C" { else {;} /** - * If the condition is @c false, the message is printed with a tag, sets the last result and a value is returned. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * If the condition is @c false, a message is printed with a tag, the last result is set and a value is returned. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * * @since 2.1 * - * @param[in] tag Used to identify the source of a log message + * @param[in] tag Used to identify the source of the log message * @param[in] condition The condition that is expected to be true * @param[in] returnValue The value to return when the condition is @c false * @param[in] r The last result to set @@ -1253,13 +1253,13 @@ extern "C" { else {;} /** - * If the condition is @c false, the message is printed with a tag, sets the last result and no value is returned. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * If the condition is @c false, a message is printed with a tag, the last result is set and no value is returned. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * * @since 2.1 * - * @param[in] tag Used to identify the source of a log message + * @param[in] tag Used to identify the source of the log message * @param[in] condition The condition that is expected to be true * @param[in] r The last result to set * @param[in] ... The message to display @@ -1274,13 +1274,13 @@ extern "C" { else {;} /** - * If the condition is @c false, the message is printed with a tag and no value is returned. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * If the condition is @c false, a message is printed with a tag and no value is returned. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * * @since 2.1 * - * @param[in] tag Used to identify the source of a log message + * @param[in] tag Used to identify the source of the log message * @param[in] condition The condition that is expected to be true * @param[in] ... The message to display * @hideinitializer @@ -1293,13 +1293,13 @@ extern "C" { else {;} /** - * If the condition is @c false, the message is printed with a tag. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * If the condition is @c false, a message is printed with a tag. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * * @since 2.1 * - * @param[in] tag Used to identify the source of a log message + * @param[in] tag Used to identify the source of the log message * @param[in] condition The condition that is expected to be true * @param[in] ... The message to display * @hideinitializer @@ -1311,13 +1311,13 @@ extern "C" { else {;} /** - * If the condition is @c false, the informative log message is printed with a tag and a value is returned. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * If the condition is @c false, an informative log message is printed with a tag and a value is returned. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * * @since 2.1 * - * @param[in] tag Used to identify the source of a log message + * @param[in] tag Used to identify the source of the log message * @param[in] condition The condition that is expected to be true * @param[in] returnValue The value to return when the condition is @c false * @param[in] ... The message to display diff --git a/inc/FBaseLong.h b/inc/FBaseLong.h index 08cb852..af05dee 100644 --- a/inc/FBaseLong.h +++ b/inc/FBaseLong.h @@ -18,9 +18,9 @@ * @file FBaseLong.h * @brief This is the header file for the %Long class. * - * @see Number() - * * This header file contains the declarations of the %Long class. + * + * @see Tizen::Base::Number */ #ifndef _FBASE_LONG_H_ #define _FBASE_LONG_H_ @@ -35,8 +35,8 @@ namespace Tizen { namespace Base * * @since 2.0 * - * The %Long class represents an integer value ranging from -2147483648 to 2147483647 - * , that is, -(2^31) to +((2^31)-1). The class is useful when passing a 32-bit @c signed + * The %Long class represents an integer value ranging from @c -2147483648 to @c 2147483647, + * that is, -(2^31) to +((2^31)-1). The class is useful when passing a 32-bit @c signed * integral value to a method that accepts only an instance of Object. Furthermore, * this class provides methods for converting %Long (and @c long) to String, and %String * to %Long (and @c long). @@ -81,7 +81,7 @@ public: * * @since 2.0 * - * @param[in] value A @c long value + * @param[in] value The @c long value */ Long(long value = 0); @@ -90,7 +90,7 @@ public: * * @since 2.0 * - * @param[in] value An instance of %Long + * @param[in] value An instance of %Long to copy */ Long(const Long& value); @@ -106,7 +106,7 @@ public: * * @since 2.0 * - * @param[in] rhs An instance of %Long + * @param[in] rhs An instance of %Long to copy */ Long& operator =(const Long& rhs); @@ -115,7 +115,7 @@ public: * * @since 2.0 * - * @return A 32-bit @c signed integer value + * @return The 32-bit @c signed integer value * @code * < 0 if the value of @c l1 is less than the value of @c l2 * == 0 if the value of @c l1 is equal to the value of @c l2 @@ -131,25 +131,25 @@ public: * * @since 2.0 * - * @return A 32-bit @c signed integer value + * @return The 32-bit @c signed integer value * * @code * < 0 if the value of the current instance is less than the value of the specified instance * == 0 if the value of the current instance is equal to the value of the specified instance * > 0 if the value of the current instance is greater than the value of the specified instance * @endcode - * @param[in] value An instance of the %Long class to compare + * @param[in] value An instance of %Long to compare */ int CompareTo(const Long& value) const; /** - * Checks whether the value of the specified instance of %Object is equal to the value of the current instance of %Long. + * Checks whether the value of the specified instance of Object is equal to the value of the current instance of %Long. * * @since 2.0 * - * @return @c true if the value of the specified instance of %Object is equal to the value of the current instance of %Long, @n + * @return @c true if the value of the specified instance of Object is equal to the value of the current instance of %Long, @n * else @c false - * @param[in] obj An instance of %Object to compare + * @param[in] obj An instance of Object to compare * @see Object::Equals() */ virtual bool Equals(const Object& obj) const; @@ -159,30 +159,31 @@ public: * * @since 2.0 * - * @return An integer value indicating the hash value of the current instance of %Long - * @remarks Two equal instances must return the same hash value. For better performance, - * the used hash function must generate a random distribution for all inputs. @n - * The default implementation of this method returns the value of the current instance. + * @return The integer value that indicates the hash value of the current instance of %Long + * @remarks + * - Two equal instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. @n + * - The default implementation of this method returns the value of the current instance. */ virtual int GetHashCode(void) const; /** - * Gets the hash value of the specified @c long value. - * - * @since 2.0 - * - * @return An integer value indicating the hash value of the specified @c long value - * @param[in] val A @c long value to get the hash value - */ + * Gets the hash value of the specified @c long value. + * + * @since 2.0 + * + * @return The integer value that indicates the hash value of the specified @c long value + * @param[in] val The @c long value used to get the hash value + */ static int GetHashCode(long val); /** - * Decodes a string into a @c signed @c long. + * Decodes a string into a @c signed @c long value. * * @since 2.0 * * @return An error code - * @param[in] s A string representing a numeric value + * @param[in] s The string that represents the numeric value * @param[out] ret The result of the operation * @exception E_SUCCESS The method is successful. * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed. @@ -202,40 +203,40 @@ public: static result Decode(const String& s, long& ret); /** - * Parses the @c signed @c long equivalent of the specified string representing a numeric value. + * Parses the @c signed @c long equivalent of the specified string that represents a numeric value. * * @since 2.0 * * @return An error code - * @param[in] s A string representing a numeric value + * @param[in] s The string that represents the numeric value * @param[out] ret The result of the operation * @exception E_SUCCESS The method is successful. * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed. * @remarks - * - This method assumes that the string representing the numeric value uses a radix 10. - * - This method guarantees that the original value of out-parameter is not changed when the method returns error. + * - This method assumes that the string that represents the numeric value uses a radix @c 10. + * - This method guarantees that the original value of the out-parameter is not changed when the method returns an error. */ static result Parse(const String& s, long& ret); /** - * Parses the @c signed @c long equivalent of the specified string representing a numeric value using the specified radix. + * Parses the @c signed @c long equivalent of the specified string that represents a numeric value using the specified radix. * * @since 2.0 * * @return An error code - * @param[in] s A string representing a numeric value - * @param[in] radix The radix of the string representing a numeric value @n - * It must be either 2, 8, 10, or 16. + * @param[in] s The string that represents the numeric value + * @param[in] radix The radix of the string that represents the numeric value @n + * It must be either 2, 8, 10, or 16. * @param[out] ret The result of the operation * @exception E_SUCCESS The method is successful. * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed. * @exception E_OUT_OF_RANGE The specified @c radix is invalid. - * @remarks This method guarantees that the original value of out-parameter is not changed when the method returns error. + * @remarks This method guarantees that the original value of the out-parameter is not changed when the method returns an error. */ static result Parse(const String& s, int radix, long& ret); /** - * Gets the @c signed @c char equivalent of the current instance of the %Long class. + * Gets the @c signed @c char equivalent of the current instance of %Long. * * @since 2.0 * @@ -244,7 +245,7 @@ public: virtual char ToChar(void) const; /** - * Gets the @c signed @c short equivalent of the current instance of the %Long class. + * Gets the @c signed @c short equivalent of the current instance of %Long. * * @since 2.0 * @@ -253,7 +254,7 @@ public: virtual short ToShort(void) const; /** - * Gets the @c signed @c int equivalent of the current instance of the %Long class. + * Gets the @c signed @c int equivalent of the current instance of %Long. * * @since 2.0 * @@ -262,7 +263,7 @@ public: virtual int ToInt(void) const; /** - * Gets the @c signed @c long equivalent of the current instance of the %Long class. + * Gets the @c signed @c long equivalent of the current instance of %Long. * * @since 2.0 * @@ -271,7 +272,7 @@ public: virtual long ToLong(void) const; /** - * Gets the @c signed @c long @c long equivalent of the current instance of the %Long class. + * Gets the @c signed @c long @c long equivalent of the current instance of %Long. * * @since 2.0 * @@ -280,7 +281,7 @@ public: virtual long long ToLongLong(void) const; /** - * Gets the @c signed @c float equivalent of the current instance of the %Long class. + * Gets the @c signed @c float equivalent of the current instance of %Long. * * @since 2.0 * @@ -289,7 +290,7 @@ public: virtual float ToFloat(void) const; /** - * Gets the @c signed @c double equivalent of the current instance of the %Long class. + * Gets the @c signed @c double equivalent of the current instance of %Long. * * @since 2.0 * @@ -298,40 +299,40 @@ public: virtual double ToDouble(void) const; /** - * Gets the string representing the value of the current instance of the %Long class. + * Gets the string that represents the value of the current instance of %Long. * * @since 2.0 * - * @return The string representing the value of the current instance + * @return The string that represents the value of the current instance */ virtual String ToString(void) const; /** - * Gets the string representing the specified @c signed @c long value. + * Gets the string that represents the specified @c signed @c long value. * * @since 2.0 * - * @return The string containing a Unicode representation of the specified @c signed @c long value - * @param[in] value A @c signed @c long value to convert + * @return The string that contains the Unicode representation of the specified @c signed @c long value + * @param[in] value The @c signed @c long value to convert */ static String ToString(long value); /** - * A constant holding the maximum value a @c short can have; 2^31-1. + * The constant holding the maximum value a @c short value can have; 2^31-1. * * @since 2.0 */ static const long VALUE_MAX = (long) 0x7FFFFFFF; /** - * A constant holding the minimum value a @c short can have; -2^31. + * The constant holding the minimum value a @c short value can have; -2^31. * * @since 2.0 */ static const long VALUE_MIN = (long) 0x80000000; /** - * A @c long value of this instance. + * The @c long value of this instance. * * @since 2.0 */ diff --git a/inc/FBaseLongComparer.h b/inc/FBaseLongComparer.h index 687ae3e..91d3bfe 100644 --- a/inc/FBaseLongComparer.h +++ b/inc/FBaseLongComparer.h @@ -18,9 +18,11 @@ * @file FBaseLongComparer.h * @brief This is the header file for the %LongComparer class. * - * @see Long and Tizen::Base::Collection::IComparer * * This header file contains the declarations of the %LongComparer class. + * + * @see Tizen::Base::Long + * @see Tizen::Base::Collection::IComparer */ #ifndef _FBASE_LONG_COMPARER_H_ #define _FBASE_LONG_COMPARER_H_ @@ -33,11 +35,11 @@ namespace Tizen { namespace Base { /** * @class LongComparer - * @brief This class checks for equivalence between 2 instances of the %Long type. + * @brief This class checks for equivalence between two instances of the %Long type. * * @since 2.0 * - * The %LongComparer class checks for equivalence between 2 instances of the Long type. + * The %LongComparer class checks for equivalence between two instances of the Long type. * * For more information on the class features, see Collection Comparisons. * @@ -90,17 +92,17 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj1 The first instance of type %Long - * @param[in] obj2 The second instance of type %Long - * @param[out] cmp The result of comparison + * @param[in] obj1 The first instance of type Long + * @param[in] obj2 The second instance of type Long + * @param[out] cmp The result of the comparison * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified object instances are not of the expected type. * @remarks The value of @c cmp can be: * * @code - * < 0 if the value of @c obj1 is less than the value of @c obj2 - * == 0 if the value of @c obj1 is equal to the value of @c obj2 - * > 0 if the value of @c obj1 is greater than the value of @c obj2 + * < 0 if the value of obj1 is less than the value of obj2 + * == 0 if the value of obj1 is equal to the value of obj2 + * > 0 if the value of obj1 is greater than the value of obj2 * @endcode */ virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const; diff --git a/inc/FBaseLongLong.h b/inc/FBaseLongLong.h index 27c73a8..4ec1223 100644 --- a/inc/FBaseLongLong.h +++ b/inc/FBaseLongLong.h @@ -18,9 +18,9 @@ * @file FBaseLongLong.h * @brief This is the header file for the %LongLong class. * - * @see Tizen::Base::Number - * * This header file contains the declarations of the %LongLong class. + * + * @see Tizen::Base::Number */ #ifndef _FBASE_LONG_LONG_H_ #define _FBASE_LONG_LONG_H_ @@ -35,8 +35,8 @@ namespace Tizen { namespace Base * * @since 2.0 * - * The %LongLong class represents an integer value ranging from -9223372036854775808 to 9223372036854775807 - * , that is, -(2^63) to +((2^63)-1). The class is useful when passing a 64-bit @c signed + * The %LongLong class represents an integer value ranging from @c -9223372036854775808 to @c 9223372036854775807, + * that is, @c -(2^63) to @c +((2^63)-1). The class is useful when passing a 64-bit @c signed * integral value to a method that accepts only an instance of Object. Furthermore, * this class provides methods for converting %LongLong (and @c long @c long) to String, and %String * to %LongLong (and @c long @c long). @@ -81,7 +81,7 @@ public: * * @since 2.0 * - * @param[in] value A @c long @c long value + * @param[in] value The @c long @c long value */ LongLong(long long value = 0); @@ -90,7 +90,7 @@ public: * * @since 2.0 * - * @param[in] value An instance of %LongLong + * @param[in] value An instance of %LongLong to copy */ LongLong(const LongLong& value); @@ -106,7 +106,7 @@ public: * * @since 2.0 * - * @param[in] rhs An instance of %LongLong + * @param[in] rhs An instance of %LongLong to copy */ LongLong& operator =(const LongLong& rhs); @@ -115,11 +115,11 @@ public: * * @since 2.0 * - * @return A 32-bit @c signed integer value + * @return The 32-bit @c signed integer value * @code - * < 0 if the value of @c l1 is less than the value of @c l2 - * == 0 if the value of @c l1 is equal to the value of @c l2 - * > 0 if the value of @c l1 is greater than the value of @c l2 + * < 0 if the value of l1 is less than the value of l2 + * == 0 if the value of l1 is equal to the value of l2 + * > 0 if the value of l1 is greater than the value of l2 * @endcode * @param[in] l1 The first @c long @c long value to compare * @param[in] l2 The second @c long @c long value to compare @@ -127,17 +127,17 @@ public: static int Compare(long long l1, long long l2); /** - * Compares the value of the current instance with the value of the specified instance of the %LongLong class. + * Compares the value of the current instance with the value of the specified instance of %LongLong. * * @since 2.0 * - * @return A 32-bit @c signed integer value + * @return The 32-bit @c signed integer value * @code * < 0 if the value of the current instance is less than the value of the specified instance * == 0 if the value of the current instance is equal to the value of the specified instance * > 0 if the value of the current instance is greater than the value of the specified instance * @endcode - * @param[in] value An instance of the %LongLong class to compare + * @param[in] value An instance of %LongLong to compare */ int CompareTo(const LongLong& value) const; @@ -158,25 +158,26 @@ public: * * @since 2.0 * - * @return An integer value indicating the hash value of the current instance of %LongLong - * @remarks Two equal instances must return the same hash value. For better performance, - * the used hash function must generate a random distribution for all inputs. @n - * The default implementation of this method returns the value of the current instance. + * @return The integer value that indicates the hash value of the current instance of %LongLong + * @remarks + * - Two equal instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. @n + * - The default implementation of this method returns the value of the current instance. */ virtual int GetHashCode(void) const; /** - * Gets the hash value of the specified @c long @c long value. - * - * @since 2.0 - * - * @return An integer value indicating the hash value of the specified @c long @c long value - * @param[in] val A @c long @c long value to get the hash value + * Gets the hash value of the specified @c long @c long value. + * + * @since 2.0 + * + * @return The integer value that indicates the hash value of the specified @c long @c long value + * @param[in] val The @c long @c long value used to get the hash value */ static int GetHashCode(long long val); /** - * Gets the @c signed @c char equivalent of the current instance of the %LongLong class. + * Gets the @c signed @c char equivalent of the current instance of %LongLong. * * @since 2.0 * @@ -185,7 +186,7 @@ public: virtual char ToChar(void) const; /** - * Gets the @c signed @c short equivalent of the current instance of the %LongLong class. + * Gets the @c signed @c short equivalent of the current instance of %LongLong. * * @since 2.0 * @@ -194,7 +195,7 @@ public: virtual short ToShort(void) const; /** - * Gets the @c signed @c int equivalent of the current instance of the %LongLong class. + * Gets the @c signed @c int equivalent of the current instance of %LongLong. * * @since 2.0 * @@ -203,7 +204,7 @@ public: virtual int ToInt(void) const; /** - * Gets the @c signed @c long equivalent of the current instance of the %LongLong class. + * Gets the @c signed @c long equivalent of the current instance of %LongLong. * * @since 2.0 * @@ -212,7 +213,7 @@ public: virtual long ToLong(void) const; /** - * Gets the @c signed @c float equivalent of the current instance of the %LongLong class. + * Gets the @c signed @c float equivalent of the current instance of %LongLong. * * @since 2.0 * @@ -221,7 +222,7 @@ public: virtual float ToFloat(void) const; /** - * Gets the @c signed @c double equivalent of the current instance of the %LongLong class. + * Gets the @c signed @c double equivalent of the current instance of %LongLong. * * @since 2.0 * @@ -230,7 +231,7 @@ public: virtual double ToDouble(void) const; /** - * Gets the @c signed @c long @c long equivalent of the current instance of the %LongLong class. + * Gets the @c signed @c long @c long equivalent of the current instance of %LongLong. * * @since 2.0 * @@ -239,75 +240,75 @@ public: virtual long long ToLongLong(void) const; /** - * Gets the string representing the value of the current instance of the %LongLong class. + * Gets the string that represents the value of the current instance of %LongLong. * * @since 2.0 * - * @return The string representing the value of the current instance + * @return The string that represents the value of the current instance */ virtual String ToString(void) const; /** - * Gets the string representing the specified @c signed @c long @c long value. + * Gets the string that represents the specified @c signed @c long @c long value. * * @since 2.0 * - * @return The string containing a Unicode representation of the specified @c signed @c long @c long value - * @param[in] value A @c signed @c long @c long value to convert + * @return The string that contains the Unicode representation of the specified @c signed @c long @c long value + * @param[in] value The @c signed @c long @c long value to convert */ static String ToString(long long value); /** - * Parses the specified string representing a numeric value and + * Parses the specified string that represents a numeric value and * returns the value as a @c signed @c long @c long (as out parameter). * * @since 2.0 * * @return An error code - * @param[in] s A string representing a numeric value + * @param[in] s The string that represents the numeric value * @param[out] ret The result of the operation * @exception E_SUCCESS The method is successful. * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed. * @remarks - * - This method assumes that the string representing the numeric value uses a radix 10. - * - This method guarantees that the original value of out-parameter is not changed when the method returns error. + * - This method assumes that the string that represents the numeric value uses a radix @c 10. + * - This method guarantees that the original value of the out-parameter is not changed when the method returns an error. */ static result Parse(const String& s, long long& ret); /** - * Parses the specified string representing a numeric value using the specified radix and + * Parses the specified string that represents a numeric value using the specified radix and * returns the value as a @c signed @c long @c long (as out parameter). * * @since 2.1 * * @return An error code - * @param[in] s A string representing a numeric value - * @param[in] radix The radix of the string representing a numeric value @n + * @param[in] s The string that represents the numeric value + * @param[in] radix The radix of the string that represents a numeric value @n * It must be either 2, 8, 10 or 16. * @param[out] ret The result of the operation * @exception E_SUCCESS The method is successful. * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed. * @exception E_OUT_OF_RANGE The specified @c radix is invalid. - * @remarks This method guarantees that the original value of out-parameter is not changed when the method returns error. + * @remarks This method guarantees that the original value of the out-parameter is not changed when the method returns an error. */ static result Parse(const String& s, int radix, long long& ret); /** - * A constant holding the maximum value a @c long @c long can have; 2^63-1. + * The constant holding the maximum value a @c long @c long can have; @c 2^63-1. * * @since 2.0 */ static const long long VALUE_MAX = (long long) 0x7FFFFFFFFFFFFFFFLL; /** - * A constant holding the minimum value a @c long @c long can have; -2^63. + * The constant holding the minimum value a @c long @c long can have; @c -2^63. * * @since 2.0 */ static const long long VALUE_MIN = (long long) 0x8000000000000000LL; /** - * A @c long @c long value of this instance. + * The @c long @c long value of this instance. * * @since 2.0 */ diff --git a/inc/FBaseLongLongComparer.h b/inc/FBaseLongLongComparer.h index 722464e..bf42322 100644 --- a/inc/FBaseLongLongComparer.h +++ b/inc/FBaseLongLongComparer.h @@ -18,9 +18,11 @@ * @file FBaseLongLongComparer.h * @brief This is the header file for the %LongLongComparer class. * - * @see Long and Tizen::Base::Collection::IComparer * * This header file contains the declarations of the %LongLongComparer class. + * + * @see Tizen::Base::Long + * @see Tizen::Base::Collection::IComparer */ #ifndef _FBASE_LONG_LONG_COMPARER_H_ #define _FBASE_LONG_LONG_COMPARER_H_ @@ -33,11 +35,11 @@ namespace Tizen { namespace Base { /** * @class LongLongComparer - * @brief This class checks for equivalence between 2 instances of the %LongLong type. + * @brief This class checks for equivalence between two instances of the %LongLong type. * * @since 2.0 * - * The %LongLongComparer class checks for equivalence between 2 instances of the %LongLong type. + * The %LongLongComparer class checks for equivalence between two instances of the LongLong type. * * For more information on the class features, see Collection Comparisons. * @@ -91,15 +93,15 @@ public: * @return An error code * @param[in] obj1 The first instance of type LongLong * @param[in] obj2 The second instance of type LongLong - * @param[out] cmp The result of comparison + * @param[out] cmp The result of the comparison * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified object instances are not of the expected type. * @remarks The value of @c cmp can be: * * @code - * < 0 if the value of @c obj1 is less than the value of @c obj2 - * == 0 if the value of @c obj1 is equal to the value of @c obj2 - * > 0 if the value of @c obj1 is greater than the value of @c obj2 + * < 0 if the value of obj1 is less than the value of obj2 + * == 0 if the value of obj1 is equal to the value of obj2 + * > 0 if the value of obj1 is greater than the value of obj2 * @endcode */ virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const; diff --git a/inc/FBaseNumber.h b/inc/FBaseNumber.h index df41931..61489b1 100644 --- a/inc/FBaseNumber.h +++ b/inc/FBaseNumber.h @@ -18,8 +18,8 @@ * @file FBaseNumber.h * @brief This is the header file for the %Number class. * - * This header file contains the declarations and definitions of the %Number class. @n - * This class is the abstract base class of all wrapped numeric types. + * This header file contains the declarations and definitions of the %Number class. + * */ #ifndef _FBASE_NUMBER_H_ #define _FBASE_NUMBER_H_ @@ -75,7 +75,7 @@ public: virtual ~Number(void) { }; /** - * Gets the @c signed @c char equivalent of the current instance of the %Number class. + * Gets the @c signed @c char equivalent of the current instance of %Number. * * @since 2.0 * @@ -84,7 +84,7 @@ public: virtual char ToChar(void) const = 0; /** - * Gets the @c signed @c short equivalent of the current instance of the %Number class. + * Gets the @c signed @c short equivalent of the current instance of %Number. * * @since 2.0 * @@ -93,7 +93,7 @@ public: virtual short ToShort(void) const = 0; /** - * Gets the @c signed @c int equivalent of the current instance of the %Number class. + * Gets the @c signed @c int equivalent of the current instance of %Number. * * @since 2.0 * @@ -102,7 +102,7 @@ public: virtual int ToInt(void) const = 0; /** - * Gets the @c signed @c long equivalent of the current instance of the %Number class. + * Gets the @c signed @c long equivalent of the current instance of %Number. * * @since 2.0 * @@ -111,7 +111,7 @@ public: virtual long ToLong(void) const = 0; /** - * Gets the @c signed @c long @c long equivalent of the current instance of the %Number class. + * Gets the @c signed @c long @c long equivalent of the current instance of %Number. * * @since 2.0 * @@ -120,7 +120,7 @@ public: virtual long long ToLongLong(void) const = 0; /** - * Gets the @c signed @c float equivalent of the current instance of the %Number class. + * Gets the @c signed @c float equivalent of the current instance of %Number. * * @since 2.0 * @@ -129,7 +129,7 @@ public: virtual float ToFloat(void) const = 0; /** - * Gets the @c signed @c double equivalent of the current instance of the %Number class. + * Gets the @c signed @c double equivalent of the current instance of %Number. * * @since 2.0 * @@ -138,11 +138,11 @@ public: virtual double ToDouble(void) const = 0; /** - * Gets the string representing the value of the current instance of the %Number class. + * Gets the string that represents the value of the current instance of %Number. * * @since 2.0 * - * @return The string representing the value of the current instance + * @return The string that represents the value of the current instance */ virtual String ToString(void) const = 0; diff --git a/inc/FBaseObject.h b/inc/FBaseObject.h index eb21496..61d97a2 100644 --- a/inc/FBaseObject.h +++ b/inc/FBaseObject.h @@ -65,9 +65,11 @@ public: * @return @c true if the value of the specified instance of %Object is equal to the value of the current instance of %Object, @n * else @c false * @param[in] obj An instance of %Object to compare - * @remarks The default implementation of this method returns @c true - * if the two instances have the same address. @n - * The method can be overridden to support value equality. Furthermore, this method must return the same result as the equality operator. + * @remarks + * - The default implementation of this method returns @c true, + * if the two instances have the same address. + * - The method can be overridden to support value equality. + * Furthermore, this method must return the same result as the equality operator. */ virtual bool Equals(const Object& obj) const; @@ -76,10 +78,11 @@ public: * * @since 2.0 * - * @return An integer value indicating the hash value of the current instance of %Object - * @remarks Two equal instances must return the same hash value. For better performance, - * the used hash function must generate a random distribution for all inputs. @n - * The default implementation of this method returns the address of the current instance. + * @return The integer value that indicates the hash value of the current instance of %Object + * @remarks + * - Two equal instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. + * - The default implementation of this method returns the address of the current instance. */ virtual int GetHashCode(void) const; diff --git a/inc/FBaseResult.h b/inc/FBaseResult.h index 4a5e490..ddbb41d 100644 --- a/inc/FBaseResult.h +++ b/inc/FBaseResult.h @@ -18,7 +18,7 @@ * @file FBaseResult.h * @brief This is the header file for the %Result class. * - * This header file contains the declaration of the %Result class. + * This header file contains the declarations of the %Result class. */ #ifndef _FBASE_RESULT_H_ #define _FBASE_RESULT_H_ @@ -61,16 +61,16 @@ _OSP_EXPORT_ result TransExceptionsInclusiveInternal(result r, result e, int num #define NUMARGS(...) (sizeof((result[]){0, ##__VA_ARGS__}) / sizeof(result) - 1) /** -* This macro returns translated exception when the checked exception doesn't correspond with the conditional exceptions. -* In contrast, this macro returns the checked exception if it corresponds with the conditional exceptions. +* This macro returns a translated exception when the checked exception does not correspond to the conditional exceptions. +* In contrast, this macro returns a checked exception if it corresponds to the conditional exceptions. * * @since 2.0 * * @return The translated exception -* @param[in] r The result that will be checked +* @param[in] r The result that is checked * @param[in] e The translated exception -* @param[in] ... The list of exceptions that will be excluded in translation process @n -* All other exceptions than this list will be translated into @c e. +* @param[in] ... The list of exceptions that are excluded from the translation process @n +* All the exceptions other than this list are translated into @c e. * * */ @@ -79,16 +79,16 @@ _OSP_EXPORT_ result TransExceptionsInclusiveInternal(result r, result e, int num /** -* This macro returns translated exception when the checked exception corresponds with the conditional exceptions. -* In contrast, this macro returns the checked exception if it doesn't correspond with the conditional exceptions. +* This macro returns a translated exception when the checked exception corresponds to the conditional exceptions. +* In contrast, this macro returns a checked exception if it does not correspond to the conditional exceptions. * * @since 2.0 * * @return The translated exception -* @param[in] r The result that will be checked +* @param[in] r The result that is checked * @param[in] e The translated exception -* @param[in] ... The list of exceptions that will be included in translation process @n -* All exceptions in this list will be translated into @c e. +* @param[in] ... The list of exceptions that are included in the translation process @n +* All the exceptions in this list are translated into @c e. * */ diff --git a/inc/FBaseRt.h b/inc/FBaseRt.h index e700caa..bec9a9f 100644 --- a/inc/FBaseRt.h +++ b/inc/FBaseRt.h @@ -48,14 +48,14 @@ * @since 2.0 * * @remarks @b Header @b %file: @b \#include @b @n - * @b Library : @b osp-appfw + * @b Library: @b osp-appfw * * * The %Runtime namespace contains classes for running applications. * The runtime environment includes threading, synchronization objects, * and timer. * - * For more information on the %Base::Runtime namespace features, see Runtime. + * For more information on the %Runtime namespace features, see Runtime. * * The following diagram illustrates the relationships between the classes belonging to the %Runtime namespace. * @image html base_runtime_namespace_classdiagram.png diff --git a/inc/FBaseRtEvent.h b/inc/FBaseRtEvent.h index 2f4501b..34155b7 100644 --- a/inc/FBaseRtEvent.h +++ b/inc/FBaseRtEvent.h @@ -18,7 +18,7 @@ * @file FBaseRtEvent.h * @brief This is the header file for the %Event class. * - * This file contains the declarations of the %Event class. + * This header file contains the declarations of the %Event class. */ #ifndef _FBASE_RT_EVENT_H_ @@ -33,12 +33,12 @@ class IEventArg; class IEventListener; /** * @class Event -* @brief This class provides methods for notifying events with argument to its listeners. +* @brief This class provides methods for notifying events with arguments to its listeners. * @since 2.0 * -* The %Event class provides methods for notifying events with argument to its listeners. -* Because bounded to either default thread or event-driven thread, it cannot be created on worker thread. -* It supports two types of listeners; one is called on the thread where the event is fired, and another is called on the thread where the listener was registered. +* The %Event class provides methods for notifying events with arguments to its listeners. +* Because it is bounded to either a default thread or an event-driven thread, it cannot be created on a worker thread. +* It supports two types of listeners; one is called on the thread where the event is fired, and another is called on the thread where the listener is registered. * * @code * @@ -120,12 +120,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] listener Listener to add - * @param[in] calledByCallerThread true, to call the listener on the caller thread of this method - * false, to call the listener on the thread in which the event is fired. - * @exception E_SUCCESS This method is successful. + * @param[in] listener The listener to add + * @param[in] calledByCallerThread Set to @c true, to call the listener on the caller thread of this method, @n + * else @c false, to call the listener on the thread in which the event is fired. + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_ALREADY_EXIST The listener already exists. - * @exception E_INVALID_OPERATION calledByCallerThread is set to true but the caller thread is a worker thread. + * @exception E_INVALID_OPERATION The specified @c calledByCallerThread is @c true but the caller thread is a worker thread. */ result AddListener(IEventListener& listener, bool calledByCallerThread = true); @@ -136,9 +136,9 @@ public: * @since 2.0 * * @return An error code - * @param[in] listener Listener to remove - * @exception E_SUCCESS This method is successful. - * @exception E_OBJ_NOT_FOUND The listener is not found. + * @param[in] listener The listener to remove + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The listener has not been found. */ result RemoveListener(IEventListener& listener); @@ -148,11 +148,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] arg The event argument. - * @exception E_SUCCESS This method is successful. - * @exception E_INVALID_STATE This event has not been initialized. + * @param[in] arg The event argument + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_STATE This event has not been initialized. * - * @remarks This takes the ownership of @c arg. So arg should be created on a heap and should not be deleted by caller. + * @remarks This takes the ownership of @c arg. @n + * So @c arg should be created on a heap and should not be deleted by caller. */ result Fire(IEventArg& arg); diff --git a/inc/FBaseRtEventDrivenThread.h b/inc/FBaseRtEventDrivenThread.h index 0f04666..a26f9e5 100644 --- a/inc/FBaseRtEventDrivenThread.h +++ b/inc/FBaseRtEventDrivenThread.h @@ -35,7 +35,7 @@ namespace Tizen { namespace Base { namespace Runtime /** * @class EventDrivenThread - * @brief This class is the fundamental class for the asynchronous execution of a thread. + * @brief This class is the fundamental class for the asynchronous execution of a thread. * * @since 2.0 * @@ -151,7 +151,7 @@ public: * @param[in] stackSize The thread stack size * @param[in] priority The thread priority * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG An invalid argument is passed. + * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. */ result Construct(long stackSize = DEFAULT_STACK_SIZE, ThreadPriority priority = THREAD_PRIORITY_MID); @@ -162,11 +162,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] name The name of the thread + * @param[in] name The name of the thread * @param[in] stackSize The thread stack size * @param[in] priority The thread priority * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG An invalid argument is passed. + * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. */ result Construct(const Tizen::Base::String& name, long stackSize = DEFAULT_STACK_SIZE, ThreadPriority priority = THREAD_PRIORITY_MID); @@ -206,13 +206,13 @@ public: /** * Called before the message loop is started. @n - * If this method returns @c false, the thread is terminated immediately. + * If the %OnStart() method returns @c false, the thread is terminated immediately. * * @since 2.0 * - * @return @c true if this thread can be run, @n - * else @c false - * @remarks You can initialize the event or event listener in this method for running this thread. + * @return @c true if this thread runs, @n + * else @c false + * @remarks The event or event listener in this method can be initialized for running this thread. * */ virtual bool OnStart(void); @@ -222,7 +222,7 @@ public: * * @since 2.0 * - * @remarks You can finalize the event or event listener in this method for running this thread. + * @remarks The event or event listener in this method can be finalized for running this thread. * */ virtual void OnStop(void); @@ -236,12 +236,12 @@ public: * If overridden, it may not work as expected. * * @return An error code - * @param[in] requestId The user-defined event ID - * @param[in] pArgs A pointer to a list of arguments - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE The thread is in an invalid state. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. + * @param[in] requestId The user-defined event ID + * @param[in] pArgs A pointer to the list of arguments + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_STATE The thread is in an invalid state. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_SYSTEM A system error has occurred. * * @see OnUserEventReceivedN() */ @@ -253,7 +253,7 @@ public: * @since 2.0 * * @param[in] requestId The user-defined event ID - * @param[in] pArgs A pointer to a list of arguments + * @param[in] pArgs A pointer to the list of arguments * * @see SendUserEvent() */ diff --git a/inc/FBaseRtIEventArg.h b/inc/FBaseRtIEventArg.h index 3137e42..342b56c 100644 --- a/inc/FBaseRtIEventArg.h +++ b/inc/FBaseRtIEventArg.h @@ -28,11 +28,11 @@ namespace Tizen { namespace Base { namespace Runtime { /** * @interface IEventArg -* @brief This interface is a tagging interface that all event argument must implement. +* @brief This interface is a tagging interface that all event arguments must implement. * -* @since 2.0 +* @since 2.0 * -* The %IEventArg interface is a tagging interface that all event argument must implement. +* The %IEventArg interface is a tagging interface that all event arguments must implement. */ class IEventArg { diff --git a/inc/FBaseRtIEventListener.h b/inc/FBaseRtIEventListener.h index b0e248b..f734d26 100644 --- a/inc/FBaseRtIEventListener.h +++ b/inc/FBaseRtIEventListener.h @@ -15,8 +15,8 @@ // /** - * @file FBaseRtIEventListener.h - * @brief This is the header file for the %IEventListener interface. + * @file FBaseRtIEventListener.h + * @brief This is the header file for the %IEventListener interface. * * This header contains the declarations of the %IEventListener interface. */ @@ -37,7 +37,7 @@ namespace Tizen { namespace Base { namespace Runtime * @since 2.0 * * The %IEventListener interface is a tagging interface that all event listeners must implement. - * The event listener can listen when the specific event occurs. The event listener + * The event listener can listen when a specific event occurs. The event listener * has several methods, and each method is called when a specific event occurs. * */ diff --git a/inc/FBaseRtIRunnable.h b/inc/FBaseRtIRunnable.h index ee587e9..fdc964e 100644 --- a/inc/FBaseRtIRunnable.h +++ b/inc/FBaseRtIRunnable.h @@ -31,16 +31,16 @@ namespace Tizen { namespace Base { namespace Runtime { /** * @interface IRunnable - * @brief This interface is the basic unit of the task. Also, it is the execution unit of - * the thread. This interface must be inherited by the class whose instances will + * @brief This interface is the basic unit of a task. Also, it is the execution unit of + * the thread. This interface must be inherited by the class whose instances are * run on the thread. * * @since 2.0 * * @remarks Classes which inherit the %IRunnable interface must implement the Run() method. * - * The %IRunnable interface is the basic unit of the task. Also, it is the execution unit of - * the thread. This interface must be inherited by the class whose instances will + * The %IRunnable interface is the basic unit of a task. Also, it is the execution unit of + * the thread. This interface must be inherited by the class whose instances are * run on the thread. * @n * For more information on the class features, see Thread Programming. @@ -89,14 +89,14 @@ public: /** * Runs the task. @n - * This method is an executable body of the task. In many cases, this method is called by the thread. + * The %Run() method is an executable body of the task. In many cases, this method is called by the thread. * Although this method can return the result of the execution, the returned value might be discarded * by the executor of this task. * * @since 2.0 * * @return A pointer to the result of the task, @n - * else @c null + * else @c null if it fails */ virtual Tizen::Base::Object* Run(void) = 0; }; // IRunnable diff --git a/inc/FBaseRtITimerEventListener.h b/inc/FBaseRtITimerEventListener.h index f5e9e26..ba026e9 100644 --- a/inc/FBaseRtITimerEventListener.h +++ b/inc/FBaseRtITimerEventListener.h @@ -42,7 +42,7 @@ class Timer; * * For more information on the class features, see Timer. * - * @see Timer() + * @see Timer */ class _OSP_EXPORT_ ITimerEventListener : virtual public IEventListener @@ -60,7 +60,7 @@ public: * * @since 2.0 * - * @param[in] timer The timer that has expired + * @param[in] timer The expired timer */ virtual void OnTimerExpired(Timer& timer) = 0; diff --git a/inc/FBaseRtIWaitingLoopCondition.h b/inc/FBaseRtIWaitingLoopCondition.h index 8e166ff..ba97476 100755 --- a/inc/FBaseRtIWaitingLoopCondition.h +++ b/inc/FBaseRtIWaitingLoopCondition.h @@ -18,6 +18,7 @@ * @file FBaseRtIWaitingLoopCondition.h * @brief This is the header file for the %IWaitingLoopCondition interface. * + * This header file contains the declarations of the %IWaitingLoopCondition interface. */ #ifndef _FBASE_RT_WAITING_LOOP_CONDITION_H_ #define _FBASE_RT_WAITING_LOOP_CONDITION_H_ @@ -27,7 +28,7 @@ namespace Tizen { namespace Base { namespace Runtime { /* * @interface IWaitingLoopCondition - * @brief This interface provides the method to check whether the WaitingLoopCondition is met. + * @brief This interface provides a method to check whether the WaitingLoopCondition is met. * * @since 2.0 */ @@ -35,14 +36,15 @@ class _OSP_EXPORT_ IWaitingLoopCondition { public: /* - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ virtual ~IWaitingLoopCondition(void) {} /* - * Check whether the waiting loop condition is met + * Checks whether the waiting loop condition is met. * * @since 2.0 * diff --git a/inc/FBaseRtLibrary.h b/inc/FBaseRtLibrary.h index c1f1edc..77265bf 100644 --- a/inc/FBaseRtLibrary.h +++ b/inc/FBaseRtLibrary.h @@ -31,14 +31,14 @@ namespace Tizen { namespace Base { namespace Runtime { /** * @class Library - * @brief This is the class for shared library. + * @brief This is the class for the shared library. * * @since 2.0 * * @final This class is not intended for extension. * * The %Library class loads the shared library with the given file path. - * It loads the library in current process' memory space, and application can use this library explicitly. + * It loads the library in current process' memory space, and the application can use this library explicitly. */ class _OSP_EXPORT_ Library : public Tizen::Base::Object @@ -64,8 +64,8 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] libraryPath The path of the library file + * @return An error code + * @param[in] libraryPath The path of the library file * @exception E_SUCCESS The method is successful. * @exception E_LIBRARY_NOT_FOUND The library cannot be found. * @exception E_INVALID_ARG The specified @c libraryPath is an empty string. @@ -80,8 +80,8 @@ public: * * @since 2.0 * - * @return The address of the specified symbol - * @param[in] symbol The symbol name + * @return The address of the specified symbol + * @param[in] symbol The symbol name * @exception E_SUCCESS The method is successful. * @exception E_SYMBOL_NOT_FOUND The symbol cannot be found. * @exception E_INVALID_ARG The specified @c symbol is an empty string. diff --git a/inc/FBaseRtMemoryManager.h b/inc/FBaseRtMemoryManager.h index 82e0da5..4a93d05 100644 --- a/inc/FBaseRtMemoryManager.h +++ b/inc/FBaseRtMemoryManager.h @@ -39,13 +39,13 @@ namespace Tizen { namespace Base { namespace Runtime { enum MemoryProtectionMode { MEMORY_PROTECTION_MODE_NONE = 0x0, /**< The memory cannot be accessed */ - MEMORY_PROTECTION_MODE_READ = 0x1, /**< The memory can be read */ - MEMORY_PROTECTION_MODE_WRITE = 0x2, /**< The memory can be modified */ - MEMORY_PROTECTION_MODE_EXEC = 0x4, /**< The memory can be executed */ + MEMORY_PROTECTION_MODE_READ = 0x1, /**< The memory can be read */ + MEMORY_PROTECTION_MODE_WRITE = 0x2, /**< The memory can be modified */ + MEMORY_PROTECTION_MODE_EXEC = 0x4, /**< The memory can be executed */ }; /** - * @class MemoryManager + * @class MemoryManager * @brief This class represents a memory manager for runtime. * * @since 2.0 @@ -86,19 +86,21 @@ class _OSP_EXPORT_ MemoryManager { public: /** - * Changes protection on a memory region. + * Changes the protection on a memory region. * * @since 2.0 * * @return An error code - * @param[in] pAddress The start address of the memory region aligned on a page boundary. + * @param[in] pAddress The start address of the memory region aligned on a page boundary * @param[in] length The length of the memory region in bytes * @param[in] protection The memory protection @n * It is either Tizen::Base::Runtime::MEMORY_PROTECTION_MODE_NONE or a bitwise OR of the * other values in Tizen::Base::Runtime::MemoryProtectionMode. * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred due to an invalid address. - * @exception E_INVALID_ARG The memory address is not valid, or the length is not a multiple of system page size. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The memory address is invalid. + * - The specified @c length is not a multiple of the system page size. */ static result ProtectMemory(const void* pAddress, long long length, unsigned long protection); diff --git a/inc/FBaseRtMonitor.h b/inc/FBaseRtMonitor.h index b9696ac..1fc48fd 100755 --- a/inc/FBaseRtMonitor.h +++ b/inc/FBaseRtMonitor.h @@ -41,11 +41,11 @@ class _MonitorImpl; * * @final This class is not intended for extension. * - * The %Monitor class represents a monitor. %Monitor is a synchronization mechanism that provides acquire/release semantics by Enter() / Exit() as well as wait/notify semantics by Wait() / Notify() / NotifyAll(). + * The %Monitor class represents a monitor. A %Monitor is a synchronization mechanism that provides acquire and release semantics by Enter() and Exit() as well as wait and notify semantics by Wait(), Notify(), and NotifyAll(). * * For more information on the class features, see Monitor. * - * The following examples demonstrates how to use the %Monitor class. In the examples, 2 classes, Consumer and Producer, share a space. + * The following examples demonstrates how to use the %Monitor class. In the examples, two classes, Consumer and Producer, share a space. * Producer writes some data to this space, and Consumer reads it. Consumer and Producer run simultaneously. * Consumer must not miss the data which Producer writes. In this case, Consumer and Producer share the monitor. * Producer notifies Consumer that its writing action is done. Consumer waits for this notification, and reads the data after receiving it. @@ -287,39 +287,39 @@ public: * @since 2.0 * * @return An error code - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. + * @exception E_SYSTEM A system error has occurred. */ result Construct(void); /** - * Acquires a lock for a monitor. @n - * Semantically, this method declares the beginning of the critical region for the monitor. This region + * Acquires a lock for the monitor. @n + * Semantically, the %Enter() method declares the beginning of the critical region for the monitor. This region * ends with the Exit() method. * * @since 2.0 * * @return An error code - * @exception E_SUCCESS The method is successful in acquiring the lock. + * @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 monitor becomes available. + * @remarks This method blocks if called on an already locked monitor object until the monitor becomes available. * @see Exit() */ result Enter(void); /** - * Releases a lock for a monitor. @n + * Releases the lock for the monitor. @n * Semantically, it declares the ending of the critical region for the monitor that begins with * the Enter() method. * * @since 2.0 * * @return An error code - * @exception E_SUCCESS The method is successful in releasing the lock. + * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. - * @remarks This method should be called only after acquiring lock by Enter() call + * @remarks This method should be called only after acquiring the lock by the Enter() call. * @see Enter() */ result Exit(void); @@ -334,7 +334,7 @@ public: * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. - * @remarks This method should be called only after acquiring lock by Enter() call + * @remarks This method should be called only after acquiring the lock by the Enter() call. * @see Notify() * @see NotifyAll() */ @@ -356,7 +356,7 @@ public: /** - * Notifies all waiting threads. + * Notifies all the waiting threads. * * @since 2.0 * diff --git a/inc/FBaseRtMonitorGuard.h b/inc/FBaseRtMonitorGuard.h index 76acb3f..fe2d86d 100644 --- a/inc/FBaseRtMonitorGuard.h +++ b/inc/FBaseRtMonitorGuard.h @@ -31,7 +31,7 @@ namespace Tizen { namespace Base { namespace Runtime /** * @class MonitorGuard -* @brief This class is the RAII style class for %Monitor class. +* @brief This class is the RAII style class for the Monitor class. * * @since 2.0 */ @@ -43,7 +43,7 @@ public: * * @since 2.0 * - * @param[in] m The %Monitor instance to be manipulated + * @param[in] m A Monitor instance to manipulate * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Monitor::Enter() for detailed exceptions */ @@ -74,12 +74,12 @@ public: } /** - * Returns whether this instance owns the lock on the given monitor at constructor. + * Checks whether this instance owns the lock on the given monitor at constructor. * * @since 2.0 * * @return true if the lock is owned, @n - * false otherwise. + * else @c false */ bool IsEntered(void) const { @@ -87,8 +87,8 @@ public: } /** - * Returns whether this instance owns the lock on the given monitor at constructor. @n - * Have same effects to calling IsEntered(). + * Checks whether this instance owns the lock on the given monitor at constructor. @n + * This method has the same effects when calling IsEntered(). * * @since 2.0 */ diff --git a/inc/FBaseRtMutex.h b/inc/FBaseRtMutex.h index 49cca8a..c9bb61b 100755 --- a/inc/FBaseRtMutex.h +++ b/inc/FBaseRtMutex.h @@ -34,8 +34,8 @@ namespace Tizen { namespace Base { namespace Runtime /** * @struct NonRecursiveMutexTag * - * This struct is used only for providing the non-recursive type of mutex. - * A non-recursive mutex is a mutex that can not be acquired multiple times by the locking thread. It returns an exception if the locking thread tries to lock the same mutex. + * This struct is used only for providing the non-recursive type of the mutex. + * A non-recursive mutex is a mutex that cannot be acquired multiple times by the locking thread. It returns an exception if the locking thread tries to lock the same mutex. * * @since 2.1 * @@ -135,14 +135,14 @@ public: /** * Creates an unnamed mutex which is a recursive mutex that can be acquired multiple times by the locking thread. - * It keeps the number of getting locked and you must unlock it the same number of times. + * It keeps the number of locks and you must unlock it the same number of times. * * @since 2.0 * - * @return An error code - * @exception E_SUCCESS The method is successful. + * @return An error code + * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. + * @exception E_SYSTEM A system error has occurred. */ result Create(void); @@ -151,7 +151,7 @@ public: * * @since 2.1 * - * @return An error code + * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. */ @@ -159,15 +159,15 @@ public: /** * Creates a named mutex which is a recursive mutex that can be acquired multiple times by the locking thread. - * It keeps the number of getting locked and you must unlock it the same number of times. @n + * It keeps the number of locks and you must unlock it the same number of times. @n * If a mutex with the specified name already exists, this creates a mutex which references that particular mutex. * * @since 2.0 * - * @return An error code + * @return An error code * @param[in] name The name of the mutex * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. */ result Create(const Tizen::Base::String& name); @@ -177,10 +177,10 @@ public: * * @since 2.0 * - * @return An error code + * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. - * @remarks This method should be called only after acquiring lock by Acquire()/ TryToAcquire() call + * @exception E_SYSTEM A system error has occurred. + * @remarks This method should be called only after acquiring a lock by calling Acquire() or TryToAcquire(). */ result Release(void); @@ -191,24 +191,24 @@ public: * * @since 2.0 * - * @return An error code + * @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 available. + * @remarks This method blocks if called on an already locked monitor object until the mutex becomes available. */ result Acquire(void); /** * Tries to acquire the mutex if it is not acquired. @n - * If the mutex is already acquired by another thread, E_OBJECT_LOCKED is returned. + * If the mutex is already acquired by another thread, @c E_OBJECT_LOCKED is returned. * * @since 2.0 * - * @return An error code - * @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 available. + * @return An error code + * @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 blocks if called on an already locked monitor object until the mutex becomes available. */ result TryToAcquire(void); diff --git a/inc/FBaseRtMutexGuard.h b/inc/FBaseRtMutexGuard.h index 23d7d9f..f0a428a 100644 --- a/inc/FBaseRtMutexGuard.h +++ b/inc/FBaseRtMutexGuard.h @@ -32,11 +32,11 @@ namespace Tizen { namespace Base { namespace Runtime /** * @class MutexGuard -* @brief This class is the RAII style class for %Mutex class. +* @brief This class is the RAII style class for the %Mutex class. * * @since 2.0 * -* The following example demonstrates how to use this %MutexGuard class +* The following example demonstrates how to use the %MutexGuard class * * @code * @@ -179,7 +179,7 @@ public: * * @since 2.0 * - * @param[in] m The %Mutex instance to be manipulated + * @param[in] m A %Mutex instance to manipulate * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Mutex::Acquire() for detailed exceptions */ @@ -195,7 +195,7 @@ public: * * @since 2.0 * - * @param[in] m The %Mutex instance to be manipulated + * @param[in] m A %Mutex instance to be manipulated * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Mutex::TryToAcquire() for detailed exceptions */ @@ -207,7 +207,7 @@ public: } /** - * This destructor releases the lock if acquired when going out of a scope + * This destructor releases the lock if acquired when going out of the scope * * @since 2.0 * @@ -220,12 +220,12 @@ public: } /** - * Returns whether this instance owns the lock on the given mutex at constructor. + * Checks whether this instance owns the lock on the given mutex at constructor. * * @since 2.0 * - * @return true if the lock is owned, @n - * false otherwise. + * @return @c true if the lock is owned, @n + * else @c false */ bool IsLocked(void) const { @@ -233,8 +233,8 @@ public: } /** - * Returns whether this instance owns the lock on the given mutex at constructor. @n - * Have same effects to calling IsLocked(). + * Checks whether this instance owns the lock on the given mutex at constructor. @n + * Has the same effects as calling IsLocked(). * * @since 2.0 */ @@ -244,11 +244,11 @@ public: } /** - * Acquires the lock manually on the given mutex at constructor in a blocking way + * Acquires the lock manually on the given mutex at constructor in a blocking way. * * @since 2.0 * - * @return An error code. + * @return An error code * @see Mutex::Acquire() for detailed exceptions */ result Lock(void) @@ -261,7 +261,7 @@ public: * * @since 2.0 * - * @return An error code. + * @return An error code * @see Mutex::TryToAcquire() for detailed exceptions */ result TryToLock(void) @@ -274,7 +274,7 @@ public: * * @since 2.0 * - * @return An error code. + * @return An error code * @see Mutex::Release() for detailed exceptions */ result Unlock(void) diff --git a/inc/FBaseRtSemaphore.h b/inc/FBaseRtSemaphore.h index ff71c2c..0bd67b4 100644 --- a/inc/FBaseRtSemaphore.h +++ b/inc/FBaseRtSemaphore.h @@ -31,14 +31,14 @@ namespace Tizen { namespace Base { namespace Runtime { /** * @class Semaphore - * @brief This class represents semaphore, a type of synchronization mechanisms. It can provide the acquiring semantics. @n + * @brief This class represents a semaphore, that is, a type of synchronization mechanism. It can provide the acquiring semantics. @n * * @since 2.0 * * @final This class is not intended for extension. * * The %Semaphore class represents a semaphore; a type of synchronization mechanism. - * It can provide the acquiring semantics. The semaphore allows the N threads to acquire the semaphore simultaneously. + * It can provide the acquiring semantics. The semaphore allows N threads to acquire the semaphore simultaneously. * * For more information on the class features, see Mutex and Semaphore. * @@ -111,12 +111,12 @@ public: * * @since 2.0 * - * @return An error code + * @return An error code * @param[in] count The number of threads that can acquire the semaphore simultaneously @n * If the count is @c 1, then it is the same as a mutex. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c count is less than @c 0. - * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. */ result Create(int count = 1); @@ -128,12 +128,12 @@ public: * * @since 2.0 * - * @return An error code + * @return An error code * @param[in] name The name of the semaphore * @param[in] count The number of threads that can acquire the semaphore simultaneously * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c count is less than @c 0. - * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. */ result Create(const Tizen::Base::String& name, int count = 1); @@ -144,24 +144,25 @@ public: * * @since 2.0 * - * @return An error code + * @return An error code * @param[in] timeout The period during which the thread tries to acquire the semaphore * @exception E_SUCCESS The method is successful. - * @exception E_TIMEOUT The operation cannot be completed within the specified time period. @n - * The method has failed to acquire the semaphore because the given time has elapsed. + * @exception E_TIMEOUT Either of the following conditions has occurred: + * - The operation cannot be completed within the specified time period. + * - The method has failed to acquire the semaphore because the given time has elapsed. * @exception E_SYSTEM A system error has occurred. */ result Acquire(long timeout = INFINITE); /** * Tries to acquire the semaphore. @n - * If the semaphore is already acquired by another thread, E_OBJECT_LOCKED is returned. + * If the semaphore is already acquired by another thread, @c E_OBJECT_LOCKED is returned. * * @since 2.0 * - * @return An error code + * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_OBJECT_LOCKED The semaphore is already locked. + * @exception E_OBJECT_LOCKED The semaphore is already locked. * @exception E_SYSTEM A system error has occurred. */ result TryToAcquire(void); @@ -171,7 +172,7 @@ public: * * @since 2.0 * - * @return An error code + * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. */ diff --git a/inc/FBaseRtSemaphoreGuard.h b/inc/FBaseRtSemaphoreGuard.h index 074da8b..9ff5625 100644 --- a/inc/FBaseRtSemaphoreGuard.h +++ b/inc/FBaseRtSemaphoreGuard.h @@ -32,7 +32,7 @@ namespace Tizen { namespace Base { namespace Runtime /** * @class SemaphoreGuard -* @brief This class is the RAII style class for %Semaphore class. +* @brief This class is the RAII style class for the %Semaphore class. * * @since 2.0 */ @@ -40,14 +40,14 @@ class SemaphoreGuard { public: /** - * This constructor acquires a semaphore count in a blocking way. - * - * @since 2.0 - * - * @param[in] s The %Semaphore instance to be manipulated - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see Semaphore::Acquire() for detailed exceptions - */ + * This constructor acquires a semaphore count in a blocking way. + * + * @since 2.0 + * + * @param[in] s A Semaphore instance to manipulate + * @remarks The specific error code can be accessed using the GetLastResult() method. + * @see Semaphore::Acquire() for detailed exceptions + */ SemaphoreGuard(Semaphore& s) : __s(s) , __acquired(false) @@ -56,14 +56,14 @@ public: } /** - * This constructor acquires a semaphore count in a non-blocking way. - * - * @since 2.0 - * - * @param[in] s The %Semaphore instance to be manipulated - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see Semaphore::TryToAcquire() for detailed exceptions - */ + * This constructor acquires a semaphore count in a non-blocking way. + * + * @since 2.0 + * + * @param[in] s A Semaphore instance to manipulate + * @remarks The specific error code can be accessed using the GetLastResult() method. + * @see Semaphore::TryToAcquire() for detailed exceptions + */ SemaphoreGuard(Semaphore& s, TryTag) : __s(s) , __acquired(false) @@ -72,76 +72,76 @@ public: } /** - * This destructor releases the acquired semaphore count when going out of a scope - * - * @since 2.0 - * - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see Semaphore::Release() for detailed exceptions - */ + * This destructor releases the acquired semaphore count when going out of the scope + * + * @since 2.0 + * + * @remarks The specific error code can be accessed using the GetLastResult() method. + * @see Semaphore::Release() for detailed exceptions + */ ~SemaphoreGuard(void) { SetLastResult(Release()); } /** - * Returns whether this instance owns a semaphore count on the given semaphore at constructor. - * - * @since 2.0 - * - * @return true if a semaphore is owned, @n - * false otherwise. - */ + * Checks whether this instance owns a semaphore count on the given semaphore at constructor. + * + * @since 2.0 + * + * @return @c true if a semaphore is owned, @n + * else @c false + */ bool IsAcquired(void) const { return __acquired; } /** - * Returns whether this instance owns a semaphore count on the given semaphore at constructor. @n - * Have same effects to calling IsAcquired(). - * - * @since 2.0 - */ + * Checks whether this instance owns a semaphore count on the given semaphore at constructor. @n + * Has the same effects as calling IsAcquired(). + * + * @since 2.0 + */ operator bool() const { return IsAcquired(); } /** - * Acquires a semaphore count manually on the given semaphore at constructor in a blocking way - * - * @since 2.0 - * - * @return An error code. - * @see Semaphore::Acquire() for detailed exceptions - */ + * Acquires a semaphore count manually on the given semaphore at constructor in a blocking way. + * + * @since 2.0 + * + * @return An error code + * @see Semaphore::Acquire() for detailed exceptions + */ result Acquire(void) { return SetAcquiredAndReturn(__s.Acquire()); } /** - * Acquires a semaphore count manually on the given semaphore at constructor in a non-blocking way - * - * @since 2.0 - * - * @return An error code. - * @see Semaphore::TryToAcquire() for detailed exceptions - */ + * Acquires a semaphore count manually on the given semaphore at constructor in a non-blocking way. + * + * @since 2.0 + * + * @return An error code + * @see Semaphore::TryToAcquire() for detailed exceptions + */ result TryToAcquire(void) { return SetAcquiredAndReturn(__s.TryToAcquire()); } /** - * Releases the acquired semaphore count manually - * - * @since 2.0 - * - * @return An error code. - * @see Semaphore::Release() for detailed exceptions - */ + * Releases the acquired semaphore count manually + * + * @since 2.0 + * + * @return An error code + * @see Semaphore::Release() for detailed exceptions + */ result Release(void) { result r = E_SUCCESS; diff --git a/inc/FBaseRtThread.h b/inc/FBaseRtThread.h index a27a4af..0a4770d 100644 --- a/inc/FBaseRtThread.h +++ b/inc/FBaseRtThread.h @@ -61,8 +61,8 @@ namespace Tizen { namespace Base { namespace Runtime */ enum ThreadType { - THREAD_TYPE_WORKER = 0, /**< @if OSPDEPREC The worker thread mode @endif */ - THREAD_TYPE_EVENT_DRIVEN, /**< @if OSPDEPREC The event-driven thread mode @endif */ + THREAD_TYPE_WORKER = 0, /**< @if OSPDEPREC The worker thread mode @endif */ + THREAD_TYPE_EVENT_DRIVEN, /**< @if OSPDEPREC The event-driven thread mode @endif */ THREAD_TYPE_MAIN // This enum value is for internal use only. Using this enum value can cause behavioral, // security-related, and consistency-related issues in the application. // The main thread mode @@ -92,7 +92,7 @@ enum ThreadPriority * @remarks This class supports only worker threads. For event-driven threads, use the EventDrivenThread class. * * The %Thread class is the fundamental class for the asynchronous execution of a thread. - * A Tizen native application can execute several threads during its operation from the multi-threading view. + * A %Tizen native application can execute several threads during its operation from the multi-threading view. * * For more information on the class features, see Thread. * @@ -169,10 +169,11 @@ public: * * @return An error code * @param[in] milliSeconds The time, in milliseconds, for which to suspend the execution @n - * A value of zero causes the thread to relinquish the remainder of its time - * slice to any other thread that is ready to run. The time cannot be negative. + * The value of zero causes the thread to relinquish the remainder of its time + * slice to any other thread that is ready to run @n + * The time cannot be negative. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A negative time value is passed. + * @exception E_INVALID_ARG A negative time value has been passed. */ static result Sleep(long milliSeconds); @@ -201,7 +202,7 @@ public: static result Exit(int exitCode = 0x00); /** - * Gets the pointer of the currently running %Thread instance. + * Gets a pointer of the currently running %Thread instance. * * @since 2.0 * @@ -224,7 +225,7 @@ public: * Initializes this instance of %Thread with the specified thread type, stack size, and priority. * * @brief [Deprecated] - * @deprecated This method is deprecated because the %Thread class does not support event-driven thread any more. Instead, use the EventDrivenThread class instead. + * @deprecated This method is deprecated because the %Thread class does not support event-driven threads any more. Instead, use the EventDrivenThread class. * * @since 2.0 * @@ -233,7 +234,7 @@ public: * @param[in] stackSize The thread stack size * @param[in] priority The thread priority * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG An invalid argument is passed. + * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @endif */ @@ -244,7 +245,7 @@ public: * Initializes this instance of %Thread with the specified name, thread type, stack size, and priority. * * @brief [Deprecated] - * @deprecated This method is deprecated because the %Thread class does not support event-driven thread any more. Instead, use the EventDrivenThread class instead. + * @deprecated This method is deprecated because the %Thread class does not support event-driven threads any more. Instead, use the EventDrivenThread class. * * @since 2.0 * @@ -254,7 +255,7 @@ public: * @param[in] stackSize The thread stack size * @param[in] priority The thread priority * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG An invalid argument is passed. + * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @endif */ @@ -270,7 +271,7 @@ public: * @param[in] stackSize The thread stack size * @param[in] priority The thread priority * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG An invalid argument is passed. + * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. */ result Construct(long stackSize = DEFAULT_STACK_SIZE, ThreadPriority priority = THREAD_PRIORITY_MID); @@ -285,7 +286,7 @@ public: * @param[in] stackSize The thread stack size * @param[in] priority The thread priority * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG An invalid argument is passed. + * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. */ result Construct(const Tizen::Base::String& name, @@ -301,7 +302,7 @@ public: * @param[in] stackSize The thread stack size * @param[in] priority The thread priority * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG An invalid argument is passed. + * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. */ result Construct(IRunnable& target, long stackSize = DEFAULT_STACK_SIZE, ThreadPriority priority = THREAD_PRIORITY_MID); @@ -311,13 +312,13 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] name The name of the thread + * @return An error code + * @param[in] name The name of the thread * @param[in] target An instance of IRunnable * @param[in] stackSize The thread stack size * @param[in] priority The thread priority * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG An invalid argument is passed. + * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. */ result Construct(const Tizen::Base::String& name, IRunnable& target, @@ -333,13 +334,13 @@ public: virtual ~Thread(void); /** - * Waits until the thread execution is terminated. + * Joins after the thread execution is terminated. * * @since 2.0 * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_OPERATION An other thread is calling this method. + * @exception E_INVALID_OPERATION Another thread is calling this method. * @exception E_SYSTEM A system error has occurred. */ result Join(void); @@ -366,8 +367,8 @@ public: * @since 2.0 * * @return An error code - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM A system error has occurred. * @remarks This is only available for event-driven threads. * @endif */ @@ -375,7 +376,7 @@ public: /** * Called when the thread is started without the IRunnable instance. @n - * The body for thread execution is specified by inheriting the %Thread class and implementing this method. + * The body for the thread execution is specified by inheriting the %Thread class and implementing this method. * * @since 2.0 * @@ -385,7 +386,7 @@ public: virtual Tizen::Base::Object* Run(void); /** - * Gets an exit code of the thread which is given by calling the Exit() method. + * Gets the exit code of the thread which is given by calling the Exit() method. * * @since 2.0 * @@ -403,7 +404,7 @@ public: * @since 2.0 * * @return The name of the thread - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. */ const Tizen::Base::String& GetName(void) const; @@ -420,8 +421,8 @@ public: * @since 2.0 * * @return @c true if this thread can be run, @n - * else @c false - * @remarks You can initialize the event or event listener in this method for running this + * else @c false + * @remarks The event or event listener in this method can be initialized for running this * thread in an event-driven mode. * @endif */ @@ -435,7 +436,7 @@ public: * @deprecated This method is deprecated because the %Thread class does not support event-driven threads. * @since 2.0 * - * @remarks You can finalize the event or event listener in this method for running this + * @remarks The event or event listener in this method can be finalized for running this * thread in an event-driven mode. * * @endif @@ -452,8 +453,8 @@ public: * @since 2.0 * * @return An error code - * @param[in] requestId The user-defined event Id - * @param[in] pArgs A pointer to a list of arguments + * @param[in] requestId The user-defined event ID + * @param[in] pArgs A pointer to the list of arguments * @exception E_SUCCESS The method is successful. * @exception E_INVALID_OPERATION The thread is not an event-driven thread. * @@ -472,8 +473,8 @@ public: * * @since 2.0 * - * @param[in] requestId The user-defined event Id - * @param[in] pArgs A pointer to a list of arguments + * @param[in] requestId The user-defined event ID + * @param[in] pArgs A pointer to the list of arguments * @see SendUserEvent() * @endif */ diff --git a/inc/FBaseRtTimer.h b/inc/FBaseRtTimer.h index 1008b0d..a388603 100644 --- a/inc/FBaseRtTimer.h +++ b/inc/FBaseRtTimer.h @@ -38,10 +38,10 @@ namespace Tizen { namespace Base { namespace Runtime * @since 2.0 * * The %Timer class can activate the timer and notify the listeners. - * It supports relative time and provides both repeatable and non-repeatable timer. - * Because Timer is handled by event-driven way, when the main loop gets blocked, even if the time is expired, the listener cannot get notified. - * Once the target goes into sleep mode, Timer does not work properly because the main loop gets stopped. - * You can use Alarm on behalf of Timer for sleep mode. + * It supports the relative time and provides both repeatable and non-repeatable timers. + * Because %Timer is handled in an event-driven way, when the main loop gets blocked, even if the time is expired, the listener cannot get notified. + * Once the target goes into the sleep mode, %Timer does not work properly because the main loop gets stopped. + * You can use Alarm on behalf of the %Timer for the sleep mode. * For more information on the class features, see Timer. * The following example demonstrates how to use the %Timer class. * @@ -141,10 +141,10 @@ public: * @since 2.0 * * @return An error code - * @param[in] listener The event listener - * @exception E_SUCCESS The method is successful. + * @param[in] listener The event listener + * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. + * @exception E_SYSTEM A system error has occurred. */ result Construct(ITimerEventListener& listener); @@ -158,45 +158,45 @@ public: * @since 2.0 * * @if OSPCOMPAT - * @compatibility This method has compatibility issues with %Tizen API versions @b prior @b to @b 2.1. @n - * For more information, see @ref CompTimerStartPage "here". + * @compatibility This method has compatibility issues with Tizen API versions @b prior @b to @b 2.1. @n + * For more information, see @ref CompTimerStartPage "here". * @endif * * @return An error code - * @param[in] timeout A timeout interval in milliseconds - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_INVALID_STATE The timer is in an invalid state for start. - * @exception E_SYSTEM A system error has occurred. - * @remarks Once the timer has been started, it cannot be started again until expired. + * @param[in] timeout The timeout interval in milliseconds + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_INVALID_STATE The timer cannot start as it is in an invalid state. + * @exception E_SYSTEM A system error has occurred. + * @remarks Once the timer has been started, it cannot be started again until it has expired. * @see Cancel() */ result Start(int timeout); /** - * @page CompTimerStartPage Compatibility for Start(int timeout) - * @section CompTimerStartPageIssueSection Issues - * Implementation of this method in %Tizen API versions prior to 2.1 has the following issue: @n - * -# The method returns E_INVALID_ARG if timeout is equal to zero. - * - * @section CompTimerStartPageSolutionSection Resolutions - * The issue mentioned above is resolved in %Tizen API version 2.1, and it is recommended to use %Tizen API version 2.1 or above. - * -# In case of zero, Timer sets timeout to the best-effort minimum interval without returning E_INVALID_ARG. - */ + * @page CompTimerStartPage Compatibility for Start(int timeout) + * @section CompTimerStartPageIssueSection Issues + * Implementation of this method in Tizen API versions prior to 2.1 has the following issue: @n + * -# The method returns @c E_INVALID_ARG if timeout is equal to zero. + * + * @section CompTimerStartPageSolutionSection Resolutions + * The issue mentioned above is resolved in Tizen API version 2.1, and it is recommended to use Tizen API version 2.1 or above. + * -# In case of zero, %Timer sets the timeout to the best possible minimum interval without returning @c E_INVALID_ARG. + */ /** * Starts the timer. @n - * The timer is expired repeatedly until canceled. + * The timer expires repeatedly until it is cancelled. * * @since 2.0 * * @return An error code - * @param[in] interval A timeout interval in milliseconds - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_INVALID_STATE The timer is in an invalid state for start. - * @exception E_SYSTEM A system error has occurred. - * @remarks To stop timer expiration or restart a timer, the timer must be canceled. + * @param[in] interval The timeout interval in milliseconds + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_INVALID_STATE The timer cannot start as it is in an invalid state. + * @exception E_SYSTEM A system error has occurred. + * @remarks To stop the timer expiration or restart the timer, the timer must be cancelled. * @see Cancel() */ result StartAsRepeatable(int interval); @@ -206,10 +206,11 @@ public: * * @since 2.0 * - * @return An error code + * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. - * @remarks The started timer can be canceled when it does not get expired. If the timer was already expired, this method also returns E_SUCCESS which affects the same manner when canceled normally. + * @remarks The started timer can be cancelled when it does not get expired. @n + * If the timer has already expired, this method also returns @c E_SUCCESS which causes the same effect as when cancelled normally. */ result Cancel(void); diff --git a/inc/FBaseRtTypes.h b/inc/FBaseRtTypes.h index 8cfe3d3..d0dc55b 100644 --- a/inc/FBaseRtTypes.h +++ b/inc/FBaseRtTypes.h @@ -16,7 +16,7 @@ /** * @file FBaseRtTypes.h - * @brief This is the header file for the 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. */ @@ -45,9 +45,9 @@ enum TimerStatus /** * @struct TryTag -* @brief This struct is used only for supporting non-blocking acquisition of a resource. +* @brief This struct is used only for supporting the non-blocking acquisition of a resource. * -* The %TryTag struct is used for just discriminating between blocking and non-blocking acquisition +* The %TryTag struct is used for just discriminating between the blocking and non-blocking acquisitions * of a resource. So, the definition is empty. * * @since 2.0 @@ -61,7 +61,7 @@ struct TryTag }; /** -* @brief Used only for just discriminating between blocking and non-blocking acquisition. +* @brief Used only for discriminating between the blocking and non-blocking acquisitions. * * @code * Mutex m; diff --git a/inc/FBaseRtWaitingLoop.h b/inc/FBaseRtWaitingLoop.h index b8f44a4..06cb7f4 100755 --- a/inc/FBaseRtWaitingLoop.h +++ b/inc/FBaseRtWaitingLoop.h @@ -33,7 +33,7 @@ namespace Tizen { namespace Base { namespace Runtime class IWaitingLoopCondition; /* * @class WaitingLoop - * @brief This class allows developers to make the current thread wait for callback events. This class should be used only for test codes and don't use this class for commercial applications + * @brief This class allows developers to make the current thread wait for callback events. This class should be used only for test codes and not for commercial applications. * @since 2.0 * * @final This class is not intended for extension. @@ -43,13 +43,14 @@ class _OSP_EXPORT_ WaitingLoop { public: /* - * Gets the WaitingLoop instance. + * Gets a pointer to the %WaitingLoop instance. * * @since 2.0 * - * @return A pointer to the WaitingLoop instance, @n + * @return A pointer to a WaitingLoop instance, @n * else @c null if it fails - * @remarks Once the WaitingLoop instance has been created, you must not use the instance between threads. Especially, the methods for waiting should be called on the thread you get the instance at first time. + * @remarks Once the WaitingLoop instance has been created, the instance between the threads must not be used. @n + * Especially, the methods that are waiting should be called on the thread where the instance is obtained for the first time. */ static WaitingLoop* GetInstance(void); @@ -58,13 +59,13 @@ public: * * @since 2.0 * - * @param[in] timeout The timeout period in milliseconds - * @exception E_SUCCESS The method is successful. - * @exception E_TIMEOUT The time is expired. - * @exception E_INVALID_STATE The waiting loop has already been waiting on a callback event. In order to wait again, you must quit the waiting loop. - * @remarks The timeout set to min(timeout, maximum), where the maximum is set using SetMaxTimeoutForWaiting(). + * @param[in] timeout The timeout period in milliseconds + * @exception E_SUCCESS The method is successful. + * @exception E_TIMEOUT The time has expired. + * @exception E_INVALID_STATE The waiting loop has already been waiting on a callback event. @n + * In order to wait again, quit the waiting loop. + * @remarks The timeout is set to min(timeout, maximum), where the maximum is set using SetMaxTimeoutForWaiting(). * @see Notify() - * @see SetMaxTimoutForWaiting() */ result Wait(int timeout); @@ -73,32 +74,35 @@ public: * * @since 2.0 * - * @param[in] condition The expiring condition - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE The waiting loop has already been waiting on a callback event. In order to wait again, you must quit the waiting loop. - * @remarks In order to use this method correctly, you have to implement a class inheriting from %IWaitingLoopCondition. + * @param[in] condition The expiring condition + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_STATE The waiting loop has already been waiting on a callback event. @n + * In order to wait again, quit the waiting loop. + * @remarks In order to use this method correctly, you have to implement a class inheriting from IWaitingLoopCondition. */ result Wait(IWaitingLoopCondition& condition); /* - * Starts the waiting loop and waits until either the expiring condition occurs or the time is expired. + * Starts the waiting loop and waits until either the expiring condition occurs or the time expires. * * @since 2.0 * - * @param[in] timeout The timeout period in milliseconds - * @param[in] condition The expiring condition - * @exception E_TIMEOUT The time is expired. - * @exception E_INVALID_STATE The waiting loop is waiting on a thread. In order to wait again, you must quit the waiting loop. - * @remarks If the timeout is over the maximum, the expired time goes together with the maximum timeout. In order to use this method correctly, you have to implement a class inheriting from %IWaitingLoopCondition interface + * @param[in] timeout The timeout period in milliseconds + * @param[in] condition The expiring condition + * @exception E_TIMEOUT The time has expired. + * @exception E_INVALID_STATE The waiting loop is waiting on a thread. @n + * In order to wait again, quit the waiting loop. + * @remarks If the timeout has crossed the maximum value, the expired time goes along with the maximum timeout. @n + * In order to use this method correctly, implement a class inheriting from the IWaitingLoopCondition interface */ result Wait(int timeout, IWaitingLoopCondition& condition); /* - * Notify the waiting thread that the related callback has completed the job. + * Notifies the waiting thread that the related callback has completed the job. * * @since 2.0 * - * @remarks This method is recommended to use when the waiting condition is not explicitly specified with Wait(). + * @remarks This method is recommended when the waiting condition is not explicitly specified by Wait(). */ void Notify(void); @@ -108,8 +112,8 @@ public: * @since 2.0 * * @param[in] timeout The timeout period in milliseconds - * else @c false - * @remarks If the timeout is considered as a small number, it will be replaced with the specified number provided by platform. + * else @c false + * @remarks If the timeout is considered as a small number, it is replaced with the specified number provided by the platform. */ static void SetMaxTimeoutForWaiting(int timeout); diff --git a/inc/FBaseShort.h b/inc/FBaseShort.h index ab6c4c1..1f05c3e 100644 --- a/inc/FBaseShort.h +++ b/inc/FBaseShort.h @@ -18,9 +18,9 @@ * @file FBaseShort.h * @brief This is the header file for the %Short class. * - * @see Number() - * * This header file contains the declarations of the %Short class. + * + * @see Tizen::Base::Number */ #ifndef _FBASE_SHORT_H_ #define _FBASE_SHORT_H_ @@ -82,7 +82,7 @@ public: * * @since 2.0 * - * @param[in] value A @c short value + * @param[in] value The @c short value */ Short(short value = 0); @@ -91,7 +91,7 @@ public: * * @since 2.0 * - * @param[in] value An instance of %Short + * @param[in] value An instance of %Short to copy */ Short(const Short& value); @@ -116,31 +116,31 @@ public: * * @since 2.0 * - * @return A 32-bit @c signed @c integer value + * @return The 32-bit @c signed @c integer value * @param[in] s1 The first @c short value to compare * @param[in] s2 The second @c short value to compare * * @code - * < 0 if @c s1 is less than @c s2 - * == 0 if @c s1 is equal to @c s2 - * > 0 if @c s1 is greater than @c s2 + * < 0 if s1 is less than s2 + * == 0 if s1 is equal to s2 + * > 0 if s1 is greater than s2 * @endcode */ static int Compare(short s1, short s2); /** - * Compares the value of the current instance of the %Short class - * with the value of the specified instance of the %Short class. + * Compares the value of the current instance of %Short + * with the value of the specified instance of %Short. * * @since 2.0 * - * @return A @c signed 32-bit @c integer value - * @param[in] value An instance of the %Short class to compare + * @return The @c signed 32-bit @c integer value + * @param[in] value An instance of %Short to compare * * @code - * < 0 if the value of the current instance is less than that of the specified instance - * == 0 if the value of the current instance is equal to that of the specified instance - * > 0 if the value of the current instance is greater than that of the specified instance + * < 0 if the value of the current instance is less than the specified instance + * == 0 if the value of the current instance is equal to the specified instance + * > 0 if the value of the current instance is greater than the specified instance * @endcode */ int CompareTo(const Short& value) const; @@ -152,7 +152,7 @@ public: * * @return @c true if the value of the specified instance of Object is equal to the value of the current instance of %Short, @n * else @c false - * @param[in] obj An instance of Object to compare + * @param[in] obj An instance of Object to compare * @remarks The method returns @c false if the specified object is not of the * type @c short. * @see Tizen::Base::Object::Equals() @@ -167,7 +167,7 @@ public: * * @return @c true if the value of the current instance is equal to the specified @c short value, @n * else @c false - * @param[in] value A @c short value to compare + * @param[in] value The @c short value to compare */ bool Equals(short value) const; @@ -176,20 +176,21 @@ public: * * @since 2.0 * - * @return An integer value indicating the hash value of the current instance of %Short - * @remarks Two equal instances must return the same hash value. For better performance, - * the used hash function must generate a random distribution for all inputs. @n - * The default implementation of this method returns the value of the current instance. + * @return The integer value that indicates the hash value of the current instance of %Short + * @remarks + * - Two equal instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. @n + * - The default implementation of this method returns the value of the current instance. */ virtual int GetHashCode(void) const; /** - * Gets the hash value of the specified @c short value. + * Gets the hash value of the specified @c short value. * - * @since 2.0 + * @since 2.0 * - * @return An integer value indicating the hash value of the specified @c short value - * @param[in] val A @c short value to get the hash value + * @return The integer value that indicates the hash value of the specified @c short value + * @param[in] val The @c short value used to get the hash value */ static int GetHashCode(short val); @@ -198,9 +199,9 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] s A numeric value - * @param[out] ret The result of the operation + * @return An error code + * @param[in] s The numeric value + * @param[out] ret The result of the operation * @exception E_SUCCESS The method is successful. * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed. * @remarks This method accepts decimal, hexadecimal, and octal numbers given by the @@ -220,138 +221,138 @@ public: static result Decode(const String& s, short& ret); /** - * Parses the specified string representing a numeric value and + * Parses the specified string that represents a numeric value and * returns the value as @c signed @c short. * * @since 2.0 * - * @return An error code - * @param[in] s A string representing a numeric value + * @return An error code + * @param[in] s The string that represents the numeric value * @param[out] ret The result of the operation * @exception E_SUCCESS The method is successful. * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed. * @remarks - * - This method assumes that the string representing the numeric value uses a radix 10. - * - This method guarantees that the original value of out-parameter is not changed when the method returns error. + * - This method assumes that the string that represents the numeric value that uses a radix @c 10. + * - This method guarantees that the original value of the out-parameter is not changed when the method returns an error. */ static result Parse(const String& s, short& ret); /** - * Parses the specified string representing a numeric value + * Parses the specified string that represents a numeric value * using the specified radix and returns the value as @c signed @c short. * * @since 2.0 * * @return An error code - * @param[in] s A string representing a numeric value - * @param[in] radix The radix of the string representing a numeric value @n - * It must either be @c 2, @c 8, @c 10, or @c 16. + * @param[in] s The string that represents the numeric value + * @param[in] radix The radix of the string that represents the numeric value @n + * It must either be 2, 8, 10, or 16. * @param[out] ret The result of the operation * @exception E_SUCCESS The method is successful. * @exception E_NUM_FORMAT The specified string does not contain a number that can be parsed. * @exception E_OUT_OF_RANGE The specified @c radix is invalid. - * @remarks This method guarantees that the original value of out-parameter is not changed when the method returns error. + * @remarks This method guarantees that the original value of the out-parameter is not changed when the method returns an error. */ static result Parse(const String& s, int radix, short& ret); /** - * Gets the @c signed @c char equivalent of the current instance of the %Short class. + * Gets the @c signed @c char equivalent of the current instance of %Short. * * @since 2.0 * - * @return A @c signed @c char equivalent of the current instance + * @return The @c signed @c char equivalent of the current instance */ virtual char ToChar(void) const; /** - * Gets the @c signed @c short equivalent of the current instance of the %Short class. + * Gets the @c signed @c short equivalent of the current instance of %Short. * * @since 2.0 * - * @return A @c signed @c short equivalent of the current instance + * @return The @c signed @c short equivalent of the current instance */ virtual short ToShort(void) const; /** - * Gets the @c signed @c int equivalent of the current instance of the %Short class. + * Gets the @c signed @c int equivalent of the current instance of %Short. * * @since 2.0 * - * @return A @c signed @c int equivalent of the current instance + * @return The @c signed @c int equivalent of the current instance */ virtual int ToInt(void) const; /** - * Gets the @c signed @c long equivalent of the current instance of the %Short class. + * Gets the @c signed @c long equivalent of the current instance of %Short. * * @since 2.0 * - * @return A @c signed @c long equivalent of the current instance + * @return The @c signed @c long equivalent of the current instance */ virtual long ToLong(void) const; /** - * Gets the @c signed @c long @c long equivalent of the current instance of the %Short class. - * - * @since 2.0 - * - * @return A @c signed @c long @c long equivalent of the current instance - */ + * Gets the @c signed @c long @c long equivalent of the current instance of %Short. + * + * @since 2.0 + * + * @return The @c signed @c long @c long equivalent of the current instance + */ virtual long long ToLongLong(void) const; /** - * Gets the @c signed @c float equivalent of the current instance of the %Short class. + * Gets the @c signed @c float equivalent of the current instance of %Short. * * @since 2.0 * - * @return A @c signed @c float equivalent of the current instance + * @return The @c signed @c float equivalent of the current instance */ virtual float ToFloat(void) const; /** - * Gets the @c signed @c double equivalent of the current instance of the %Short class. + * Gets the @c signed @c double equivalent of the current instance of %Short. * * @since 2.0 * - * @return A @c signed @c double equivalent of the current instance + * @return The @c signed @c double equivalent of the current instance */ virtual double ToDouble(void) const; /** - * Gets the string representing the value of the current instance of the %Short class. + * Gets the string that represents the value of the current instance of %Short. * * @since 2.0 * - * @return A string representing the value of the current instance + * @return The string that represents the value of the current instance */ virtual String ToString(void) const; /** - * Gets the string representing the specified @c signed @c short value. + * Gets the string that represents the specified @c signed @c short value. * * @since 2.0 * - * @return A string containing a Unicode representation of the specified @c signed @c short value - * @param[in] value A @c signed @c short value to convert + * @return The string that contains the Unicode representation of the specified @c signed @c short value + * @param[in] value The @c signed @c short value to convert */ static String ToString(short value); /** - * A constant holding the maximum value a @c short will be equal to 2^15-1. + * The constant holding the maximum value a @c short can be equal to 2^15-1. * * @since 2.0 */ static const short VALUE_MAX = (short) 0x7FFF; /** - * A constant holding the minimum value a @c short will be equal to -2^15. + * The constant holding the minimum value a @c short can be equal to -2^15. * * @since 2.0 */ static const short VALUE_MIN = (short) 0x8000; /** - * A @c short value of this instance. + * The @c short value of this instance. * * @since 2.0 */ diff --git a/inc/FBaseShortComparer.h b/inc/FBaseShortComparer.h index 36ad325..9af19e6 100644 --- a/inc/FBaseShortComparer.h +++ b/inc/FBaseShortComparer.h @@ -18,10 +18,10 @@ * @file FBaseShortComparer.h * @brief This is the header file for the %ShortComparer class. * - * @see Short - * @see Tizen::Base::Collection::IComparer - * * This header file contains the declarations of the %ShortComparer class. + * + * @see Tizen::Base::Short + * @see Tizen::Base::Collection::IComparer */ #ifndef _FBASE_SHORT_COMPARER_H_ #define _FBASE_SHORT_COMPARER_H_ @@ -35,11 +35,11 @@ namespace Tizen { namespace Base { /** * @class ShortComparer - * @brief This class compares 2 instances of the %Short type for equivalence. + * @brief This class compares two instances of the %Short type for equivalence. * * @since 2.0 * - * The %ShortComparer class compares 2 instances of the Short type for equivalence. + * The %ShortComparer class compares two instances of the Short type for equivalence. * * For more information on the class features, see Collection Comparisons. * @@ -91,18 +91,18 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] obj1 An object of Short to compare - * @param[in] obj2 An object of Short to compare - * @param[out] cmp The result of comparison + * @return An error code + * @param[in] obj1 The object of Short to compare + * @param[in] obj2 The object of Short to compare + * @param[out] cmp The result of the comparison * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified object instances are not of the expected type. - * @remarks The value of @c cmp can be: + * @remarks The value of @c cmp can be: * * @code - * < 0 if the value of @c obj1 is less than the value of @c obj2 - * == 0 if the value of @c obj1 is equal to the value of @c obj2 - * > 0 if the value of @c obj1 is greater than the value of @c obj2 + * < 0 if the value of obj1 is less than the value of obj2 + * == 0 if the value of obj1 is equal to the value of obj2 + * > 0 if the value of obj1 is greater than the value of obj2 * @endcode */ virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const; diff --git a/inc/FBaseString.h b/inc/FBaseString.h index 185a3e3..22b5542 100644 --- a/inc/FBaseString.h +++ b/inc/FBaseString.h @@ -80,7 +80,7 @@ public: * * @since 2.0 * - * @param[in] capacity The default capacity of this instance + * @param[in] capacity The default capacity of this instance */ String(int capacity); @@ -89,7 +89,7 @@ public: * * @since 2.0 * - * @param[in] ch A Unicode character + * @param[in] ch The Unicode character */ String(wchar_t ch); @@ -98,7 +98,7 @@ public: * * @since 2.0 * - * @param[in] pValue A pointer to an array of Unicode characters + * @param[in] pValue A pointer to the array of Unicode characters */ String(const wchar_t* pValue); @@ -107,7 +107,7 @@ public: * * @since 2.0 * - * @param[in] pValue A pointer to an array of UTF-8 characters + * @param[in] pValue A pointer to the array of UTF-8 characters */ String(const char* pValue); @@ -116,36 +116,36 @@ public: * * @since 2.0 * - * @param[in] value An instance of %String + * @param[in] value An instance of %String to copy */ String(const String& value); /** - * TThis destructor overrides Tizen::Base::Object::~Object(). + * This destructor overrides Tizen::Base::Object::~Object(). * * @since 2.0 * - * @remarks The internally allocated memory block is freed when the instance is destroyed. + * @remarks The internally allocated memory block is freed when the instance is destroyed. */ virtual ~String(void); /** - * Returns the Unicode character at the specified @c index. + * Gets the Unicode character at the specified index. * * @since 2.0 * - * @return A const reference to the Unicode character - * @param[in] index An index within the current instance of %String + * @return A constant reference to the Unicode character + * @param[in] index The index within the current instance of %String */ const wchar_t& operator [](int index) const; /** - * Returns a reference to the Unicode character at the specified @c index. + * Gets a reference to the Unicode character at the specified index. * * @since 2.0 * * @return A reference to the Unicode character - * @param[in] index An index within the current instance of %String + * @param[in] index The index within the current instance of %String */ wchar_t& operator [](int index); @@ -156,7 +156,7 @@ public: * @since 2.0 * * @return A reference to the %String instance - * @param[in] pRhs A pointer to an array of Unicode characters + * @param[in] pRhs A pointer to the array of Unicode characters */ String& operator =(const wchar_t* pRhs); @@ -166,7 +166,7 @@ public: * @since 2.0 * * @return A reference to the %String instance - * @param[in] rhs An instance of %String + * @param[in] rhs An instance of %String to copy */ String& operator =(const String& rhs); @@ -177,7 +177,7 @@ public: * @since 2.0 * * @return A reference to the %String instance - * @param[in] pRhs A pointer to an array of Unicode characters + * @param[in] pRhs A pointer to the array of Unicode characters */ String& operator +=(const wchar_t* pRhs); @@ -197,7 +197,7 @@ public: * * @since 2.0 * - * @return The concatenated %String instance + * @return The concatenated %String instance * @param[in] lhs A reference to the %String instance on the left-hand side of the operator * @param[in] rhs A reference to the %String instance on the right-hand side of the operator */ @@ -208,10 +208,10 @@ public: * * @since 2.0 * - * @return @c true if the text of the specified %String instance equals the calling instance's text, @n + * @return @c true if the text of the specified %String instance equals the calling instance's text, @n * else @c false - * @param[in] rhs A reference to the %String instance on the right-hand side of the operator - * @remarks The operator performs an ordinal comparison of each Unicode character. + * @param[in] rhs A reference to the %String instance on the right-hand side of the operator + * @remarks The operator performs an ordinal comparison of each Unicode character. */ bool operator ==(const String& rhs) const; @@ -220,10 +220,10 @@ public: * * @since 2.0 * - * @return @c true if the text of the specified %String instance is not equal to the calling instance's text, @n + * @return @c true if the text of the specified %String instance is not equal to the calling instance's text, @n * else @c false * @param[in] rhs A reference to the %String instance on the right-hand side of the operator - * @remarks The operator performs an ordinal comparison of each Unicode character. + * @remarks The operator performs an ordinal comparison of each Unicode character. */ bool operator !=(const String& rhs) const; @@ -243,7 +243,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] ch A @c wchar_t value to insert + * @param[in] ch The @c wchar_t value to insert * @exception E_SUCCESS The method is successful. */ result Append(wchar_t ch); @@ -254,79 +254,79 @@ public: * @since 2.0 * * @return An error code - * @param[in] ch A @c char value to insert + * @param[in] ch The @c char value to insert * @exception E_SUCCESS The method is successful. */ result Append(char ch); /** - * Appends the string representing the specified 32-bit @c int value to this + * Appends the string that represents the specified 32-bit @c int value to this * instance of %String. * * @since 2.0 * * @return An error code - * @param[in] i A 32-bit integer value to insert + * @param[in] i The 32-bit integer value to insert * @exception E_SUCCESS The method is successful. */ result Append(int i); /** - * Appends the string representing the specified @c short value to this + * Appends the string that represents the specified @c short value to this * instance of %String. * * @since 2.0 * * @return An error code - * @param[in] s A @c short value to insert + * @param[in] s The @c short value to insert * @exception E_SUCCESS The method is successful. */ result Append(short s); /** - * Appends the string representing the specified @c long value to this + * Appends the string that represents the specified @c long value to this * instance of %String. * * @since 2.0 * * @return An error code - * @param[in] l A @c long value to insert + * @param[in] l The @c long value to insert * @exception E_SUCCESS The method is successful. */ result Append(long l); /** - * Appends the string representing the specified @c long @c long value to this + * Appends the string that represents the specified @c long @c long value to this * instance of %String. * * @since 2.0 * * @return An error code - * @param[in] ll A @c long @c long value to insert + * @param[in] ll The @c long @c long value to insert * @exception E_SUCCESS The method is successful. */ result Append(long long ll); /** - * Appends the string representing the specified @c float value to this + * Appends the string that represents the specified @c float value to this * instance of %String. * * @since 2.0 * * @return An error code - * @param[in] f A @c float value to insert + * @param[in] f The @c float value to insert * @exception E_SUCCESS The method is successful. */ result Append(float f); /** - * Appends the string representing the specified @c double value to this + * Appends the string that represents the specified @c double value to this * instance of %String. * * @since 2.0 * * @return An error code - * @param[in] d A @c double value to insert + * @param[in] d The @c double value to insert * @exception E_SUCCESS The method is successful. */ result Append(double d); @@ -338,7 +338,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] p A pointer to a Unicode character array + * @param[in] p A pointer to the Unicode character array * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A @c null pointer is passed. */ @@ -351,7 +351,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] str An instance of %String to append + * @param[in] str An instance of %String to append * @exception E_SUCCESS The method is successful. */ result Append(const String& str); @@ -369,11 +369,11 @@ public: * * @since 2.0 * - * @return A 32-bit @c signed integer value + * @return The 32-bit @c signed integer value * @param[in] str0 The first %String instance to compare * @param[in] str1 The second %String instance to compare - * @remarks This method performs an ordinal comparison of each Unicode - * character contained in the two given %String instances. + * @remarks This method performs an ordinal comparison of each Unicode + * character contained in the two given %String instances. @n * For instance, "U+xxx" is greater than "U+XXX", but smaller than "U+yyy". * * @code @@ -390,15 +390,15 @@ public: * * @since 2.0 * - * @return A 32-bit @c signed integer value - *@code + * @return The 32-bit @c signed integer value + * @code * < 0 if the value of the current instance is less than the value of the specified %String instance * == 0 if the value of the current instance is equal to the value of the specified %String instance * > 0 if the value of the current instance is greater than the value of the specified %String instance - *@endcode + * @endcode * @param[in] str An instance of %String to compare - * @remarks This method performs an ordinal comparison of each Unicode character. For instance, - * L"U+xxx" is greater than L"U+XXX", but smaller than L"U+yyy". + * @remarks This method performs an ordinal comparison of each Unicode character. @n + * For instance, L"U+xxx" is greater than L"U+XXX", but smaller than L"U+yyy". */ int CompareTo(const String& str) const; @@ -410,7 +410,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] minLength A minimum length to ensure + * @param[in] minLength The minimum length to ensure * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c minLength is negative. */ @@ -443,7 +443,7 @@ public: * else @c false * * @remarks This method performs an ordinal comparison of each Unicode - * character contained in the two given %String instances. + * character contained in the two given %String instances. */ bool Equals(const String& str, bool caseSensitive) const; @@ -456,9 +456,12 @@ public: * @param[in] length The maximum number of wide characters to write, including the terminating @c null character * @param[in] pFormat The wide character format specifier * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c length is negative or @c pFormat is @c null. - * @remarks If an "l" modifier is present in @c pFormat (for example, L"@%ls"), it is a pointer to an array of wide characters. @n - * @remarks A pointer to an array of UTF-8 characters is not allowed in the Format() method (for example, Format(20, L"@%s", pUTF8Str)). + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c length is negative. + * - The specified @c pFormat is @c null. + * @remarks + * - If an "l" modifier is present in @c pFormat (for example, L"@%ls"), it is a pointer to an array of wide characters. + * - A pointer to an array of UTF-8 characters is not allowed in the Format() method (for example, Format(20, L"@%s", pUTF8Str)). * The following format specifiers are supported in this method: * @code * specifier Output @@ -495,10 +498,9 @@ public: * * @since 2.0 * - * @return The hash value of the current instance - * @remarks Two equal instances must return the same hash value. For better performance, - * the hash function used must generate a random distribution - * for all inputs. + * @return The hash value of the current instance + * @remarks Two equal instances must return the same hash value. @n + * For better performance, the hash function used must generate a random distribution for all the inputs. */ virtual int GetHashCode(void) const; @@ -511,26 +513,30 @@ public: * @param[in] indexAt The position of the character * @param[out] ch The character at the specified index * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is out of range, or - * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is out of the valid range. + * - The specified @c indexAt is either greater than or equal to the length of the current instance. + * - The specified @c indexAt is less than @c 0. */ result GetCharAt(int indexAt, wchar_t& ch) const; /** * Searches for a character in the calling instance. @n - * Gets the index of the first character that matches to + * Gets the index of the first character that matches * the specified character in this instance. * * @since 2.0 * * @return An error code * @param[in] ch The Unicode character to locate - * @param[in] startIndex The starting position of search + * @param[in] startIndex The starting position of the search * @param[out] indexOf The index of the character - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified character is not found. - * @exception E_OUT_OF_RANGE The specified index is out of range, or - * the specified @c startIndex is either greater than or equal to the length of the current instance or less than @c 0. + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified character is not found. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is out of the valid range. + * - The specified @c startIndex is either greater than or equal to the length of the current instance. + * - The specified @c startIndex is less than @c 0. */ result IndexOf(wchar_t ch, int startIndex, int& indexOf) const; @@ -546,135 +552,153 @@ public: * @param[out] indexOf The index of the substring * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified string is not found. - * @exception E_OUT_OF_RANGE The specified index is out of range, or - * the specified @c startIndex is either greater than or equal to the length of the current instance or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is out of the valid range. + * - The specified @c startIndex is either greater than or equal to the length of the current instance. + * - The specified @c startIndex is less than @c 0. */ result IndexOf(const String& str, int startIndex, int& indexOf) const; /** - * Inserts the string representing the specified Unicode character + * Inserts the string that represents the specified Unicode character * at the specified position in the calling instance. * * @since 2.0 * * @return An error code * - * @param[in] ch A Unicode character to insert + * @param[in] ch The Unicode character to insert * @param[in] indexAt The position of the character * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is out of range, or - * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is out of the valid range. + * - The specified @c indexAt is either greater than or equal to the length of the current instance. + * - The specified @c indexAt is less than @c 0. */ result Insert(wchar_t ch, int indexAt); /** - * Inserts the string representing the specified @c char value + * Inserts the string that represents the specified @c char value * at the specified position in the calling instance. * * @since 2.0 * * @return An error code * - * @param[in] ch A @c char value to insert + * @param[in] ch The @c char value to insert * @param[in] indexAt The position of the character * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is out of range, or - * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is out of the valid range. + * - The specified @c indexAt is either greater than or equal to the length of the current instance. + * - The specified @c indexAt is less than @c 0. */ result Insert(char ch, int indexAt); /** - * Inserts the string representing the specified 16-bit integer + * Inserts the string that represents the specified 16-bit integer * at the specified position in the calling instance. * * @since 2.0 * * @return An error code - * @param[in] s A 16-bit integer value to insert + * @param[in] s The 16-bit integer value to insert * @param[in] indexAt The position of the character * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is out of range, or - * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is out of the valid range. + * - The specified @c indexAt is either greater than or equal to the length of the current instance. + * - The specified @c indexAt is less than @c 0. */ result Insert(short s, int indexAt); /** - * Inserts the string representing the specified 32-bit integer + * Inserts the string that represents the specified 32-bit integer * at the specified position in the calling instance. * * @since 2.0 * * @return An error code - * @param[in] i A 32-bit integer value to insert + * @param[in] i The 32-bit integer value to insert * @param[in] indexAt The position of the character * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is out of range, or - * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is out of the valid range. + * - The specified @c indexAt is either greater than or equal to the length of the current instance. + * - The specified @c indexAt is less than @c 0. */ result Insert(int i, int indexAt); /** - * Inserts the string representing the specified @c long value + * Inserts the string that represents the specified @c long value * at the specified position in the calling instance. * * @since 2.0 * * @return An error code - * @param[in] l A @c long value to insert + * @param[in] l The @c long value to insert * @param[in] indexAt The position of the character * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is out of range, or - * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is out of the valid range. + * - The specified @c indexAt is either greater than or equal to the length of the current instance. + * - The specified @c indexAt is less than @c 0. */ result Insert(long l, int indexAt); /** - * Inserts the string representing the specified @c long @c long value + * Inserts the string that represents the specified @c long @c long value * at the specified position in the calling instance. * * @since 2.0 * * @return An error code - * @param[in] ll A @c long @c long value to insert + * @param[in] ll The @c long @c long value to insert * @param[in] indexAt The position of the character * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is out of range, or - * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is out of the valid range. + * - The specified @c indexAt is either greater than or equal to the length of the current instance. + * - The specified @c indexAt is less than @c 0. */ result Insert(long long ll, int indexAt); /** - * Inserts the string representing the specified @c float value + * Inserts the string that represents the specified @c float value * at the specified position in the calling instance. * * @since 2.0 * * @return An error code - * @param[in] f A @c float value to insert + * @param[in] f The @c float value to insert * @param[in] indexAt The position of the character * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is out of range, or - * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is out of the valid range. + * - The specified @c indexAt is either greater than or equal to the length of the current instance. + * - The specified @c indexAt is less than @c 0. */ result Insert(float f, int indexAt); /** - * Inserts the string representing the specified @c double value + * Inserts the string that represents the specified @c double value * at the specified position in the calling instance. * * @since 2.0 * * @return An error code - * @param[in] d A @c double value to insert + * @param[in] d The @c double value to insert * @param[in] indexAt The position of the character * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is out of range, or - * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is out of the valid range. + * - The specified @c indexAt is either greater than or equal to the length of the current instance. + * - The specified @c indexAt is less than @c 0. */ result Insert(double d, int indexAt); /** - * Inserts the string representing the specified @c null-terminated + * Inserts the string that represents the specified @c null-terminated * string at the specified position in the calling instance. * * @since 2.0 @@ -683,14 +707,16 @@ public: * @param[in] p An instance of %String to insert * @param[in] indexAt The position of the character * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is out of range, or - * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is out of the valid range. + * - The specified @c indexAt is either greater than or equal to the length of the current instance. + * - The specified @c indexAt is less than @c 0. * @exception E_INVALID_ARG A @c null pointer is passed. */ result Insert(const wchar_t* p, int indexAt); /** - * Inserts the string representing the specified instance of %String + * Inserts the string that represents the specified instance of %String * at the specified position in the calling instance. * * @since 2.0 @@ -699,8 +725,10 @@ public: * @param[in] str An instance of %String to insert * @param[in] indexAt The position of the character * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is out of range, or - * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is out of the valid range. + * - The specified @c indexAt is either greater than or equal to the length of the current instance. + * - The specified @c indexAt is less than @c 0. */ result Insert(const String& str, int indexAt); @@ -712,12 +740,14 @@ public: * * @return An error code * @param[in] ch The Unicode character to locate - * @param[in] startIndex The starting position of search + * @param[in] startIndex The starting position of the search * @param[out] indexOf The index of character * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified character is not found. - * @exception E_OUT_OF_RANGE The specified index is out of range, or - * the specified @c startIndex is either greater than or equal to the length of the current instance or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is out of the valid range. + * - The specified @c startIndex is either greater than or equal to the length of the current instance. + * - The specified @c startIndex is less than @c 0. */ result LastIndexOf(wchar_t ch, int startIndex, int& indexOf) const; @@ -729,13 +759,15 @@ public: * * @return An error code * @param[in] str An instance of %String to locate - * @param[in] startIndex The starting position of search + * @param[in] startIndex The starting position of the search * @param[out] indexOf The index of the substring * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified character is not found. - * @exception E_OUT_OF_RANGE The specified index is out of range, or - * the specified @c startIndex is either greater than or equal to the length of the current instance or less than @c 0. - * @remarks If the substring is empty, E_SUCCESS is returned and the value of @c indexOf is set to @c startIndex. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is out of the valid range. + * - The specified @c startIndex is either greater than or equal to the length of the current instance. + * - The specified @c startIndex is less than @c 0. + * @remarks If the substring is empty, @c E_SUCCESS is returned and the value of @c indexOf is set to @c startIndex. */ result LastIndexOf(const String& str, int startIndex, int& indexOf) const; @@ -748,55 +780,59 @@ public: * @param[in] startIndex The position where the removal begins * @param[in] length The number of characters to remove * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is out of range. @n - * - The specified @c startIndex is either greater than or equal to the length of the current instance or less than @c 0. @n - * - The specified @c count is either greater than the length of substring starting from @c startIndex or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is out of the valid range. + * - The specified @c startIndex is either greater than or equal to the length of the current instance. + * - The specified @c startIndex is less than @c 0. + * - The specified @c count is either greater than the length of the substring starting from @c startIndex. + * - The specified @c count is less than @c 0. */ result Remove(int startIndex, int length); /** - * Replaces all occurrences of the specified characters. + * Replaces all the occurrences of the specified characters. * * @since 2.0 * - * @param[in] original The character to replace - * @param[in] replace The character to replace all occurrences of @c original + * @param[in] original The character to replace + * @param[in] replace The character to replace all the occurrences of @c original */ void Replace(wchar_t original, wchar_t replace); /** - * Replaces all occurrences of the specified string. + * Replaces all the occurrences of the specified string. * * @since 2.0 * * @return An error code * @param[in] original An instance of %String to replace - * @param[in] replace An instance of %String to replace all occurrences of @c original + * @param[in] replace An instance of %String to replace all the occurrences of @c original * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c original is an empty string. */ result Replace(const String& original, const String& replace); /** - * Replaces all occurrences of the specified string within the substring + * Replaces all the occurrences of the specified string within the substring * of this instance of %String. * * @since 2.0 * * @return An error code * @param[in] original An instance of %String to replace - * @param[in] replace An instance of %String to replace all occurrences of @c original + * @param[in] replace An instance of %String to replace all the occurrences of @c original * @param[in] startIndex The starting position of the substring * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c original is an empty string. - * @exception E_OUT_OF_RANGE The specified index is out of range, or - * the specified @c startIndex is either greater than or equal to the length of the current instance or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is out of the valid range. + * - The specified @c startIndex is either greater than or equal to the length of the current instance. + * - The specified @c startIndex is less than @c 0. */ result Replace(const String& original, const String& replace, int startIndex); /** - * Reverses the sequence of characters in the calling instance. + * Reverses the sequence of the characters in the calling instance. * * @since 2.0 * @@ -823,11 +859,13 @@ public: * @since 2.0 * * @return An error code - * @param[in] ch A new character + * @param[in] ch The new character * @param[in] indexAt The position of the character * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is out of range, or - * the specified @c indexAt is either greater than or equal to the length of the current instance or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is out of the valid range. + * - The specified @c indexAt is either greater than or equal to the length of the current instance. + * - The specified @c indexAt is less than @c 0. */ result SetCharAt(wchar_t ch, int indexAt); @@ -840,10 +878,10 @@ public: * @param[in] newLength The new length * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c newLength is negative. - * @remarks If the new length is greater than the current length, the - * string is padded with spaces. On the other hand, - * if the new length is smaller than the current length, then - * the text contained in this instance is truncated. + * @remarks If the new length is greater than the current length, the + * string is padded with spaces. @n + * On the other hand, if the new length is smaller than the current length, then + * the text contained in this instance is truncated. */ result SetLength(int newLength); @@ -856,8 +894,10 @@ public: * @param[in] startIndex The starting index of the substring * @param[out] out The substring * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified index is out of range, or - * the specified @c startIndex is either greater than or equal to the length of the current instance or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is out of the valid range. + * - The specified @c startIndex is either greater than or equal to the length of the current instance. + * - The specified @c startIndex is less than @c 0. */ result SubString(int startIndex, String& out) const; @@ -871,10 +911,12 @@ public: * @param[in] length The length of the substring * @param[out] out The substring * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: @n - * - The specified index is out of range. @n - * - The specified @c startIndex is either greater than or equal to the length of the current instance or less than @c 0. @n - * - The specified @c length is either greater than the length of substring starting from @c startIndex or less than @c 0. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - The specified @c index is out of the valid range. + * - The specified @c startIndex is either greater than or equal to the length of the current instance. + * - The specified @c startIndex is less than @c 0. + * - The specified @c length is either greater than the length of the substring starting from @c startIndex. + * - The specified @c length is less than @c 0. */ result SubString(int startIndex, int length, String& out) const; @@ -883,7 +925,7 @@ public: * * @since 2.0 * - * @return @c true if this instance starts with the specified text, @n + * @return @c true if this instance starts with the specified text, @n * else @c false * @param[in] str The string to match * @param[in] startIndex The start position of the string @@ -895,7 +937,7 @@ public: * * @since 2.0 * - * @return @c true if this instance ends with the specified text, @n + * @return @c true if this instance ends with the specified text, @n * else @c false * @param[in] str An instance of %String to match */ @@ -906,13 +948,13 @@ public: * Gets the lowercase form of the string in the calling instance. @n * Unicode characters other than the English alphabets are not changed. * - * @brief [Deprecated] - * @deprecated This method is deprecated as a new method has been introduced. - * Instead of using this method, use the ToLowerCase(%String& out) method that supports Unicode characters other than the English alphabets. - * @since 2.0 + * @brief [Deprecated] + * @deprecated This method is deprecated as a new method has been introduced. + * Instead of using this method, use the ToLowerCase(%String& out) method that supports Unicode characters other than the English alphabets. + * @since 2.0 * * @return An error code - * @param[out] out An instance of %String that contains the modified value of the calling instance + * @param[out] out An instance of %String that contains the modified value of the calling instance * @exception E_SUCCESS The method is successful. * @endif */ @@ -937,10 +979,10 @@ public: * * @brief [Deprecated] * @deprecated This method is deprecated as a new method has been introduced. - * Instead of using this method, use the ToUpperCase(%String& out) method that supports Unicode characters other than the English alphabets. + * Instead of using this method, use the ToUpperCase(%String& out) method that supports Unicode characters other than the English alphabets. * @since 2.0 * - * @return An error code + * @return An error code * @param[out] out An instance of %String that contains the modified value of the calling instance * @exception E_SUCCESS The method is successful. * @endif @@ -953,7 +995,7 @@ public: * * @since 2.0 * - * @return An error code + * @return An error code * @param[out] out An instance of %String that contains the modified value of the calling instance * @exception E_SUCCESS The method is successful. */ @@ -966,7 +1008,7 @@ public: * * @brief [Deprecated] * @deprecated This method is deprecated as a new method has been introduced. - * Instead of using this method, use the ToLowerCase() method that supports Unicode characters other than the English alphabets. + * Instead of using this method, use the ToLowerCase() method that supports Unicode characters other than the English alphabets. * * @since 2.0 * @endif @@ -988,7 +1030,7 @@ public: * * @brief [Deprecated] * @deprecated This method is deprecated as a new method has been introduced. - * Instead of using this method, use the ToUpperCase() method that supports Unicode characters other than the English alphabets. + * Instead of using this method, use the ToUpperCase() method that supports Unicode characters other than the English alphabets. * * @since 2.0 * @endif @@ -1034,7 +1076,7 @@ public: * @since 2.0 * * @return A Unicode pointer to the calling instance's internal buffer - * @remarks GetPointer() does not guarantee that every call to this function returns same address. + * @remarks GetPointer() does not guarantee that every call to this method returns the same address. */ const wchar_t* GetPointer(void) const; @@ -1043,14 +1085,14 @@ public: * * @since 2.0 * - * @return @c true if this instance contains the specified substring, @n - * else @c false + * @return @c true if this instance contains the specified substring, @n + * else @c false * @param[in] str The string to match */ bool Contains(const String& str) const; /** - * A constant holding the default capacity of %String. + * The constant holding the default capacity of %String. * * @since 2.0 */ diff --git a/inc/FBaseStringComparer.h b/inc/FBaseStringComparer.h index 98bb08f..4f86c01 100644 --- a/inc/FBaseStringComparer.h +++ b/inc/FBaseStringComparer.h @@ -15,12 +15,13 @@ // /** - * @file FBaseStringComparer.h + * @file FBaseStringComparer.h * @brief This is the header file for the %StringComparer class. * - * @see String and Tizen::Base::Collection::IComparer - * * This header file contains the declarations of the %StringComparer class. + * + * @see Tizen::Base::String + * @see Tizen::Base::Collection::IComparer */ #ifndef _FBASE_STRING_COMPARER_H_ #define _FBASE_STRING_COMPARER_H_ @@ -35,11 +36,11 @@ namespace Tizen { namespace Base { /** * @class StringComparer - * @brief This class checks for equivalence between 2 instances of the %String type. + * @brief This class checks for equivalence between two instances of the %String type. * * @since 2.0 * - * The %StringComparer class checks for equivalence between 2 instances of the String type. + * The %StringComparer class checks for equivalence between two instances of the String type. * * For more information on the class features, see Collection Comparisons. * @@ -92,17 +93,17 @@ public: * @since 2.0 * * @return An error code - * @param[in] obj1 An object of String to compare - * @param[in] obj2 An object of String to compare - * @param[out] cmp The result of comparison + * @param[in] obj1 The object of String to compare + * @param[in] obj2 The object of String to compare + * @param[out] cmp The result of the comparison * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified object instances are not of the expected type. * @remarks The value of @c cmp can be: * * @code - * < 0 if the value of @c obj1 is less than the value of @c obj2 - * == 0 if the value of @c obj1 is equal to the value of @c obj2 - * > 0 if the value of @c obj1 is greater than the value of @c obj2 + * < 0 if the value of obj1 is less than the value of obj2 + * == 0 if the value of obj1 is equal to the value of obj2 + * > 0 if the value of obj1 is greater than the value of obj2 * @endcode */ virtual result Compare(const Tizen::Base::Object& obj1, const Tizen::Base::Object& obj2, int& cmp) const; diff --git a/inc/FBaseStringHashCodeProvider.h b/inc/FBaseStringHashCodeProvider.h index 9e98d1e..d84ea7e 100644 --- a/inc/FBaseStringHashCodeProvider.h +++ b/inc/FBaseStringHashCodeProvider.h @@ -91,11 +91,12 @@ public: * * @since 2.1 * - * @return The hash code of an instance of type String + * @return The hash code of the instance of type String * @param[in] str The String instance whose hash code is requested - * @remarks The hash algorithm is usually specific to a type. - * Two equal instances must return the same hash value. - * For better performance, the used hash function must generate a random distribution for all inputs. + * @remarks + * - The hash algorithm is usually specific to a type. + * - Two equal instances must return the same hash value.@n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(const Tizen::Base::String& str) const; @@ -106,9 +107,10 @@ public: * * @return The hash code of the specified object * @param[in] obj The Object whose hash code is requested - * @remarks The hash algorithm is usually specific to a type. - * Two equal instances must return the same hash value. - * For better performance, the used hash function must generate a random distribution for all inputs. + * @remarks + * - The hash algorithm is usually specific to a type. + * - Two equal instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all the inputs. */ virtual int GetHashCode(const Tizen::Base::Object& obj) const; diff --git a/inc/FBaseSysLog.h b/inc/FBaseSysLog.h index ff1ccc6..1a4db0c 100644 --- a/inc/FBaseSysLog.h +++ b/inc/FBaseSysLog.h @@ -18,7 +18,7 @@ * @file FBaseSysLog.h * @brief This is the header file for the %Log macros. * - * This header file defines the %Log macros. + * This header file defines the Log macros. */ #ifndef _FBASE_SYS_LOG_H_ @@ -43,14 +43,14 @@ extern "C" { /** * @mainpage Tizen Platform API Reference * - * The Tizen platform API Reference provides descriptions of APIs for the platform developers. + * The Tizen platform API Reference provides the description of APIs for the platform developers. */ /** * @defgroup GroupMacros Debugging Macros * - * This page describes Tizen debugging macros used by the Tizen modules. - * These debugging macros should use specific NID ( Namespace ID ) to distinguish each Tizen modules. + * This page describes the Tizen debugging macros used by the Tizen modules. + * These debugging macros should use specific NIDs ( Namespace ID ) to distinguish each Tizen module. * * @since 2.0 */ @@ -63,15 +63,15 @@ extern "C" { */ /** - * This macro allows display of informative log messages. + * This macro allows the display of informative log messages. * This system log macro is for the platform modules. * * @since 2.0 * * @param[in] NID The Tizen namespace - * @param[in] ... The message to display + * @param[in] ... The message to display * - * The following example demonstrates how to use the SysLog macro. + * The following example demonstrates how to use the %SysLog macro. * * @code * bool @@ -87,7 +87,7 @@ extern "C" { #define SysLog(NID, ...) SysLogInternal(NID, __PRETTY_FUNCTION__, __LINE__, __VA_ARGS__) /** - * This macro allows display of exception log messages with a tag and sets the last result. + * This macro allows the display of exception log messages with a tag and sets the last result. * This system log macro is for the platform modules. * * @since 2.0 @@ -119,14 +119,14 @@ extern "C" { #define SysLogException(NID, r, ...) SysLogExceptionInternal(NID, r, __PRETTY_FUNCTION__, __LINE__, __VA_ARGS__) /** - * This macro allows display of informative log messages with a tag. + * This macro allows the display of informative log messages with a tag. * This system log macro is for the platform modules. * * @since 2.0 * * @param[in] NID The Tizen namespace * @param[in] tag The user defined tag - * @param[in] ... The message to display + * @param[in] ... The message to display * * The following example demonstrates how to use the SysLogTag macro. * @@ -144,7 +144,7 @@ extern "C" { #define SysLogTag(NID, tag, ...) SysLogTagInternal(NID, tag, __PRETTY_FUNCTION__, __LINE__, __VA_ARGS__) /** - * This macro allows display of exception log messages with a tag and sets the last result. + * This macro allows the display of exception log messages with a tag and sets the last result. * This system log macro is for the platform modules. * * @since 2.0 @@ -152,7 +152,7 @@ extern "C" { * @param[in] NID The Tizen namespace * @param[in] tag The user defined tag * @param[in] r The last result to set - * @param[in] ... The message to display + * @param[in] ... The message to display * * The following example demonstrates how to use the SysLogTagException macro. * @@ -172,13 +172,13 @@ extern "C" { /** - * This macro allows display of informative log message with a tag, when the condition is @c false. + * This macro allows the display of informative log messages with a tag, when the condition is @c false. * This system log macro is for the platform modules. * * @since 2.0 * * @param[in] NID The Tizen namespace - * @param[in] condition The condition that is expected to be true + * @param[in] condition The condition that is expected to be true * @param[in] ... The message to display * * The following example demonstrates how to use the SysTryLog macro. @@ -205,15 +205,15 @@ extern "C" { } while (0); /** - * This macro allows display of informative log message, when the condition is @c false. - * Executes statements and goes to label. + * This macro allows the display of informative log messages, when the condition is @c false. + * Executes statements and goes to the catch label. * This system log macro is for the platform modules. * * @since 2.0 * * @param[in] NID The Tizen namespace - * @param[in] condition The condition that is expected to be true - * @param[in] expr Expressions that are evaluated before going to CATCH label + * @param[in] condition The condition that is expected to be true + * @param[in] expr Expressions that are evaluated before going to the CATCH label * @param[in] ... The message to display * * The following example demonstrates how to use the SysTryLogCatch macro. @@ -244,15 +244,15 @@ extern "C" { } while (0); /** - * This macro allows display of informative log message and returns returnValue, when the condition is @c false. + * This macro allows the display of informative log messages and returns @c returnValue, when the condition is @c false. * This system log macro is for the platform modules. * * @since 2.0 * - * @param[in] NID The Tizen namespace + * @param[in] NID The Tizen namespace * @param[in] condition The condition that is expected to be true - * @param[in] returnValue The value to return when the condition is @c false - * @param[in] ... The message to display + * @param[in] returnValue The value to return when the condition is @c false + * @param[in] ... The message to display * * The following example demonstrates how to use the SysTryLogReturn macro. * @@ -281,14 +281,14 @@ extern "C" { /** - * This macro allows display of exception log message with a tag and sets the last result, when the condition is @c false. + * This macro allows the display of exception log messages with a tag and sets the last result, when the condition is @c false. * This system log macro is for the platform modules. * * @since 2.0 * * @param[in] NID The Tizen namespace - * @param[in] condition The condition that is expected to be true - * @param[in] returnValue The value to return when the condition is @c false + * @param[in] condition The condition that is expected to be true + * @param[in] returnValue The value to return when the condition is @c false * @param[in] r The last result to set * @param[in] ... The message to display * @@ -318,14 +318,14 @@ extern "C" { } while (0); /** - * This macro allows display of exception log message with a tag and sets the last result, when the condition is @c false. + * This macro allows the display of exception log messages with a tag and sets the last result, when the condition is @c false. * This is a shorthand macro for SysTryReturn(NID, condition, r, r, "[" # r "] " ...). * This system log macro is for the platform modules. * * @since 2.0 * * @param[in] NID The Tizen namespace - * @param[in] condition The condition that is expected to be true + * @param[in] condition The condition that is expected to be true * @param[in] r The last result to set * @param[in] ... The message to display * @@ -356,13 +356,13 @@ extern "C" { } while (0); /** - * This macro allows display of exception log message with a tag and sets the last result, when the condition is @c false. + * This macro allows the display of exception log messages with a tag and sets the last result, when the condition is @c false. * This system log macro is for the platform modules. * * @since 2.0 * * @param[in] NID The Tizen namespace - * @param[in] condition The condition that is expected to be true + * @param[in] condition The condition that is expected to be true * @param[in] r The last result to set * @param[in] ... The message to display * @@ -392,15 +392,15 @@ extern "C" { } while (0); /** - * This macro allows display of exception log message with a tag, when the condition is @c false. - * Executes statements, sets the last result and goes to label. + * This macro allows the display of exception log messages with a tag, when the condition is @c false. + * Executes statements, sets the last result and goes to the catch label. * This system log macro is for the platform modules. * * @since 2.0 * * @param[in] NID The Tizen namespace - * @param[in] condition The condition that is expected to be true - * @param[in] expr Expressions that are evaluated before going to CATCH label + * @param[in] condition The condition that is expected to be true + * @param[in] expr Expressions that are evaluated before going to the CATCH label * @param[in] r The last result to set * @param[in] ... The message to display * @@ -432,16 +432,16 @@ extern "C" { } while (0); /** - * This macro allows display of exception log message with a tag, when the condition is @c false. - * Executes statements, sets the last result and goes to label. + * This macro allows the display of exception log messages with a tag, when the condition is @c false. + * Executes statements, sets the last result and goes to the catch label. * This system log macro is for the platform modules. * * @since 2.0 * * @param[in] NID The Tizen namespace - * @param[in] condition The condition that is expected to be true - * @param[in] expr Expressions that are evaluated before going to catchLabel label - * @param[in] catchLabel The label for goto operation + * @param[in] condition The condition that is expected to be true + * @param[in] expr Expressions that are evaluated before going to the CATCH label + * @param[in] catchLabel The label for the goto operation * @param[in] r The last result to set * @param[in] ... The message to display * @@ -474,7 +474,7 @@ extern "C" { /** - * This macro allows display of exception log message and the program will expire, when the condition is @c false. + * This macro allows the display of exception log messages and the program expires, when the condition is @c false. * This system log macro is for the platform modules. * * @since 2.0 @@ -505,12 +505,12 @@ extern "C" { } while (0); /** - * This macro allows display of exception log message with a tag and the program will expire, when the condition is @c false. + * This macro allows the display of exception log messages with a tag and the program expires, when the condition is @c false. * This system log macro is for the platform modules. * * @since 2.0 * - * @param[in] condition The condition that is expected to be true + * @param[in] condition The condition that is expected to be true * @param[in] ... The message to display * * The following example demonstrates how to use the SysAssertf macro. @@ -538,7 +538,7 @@ extern "C" { /** - * This macro generates an error message during compile time, when the condition is @c false. + * This macro generates an error message during the compile time, when the condition is @c false. * This system log macro is for the platform modules. * * @since 2.0 @@ -568,7 +568,7 @@ case condition: \ /** - * This macro allows display of exception log messages. + * This macro allows the display of exception log messages. * This system log macro is for the platform modules. * * @since 2.0 @@ -605,9 +605,9 @@ case condition: \ #else /** - * This macro is to protect informative log messages which needs to keep security. - * It allows display of informative log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, it will be removed in the compile time. + * This macro is used to protect informative log messages which need security. + * It allows the display of informative log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, it is removed in the compile time. * This system log macro is for the platform modules. * * @since 2.1 @@ -631,9 +631,9 @@ case condition: \ #define SysSecureLog(NID, ...) /** - * This macro is to protect exception log messages which needs to keep security, and sets the last result. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * This macro is used to protect exception log messages which needs security, and sets the last result. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * This system log macro is for the platform modules. * * @since 2.1 @@ -665,9 +665,9 @@ case condition: \ #define SysSecureLogException(NID, r,...) SetLastResult(r); /** - * This macro is to protect informative log messages which needs to keep security, with a tag. - * It allows display of informative log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, it will be removed in the compile time. + * This macro is used to protect informative log messages which need security, with a tag. + * It allows the display of informative log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, it is removed in the compile time. * This system log macro is for the platform modules. * * @since 2.1 @@ -692,9 +692,9 @@ case condition: \ #define SysSecureLogTag(NID, tag, ...) /** - * This macro is to protect exception log messages which needs to keep security, with a tag and sets the last result. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * This macro is used to protect exception log messages which need security, with a tag and sets the last result. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * This system log macro is for the platform modules. * * @since 2.1 @@ -722,15 +722,15 @@ case condition: \ #endif /** - * This macro allows display of informative log message with a tag, when the condition is @c false. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * This macro allows the display of informative log messages with a tag, when the condition is @c false. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * This system log macro is for the platform modules. * * @since 2.1 * * @param[in] NID The Tizen namespace - * @param[in] condition The condition that is expected to be true + * @param[in] condition The condition that is expected to be true * @param[in] ... The message to display * * The following example demonstrates how to use the SysSecureTry macro. @@ -757,17 +757,17 @@ case condition: \ } while (0); /** - * This macro allows display of informative log message, when the condition is @c false. - * Executes statements and goes to label. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * This macro allows the display of informative log messages, when the condition is @c false. + * Executes statements and goes to the catch label. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * This system log macro is for the platform modules. * * @since 2.1 * * @param[in] NID The Tizen namespace - * @param[in] condition The condition that is expected to be true - * @param[in] expr Expressions that are evaluated before going to CATCH label + * @param[in] condition The condition that is expected to be true + * @param[in] expr Expressions that are evaluated before going to the CATCH label * @param[in] ... The message to display * @hideinitializer */ @@ -782,16 +782,16 @@ case condition: \ } while (0); /** - * This macro allows display of informative log message and returns returnValue, when the condition is @c false. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * This macro allows the display of informative log messages and returns @c returnValue, when the condition is @c false. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * This system log macro is for the platform modules. * * @since 2.1 * * @param[in] NID The Tizen namespace - * @param[in] condition The condition that is expected to be true - * @param[in] returnValue The value to return when the condition is @c false + * @param[in] condition The condition that is expected to be true + * @param[in] returnValue The value to return when the condition is @c false * @param[in] ... The message to display * @hideinitializer */ @@ -805,16 +805,16 @@ case condition: \ } while (0); /** - * This macro allows display of exception log message with a tag and sets the last result, when the condition is @c false. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * This macro allows the display of exception log messages with a tag and sets the last result, when the condition is @c false. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * This system log macro is for the platform modules. * * @since 2.1 * * @param[in] NID The Tizen namespace - * @param[in] condition The condition that is expected to be true - * @param[in] returnValue The value to return when the condition is @c false + * @param[in] condition The condition that is expected to be true + * @param[in] returnValue The value to return when the condition is @c false * @param[in] r The last result to set * @param[in] ... The message to display * @hideinitializer @@ -830,16 +830,16 @@ case condition: \ #if defined(_SECURE_LOG) /** - * This macro allows display of exception log message with a tag and sets the last result, when the condition is @c false. + * This macro allows the display of exception log messages with a tag and sets the last result, when the condition is @c false. * This is a shorthand macro for SysSecureTryReturn(NID, condition, r, r, "[" # r "] " ...). - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * This system log macro is for the platform modules. * * @since 2.1 * * @param[in] NID The Tizen namespace - * @param[in] condition The condition that is expected to be true + * @param[in] condition The condition that is expected to be true * @param[in] r The last result to set * @param[in] ... The message to display * @hideinitializer @@ -865,15 +865,15 @@ case condition: \ #endif /** - * This macro allows display of exception log message with a tag and sets the last result, when the condition is @c false. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * This macro allows the display of exception log messages with a tag and sets the last result, when the condition is @c false. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * This system log macro is for the platform modules. * * @since 2.1 * * @param[in] NID The Tizen namespace - * @param[in] condition The condition that is expected to be true + * @param[in] condition The condition that is expected to be true * @param[in] r The last result to set * @param[in] ... The message to display * @hideinitializer @@ -888,17 +888,17 @@ case condition: \ } while (0); /** - * This macro allows display of exception log message with a tag, when the condition is @c false. - * Executes statements, sets the last result and goes to label. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * This macro allows the display of exception log messages with a tag, when the condition is @c false. + * Executes statements, sets the last result and goes to the catch label. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * This system log macro is for the platform modules. * * @since 2.1 * * @param[in] NID The Tizen namespace - * @param[in] condition The condition that is expected to be true - * @param[in] expr Expressions that are evaluated before going to CATCH label + * @param[in] condition The condition that is expected to be true + * @param[in] expr Expressions that are evaluated before going to the CATCH label * @param[in] r The last result to set * @param[in] ... The message to display * @hideinitializer @@ -914,18 +914,18 @@ case condition: \ } while (0); /** - * This macro allows display of exception log message with a tag, when the condition is @c false. - * Executes statements, sets the last result and goes to label. - * It allows display of exception log messages if compiled with "_SECURE_LOG" definition. - * Otherwise, log printing functionality will be removed in the compile time. + * This macro allows the display of exception log messages with a tag, when the condition is @c false. + * Executes statements, sets the last result and goes to the catch label. + * It allows the display of exception log messages if compiled with the "_SECURE_LOG" definition. + * Otherwise, the log printing functionality is removed in the compile time. * This system log macro is for the platform modules. * * @since 2.1 * * @param[in] NID The Tizen namespace - * @param[in] condition The condition that is expected to be true - * @param[in] expr Expressions that are evaluated before going to catchLabel label - * @param[in] catchLabel The label for goto operation + * @param[in] condition The condition that is expected to be true + * @param[in] expr Expressions that are evaluated before going to the CATCH label + * @param[in] catchLabel The label for the goto operation * @param[in] r The last result to set * @param[in] ... The message to display * @hideinitializer diff --git a/inc/FBaseTimeSpan.h b/inc/FBaseTimeSpan.h index fd15b5a..fe0a1db 100644 --- a/inc/FBaseTimeSpan.h +++ b/inc/FBaseTimeSpan.h @@ -197,24 +197,24 @@ public: bool operator !=(const TimeSpan& rhs) const; /** - * Checks whether the value of the calling instance is less than that of - * the specified instance of %TimeSpan. + * Checks whether the value of the calling instance is less than + * the value of the specified instance of %TimeSpan. * * @since 2.0 * - * @return @c true if the value of the calling instance is less than that of the specified instance of %TimeSpan, @n + * @return @c true if the value of the calling instance is less than the value of the specified instance of %TimeSpan, @n * else @c false * @param[in] rhs An instance of %TimeSpan to compare */ bool operator <(const TimeSpan& rhs) const; /** - * Checks whether the value of the calling instance is greater than that of - * the specified instance of %TimeSpan. + * Checks whether the value of the calling instance is greater than + * the value of the specified instance of %TimeSpan. * * @since 2.0 * - * @return @c true if the value of the calling instance is greater than that of the specified instance of %TimeSpan, @n + * @return @c true if the value of the calling instance is greater than the value of the specified instance of %TimeSpan, @n * else @c false * @param[in] rhs An instance of %TimeSpan to compare */ @@ -249,14 +249,14 @@ public: * * @since 2.0 * - * @return A 32-bit @c signed integer value + * @return The 32-bit @c signed integer value * @param[in] t1 An instance of %TimeSpan to compare * @param[in] t2 An instance of %TimeSpan to compare * * @code - * < 0 if the value of @c t1 is less than the value of @c t2 - * == 0 if the value of @c t1 is equal to the value of @c t2 - * > 0 if the value of @c t1 is greater than the value of @c t2 + * < 0 if the value of t1 is less than the value of t2 + * == 0 if the value of t1 is equal to the value of t2 + * > 0 if the value of t1 is greater than the value of t2 * @endcode */ static int Compare(const TimeSpan& t1, const TimeSpan& t2); @@ -266,13 +266,13 @@ public: * * @since 2.0 * - * @return A 32-bit @c signed integer value + * @return The 32-bit @c signed integer value * @param[in] value An instance of %TimeSpan to compare * * @code - * < 0 if the value of the current instance is less than the value of @c obj - * == 0 if the value of the current instance is equal to the value of @c obj - * > 0 if the value of the current instance is greater than the value of @c obj + * < 0 if the value of the current instance is less than the value of obj + * == 0 if the value of the current instance is equal to the value of obj + * > 0 if the value of the current instance is greater than the value of obj * @endcode */ int CompareTo(const TimeSpan& value) const; @@ -294,8 +294,8 @@ public: * * @since 2.0 * - * @return An instance of %TimeSpan containing the absolute value - * @remarks This method is used to get absolute difference between two %TimeSpan instances. + * @return An instance of %TimeSpan that contains the absolute value + * @remarks This method is used to get the absolute difference between two %TimeSpan instances. * * @code * TimeSpan t1(1000); // 1000 milliseconds @@ -321,7 +321,7 @@ public: * * @since 2.0 * - * @return An instance of %Timespan containing the negative value of the calling instance + * @return An instance of %Timespan that contains the negative value of the calling instance */ TimeSpan Negate(void) const; @@ -380,28 +380,28 @@ public: long long GetTicks(void) const; /** - * A constant holding the number of ticks in a day. + * The constant holding the number of ticks in a day. * * @since 2.0 */ static const long long NUM_OF_TICKS_IN_DAY = 86400000LL; /** - * A constant holding the number of ticks in an hour. + * The constant holding the number of ticks in an hour. * * @since 2.0 */ static const long long NUM_OF_TICKS_IN_HOUR = 3600000LL; /** - * A constant holding the number of ticks in a minute. + * The constant holding the number of ticks in a minute. * * @since 2.0 */ static const long long NUM_OF_TICKS_IN_MINUTE = 60000LL; /** - * A constant holding the number of ticks in a second. + * The constant holding the number of ticks in a second. * * @since 2.0 */ diff --git a/inc/FBaseTypes.h b/inc/FBaseTypes.h index bac586a..95b6ec5 100644 --- a/inc/FBaseTypes.h +++ b/inc/FBaseTypes.h @@ -40,9 +40,9 @@ namespace Tizen { namespace Base */ enum SortOrder { - SORT_ORDER_ASCENDING = 0, /**< A constant for sorting the results in ascending order */ - SORT_ORDER_DESCENDING, /**< A constant for sorting the results in descending order */ - SORT_ORDER_NONE /**< A constant for indicating the results are not sorted */ + SORT_ORDER_ASCENDING = 0, /**< A constant for sorting the results in the ascending order */ + SORT_ORDER_DESCENDING, /**< A constant for sorting the results in the descending order */ + SORT_ORDER_NONE /**< A constant for indicating that the results are not sorted */ }; @@ -72,8 +72,8 @@ enum StringMatchCriteria */ enum ComparisonOperator { - COMPARISON_OP_EQUAL = 0, /**< A comparison operator that checks the value equality */ - COMPARISON_OP_NOT_EQUAL, /**< A comparison operator that checks the value inequality */ + COMPARISON_OP_EQUAL = 0, /**< A comparison operator that checks the value's equality */ + COMPARISON_OP_NOT_EQUAL, /**< A comparison operator that checks the value's inequality */ COMPARISON_OP_GREATER_THAN, /**< A comparison operator that checks whether a value is greater than the other */ COMPARISON_OP_LESS_THAN, /**< A comparison operator that checks whether a value is less than the other */ COMPARISON_OP_GREATER_THAN_EQUAL_TO, /**< A comparison operator that checks whether a value is greater than or equal to the other */ diff --git a/inc/FBaseUtil.h b/inc/FBaseUtil.h index 70e6974..67e201e 100644 --- a/inc/FBaseUtil.h +++ b/inc/FBaseUtil.h @@ -67,18 +67,18 @@ #include /** - * @namespace Tizen::Base::Utility - * @brief This namespace contains classes for various utilities. + * @namespace Tizen::Base::Utility + * @brief This namespace contains classes for various utilities. * @since 2.0 * * @remarks @b Header @b %file: @b \#include @b @n - * @b Library : @b osp-appfw + * @b Library: @b osp-appfw * * The %Utility namespace contains interfaces and classes that * define various utilities of an object, such as Math and StringTokenizer. - * It also contains methods to perform some common functions needed by the applications, such as file zipping and URL encoding and decoding. + * It also contains methods to perform some common functions needed by applications, such as file zipping, and URL encoding and decoding. * - * For more information on the %Base::Utility namespace features, see Utility. + * For more information on the %Utility namespace features, see Utility. * * The following diagram illustrates the relationships between the classes belonging to the %Utility namespace. * @image html base_utility_namespace_classdiagram.png diff --git a/inc/FBaseUtilDeflator.h b/inc/FBaseUtilDeflator.h index b52f7b8..5aa6431 100644 --- a/inc/FBaseUtilDeflator.h +++ b/inc/FBaseUtilDeflator.h @@ -96,11 +96,11 @@ public: * @return A pointer to the ByteBuffer instance with the deflated equivalent of the source buffer @n * The buffer's limit is the length of the deflated data, @n * else @c null if an exception occurs. - * @param[in] src The buffer to deflate - * @param[in] byteCount The number of bytes to deflate from the source buffer - * @param[in] level Set to @c BEST_SPEED or @c BEST_COMPRESSION @n - * By default, it is set to @c DEFAULT_COMPRESSION. - * @exception E_SUCCESS The method is successful. + * @param[in] src The buffer to deflate + * @param[in] byteCount The number of bytes to deflate from the source buffer + * @param[in] level Set to @c BEST_SPEED or @c BEST_COMPRESSION @n + * By default, it is set to @c DEFAULT_COMPRESSION. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -116,12 +116,12 @@ public: * @return A pointer to the ByteBuffer instance with the deflated equivalent of the source buffer @n * The buffer's limit is the length of the deflated data, @n * else @c null if an exception occurs. - * @param[in] src The buffer to deflate - * @param[in] level Set to @c BEST_SPEED or @c BEST_COMPRESSION @n - * By default, it is set to @c DEFAULT_COMPRESSION. - * @exception E_SUCCESS The method is successful. + * @param[in] src The buffer to deflate + * @param[in] level Set to @c BEST_SPEED or @c BEST_COMPRESSION @n + * By default, it is set to @c DEFAULT_COMPRESSION. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_SYSTEM A system error has occurred. + * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Base::Utility::Inflator */ diff --git a/inc/FBaseUtilFileUnzipper.h b/inc/FBaseUtilFileUnzipper.h index c5bcd58..c4162f3 100644 --- a/inc/FBaseUtilFileUnzipper.h +++ b/inc/FBaseUtilFileUnzipper.h @@ -94,10 +94,10 @@ public: /** * Initializes this instance of %FileUnzipper with the specified filepath. @n - * This method opens a zip file in the read mode. + * The %Construct() method opens a zip file in the read mode. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT @@ -106,15 +106,15 @@ public: * @endif * * @return An error code - * @param [in] filePath The path of the file to open or create - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The length of the specified path is @c 0 or exceeds system limitations. @n - * - The specified path contains prohibited character(s). @n + * @param [in] filePath The path of the file to open or create + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The length of the specified path is either @c 0 or exceeds system limitations. + * - The specified path contains prohibited character(s). * - The specified path is invalid. - * @exception E_ILLEGAL_ACCESS The specified file path is inaccessible as per the %Tizen platform policy. + * @exception E_ILLEGAL_ACCESS The specified @c filePath is inaccessible as per the Tizen platform policy. * @exception E_FILE_NOT_FOUND The specified file cannot be found or accessed. - * @exception E_IO An unexpected device failure has occurred. + * @exception E_IO An unexpected device failure has occurred. * @remarks The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported. * @see Tizen::Io::File */ @@ -124,7 +124,7 @@ public: * Unzips a zip file at the specified path or destination. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT @@ -133,19 +133,21 @@ public: * @endif * * @return An error code - * @param [in] dirPath A directory path to unzip + * @param [in] dirPath The directory path to unzip * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The length of the specified path is @c 0 or exceeds system limitations. @n - * - The specified path contains prohibited character(s). @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The length of the specified path is either @c 0 or exceeds system limitations. + * - The specified path contains prohibited character(s). * - The specified path is invalid. - * @exception E_ILLEGAL_ACCESS The specified path is not permitted, or - * access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: + * - The specified path is not permitted. + * - The access is denied due to insufficient permission. * @exception E_IO An unexpected device failure has occurred. - * @remarks The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported. - * @remarks This operation consumes a lot of time if the zip-archive contains large number of files or - * directories. - * In such cases, it is recommended to call this method in a separate thread. + * @remarks + * - The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported. + * - This operation consumes a lot of time if the zip-archive contains large number of files or + * directories. @n + * In such cases, it is recommended to call this method in a separate thread. * @see Tizen::Io::File */ result UnzipTo(const String& dirPath) const; @@ -154,7 +156,7 @@ public: * Unzips a zip entry from a zip-archive to the specified path. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT @@ -163,22 +165,24 @@ public: * @endif * * @return An error code - * @param [in] dirPath A directory path to unzip - * @param [in] zipEntryName A zip entry name that could be a file or directory name + * @param [in] dirPath The directory path to unzip + * @param [in] zipEntryName The zip entry name that could be a file or a directory name * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The length of the specified path is @c 0 or exceeds system limitations. @n - * - The specified path contains prohibited character(s). @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The length of the specified path is either @c 0 or exceeds system limitations. @n + * - The specified path contains prohibited character(s). * - The specified path is invalid. - * @exception E_ILLEGAL_ACCESS The specified path is not permitted, or - * access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: + * - The specified path is not permitted. + * - The access is denied due to insufficient permission. * @exception E_FILE_NOT_FOUND The entry of the specified file or path cannot be found in the archive. * @exception E_IO An unexpected device failure has occurred. - * @remarks The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported. - * @remarks If the value of @c zipEntryName is a directory name present in the archive, this method + * @remarks + * - The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported. + * - If the value of @c zipEntryName is a directory name present in the archive, this method * creates an empty directory. @n * For example, UnzipTo(Tizen::App::App::GetInstance()->GetAppDataPath() + L"Test/", L"/someDir/") will create @b '[AppDataPath]/Test/someDir' - * directory only, and the files or subdirectories under @b 'someDir' will not be extracted. + * directory only, and the files or subdirectories under @b 'someDir' are not extracted. * @see Tizen::Io::File */ result UnzipTo(const String& dirPath, const String& zipEntryName) const; @@ -223,22 +227,22 @@ public: int GetDirectoryCount(void) const; /** - * Gets a zip entry associated with the file or directory name passed as parameter. + * Gets a zip entry associated with the file or directory name passed as a parameter. * * @since 2.0 * * @return An error code - * @param [in] zipEntryName A zip entry name that could be a file or directory name + * @param [in] zipEntryName The zip entry name that could be a file or directory name * @param [out] entry A reference to the ZipEntry * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The length of the specified path is @c 0 or exceeds system limitations. @n - * - The specified path contains prohibited character(s). @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The length of the specified path is either @c 0 or exceeds system limitations. + * - The specified path contains prohibited character(s). * - The specified path is invalid. * @exception E_FILE_NOT_FOUND The entry of the specified file or path cannot be found in the archive. * @exception E_IO An unexpected device failure has occurred. - * @remarks If the value of @c zipEntryName is a directory name, it must have a suffix '/'. - * For example, @b Tizen::App::App::GetInstance()->GetAppDataPath() + L"Test/" or @b Tizen::App::App::GetInstance()->GetAppDataPath() + L"Test/DATA/". + * @remarks If the value of @c zipEntryName is a directory name, it must have a suffix '/'. @n + * For example, @b Tizen::App::App::GetInstance()->GetAppDataPath() + L"Test/" or @b Tizen::App::App::GetInstance()->GetAppDataPath() + L"Test/DATA/". */ result GetEntry(const String& zipEntryName, ZipEntry& entry) const; @@ -248,11 +252,11 @@ public: * @since 2.0 * * @return An error code - * @param [in] index An index of the zip entry to access @n + * @param [in] index The index of the zip entry to access @n * The index starts from @c 0. * @param [out] entry A reference to the ZipEntry * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified index is out of range, or an invalid index is passed. + * @exception E_INVALID_ARG The specified index is either invalid or out of the valid range. * @exception E_IO An unexpected device failure has occurred. */ result GetEntry(int index, ZipEntry& entry) const; diff --git a/inc/FBaseUtilFileZipper.h b/inc/FBaseUtilFileZipper.h index 709db8a..57621c0 100644 --- a/inc/FBaseUtilFileZipper.h +++ b/inc/FBaseUtilFileZipper.h @@ -84,7 +84,7 @@ public: /** * Initializes this instance of %FileZipper with the specified filepath. @n - * This method opens an existing zip file in append mode. If the file does not exist, it creates and opens the file in + * This method opens an existing zip file in the append mode. If the file does not exist, it creates and opens the file in the * append mode. * * @if OSPCOMPAT @@ -97,15 +97,16 @@ public: * @endif * * @return An error code - * @param [in] filePath The path of the zip file to open or create - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The length of the specified path is @c 0 or exceeds system limitations. @n - * - The specified path contains prohibited character(s). @n + * @param [in] filePath The path of the zip file to open or create + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The length of the specified path is either @c 0 or exceeds system limitations. + * - The specified path contains prohibited character(s). * - The specified path is invalid. - * @exception E_ILLEGAL_ACCESS The specified path is not permitted, or - * access is denied due to insufficient permission. - * @exception E_IO An unexpected device failure has occurred. + * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: + * - The specified path is not permitted. + * - The access is denied due to insufficient permission. + * @exception E_IO An unexpected device failure has occurred. * @remarks The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported. * @see Tizen::Io::File */ @@ -124,27 +125,29 @@ public: * @endif * * @return An error code - * @param [in] filePath The path of the file to add to the zip file - * @param [in] excludePath Set to @c true to exclude the path and to store only the file name, @n - * else @c false to insert the entire path name in the zip-archive - * @param [in] level Set to @c BEST_SPEED or @c BEST_COMPRESSION @n - * By default, it is set to @c DEFAULT_COMPRESSION. - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The length of the specified path is @c 0 or exceeds system limitations. @n - * - The specified path contains prohibited character(s). @n - * - The specified path is invalid. - * @exception E_ILLEGAL_ACCESS The specified path is not permitted, or - * access is denied due to insufficient permission. - * @exception E_FILE_NOT_FOUND The specified file cannot be found. + * @param [in] filePath The path of the file to add to the zip file + * @param [in] excludePath Set to @c true to exclude the path and to store only the file name, @n + * else @c false to insert the entire path name in the zip-archive + * @param [in] level Set to @c BEST_SPEED or @c BEST_COMPRESSION @n + * By default, it is set to @c DEFAULT_COMPRESSION. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The length of the specified path is either @c 0 or exceeds system limitations. + * - The specified path contains prohibited character(s). + * - The specified path is invalid. + * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: + * - The specified path is not permitted. + * - The access is denied due to insufficient permission. + * @exception E_FILE_NOT_FOUND The specified file cannot be found. * @exception E_FILE_ALREADY_EXIST The specified file already exists in the zip-archive, but the * flag for overwriting the file is not set. - * @exception E_IO An unexpected device failure has occurred. - * @remarks The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported. - * @remarks If the value of @c excludePath is set to @c false, full path name is inserted to the zip- + * @exception E_IO An unexpected device failure has occurred. + * @remarks + * - The paths for @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"data" and @b Tizen::App::AppManager::GetAppSharedPath(appId) + L"trusted" are not supported. + * - If the value of @c excludePath is set to @c false, the full path name is inserted to the zip- * archive. Therefore, developers should handle the path name carefully. @n - * For example, if you add @b '/Test/data.txt' file to the zip-archive, and if the - * @c excludePath parameter is set to @c false, while unzipping the file in @b '/Test' + * For example, if you add @b '/Test/data.txt' file to the zip-archive, and if + * @c excludePath is set to @c false, while unzipping the file in @b '/Test' * directory, then the file is extracted in @b '/Test/Test/data.txt'. * @see Tizen::Io::File */ diff --git a/inc/FBaseUtilInflator.h b/inc/FBaseUtilInflator.h index f423982..0318769 100644 --- a/inc/FBaseUtilInflator.h +++ b/inc/FBaseUtilInflator.h @@ -88,11 +88,11 @@ public: * @return A pointer to the ByteBuffer instance with the inflated equivalent of the source buffer @n * The buffer's limit is the length of the inflated data, @n * else @c null if an exception occurs. - * @param[in] src The buffer to inflate - * @param[in] byteCount The number of bytes to inflate from the source buffer - * @exception E_SUCCESS The method is successful. + * @param[in] src The buffer to inflate + * @param[in] byteCount The number of bytes to inflate from the source buffer + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_SYSTEM A system error has occurred. + * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Base::Utility::Deflator */ @@ -106,10 +106,10 @@ public: * @return A pointer to the ByteBuffer instance with the inflated equivalent of the source buffer @n * The buffer's limit is the length of the inflated data, @n * else @c null if an exception occurs. - * @param[in] src The buffer to inflate - * @exception E_SUCCESS The method is successful. + * @param[in] src The buffer to inflate + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_SYSTEM A system error has occurred. + * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Base::Utility::Deflator */ diff --git a/inc/FBaseUtilLinkInfo.h b/inc/FBaseUtilLinkInfo.h index 4515813..76343cc 100644 --- a/inc/FBaseUtilLinkInfo.h +++ b/inc/FBaseUtilLinkInfo.h @@ -77,7 +77,6 @@ public: * @param[in] linkType The link type * @param[in] link The link * @remarks The link's @c text is set to the same string as @c link. - * @see Tizen::Base::Utility::LinkType */ LinkInfo(LinkType linkType, const Tizen::Base::String& link); @@ -88,8 +87,7 @@ public: * * @param[in] linkType The link type * @param[in] link The link - * @param[in] text A string that represents the link - * @see Tizen::Base::Utility::LinkType + * @param[in] text The string that represents the link */ LinkInfo(LinkType linkType, const Tizen::Base::String& link, const Tizen::Base::String& text); @@ -99,7 +97,7 @@ public: * @since 2.0 * * @return A reference to the calling instance - * @param[in] rhs An instance of %LinkInfo + * @param[in] rhs An instance of %LinkInfo to copy */ LinkInfo& operator =(const LinkInfo& rhs); @@ -130,7 +128,6 @@ public: * * @return The link type * @see SetLinkType() - * @see Tizen::Base::Utility::LinkType */ LinkType GetLinkType(void) const; @@ -141,7 +138,6 @@ public: * * @param[in] linkType The link type * @see GetLinkType() - * @see Tizen::Base::Utility::LinkType */ void SetLinkType(LinkType linkType); diff --git a/inc/FBaseUtilMath.h b/inc/FBaseUtilMath.h index f8e48e9..0b17e32 100644 --- a/inc/FBaseUtilMath.h +++ b/inc/FBaseUtilMath.h @@ -29,7 +29,7 @@ namespace Tizen { namespace Base { namespace Utility { /** * @class Math - * @brief This class is the wrapper class for %Math Library. + * @brief This class is the wrapper class for the %Math Library. * * @since 2.0 * @@ -68,43 +68,43 @@ public: static int Abs(int x); /** - * Gets the arc sine of the specified @c double integer. @n + * Gets the arc sine of the specified @c double integer. @n * Returns a value between @c -PI/2 and @c PI/2. * * @since 2.0 * * @return The arc sine of the input, @n - * else Not-a-Number if @c x is out of range + * else Not-a-Number if @c x is out of the valid range * @param[in] x A radian angle @n - * It must be within the range @c -1 to @c 1 (inclusive). + * It must be within the range @c -1 to @c 1 (inclusive). * @see Acos() * @see Atan() */ static double Asin(double x); /** - * Gets the arc cosine of the specified double integer. @n + * Gets the arc cosine of the specified double integer. @n * Returns a value between @c 0 and @c PI. * * @since 2.0 * * @return The arc cosine of the input, @n - * else Not-a-Number if @c x is out of range + * else Not-a-Number if @c x is out of the valid range * @param[in] x A radian angle @n - * It must be within the range @c -1 to @c 1 (inclusive). + * It must be within the range @c -1 to @c 1 (inclusive). * @see Asin() * @see Atan() */ static double Acos(double x); /** - * Gets the arc tangent of the specified @c double integer. @n + * Gets the arc tangent of the specified @c double integer. @n * Returns a value between @c -PI/2 and @c PI/2. * * @since 2.0 * * @return The arc tangent of the input - * @param[in] x A radian angle + * @param[in] x A radian angle * @see Asin() * @see Acos() */ @@ -118,17 +118,17 @@ public: * @since 2.0 * * @return The smallest integer that is greater than or equal to the input - * @param[in] x A floating point value + * @param[in] x A floating point value */ static double Ceiling(double x); /** - * Gets the cosine of the specified @c double integer. @n + * Gets the cosine of the specified @c double integer. @n * Returns a value between @c -1 and @c 1. * * @since 2.0 * - * @return The cosine of the input + * @return The cosine of the input * @param[in] x A radian angle * @see Sin() * @see Tan() @@ -136,7 +136,7 @@ public: static double Cos(double x); /** - * Gets the hyperbolic cosine of the specified @c double integer. + * Gets the hyperbolic cosine of the specified @c double integer. * * @since 2.0 * @@ -146,12 +146,12 @@ public: static double Cosh(double x); /** - * Gets the exponential value of the specified @c double integer. + * Gets the exponential value of the specified @c double integer. * * @since 2.0 * * @return The exponential value of the input - * @param[in] x A floating point value + * @param[in] x A floating point value */ static double Exp(double x); @@ -163,7 +163,7 @@ public: * @since 2.0 * * @return The largest @c double integer that is less than or equal to the input - * @param[in] x A floating point value + * @param[in] x A floating point value */ static double Floor(double x); @@ -173,7 +173,7 @@ public: * @since 2.0 * * @return The natural logarithm of the input - * @param[in] x A floating point value + * @param[in] x A floating point value */ static double Log(double x); @@ -183,7 +183,7 @@ public: * @since 2.0 * * @return The logarithm to the base 10 of the input - * @param[in] x A floating point value + * @param[in] x A floating point value */ static double Log10(double x); @@ -194,8 +194,8 @@ public: * @since 2.0 * * @return The greater of the two integer values - * @param[in] x An integer value - * @param[in] y An integer value + * @param[in] x An integer value + * @param[in] y An integer value * @see Min() */ static int Max(int x, int y); @@ -208,9 +208,9 @@ public: * @since 2.0 * * @return The greater of the two floating point values - * @param[in] x A floating point value - * @param[in] y A floating point value - * @see Min() + * @param[in] x A floating point value + * @param[in] y A floating point value + * @see Min() */ static double Max(double x, double y); @@ -221,8 +221,8 @@ public: * @since 2.0 * * @return The smaller of the two integer values - * @param[in] x An integer value - * @param[in] y An integer value + * @param[in] x An integer value + * @param[in] y An integer value * @see Max() */ static int Min(int x, int y); @@ -235,8 +235,8 @@ public: * @since 2.0 * * @return The smaller of the two @c double values - * @param[in] x A floating point value - * @param[in] y A floating point value + * @param[in] x A floating point value + * @param[in] y A floating point value * @see Max() */ static double Min(double x, double y); @@ -247,11 +247,12 @@ public: * @since 2.0 * * @return @c x raised to the power of @c y, @n - * else Not-a-Number if @c x and @c y do not satisfy the conditions described below - * @param[in] x A floating point value - * @param[in] y A floating point value - * @remarks @li @c x cannot be negative if @c y is a fractional value. - * @li @c x cannot be @c 0 if @c y is less than or equal to @c 0. + * else Not-a-Number if @c x and @c y do not satisfy the conditions described below + * @param[in] x A floating point value + * @param[in] y A floating point value + * @remarks + * - @li @c x cannot be negative if @c y is a fractional value. + * - @li @c x cannot be @c 0 if @c y is less than or equal to @c 0. */ static double Pow(double x, double y); @@ -261,30 +262,30 @@ public: * @since 2.0 * * @return The closest integer to the specified input - * @param[in] x A floating point value + * @param[in] x A floating point value */ static double Round(double x); /** - * Gets the sine of the specified @c double integer. @n + * Gets the sine of the specified @c double integer. @n * Returns a value between @c -1 and @c 1. * * @since 2.0 * * @return The sine of the input - * @param[in] x A radian angle + * @param[in] x A radian angle * @see Cos() * @see Tan() */ static double Sin(double x); /** - * Gets the hyperbolic sine of the specified @c double integer. + * Gets the hyperbolic sine of the specified @c double integer. * * @since 2.0 * * @return The hyperbolic sine of the input - * @param[in] x A radian angle + * @param[in] x A radian angle */ static double Sinh(double x); @@ -294,18 +295,18 @@ public: * @since 2.0 * * @return The square root of the input, @n - * else Not-a-Number if @c x is a negative number - * @param[in] x A non-negative floating point value + * else Not-a-Number if @c x is a negative number + * @param[in] x A non-negative floating point value */ static double Sqrt(double x); /** - * Gets the tangent of the specified @c double integer. + * Gets the tangent of the specified @c double integer. * * @since 2.0 * * @return The tangent of the input - * @param[in] x A radian angle + * @param[in] x A radian angle * @see Sin() * @see Cos() */ @@ -317,7 +318,7 @@ public: * @since 2.0 * * @return The hyperbolic tangent of the input - * @param[in] x A radian angle + * @param[in] x A radian angle */ static double Tanh(double x); @@ -327,7 +328,7 @@ public: * * @since 2.0 * - * @param[in] seed An integer value to use as seed by the pseudo-random number generator algorithm + * @param[in] seed The integer value used as a seed by the pseudo-random number generator algorithm * @see Rand() */ static void Srand(unsigned int seed); @@ -338,14 +339,14 @@ public: * * @since 2.0 * - * @return An integer value between @c 0 and @c RAND_VALUE_MAX + * @return The integer value between @c 0 and @c RAND_VALUE_MAX * @remarks This method uses a seed to generate the pseudo-random numbers, that must be initialized to some distinctive value using Srand(). * @see Srand() */ static int Rand(void); /** - * Gets the constant value of E (the base of natural logarithms). + * Gets the constant value of E (the base of natural logarithms). * * @since 2.0 * @@ -354,7 +355,7 @@ public: static const double GetE(void); /** - * Gets the constant value of PI. + * Gets the constant value of PI. * * @since 2.0 * @@ -363,10 +364,10 @@ public: static const double GetPi(void); /** - * The maximum value that can be returned by the Rand() method. - * - * @since 2.0 - */ + * The maximum value that can be returned by the Rand() method. + * + * @since 2.0 + */ static const int RAND_VALUE_MAX = 32767; // 0x7fff diff --git a/inc/FBaseUtilRegularExpression.h b/inc/FBaseUtilRegularExpression.h index 6231517..186bff5 100644 --- a/inc/FBaseUtilRegularExpression.h +++ b/inc/FBaseUtilRegularExpression.h @@ -39,28 +39,28 @@ namespace Tizen { namespace Base { namespace Utility */ enum RegularExpressionOptions { - REGEX_CASELESS = 0x00000001, /**< The case insensitive match option */ - REGEX_MULTI_LINE = 0x00000002, /**< The multiple lines match option @n - Without this option, (^) matches only at the start of the string, while ($) matches only at - the end of the string, or before a terminating newline. */ - REGEX_DOTALL = 0x00000004, /**< The dot matches newlines option @n - Without this option, a dot does not match when the current position is at a newline. */ + REGEX_CASELESS = 0x00000001, /**< The case insensitive match option */ + REGEX_MULTI_LINE = 0x00000002, /**< The multiple lines match option @n + Without this option, (^) matches only at the start of the string, while ($) matches only at + the end of the string, or before a terminating newline */ + REGEX_DOTALL = 0x00000004, /**< The dot matches newlines option @n + Without this option, a dot does not match when the current position is at a newline */ REGEX_EXTENDED = 0x00000008, /**< The ignored whitespaces in a pattern */ - REGEX_DOLLAR_ENDONLY = 0x00000020, /**< The option to match the dollar symbol ($) only at the end @n - Without this option, a dollar symbol also matches immediately before a newline. */ - REGEX_UNGREEDY = 0x00000200, /**< The option to reverse the (*) and (*?) symbols @n - If this option is set, the quantifiers are not greedy by default, however they are, if followed by a question mark. */ - REGEX_UNICODE = 0x01000000, /**< The option to support the unicode characters @n - Without this option, only the ASCII characters are recognized. */ + REGEX_DOLLAR_ENDONLY = 0x00000020, /**< The option to match the dollar symbol ($) only at the end @n + Without this option, a dollar symbol also matches immediately before a newline */ + REGEX_UNGREEDY = 0x00000200, /**< The option to reverse the (*) and (*?) symbols @n + If this option is set, the quantifiers are not greedy by default, however they are, if followed by a question mark */ + REGEX_UNICODE = 0x01000000, /**< The option to support the unicode characters @n + Without this option, only the ASCII characters are recognized */ }; /** * @class RegularExpression - * @brief This class provides the functionality for a regular expression. + * @brief This class provides the functionality for a regular expression. * * @since 2.0 * - * The %RegularExpression class provides operations of a regular expression based on PCRE and the syntax based on + * The %RegularExpression class provides the operations of a regular expression based on PCRE and the syntax based on * the Perl regular expression. * The various supported operations are Match(), Replace(), and Consume(). * @@ -116,11 +116,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] pattern The pattern to use - * @param[in] options The option for the regular expression - * @exception E_SUCCESS The method is successful. + * @param[in] pattern The pattern to use + * @param[in] options The option for the regular expression + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE This instance has already been constructed. - * @exception E_INVALID_ARG The length of the specified @c pattern parameter is @c 0. + * @exception E_INVALID_ARG The length of the specified @c pattern is @c 0. * * The following example demonstrates how to use the %Construct() method. * @code @@ -144,26 +144,25 @@ public: * * @return @c true if the text matches successfully, @n * else @c false - * @param[in] text The text to match - * @param[in] fullMatch Set to @c true to match exactly, @n - * else @c false to match any substring of the text - * @param[out] pMatchedString A list of the matched string instances @n - * The count of the matched items is acquired from IList::GetCount() and - * the maximum count of the items is @c 16. + * @param[in] text The text to match + * @param[in] fullMatch Set to @c true to match exactly, @n + * else @c false to match any substring of the text + * @param[out] pMatchedString The list of the matched string instances @n + * The count of the matched items is acquired from IList::GetCount() and + * the maximum count of the items is @c 16. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE This instance has not been constructed as yet. - * @exception E_INVALID_ARG The length of the specified @c text parameter is @c 0. + * @exception E_INVALID_ARG The length of the specified @c text is @c 0. * @remarks * - The specific error code can be accessed using the GetLastResult() method. - * - If the grouping subpatterns are used in a pattern, - * the @c pMatchedString list will contain the grouping data. @n + * - If the grouping subpatterns are used in a pattern, the @c pMatchedString list contains the grouping data. @n * For example, if the pattern has two grouping subpatterns, - * there will be three data sets in the @c pMatchedString list. @n - * The first data set will be a full grouping data and the second - * and the third data sets will contain individual grouping data. - * - Because this method returns a new instance through an out-parameter @c pMatchedString, + * there are three data sets in the @c pMatchedString list. + * The first data set contains full grouping data while the second + * and third data set contains individual grouping data. + * Because this method returns a new instance through an out-parameter @c pMatchedString, * the caller needs to delete it after use. @n - * Setting the element deleter of @c pMatchedString to SingleObjectDeleter is recommended. + * - Setting the element deleter of @c pMatchedString to SingleObjectDeleter is recommended. * * The following example demonstrates how to use the %Match() method. * @@ -192,26 +191,27 @@ public: /** * Matches the pattern from the starting point of the text and removes the matched string. @n - * If the pattern does not match the text at the starting point, it will return @c false. + * If the pattern does not match the text at the starting point, it returns @c false. * * @since 2.0 * * @return @c true if the text matches successfully, @n * else @c false - * @param[in, out] text The text to consume - * @param[out] pMatchedString A list of matched string instances @n - * The count of the matched items is acquired from IList::GetCount() and - * the maximum count of the items is @c 16. + * @param[in, out] text The text to consume + * @param[out] pMatchedString The list of matched string instances @n + * The count of the matched items is acquired from IList::GetCount() and + * the maximum count of the items is @c 16. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE This instance has not been constructed as yet. - * @exception E_INVALID_ARG The length of the specified @c text parameter is @c 0. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks If the grouping subpatterns are used in a pattern, the @c pMatchedString list will - * contain the grouping data. @n + * @exception E_INVALID_ARG The length of the specified @c text is @c 0. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - If the grouping subpatterns are used in a pattern, the @c pMatchedString list + * contains grouping data. @n * For example, if the pattern has two grouping subpatterns, - * there will be three data sets in the @c pMatchedString list. @n - * The first data set will be a full grouping data and the second - * and the third data sets will contain individual grouping data. + * there are three data sets in the @c pMatchedString list. @n + * The first data set contains full grouping data while the second + * and the third data set contains individual grouping data. * * The following example demonstrates how to use the %Consume() method. * @code @@ -243,20 +243,21 @@ public: * * @return @c true if the text matches successfully, @n * else @c false - * @param[in, out] text The text to find and consume - * @param[out] pMatchedString A list of matched string instances @n - * The count of the matched items is acquired from IList::GetCount() and - * the maximum count of the items is @c 16. + * @param[in, out] text The text to find and consume + * @param[out] pMatchedString The list of matched string instances @n + * The count of the matched items is acquired from IList::GetCount() and + * the maximum count of the items is @c 16. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE This instance has not been constructed as yet. - * @exception E_INVALID_ARG The length of the specified @c text parameter is @c 0. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks If the grouping subpatterns are used in a pattern, - * the @c pMatchedString list will contain the grouping data. @n + * @exception E_INVALID_ARG The length of the specified @c text is @c 0. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - If the grouping subpatterns are used in a pattern, + * the @c pMatchedString list contains grouping data. @n * For example, if the pattern has two grouping subpatterns, - * there will be three data sets in the @c pMatchedString list. @n - * The first data set will be a full grouping data and the second - * and the third data sets will contain individual grouping data. + * there are three data sets in the @c pMatchedString list. @n + * The first data set contains full grouping data while the second + * and the third data sets contains individual grouping data. * * The following example demonstrates how to use the %FindAndConsume() method. * @@ -289,15 +290,16 @@ public: * * @return @c true if the text is replaced successfully, @n * else @c false - * @param[in, out] text The text to replace when it is matched to a pattern - * @param[in] rewrite The text with which to replace - * @param[in] globalReplace Set to @c true to replace globally, @n - * else @c false to replace the first match of the pattern in the text - * @param[in] startPos The starting position of the text + * @param[in, out] text The text to replace when it is matched to a pattern + * @param[in] rewrite The text with which to replace + * @param[in] globalReplace Set to @c true to replace globally, @n + * else @c false to replace the first match of the pattern in the text + * @param[in] startPos The starting position of the text * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE This instance has not been constructed as yet. - * @exception E_INVALID_ARG The length of the specified @c pattern parameter is @c 0, or - * the size of @c pMatchedString exceeds limitations. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The length of the specified @c pattern is @c 0. + * - The size of @c pMatchedString exceeds the limitations. * @remarks The specific error code can be accessed using the GetLastResult() method. * * The following example demonstrates how to use the %Replace() method. @@ -324,13 +326,14 @@ public: * * @return @c true if the text is extracted successfully, @n * else @c false - * @param[in] text The text to match - * @param[in] rewrite The text to replace - * @param[out] out The text to extract + * @param[in] text The text to match + * @param[in] rewrite The text to replace + * @param[out] out The text to extract * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE This instance has not been constructed as yet. - * @exception E_INVALID_ARG The length of the specified @c pattern parameter is @c 0, or - * the size of @c pMatchedString exceeds limitations. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The length of the specified @c pattern is @c 0. + * - The size of @c pMatchedString exceeds the limitations. * @remarks The specific error code can be accessed using the GetLastResult() method. * * The following example demonstrates how to use the %Extract() method. @@ -377,7 +380,8 @@ public: * * @since 2.0 * - * @return The pattern used to compile the regular expression @n An empty string if this instance is not initialized + * @return The pattern used to compile the regular expression, @n + * else an empty string if this instance is not initialized */ Tizen::Base::String GetPattern(void) const; @@ -386,9 +390,9 @@ public: * * @since 2.0 * - * @param[in] options The logical OR operator values of RegularExpressionOptions + * @param[in] options The logical OR operator values of RegularExpressionOptions * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The value of @c options is invalid. + * @exception E_INVALID_ARG The value of the specified @c options is invalid. */ result SetOptions(unsigned long options); diff --git a/inc/FBaseUtilScanner.h b/inc/FBaseUtilScanner.h index fe9b4fe..ce51fe1 100644 --- a/inc/FBaseUtilScanner.h +++ b/inc/FBaseUtilScanner.h @@ -33,10 +33,10 @@ namespace Tizen { namespace Base { namespace Utility { /** * @class Scanner - * @brief This class provides to parse primitive types and strings, and supports to use regular expressions and various encoding schemes. + * @brief This class provides methods to parse primitive types and strings, and supports the use of regular expressions and various encoding schemes. * @since 2.1 * - * The %Scanner class breaks the input, which can be either a %String instance or strings from a file, into tokens using a delimiter. + * The %Scanner class breaks the input, which can either be a String instance or strings from a file, into tokens using a delimiter. * The delimiter is set to whitespace as a default value. The resulting tokens are converted into values of different types according * to the methods in %Scanner. * @@ -96,9 +96,9 @@ public: * * @since 2.1 * @return An error code - * @param[in] inputStr The string to scan + * @param[in] inputStr The string to scan * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The length of the specified @c string parameter is @c 0. + * @exception E_INVALID_ARG The length of the specified @c string is @c 0. */ result Construct(const String& inputStr); @@ -107,203 +107,203 @@ public: * * @since 2.1 * @return An error code - * @param[in] inputFilePath The file to read to construct input data - * @param[in] encodingScheme The encoding type of the file - * @exception E_SUCCESS The method is successful. + * @param[in] inputFilePath The file to read to construct input data + * @param[in] encodingScheme The encoding type of the file + * @exception E_SUCCESS The method is successful. * @exception E_FILE_NOT_FOUND The input file does not exist. - * @exception E_IO The file operation is invalid. - * @exception E_INVALID_ARG The specified encoding scheme does not exist. + * @exception E_IO The file operation is invalid. + * @exception E_INVALID_ARG The specified encoding scheme does not exist. * @remarks The supported encoding schemes are ASCII, GSM, UCS-2, UCS-2LE, UCS-2BE, UCS-4, UCS-4LE, UCS-4BE, UTF-8, UTF-16, UTF-16LE, UTF-16BE, UTF-32, UTF-32LE, UTF-32BE, ISO-8859-1~16 (except ISO-8859-12), Windows-874, Windows-1250 ~ Windows-1258, KSC5601, BIG5, GB2312, Shift_JIS, and ISO-2022-jp. */ result Construct(const String& inputFilePath, const String& encodingScheme); /** - * Gets the substring of the input data matching to the pattern constructed from the specified string. @n - * Delimiter will be ignored and the returned string does not include any line terminator. - * If such a pattern in the input data is not found upto the next line terminator, return an empty string through the out parameter, matchedStr. + * Gets the substring of the input data matching the pattern constructed from the specified string. @n + * Delimiter is ignored and the returned string does not include any line terminator. + * If such a pattern in the input data is not found upto the next line terminator, the %FindInLine() method returns an empty string through the out parameter, @c matchedStr. * * @since 2.1 * @return An error code * @param[in] patternStr The string to construct the pattern * @param[out] matchedStr The matched string or empty string * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The length of the specified @c string parameter is @c 0. - * @exception E_DATA_NOT_FOUND No substring is found in the input data of current instance. + * @exception E_INVALID_ARG The length of the specified @c string is @c 0. + * @exception E_DATA_NOT_FOUND No substring is found in the input data of the current instance. */ result FindInLine(const String& patternStr, String& matchedStr); /** * Gets the substring matching the pattern from the input data. @n - * Delimiter will be ignored and the returned string does not include any line terminator. - * If such a pattern in the input data is not found upto the next line terminator, return an empty string through the out parameter, matchedStr. + * Delimiter is ignored and the returned string does not include any line terminator. + * If such a pattern in the input data is not found upto the next line terminator, the %FindInLine() method returns an empty string through the out parameter, @c matchedStr. * * @since 2.1 * @return An error code - * @param[in] pattern The pattern to compile for finding substring from input data - * @param[out] matchedStr The matched string or empty string - * @exception E_SUCCESS The method is successful. - * @exception E_DATA_NOT_FOUND No substring is found in the input data of current instance. + * @param[in] pattern The pattern to compile for finding the substring from the input data + * @param[out] matchedStr The matched string or empty string + * @exception E_SUCCESS The method is successful. + * @exception E_DATA_NOT_FOUND No substring is found in the input data of the current instance. */ result FindInLine(const RegularExpression& pattern, String& matchedStr); /** - * Gets the next token as @c signed @c char. @n Next token is converted to @c signed @c char using default radix. - * The @c signed @c char can hold value from -128 to 127. + * Gets the next token as @c signed @c char. @n The next token is converted to a @c signed @c char using a default radix. + * The @c signed @c char can hold values from -128 to 127. * * @since 2.1 * @return An error code - * @param[out] nextSignedChar The next token as a @c signed @c char - * @exception E_SUCCESS The method is successful. - * @exception E_NUM_FORMAT The next token cannot be translated into a valid signed @c char value. - * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner. + * @param[out] nextSignedChar The next token as a @c signed @c char + * @exception E_SUCCESS The method is successful. + * @exception E_NUM_FORMAT The next token cannot be translated into a valid signed @c char value. + * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner. */ result GetNextSignedChar(signed char& nextSignedChar) const; /** - * Gets the next token as @c signed @c char. @n Next token is converted to @c signed @c char using specified @c radix. - * The @c signed @c char can hold value from -128 to 127. + * Gets the next token as @c signed @c char. @n The next token is converted to a @c signed @c char using the specified @c radix. + * The @c signed @c char can hold values from -128 to 127. * * @since 2.1 * @return An error code - * @param[out] nextSignedChar The next token as a @c signed @c char - * @param[in] radix The radix to use for conversion - * @exception E_SUCCESS The method is successful. - * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c signed @c char value. - * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner. + * @param[out] nextSignedChar The next token as a @c signed @c char + * @param[in] radix The radix to use for conversion + * @exception E_SUCCESS The method is successful. + * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c signed @c char value. + * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner. */ result GetNextSignedChar(signed char& nextSignedChar, int radix) const; /** - * Gets the next token as @c int. @n Next token is converted to signed integer using default radix. - * The signed integer can hold value from -2^31 to 2^31-1. + * Gets the next token as @c int. @n The next token is converted to a @c signed integer using a default radix. + * The @c signed integer can hold values from -2^31 to 2^31-1. * * @since 2.1 * @return An error code - * @param[out] nextInt The next token as a signed integer - * @exception E_SUCCESS The method is successful. - * @exception E_NUM_FORMAT The next token cannot be translated into a valid integer value. - * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner. + * @param[out] nextInt The next token as a @c signed integer + * @exception E_SUCCESS The method is successful. + * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c signed integer value. + * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner. */ result GetNextInt(int& nextInt) const; /** - * Gets the next token as @c int. @n Next token is converted to signed integer using specified @c radix. - * The signed integer can hold value from -2^31 to 2^31-1. + * Gets the next token as @c int. @n The next token is converted to a @c signed integer using the specified @c radix. + * The @c signed integer can hold values from -2^31 to 2^31-1. * * @since 2.1 * @return An error code - * @param[out] nextInt The next token as a signed integer - * @param[in] radix The radix to use for conversion - * @exception E_SUCCESS The method is successful. - * @exception E_NUM_FORMAT The next token cannot be translated into a valid integer value. - * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner. + * @param[out] nextInt The next token as a @c signed integer + * @param[in] radix The radix to use for conversion + * @exception E_SUCCESS The method is successful. + * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c signed integer value. + * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner. */ result GetNextInt(int& nextInt, int radix) const; /** - * Gets the next token as @c short. @n Next token is converted to signed @c short using default radix. - * The signed @c short can hold value from -2^15 to 2^15-1. + * Gets the next token as @c short. @n The next token is converted to a @c signed @c short using a default radix. + * The @c signed @c short can hold values from -2^15 to 2^15-1. * * @since 2.1 * @return An error code - * @param[out] nextShort The next token as a signed @c short - * @exception E_SUCCESS The method is successful. - * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c short value. - * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner. + * @param[out] nextShort The next token as a signed @c short + * @exception E_SUCCESS The method is successful. + * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c signed @c short value. + * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner. */ result GetNextShort(short& nextShort) const; /** - * Gets the next token as @c short. @n Next token is converted to signed @c short using specified @c radix. - * The signed @c short can hold value from -2^15 to 2^15-1. + * Gets the next token as @c short. @n The next token is converted to a @c signed @c short using the specified @c radix. + * The @c signed @c short can hold values from -2^15 to 2^15-1. * * @since 2.1 * @return An error code - * @param[out] nextShort The next token as a signed @c short - * @param[in] radix The radix to use for conversion - * @exception E_SUCCESS The method is successful. - * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c short value. - * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner. + * @param[out] nextShort The next token as a @c signed @c short + * @param[in] radix The radix to use for conversion + * @exception E_SUCCESS The method is successful. + * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c signed @c short value. + * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner. */ result GetNextShort(short& nextShort, int radix) const; /** - * Gets the next token as @c long @c long. @n Next token is converted to signed @c long @c long using default radix. - * The signed @c long @c long can hold value from -2^63 to 2^63-1. + * Gets the next token as @c long @c long. @n The next token is converted to a @c signed @c long @c long using a default radix. + * The @c signed @c long @c long can hold values from -2^63 to 2^63-1. * * @since 2.1 * @return An error code - * @param[out] nextLongLong The next token as a signed @c long @c long - * @exception E_SUCCESS The method is successful. - * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c long @c long value. - * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner. + * @param[out] nextLongLong The next token as a @c signed @c long @c long + * @exception E_SUCCESS The method is successful. + * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c signed @c long @c long value. + * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner. */ result GetNextLongLong(long long& nextLongLong) const; /** - * Gets the next token as @c long @c long. @n Next token is converted to signed @c long @c long using specified @c radix. - * The signed @c long @c long can hold value from -2^63 to 2^63-1. + * Gets the next token as @c long @c long. @n The next token is converted to a @c signed @c long @c long using the specified @c radix. + * The @c signed @c long @c long can hold values from -2^63 to 2^63-1. * * @since 2.1 * @return An error code - * @param[out] nextLongLong The next token as a signed @c long @c long - * @param[in] radix The radix to use for conversion - * @exception E_SUCCESS The method is successful. - * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c long @c long value. - * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner. + * @param[out] nextLongLong The next token as a @c signed @c long @c long + * @param[in] radix The radix to use for conversion + * @exception E_SUCCESS The method is successful. + * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c signed @c long @c long value. + * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner. */ result GetNextLongLong(long long& nextLongLong, int radix) const; /** - * Gets the next token as @c float. @n Next token is converted to @c float. - * The signed @c float can hold a single-precision 32-bit floating number. + * Gets the next token as @c float. @n The next token is converted to @c float. + * The @c signed @c float can hold a single-precision 32-bit floating number. * * @since 2.1 * @return An error code - * @param[out] nextFloat The next token as a @c float - * @exception E_SUCCESS The method is successful. - * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c float value. - * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner. + * @param[out] nextFloat The next token as a @c float + * @exception E_SUCCESS The method is successful. + * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c float value. + * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner. */ result GetNextFloat(float& nextFloat) const; /** - * Gets the next token as @c double. @n Next token is converted to @c double. + * Gets the next token as @c double. @n The next token is converted to @c double. * The signed @c double can hold a double-precision 64-bit floating number. * * @since 2.1 * @return An error code - * @param[out] nextDouble The next token as a @c double - * @exception E_SUCCESS The method is successful. - * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c double value. - * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner. + * @param[out] nextDouble The next token as a @c double + * @exception E_SUCCESS The method is successful. + * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c double value. + * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner. */ result GetNextDouble(double& nextDouble) const; /** - * Gets the next token as @c bool. @n Next token is converted to boolean. + * Gets the next token as @c bool. @n The next token is converted to boolean. * Nothing can be converted, except true/TRUE or false/FALSE. * * @since 2.1 * @return An error code - * @param[out] nextBool The next token as @c bool - * @exception E_SUCCESS The method is successful. - * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c bool value. - * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner. + * @param[out] nextBool The next token as @c bool + * @exception E_SUCCESS The method is successful. + * @exception E_NUM_FORMAT The next token cannot be translated into a valid @c bool value. + * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner. */ result GetNextBool(bool& nextBool) const; /** - * Gets the input string up to next line delimiter and advances the %Scanner to the beginning of the next line. @n + * Gets the input string up to the next line delimiter and advances the %Scanner to the beginning of the next line. @n * The returned string does not include any line terminator. * * @since 2.1 * @return An error code - * @param[out] nextLine The next line as an instance of String - * @exception E_SUCCESS The method is successful. - * @exception E_DATA_NOT_ENOUGH There are no remaining lines for the current instance of %Scanner. + * @param[out] nextLine The next line as an instance of String + * @exception E_SUCCESS The method is successful. + * @exception E_DATA_NOT_ENOUGH There are no lines remaining for the current instance of %Scanner. * * The following example demonstrates how to use the %GetNextLine() method. * @@ -334,9 +334,9 @@ public: * * @since 2.1 * @return An error code - * @param[out] nextTok The next token as an instance of String - * @exception E_SUCCESS The method is successful. - * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner. + * @param[out] nextTok The next token as an instance of String + * @exception E_SUCCESS The method is successful. + * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner. * * The following example demonstrates how to use the %GetNextToken() method. * @code @@ -364,30 +364,30 @@ public: result GetNextToken(String& nextTok) const; /** - * Gets the next token as String if it matches to the pattern constructed from the specified string. + * Gets the next token as String if it matches the pattern constructed from the specified string. * * @since 2.1 * @return An error code - * @param[in] pattern The string to construct the pattern - * @param[out] nextTok The next token as an instance of String, @n - * else an empty string if not matched - * @exception E_SUCCESS The method is successful. - * @exception E_DATA_NOT_FOUND The next token does not match to the pattern. - * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner. + * @param[in] pattern The string from which to construct the pattern + * @param[out] nextTok The next token as an instance of String, @n + * else an empty string if it is does not match + * @exception E_SUCCESS The method is successful. + * @exception E_DATA_NOT_FOUND The next token does not match the pattern. + * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner. */ result GetNextToken(const String& pattern, String& nextTok) const; /** - * Gets the next token as String if it matches to the pattern. + * Gets the next token as String if it matches the pattern. * * @since 2.1 * @return An error code - * @param[in] pattern The pattern to find. - * @param[out] nextTok The next token as an instance of String, @n - * else an empty string if not matched - * @exception E_SUCCESS The method is successful. - * @exception E_DATA_NOT_FOUND The next token does not match to the pattern. - * @exception E_DATA_NOT_ENOUGH There are no remaining tokens for the current instance of %Scanner. + * @param[in] pattern The pattern to find + * @param[out] nextTok The next token as an instance of String, @n + * else an empty string if it is does not match + * @exception E_SUCCESS The method is successful. + * @exception E_DATA_NOT_FOUND The next token does not match the pattern. + * @exception E_DATA_NOT_ENOUGH There are no tokens remaining for the current instance of %Scanner. */ result GetNextToken(const RegularExpression& pattern, String& nextTok) const; @@ -412,110 +412,110 @@ public: * * @since 2.1 * @return @c true if the current instance has another token, @n - * else @c false + * else @c false */ bool HasNextToken(void) const; /** - * Checks whether the next token matches to the pattern constructed from the specified string. + * Checks whether the next token matches the pattern constructed from the specified string. * * @since 2.1 - * @return @c true if the next token matches to the pattern constructed from the specified string, @n - * else @c false + * @return @c true if the next token matches the pattern constructed from the specified string, @n + * else @c false * @param[in] pattern The string to construct the pattern */ bool HasNextToken(const String& pattern) const; /** - * Checks whether the next token matches to the pattern. + * Checks whether the next token matches the pattern. * * @since 2.1 - * @return @c true if the next token matches to the pattern, @n - * else @c false + * @return @c true if the next token matches the pattern, @n + * else @c false * @param[in] pattern The pattern to find */ bool HasNextToken(const RegularExpression& pattern) const; /** * Checks whether the next token can be translated into a valid @c signed @c char value in the default radix. - * The @c signed @c char can hold value from -128 to 127. + * The @c signed @c char can hold values from -128 to 127. * * @since 2.1 * @return @c true if the next token can be translated into a valid @c signed @c char value in the current radix, @n - * else @c false + * else @c false */ bool IsNextTokenConvertibleToSignedChar(void) const; /** * Checks whether the next token can be translated into a valid @c signed @c char value in the specified @c radix. - * The @c signed @c char can hold value from -128 to 127. + * The @c signed @c char can hold values from -128 to 127. * * @since 2.1 * @return @c true if the next token can be translated into a valid @c signed @c char value in the current radix, @n - * else @c false - * @param[in] radix The radix to use to translate the token as a valid @c signed @c char value + * else @c false + * @param[in] radix The radix used to translate the token as a valid @c signed @c char value */ bool IsNextTokenConvertibleToSignedChar(int radix) const; /** * Checks whether the next token can be translated into a valid @c int value in the default radix. @n - * The signed integer can hold value from -2^31 to 2^31-1. + * The @c signed integer can hold values from -2^31 to 2^31-1. * * @since 2.1 - * @return @c true if the next token can be translated into a valid @c int value in the current radix, @n - * else @c false + * @return @c true if the next token can be translated into a valid @c int value in the current radix, @n + * else @c false */ bool IsNextTokenConvertibleToInt(void) const; /** * Checks whether the next token can be translated into a valid @c int value in the specified @c radix. @n - * The signed integer can hold value from -2^31 to 2^31-1. + * The @c signed integer can hold values from -2^31 to 2^31-1. * * @since 2.1 * @return @c true if the next token can be translated into a valid @c int value in the current radix, @n - * else @c false - * @param[in] radix The radix to use to translate the token as a valid @c int value + * else @c false + * @param[in] radix The radix used to translate the token as a valid @c int value */ bool IsNextTokenConvertibleToInt(int radix) const; /** * Checks whether the next token can be translated into a valid @c short value in the default radix. @n - * The signed @c short can hold value from -2^15 to 2^15-1. + * The @c signed @c short can hold values from -2^15 to 2^15-1. * * @since 2.1 - * @return @c true if the next token can be translated into a valid @c short value in the current radix, @n - * else @c false + * @return @c true if the next token can be translated into a valid @c short value in the current radix, @n + * else @c false */ bool IsNextTokenConvertibleToShort(void) const; /** * Checks whether the next token can be translated into a valid @c short value in the specified @c radix. @n - * The signed @c short can hold value from -2^15 to 2^15-1. + * The @c signed @c short can hold values from -2^15 to 2^15-1. * * @since 2.1 * @return @c true if the next token can be translated into a valid @c short value in the current radix, @n - * else @c false - * @param[in] radix The radix to use to translate the token as a valid @c short value + * else @c false + * @param[in] radix The radix used to translate the token as a valid @c short value */ bool IsNextTokenConvertibleToShort(int radix) const; /** * Checks whether the next token can be translated into a valid @c long @c long value. @n - * The signed @c long @c long can hold value from -2^63 to 2^63-1. + * The @c signed @c long @c long can hold value from -2^63 to 2^63-1. * * @since 2.1 * @return @c true if the next token can be translated into a valid @c long @c long value in the current radix, @n - * else @c false + * else @c false */ bool IsNextTokenConvertibleToLongLong(void) const; /** * Checks whether the next token can be translated into a valid @c float value. @n - * The signed @c float can hold a single-precision 32-bit floating number. + * The @c signed @c float can hold a single-precision 32-bit floating number. * * @since 2.1 * @return @c true if the next token can be translated into a valid @c float value in the current radix, @n - * else @c false + * else @c false */ bool IsNextTokenConvertibleToFloat(void) const; @@ -525,7 +525,7 @@ public: * * @since 2.1 * @return @c true if the next token can be translated into a valid @c double value in the current radix, @n - * else @c false + * else @c false */ bool IsNextTokenConvertibleToDouble(void) const; @@ -535,7 +535,7 @@ public: * * @since 2.1 * @return @c true if the next token can be translated into a valid @c bool value, @n - * else @c false + * else @c false */ bool IsNextTokenConvertibleToBool(void) const; @@ -544,7 +544,7 @@ public: * * @since 2.1 * @return @c true if the input data of the current instance of %Scanner has another line, @n - * else @c false + * else @c false */ bool HasNextLine(void) const; diff --git a/inc/FBaseUtilStringTokenizer.h b/inc/FBaseUtilStringTokenizer.h index d880cc6..2c998f7 100644 --- a/inc/FBaseUtilStringTokenizer.h +++ b/inc/FBaseUtilStringTokenizer.h @@ -18,9 +18,9 @@ * @file FBaseUtilStringTokenizer.h * @brief This is the header file for the %StringTokenizer class. * - * @see String() - * * This header file contains the declarations of the %StringTokenizer class. + * + * @see Tizen::Base::String */ #ifndef _FBASE_UTIL_STRING_TOKENIZER_H_ @@ -83,7 +83,7 @@ public: * * @param[in] value An instance of String to parse * @param[in] delimiters The delimiters - * @param[in] isToken A flag indicating whether to return the delimiters as tokens @n + * @param[in] isToken The flag that indicates whether to return the delimiters as tokens @n * Set to @c true to treat the delimiters as tokens, @n * else @c false to skip the delimiters. * @@ -100,11 +100,11 @@ public: virtual ~StringTokenizer(void); /** - * Gets the token count indicating the number of times the GetNextToken() method can be called before it returns an error code. + * Gets the token count that indicates the number of times the %GetNextToken() method can be called before it returns an error code. * * @since 2.0 * - * @return An integer value indicating the number of times the GetNextToken() method can be called + * @return The integer value that indicates the number of times the GetNextToken() method can be called */ int GetTokenCount(void); @@ -124,7 +124,7 @@ public: * @since 2.0 * * @return An error code - * @param[out] token The next token + * @param[out] token The next token * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_RANGE The string tokenizer has no more tokens. */ @@ -136,7 +136,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] delimiters The new delimiters + * @param[in] delimiters The new delimiters * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * diff --git a/inc/FBaseUtilStringUtil.h b/inc/FBaseUtilStringUtil.h index 128cdd3..31d7dd8 100644 --- a/inc/FBaseUtilStringUtil.h +++ b/inc/FBaseUtilStringUtil.h @@ -33,11 +33,11 @@ namespace Tizen { namespace Base { namespace Utility { /** * @class StringUtil - * @brief This class provides various utility methods for %String. + * @brief This class provides utility methods for %String operations. * * @since 2.0 * - * The %StringUtil class provides various utility methods for String. + * The %StringUtil class provides utility methods for String operations. * * For more information on the class features, see Utility. * @@ -81,17 +81,18 @@ public: * Converts an McharBuffer to a null-terminated string. @n * The position of the buffer is not changed. * - * @brief [Deprecated] - * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. - * Instead of using this method, use the WcharBufferToString(const WcharBuffer& mb, String& str) method. - * @since 2.0 + * @brief [Deprecated] + * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. + * Instead of using this method, use the WcharBufferToString(const WcharBuffer& mb, String& str) method. + * @since 2.0 * * @return An error code - * @param[in] mb An instance of McharBuffer - * @param[out] str The current position + * @param[in] mb An instance of McharBuffer + * @param[out] str The null-terminated string * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * @c null does not exist between the position and limit of buffer. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - @c null does not exist between the position and limit of buffer. * @endif */ static result MbToString(const McharBuffer& mb, String& str); @@ -100,14 +101,15 @@ public: * Converts an WcharBuffer to a null-terminated string. @n * The position of the buffer is not changed. * - * @since 2.0 + * @since 2.0 * * @return An error code * @param[in] wb An instance of WcharBuffer - * @param[out] str The current position + * @param[out] str The null-terminated string * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * @c null does not exist between the position and limit of buffer. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - @c null does not exist between the position and limit of buffer. */ static result WcharBufferToString(const WcharBuffer& wb, String& str); @@ -116,10 +118,10 @@ public: * Gets a new McharBuffer from the specified string. @n * The buffer's limit is the length of the string plus one and the starting position is @c 0. * - * @brief [Deprecated] - * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. - * Instead of using this method, use the StringToWcharBufferN(const String& str) method. - * @since 2.0 + * @brief [Deprecated] + * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. + * Instead of using this method, use the StringToWcharBufferN(const String& str) method. + * @since 2.0 * * @return A pointer to the McharBuffer instance from the specified string, @n * else @c null if an exception occurs @@ -135,7 +137,7 @@ public: * Gets a new WcharBuffer from the specified string. @n * The buffer's limit is the length of the string plus one and the starting position is @c 0. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the WcharBuffer instance from the specified string, @n * else @c null if an exception occurs @@ -151,10 +153,10 @@ public: * Gets a new McharBuffer from a substring of the specified string. @n * The buffer's limit is the length of the string plus one and the starting position is @c 0. * - * @brief [Deprecated] - * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. - * Instead of using this method, use the StringToWcharBufferN(const String& str, int index, int length) method. - * @since 2.0 + * @brief [Deprecated] + * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. + * Instead of using this method, use the StringToWcharBufferN(const String& str, int index, int length) method. + * @since 2.0 * * @return A pointer to the McharBuffer instance from the substring of the specified string, @n * else @c null if an exception occurs @@ -193,13 +195,13 @@ public: /** * @if OSPDEPREC - * Gets the string length in the McharBuffer. @n + * Gets the string length in the specified McharBuffer. @n * The string length is the length from the current position of the %McharBuffer to the @c null character. * The position of the buffer is not changed. * - * @brief [Deprecated] - * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. - * Instead of using this method, use the GetStringLengthInWcharBuffer(const WcharBuffer& wb) method. + * @brief [Deprecated] + * @deprecated This method is deprecated as @c mchar type is changed to @c wchar_t type. + * Instead of using this method, use the GetStringLengthInWcharBuffer(const WcharBuffer& wb) method. * * @since 2.0 * @@ -212,7 +214,7 @@ public: static int GetStringLengthInMb(const McharBuffer& mb); /** - * Gets the string length in the WcharBuffer. @n + * Gets the string length in the specified WcharBuffer. @n * The string length is the length from the current position of the %WcharBuffer to the @c null character. * The position of the buffer is not changed. * @@ -233,12 +235,10 @@ public: * * @return A pointer to the ByteBuffer instance encoded from the specified string, @n * else @c null if an exception occurs - * @param[in] unicodeString A string to encode + * @param[in] unicodeString The string to encode * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. - * @see Tizen::Base::ByteBuffer - * @see Tizen::Base::String */ static ByteBuffer* StringToUtf8N(const String& unicodeString); @@ -249,7 +249,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] pUtf8String A pointer to a String instance containing UTF-8 codes + * @param[in] pUtf8String A pointer to the String instance containing UTF-8 codes * @param[out] unicodeString A string containing Unicode characters * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c pUtf8String is a @c null reference. @@ -278,7 +278,7 @@ public: * * @return A pointer to the ByteBuffer instance decoded from the specified string, @n * else @c null if an exception occurs - * @param[in] base64String A string to decode + * @param[in] base64String The string to decode * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. @n * The specified @c base64String is not a valid Base64 string. @@ -314,11 +314,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] buffer An instance of ByteBuffer to encode - * @param[out] encodedString An instance of String consisting of base 64 characters + * @param[in] buffer An instance of ByteBuffer to encode + * @param[out] encodedString An instance of String consisting of base 64 characters * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the @c buffer is empty. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The @c buffer is empty. * * The following example demonstrates how to use the %EncodeToBase64String() method. * diff --git a/inc/FBaseUtilTypes.h b/inc/FBaseUtilTypes.h index 7b80631..6520e1a 100644 --- a/inc/FBaseUtilTypes.h +++ b/inc/FBaseUtilTypes.h @@ -37,9 +37,9 @@ namespace Tizen { namespace Base { namespace Utility */ enum CompressionLevel { - BEST_SPEED = 0, /**< For best speed */ - BEST_COMPRESSION, /**< For best compression */ - DEFAULT_COMPRESSION /**< For average speed and average compression */ + BEST_SPEED = 0, /**< The compression level for best speed */ + BEST_COMPRESSION, /**< The compression level for best compression */ + DEFAULT_COMPRESSION /**< The compression level for average speed and average compression */ }; diff --git a/inc/FBaseUtilUri.h b/inc/FBaseUtilUri.h index 74593fc..795909c 100644 --- a/inc/FBaseUtilUri.h +++ b/inc/FBaseUtilUri.h @@ -33,13 +33,13 @@ namespace Tizen { namespace Base { namespace Utility /** * @class Uri - * @brief This class provides useful methods for URI. + * @brief This class provides methods for managing URI. * * @since 2.0 * - * The %Uri class represents a Uniform Resource Identifier (URI) as defined by RFC2396 and provides accessors - * which access the URI component. - * It also provides methods for creating, accessing, normalizing, resolving, and relativizing %Uri instances. + * The %Uri class represents a Uniform Resource Identifier (URI) as defined by RFC2396 and provides methods + * for managing URI. + * The %Uri class provides methods for creating, accessing, normalizing, resolving, and relativizing %Uri instances. * * For more information on the class features, see URI. * @@ -104,21 +104,21 @@ public: virtual ~Uri(void); /** - * Sets the current %Uri instance to the value of the specified instance of %Uri. + * Sets the current %Uri instance with the value of the specified %Uri instance. * * @since 2.0 * - * @param[in] uri An instance of %Uri + * @param[in] uri An instance of %Uri to set */ void SetUri(const Uri& uri); /** - * Sets the current %Uri instance by parsing a given string. + * Sets the current %Uri instance by parsing the specified string. * * @since 2.0 * * @return An error code - * @param[in] str A string to parse into a URI + * @param[in] str The string to parse for URI value * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c str is an empty string. * @exception E_INVALID_FORMAT The specified @c str violates the URI syntax (RFC 2396). @@ -126,16 +126,16 @@ public: result SetUri(const Tizen::Base::String& str); /** - * Sets an absolute %Uri instance with given components. + * Sets an absolute %Uri instance with specified components. * * @since 2.0 * * @return An error code - * @param[in] scheme The scheme - * @param[in] ssp The scheme-specific-part - * @param[in] fragment The fragment + * @param[in] scheme The scheme + * @param[in] ssp The scheme-specific-part + * @param[in] fragment The fragment * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_FORMAT A component violates the URI syntax(RFC 2396). + * @exception E_INVALID_FORMAT A specified component violates the URI syntax(RFC 2396). */ result SetUri(const Tizen::Base::String& scheme, const Tizen::Base::String& ssp, const Tizen::Base::String& fragment); @@ -145,15 +145,15 @@ public: * @since 2.0 * * @return An error code - * @param[in] scheme The scheme - * @param[in] userInfo The user name and authorization - * @param[in] host The host name - * @param[in] port The port number - * @param[in] path The path - * @param[in] query The query - * @param[in] fragment The fragment + * @param[in] scheme The scheme + * @param[in] userInfo The user name and authorization + * @param[in] host The host name + * @param[in] port The port number + * @param[in] path The path + * @param[in] query The query + * @param[in] fragment The fragment * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_FORMAT A component violates the URI syntax(RFC 2396). + * @exception E_INVALID_FORMAT A specified component violates the URI syntax(RFC 2396). */ result SetUri(const Tizen::Base::String& scheme, const Tizen::Base::String& userInfo, const Tizen::Base::String& host, int port, const Tizen::Base::String& path, const Tizen::Base::String& query, const Tizen::Base::String& fragment); @@ -163,12 +163,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] scheme The scheme - * @param[in] host The host name - * @param[in] path The path - * @param[in] fragment The fragment + * @param[in] scheme The scheme + * @param[in] host The host name + * @param[in] path The path + * @param[in] fragment The fragment * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_FORMAT A component violates the URI syntax(RFC 2396). + * @exception E_INVALID_FORMAT A specified component violates the URI syntax(RFC 2396). * @remarks The authority and query component are left empty, and the port is set to @c -1. */ result SetUri(const Tizen::Base::String& scheme, const Tizen::Base::String& host, const Tizen::Base::String& path, const Tizen::Base::String& fragment); @@ -179,13 +179,13 @@ public: * @since 2.0 * * @return An error code - * @param[in] scheme The scheme - * @param[in] authority The authority - * @param[in] path The path - * @param[in] query The query - * @param[in] fragment The fragment + * @param[in] scheme The scheme + * @param[in] authority The authority + * @param[in] path The path + * @param[in] query The query + * @param[in] fragment The fragment * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_FORMAT A component violates the URI syntax(RFC 2396). + * @exception E_INVALID_FORMAT A specified component violates the URI syntax(RFC 2396). */ result SetUri(const Tizen::Base::String& scheme, const Tizen::Base::String& authority, const Tizen::Base::String& path, const Tizen::Base::String& query, const Tizen::Base::String& fragment); @@ -207,7 +207,7 @@ public: * @return The value of the authority component, @n * else an empty string if the authority component is undefined * @remarks The string returned by this method is equal to the string returned by GetEncodedAuthority(), - * except that all sequences of the escaped octets are decoded. + * except that all the sequences of the escaped octets are decoded. */ Tizen::Base::String GetAuthority(void) const; @@ -219,7 +219,7 @@ public: * @return The value of the fragment component, @n * else an empty string if the fragment component is undefined * @remarks The string returned by this method is equal to the string returned by GetEncodedFragment(), - * except that all sequences of the escaped octets are decoded. + * except that all the sequences of the escaped octets are decoded. */ Tizen::Base::String GetFragment(void) const; @@ -241,7 +241,7 @@ public: * @return The value of the path component, @n * else an empty string if the path component is undefined * @remarks The string returned by this method is equal to the string returned by GetEncodedPath(), - * except that all sequences of the escaped octets are decoded. + * except that all the sequences of the escaped octets are decoded. */ Tizen::Base::String GetPath(void) const; @@ -265,7 +265,7 @@ public: * @return The value of the query component, @n * else an empty string if the query component is undefined * @remarks The string returned by this method is equal to the string returned by GetEncodedQuery(), - * except that all sequences of the escaped octets are decoded. + * except that all the sequences of the escaped octets are decoded. */ Tizen::Base::String GetQuery(void) const; @@ -289,7 +289,7 @@ public: * @return The value of the scheme-specific-part component, @n * else an empty string if the scheme-specific-part component is undefined * @remarks The string returned by this method is equal to the string returned by GetEncodedSchemeSpecificPart(), - * except that all sequences of the escaped octets are decoded. + * except that all the sequences of the escaped octets are decoded. */ Tizen::Base::String GetSchemeSpecificPart(void) const; @@ -302,7 +302,7 @@ public: * @return The value of the user-info component, @n * else an empty string if the user-info component is undefined * @remarks The string returned by this method is equal to the string returned by GetEncodedUserInfo(), - * except that all sequences of the escaped octets are decoded. + * except that all the sequences of the escaped octets are decoded. */ Tizen::Base::String GetUserInfo(void) const; @@ -391,7 +391,7 @@ public: /** - * Checks whether the calling %Uri instance is an opaque URI. + * Checks whether the current %Uri instance is an opaque URI. * * @since 2.0 * @@ -425,7 +425,7 @@ public: Tizen::Base::String GetEncodedString(void) const; /** - * Compares the calling URI instance to the specified %Uri instance. @n + * Compares the current URI instance with the specified %Uri instance. @n * When comparing corresponding components of two URIs, if one component in the current instance is undefined * but the other is defined, then the current instance is considered to be less than the given object. * @@ -437,7 +437,7 @@ public: * = 0 if the current instance is equal to the given object * > 0 if the current instance is greater than the given object * @endcode - * @param[in] uri An instance of %Uri + * @param[in] uri An instance of %Uri to compare * @remarks * * Ordering of URIs @@ -453,7 +453,7 @@ public: * to the ordering of fragments, without regard to case. * 5. Authority * If two hierarchical URIs have identical schemes, they are ordered according to the authority, - * without regard to the case. + * without regard to the case. @n * 5-1. Server-based authority * If two URIs are server-based, they are ordered according to their user-information, * without regard to case. @@ -475,11 +475,12 @@ public: * * @return @c true if the two instances are equal, @n * else @c false - * @param[in] obj The object to compare with the current instance - * @remarks Two equal instances must return the same hash value. The default - * implementation of this method returns @c true if two instances - * have the same address. @n - * The method can be overridden to support value equality. Furthermore, the Equals() + * @param[in] obj The object to compare with the current instance + * @remarks + * - Two equal instances must return the same hash value. @n The default + * implementation of this method returns @c true if the two instances + * have the same address. + * - The method can be overridden to support value equality. Furthermore, the Equals() * method must return the same results as the equality operator. */ virtual bool Equals(const Tizen::Base::Object& obj) const; @@ -491,8 +492,8 @@ public: * @since 2.0 * * @return The hash value of the current instance - * @remarks Two equal instances must return the same hash value. For better performance, - * the used hash function must generate a random distribution for all inputs. + * @remarks Two equal instances must return the same hash value. @n + * For better performance, the used hash function must generate a random distribution for all inputs. */ virtual int GetHashCode(void) const; @@ -505,8 +506,9 @@ public: * @return The normalized URI, @n * else the current URI in case any error occurs * @remarks Normalization is the process of removing unnecessary "." and ".." segments from the path component of the - * hierarchical URI. All "." segments are removed and If a ".." segment is preceded by a non-".." segment, - * both of these segments are removed. If a URI is opaque, the normalization has no effect. + * hierarchical URI. All "." segments are removed. + * If a ".." segment is preceded by a non-".." segment, + * both the segments are removed. If a URI is opaque, the normalization has no effect. * * The following example demonstrates how to use the %Normalize() method. * @@ -531,7 +533,7 @@ public: * @param[out] uri The parsed URI * @exception E_SUCCESS The method is successful. * @exception E_INVALID_FORMAT The authority component is defined but cannot be parsed as a server-based authority. - * @remarks This method is provided because the generic URI syntax cannot always distinguish a malformed server-based authority from a legitimate registry-based authority. + * @remarks This method is provided because the generic URI syntax cannot always distinguish a malformed server-based authority from a legitimate registry-based authority. @n * For example, the authority component in the URI string "//foo:bar/" is not a legal * server-based authority but it is legal as a registry-based authority. */ @@ -539,23 +541,24 @@ public: /** - * Relativizes the specified %Uri instance against the calling %Uri instance. + * Relativizes the specified %Uri instance against the current %Uri instance. * * @since 2.0 * * @return An error code - * @param[in] uri The %Uri to relativize against the calling %Uri + * @param[in] uri The %Uri to relativize against the current %Uri instance * @param[out] resultUri The relativized URI * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks Relativization is the opposite of Resolution. It is used - * to divide a URI into the base URI and the relative URI. + * @remarks + * - Relativization is the opposite of Resolution. + * - It is used to divide a URI into the base URI and the relative URI. */ result Relativize(const Uri& uri, Uri& resultUri); /** - * Resolves the specified %Uri instance against the calling %Uri instance. + * Resolves the specified %Uri instance against the current %Uri instance. * * @since 2.0 * @@ -564,9 +567,10 @@ public: * @param[out] resultUri The resolved URI * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks Resolution is the process of resolving a URI against another, base URI. For hierarchical URI, - * the path of the original is resolved against the path of the base URI and then normalized. @ - * For example, to resolve the URI "/downloads/tizen-sdk" against the base URI "https://developer.tizen.org", + * @remarks + * - Resolution is the process of resolving a URI against another, base URI. + * - For a hierarchical URI, the path of the original URI is resolved against the path of the base URI and then normalized. @n + * For example, when you resolve the URI "/downloads/tizen-sdk" against the base URI "https://developer.tizen.org", * the resultant URI is "https://developer.tizen.org/downloads/tizen-sdk". */ result Resolve(const Uri& uri, Uri& resultUri); @@ -578,7 +582,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] authority The authority + * @param[in] authority The authority to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_FORMAT The specified string is invalid. */ @@ -586,12 +590,12 @@ public: /** - * Sets the fragment component to the specified String instance. + * Sets the fragment component to the specified String instance * * @since 2.0 * * @return An error code - * @param[in] fragment The new fragment + * @param[in] fragment The fragment to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_FORMAT The specified string is invalid. */ @@ -604,7 +608,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] host The new host + * @param[in] host The host to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_FORMAT The specified string is invalid. */ @@ -617,7 +621,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] path The new path component + * @param[in] path The path to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_FORMAT The specified string is invalid. */ @@ -630,7 +634,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] port The new port component + * @param[in] port The port to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c port is negative. */ @@ -643,7 +647,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] query The new query string + * @param[in] query The query to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_FORMAT The specified string is invalid. */ @@ -656,7 +660,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] scheme The new scheme + * @param[in] scheme The scheme to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_FORMAT The specified string is invalid. */ @@ -669,7 +673,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] ssp The new scheme-specific-part component + * @param[in] ssp The scheme-specific-part to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_FORMAT The specified string is invalid. */ @@ -682,7 +686,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] userInfo The new user-info string + * @param[in] userInfo The user-info to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_FORMAT The specified string is invalid. */ @@ -690,11 +694,11 @@ public: /** - * Gets the content of the calling %Uri instance as a string containing escaped octets. + * Gets the content of the current %Uri instance as a string containing escaped octets. * * @since 2.0 * - * @return The content of this URI as a string containing escaped octets + * @return The content of the current %Uri instance as a string containing escaped octets */ Tizen::Base::String ToString(void) const; diff --git a/inc/FBaseUtilUrlDecoder.h b/inc/FBaseUtilUrlDecoder.h index 3ecf31f..78a3837 100644 --- a/inc/FBaseUtilUrlDecoder.h +++ b/inc/FBaseUtilUrlDecoder.h @@ -64,7 +64,7 @@ class _OSP_EXPORT_ UrlDecoder { public: /** - * Decodes an encoded string using a specific encoding scheme. + * Decodes the specified encoded string using the specified encoding scheme. * * @since 2.0 * @@ -77,11 +77,12 @@ public: * @exception E_SYSTEM A system error has occurred. * @exception E_UNSUPPORTED_TYPE The specified encoding scheme is not supported. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. - * @remarks This method is used for decoding. It decodes an application/x-www-form-urlencoded string using a - * specific encoding scheme. The supplied encoding scheme is used to determine what characters are represented - * by any consecutive sequences of the form "%ab", where ab is the two-digit hexadecimal representation of a - * byte. - *@see UrlEncoder + * @remarks This method is used for decoding. It decodes an application/x-www-form-urlencoded string using a + * specific encoding scheme. @n + * The supplied encoding scheme is used to determine what characters are represented + * by any consecutive sequences of the form "%ab", where ab is the two-digit hexadecimal representation of a + * byte. + * @see UrlEncoder */ static result Decode(const Tizen::Base::String& str, const Tizen::Base::String& encodingScheme, Tizen::Base::String& decodedStr); diff --git a/inc/FBaseUtilUrlEncoder.h b/inc/FBaseUtilUrlEncoder.h index 877e026..8a0b5bb 100644 --- a/inc/FBaseUtilUrlEncoder.h +++ b/inc/FBaseUtilUrlEncoder.h @@ -66,7 +66,7 @@ class _OSP_EXPORT_ UrlEncoder { public: /** - * Encodes an input string using a specific encoding scheme. @n + * Encodes the specified input string using the specified encoding scheme. @n * It encodes all unsafe characters of a string. * * @since 2.0 @@ -77,13 +77,14 @@ public: * @param[out] encodedStr The encoded string * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_SYSTEM A system error has occurred. + * @exception E_SYSTEM A system error has occurred. * @exception E_UNSUPPORTED_TYPE The specified encoding scheme is not supported. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. - * @remarks This method is used for encoding. It encodes input string into an - * application/x-www-form-urlencoded format using a specific encoding scheme. This method uses the specified - * encoding scheme to obtain the bytes for unsafe characters. - *@see UrlDecoder + * @remarks This method is used for encoding. @n + * It encodes input string into an + * application/x-www-form-urlencoded format using a specific encoding scheme. @n + * This method uses the specified encoding scheme to obtain the bytes for unsafe characters. + * @see UrlDecoder */ static result Encode(const Tizen::Base::String& str, const Tizen::Base::String& encodingScheme, Tizen::Base::String& encodedStr); diff --git a/inc/FBaseUtilZipEntry.h b/inc/FBaseUtilZipEntry.h index bc871d2..24f5139 100644 --- a/inc/FBaseUtilZipEntry.h +++ b/inc/FBaseUtilZipEntry.h @@ -34,7 +34,7 @@ namespace Tizen { namespace Base { namespace Utility { /** * @class ZipEntry - * @brief This class provides access to the entries of a zip-archive. + * @brief This class provides methods to access the entries of a zip-archive. * * @since 2.0 * @@ -105,28 +105,28 @@ public: virtual ~ZipEntry(void); /** - * Gets an entry name associated with a zip entry. @n + * Gets the entry name associated with the zip entry. @n * It can be a file or directory name. * * @since 2.0 * - * @return An entry name + * @return The entry name * */ String GetName(void) const; /** - * Gets the compression level associated with a zip entry. + * Gets the compression level associated with the zip entry. * * @since 2.0 * - * @return The compression level associated with a zip entry + * @return The compression level associated with the zip entry * */ CompressionLevel GetCompressionLevel(void) const; /** - * Checks whether a zip entry is a file or directory. + * Checks whether the zip entry is a file or directory. * * @since 2.0 * @@ -136,42 +136,42 @@ public: bool IsDirectory(void) const; /** - * Gets the compressed size of a zip entry. + * Gets the compressed size of the zip entry. * * @since 2.0 * - * @return The compressed size of a zip entry + * @return The compressed size of the zip entry */ unsigned long GetCompressedSize(void) const; /** - * Gets the uncompressed size of a zip entry. + * Gets the uncompressed size of the zip entry. * * @since 2.0 * - * @return The uncompressed size of a zip entry + * @return The uncompressed size of the zip entry */ unsigned long GetUncompressedSize(void) const; /** - * Gets the name of a zip file to which %ZipEntry belongs. + * Gets the name of the zip file to which %ZipEntry belongs. * * @since 2.0 * - * @return The name of a zip file - * @remarks This method returns the name of a zip file that is opened - * in the FileUnzipper::Construct() method. + * @return The name of the zip file + * @remarks This method returns the name of the zip file that is opened + * in the FileUnzipper::Construct() method. */ String GetArchiveName(void) const; /** - * Compares the specified instance to the calling instance. + * Compares the specified instance to the current instance. * * @since 2.0 * * @return @c true if the specified instance equals the current instance, @n * else @c false - * @param[in] obj The object to compare with the current instance + * @param[in] obj The object to compare with the current instance * @remarks This method returns @c true if all the attributes in the instance are same. */ virtual bool Equals(const Tizen::Base::Object& obj) const; diff --git a/inc/FBaseUuId.h b/inc/FBaseUuId.h index 56df6bb..8ebb175 100644 --- a/inc/FBaseUuId.h +++ b/inc/FBaseUuId.h @@ -35,11 +35,12 @@ namespace Tizen { namespace Base { /** * @class UuId - * @brief This class is the base class of the wrapped UUID types and provides useful operators. + * @brief This class is the base class of the wrapped UUID types and provides methods for UUIDs. * * @since 2.0 * - * The %UuId class is the base class of the wrapped UUID types and provides useful operators. The UUID consists of 32 hexadecimal digits displayed in 5 groups separated by hyphens to form a total of 36 characters (32 digits and 4 hyphens '-'). + * The %UuId class is the base class of the wrapped UUID types and provides useful operators. The UUID consists of 32 hexadecimal + * digits displayed in 5 groups separated by hyphens to form a total of 36 characters (32 digits and 4 hyphens '-'). * * It also provides operators for assignment and equality, and methods for parsing, comparing, and generalization. * @@ -97,10 +98,10 @@ public: * @if OSPDEPREC * Initializes an instance of %UuId with the value of the specified UUID. * - * @brief [Deprecated] - * @deprecated This method is deprecated as a UUID type is deprecated. - * Instead of using this method, use the UuId(const byte uuid[16]) method. - * @since 2.0 + * @brief [Deprecated] + * @deprecated This method is deprecated as a UUID type is deprecated. + * Instead of using this method, use the UuId(const byte uuid[16]) method. + * @since 2.0 * * @param[in] uuid An instance of UUID * @endif @@ -108,7 +109,7 @@ public: UuId(const UUID& uuid); /** - * Initializes an instance of %UuId with the uuid value. + * Initializes an instance of %UuId with the specified uuid value. * * @since 2.0 * @@ -134,7 +135,7 @@ public: * @return @c true if the UUID and the %UuId instance are equal, @n * else @c false * @param[in] uuid1 An instance of UUID - * @param[in] uuid2 An instance of %UuId + * @param[in] uuid2 An instance of %UuId * @endif */ _OSP_EXPORT_ friend bool operator ==(const UUID& uuid1, const UuId& uuid2); @@ -144,7 +145,7 @@ public: * * @since 2.0 * - * @return @c true if the two IDs are equal, @n + * @return @c true if the two instances are equal, @n * else @c false * @param[in] uuid An instance of %UuId */ @@ -194,8 +195,10 @@ public: * * @return @c true if the specified instance of Object is equal to the current instance of %UuId, @n * else @c false - * @param[in] obj An instance of Object to compare - * @remarks This method can be overridden to support value equality. Furthermore, the method must return the same result as the equality operator. + * @param[in] obj An instance of Object to compare + * @remarks This method can be overridden to support value equality. @n + * Furthermore, the method must return the same result + * as the equality operator. * @see Tizen::Base::Object::GetHashCode() */ virtual bool Equals(const Object& obj) const; @@ -206,19 +209,21 @@ public: * @since 2.0 * * @return The integer value equivalent of the hash value of the current instance of %UuId - * @remarks Two equal instances must return the same hash value. For better performance, - * the used hash function must generate a random distribution for all inputs. @n - * The default implementation of this method returns the value of the current instance. + * @remarks + * - Two equal instances must return the same hash value. @n + * For better performance, the used hash function must + * generate a random distribution for all inputs. + * - The default implementation of this method returns the value of the current instance. */ virtual int GetHashCode(void) const; /** - * Gets the string representing the value of the current instance when implemented by a class. + * Gets the string representing the value of the current instance. * - * @since 2.0 + * @since 2.0 * - * @return An instance of the String class with the unicode representation of the value of the current instance @n - * If an error such as E_OUT_OF_MEMORY occurs, an empty string is returned. + * @return An instance of the String class with the unicode representation of the value of the current instance, @n + * else an empty string if an error such as @c E_OUT_OF_MEMORY occurs */ String ToString(void) const; @@ -247,23 +252,23 @@ public: * @exception E_INVALID_ARG The string does not contain an %UuId that can be parsed. * @remarks * - The format of a string representing a %UuId value is xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx (For example, 130DF2EC-8233-4975-B03D-F0AD99E3449D). - * - This method guarantees that the original value of out-parameter is not changed when the method returns error. + * - This method guarantees that the original value of out-parameter is not changed when the method returns an error. */ static result Parse(const String& str, UuId& uuid); /** * Generates a new %UuId instance with a random value. * - * @since 2.0 + * @since 2.0 * * @return A new %UuId instance */ static UuId* GenerateN(void); /** - * Get a new invalid %UuId instance. + * Gets a new invalid %UuId instance. * - * @since 2.0 + * @since 2.0 * * @return A new invalid %UuId instance */ @@ -282,7 +287,7 @@ public: static const UuId INVALID_UUID; /** - * A byte array of uuid value. + * A byte array of the uuid value. * * @since 2.0 */ diff --git a/inc/FIo.h b/inc/FIo.h index 1f403ca..846f09b 100644 --- a/inc/FIo.h +++ b/inc/FIo.h @@ -57,12 +57,13 @@ * @since 2.0 * * @remarks @b Header @b %file: @b \#include @b @n - * @b Library : @b osp-appfw + * @b Library: @b osp-appfw * * The %Io namespace allows applications to input/output data to/from file systems and other programs and process it. * Thus, the %Io namespace is an interface between the system and the application. - * The %Io namespace provides classes and methods for managing files, directories, registries, databases, channels, and serial port communication. - * @n + * The %Io namespace provides classes and methods for managing files, directories, registries, databases, channels, + * and serial port communication. + * * For more information on the %Io namespace features, see Io Guide. * * The following diagram illustrates the relationships between the classes belonging to the %Io namespace. diff --git a/inc/FIoClientChannel.h b/inc/FIoClientChannel.h index 4c75e4f..4b5f350 100644 --- a/inc/FIoClientChannel.h +++ b/inc/FIoClientChannel.h @@ -126,7 +126,7 @@ public: * * @since 2.0 * - * @return A pointer to the %ClientChannel instance, @n + * @return The pointer to the %ClientChannel instance, @n * else @c null if it fails * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -139,7 +139,7 @@ public: * * @since 2.0 * - * @return A pointer to the %ClientChannel instance, @n + * @return The pointer to the %ClientChannel instance, @n * else @c null if it fails * @param[in] channelName The channel name * @exception E_SUCCESS The method is successful. @@ -163,13 +163,13 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] serverChannelId The server channel ID which can be either application ID or appicationID.ChannelName - * @param[in] pArgs A pointer to an argument list of type String - * @param[out] reqId The request ID - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The server channel is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @return An error code + * @param[in] serverChannelId The server channel ID which can be either application ID or appicationID.ChannelName + * @param[in] pArgs A pointer to an argument list of type String + * @param[out] reqId The request ID + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The server channel is not found. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ result SendRequest(const Tizen::Base::String& serverChannelId, const Tizen::Base::Collection::IList* pArgs, RequestId& reqId); diff --git a/inc/FIoDataRow.h b/inc/FIoDataRow.h old mode 100755 new mode 100644 index 62ae288..69ae007 --- a/inc/FIoDataRow.h +++ b/inc/FIoDataRow.h @@ -16,7 +16,7 @@ /** * @file FIoDataRow.h -* @brief This is the header file for the %DataRow class. +* @brief This is the header file for the %DataRow class. * * This header file contains the declarations of the %DataRow class. */ @@ -57,28 +57,29 @@ public: virtual ~DataRow(void); /** - * Sets a Tizen::Base::ByteBuffer value to the column whose index is specified. + * Sets a Tizen::Base::ByteBuffer value to the column with the specified index. * * @since 2.1 * - * @return An error code + * @return An error code * @param[in] columnIndex The index of the column whose value is set @n - * The column index starts from 0. + * The column index starts from @c 0. * @param[in] pValue The value to set @n - * The specified @c pValue is a pointer to user-provided Tizen::Base::ByteBuffer type buffer. + * The specified @c pValue is a pointer to user-provided Tizen::Base::ByteBuffer type buffer. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The specified @c columnIndex is out of range. * - The specified @c pValue is @c null. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. - * @remarks This method performs a shallow copy. It copies only the pointer; not the element itself. @n - * The platform will take the ownership of @c pValue after calling this method. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. + * @remarks + * - This method performs a shallow copy. It copies just the pointer and not the element itself. + * - The platform will take the ownership of @c pValue after calling this method. */ result SetBlobAt(int columnIndex, Tizen::Base::ByteBuffer* pValue); /** - * Sets a Tizen::Base::DateTime value to the column whose index is specified. + * Sets a Tizen::Base::DateTime value to the column with the specified index. * * @since 2.1 * @@ -88,69 +89,69 @@ public: * @param[in] value The value to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. - * @remarks Tizen::Io::DbColumnType of the specified @c value is DB_COLUMNTYPE_TEXT. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. + * @remarks Tizen::Io::DbColumnType of the specified @c value is ::DB_COLUMNTYPE_TEXT. */ result SetDateTimeAt(int columnIndex, const Tizen::Base::DateTime& value); /** - * Sets a @c double value to the column whose index is specified. + * Sets a @c double value to the column with the specified index. * - * @since 2.1 + * @since 2.1 * - * @return An error code - * @param[in] columnIndex The index of the column whose value is set @n - * The column index starts from 0. - * @param[in] value The value to set + * @return An error code + * @param[in] columnIndex The index of the column whose value is set @n + * The column index starts from @c 0. + * @param[in] value The value to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. */ result SetDoubleAt(int columnIndex, double value); /** - * Sets an @c int value to the column whose index is specified. + * Sets an @c int value to the column with the specified index. * - * @since 2.1 + * @since 2.1 * - * @return An error code - * @param[in] columnIndex The index of the column whose value is set @n - * The column index starts from 0. - * @param[in] value The value to set + * @return An error code + * @param[in] columnIndex The index of the column whose value is set @n + * The column index starts from @c 0. + * @param[in] value The value to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the operation do not match. */ result SetIntAt(int columnIndex, int value); /** - * Sets a @c long @c long value to the column whose index is specified. + * Sets a @c long @c long value to the column with the specified index. * - * @since 2.1 + * @since 2.1 * - * @return An error code - * @param[in] columnIndex The index of the column whose value is set @n - * The column index starts from 0. - * @param[in] value The value to set + * @return An error code + * @param[in] columnIndex The index of the column whose value is set @n + * The column index starts from @c 0. + * @param[in] value The value to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. */ result SetInt64At(int columnIndex, long long value); /** - * Sets a Tizen::Base::String value to the column whose index is specified. + * Sets a Tizen::Base::String value to the column with the specified index. * * @since 2.1 * * @return An error code - * @param[in] columnIndex The index of the column whose value is set @n - * The column index starts from 0. - * @param[in] value The value to set + * @param[in] columnIndex The index of the column whose value is set @n + * The column index starts from @c 0. + * @param[in] value The value to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. */ result SetStringAt(int columnIndex, const Tizen::Base::String& value); diff --git a/inc/FIoDataSet.h b/inc/FIoDataSet.h old mode 100755 new mode 100644 index 1a1597c..3de74f3 --- a/inc/FIoDataSet.h +++ b/inc/FIoDataSet.h @@ -63,13 +63,13 @@ public: virtual ~DataSet(void); /** - * Creates in-memory table. + * Creates an in-memory table. * - * @since 2.1 + * @since 2.1 * - * @return An error code + * @return An error code * @param[in] columnNames The list of column names to create @n - * The object type in the specified list should be String. + * The object type in the specified list should be String. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c columnNames has no element. */ @@ -82,15 +82,14 @@ public: * * @return A pointer to the DataRow instance, @n * else @c null if the memory is insufficient - * @remarks The column type is decided by the type of each element inserted in first row. - * If a specific column element on the first row is not inserted, then the column's type is @c DB_COLUMNTYPE_NULL - * In that case, when a new column element is added later, - * then the column's type will be changed according to the new element. + * @remarks The column type is decided by the type of each element inserted in first row. @n + * If a specific column element on the first row is not inserted, then the column's type is ::DB_COLUMNTYPE_NULL. @n + * In that case, when a new column element is added later, then the column's type will be changed according to the new element. */ DataRow* CreateDataRowN(void); /** - * Gets a table enumerator. + * Gets the table enumerator. * * @since 2.1 * @@ -125,7 +124,7 @@ public: virtual bool Equals(const Tizen::Base::Object& obj) const; /** - * Gets the hash value of a current instance. + * Gets the hash value of the current instance. * * @since 2.1 * diff --git a/inc/FIoDataSetEnumerator.h b/inc/FIoDataSetEnumerator.h old mode 100755 new mode 100644 index 6873f50..790c270 --- a/inc/FIoDataSetEnumerator.h +++ b/inc/FIoDataSetEnumerator.h @@ -68,23 +68,23 @@ public: /** * Moves the enumerator to the next position. * - * @since 2.1 + * @since 2.1 * - * @return An error code + * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. * @exception E_OUT_OF_RANGE The enumerator has reached out of the data set. * @exception E_OBJECT_LOCKED The DataSet instance is locked. * @exception E_INVALID_FORMAT The in-memory data is malformed. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks After getting this %DataSetEnumerator instance, - * if this method is called first, the cursor goes to the first position. - * @see Tizen::Io::DataSetEnumerator::MovePrevious() - * @see Tizen::Io::DataSetEnumerator::MoveFirst() - * @see Tizen::Io::DataSetEnumerator::MoveLast() + * @remarks After getting this %DataSetEnumerator instance, + * if this method is called first, the cursor goes to the first position. + * @see Tizen::Io::DataSetEnumerator::MovePrevious() + * @see Tizen::Io::DataSetEnumerator::MoveFirst() + * @see Tizen::Io::DataSetEnumerator::MoveLast() */ virtual result MoveNext(void); @@ -92,190 +92,192 @@ public: /** * Moves the enumerator to the previous position. * - * @since 2.1 + * @since 2.1 * - * @return An error code + * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. * @exception E_OUT_OF_RANGE The enumerator has reached out of the data set. * @exception E_OBJECT_LOCKED The DataSet instance is locked. * @exception E_INVALID_FORMAT The in-memory data is malformed. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see Tizen::Io::DataSetEnumerator::MoveNext() - * @see Tizen::Io::DataSetEnumerator::MoveFirst() - * @see Tizen::Io::DataSetEnumerator::MoveLast() + * @see Tizen::Io::DataSetEnumerator::MoveNext() + * @see Tizen::Io::DataSetEnumerator::MoveFirst() + * @see Tizen::Io::DataSetEnumerator::MoveLast() */ virtual result MovePrevious(void); /** * Moves the enumerator to the first position. * - * @since 2.1 + * @since 2.1 * - * @return An error code + * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. - * @exception E_OBJECT_LOCKED The DataSet instance is locked. + * @exception E_OBJECT_LOCKED The DataSet instance is locked. * @exception E_INVALID_FORMAT The in-memory data is malformed. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see Tizen:Io::DataSetEnumerator::MoveNext() - * @see Tizen:Io::DataSetEnumerator::MovePrevious() - * @see Tizen:Io::DataSetEnumerator::MoveLast() + * @see Tizen:Io::DataSetEnumerator::MoveNext() + * @see Tizen:Io::DataSetEnumerator::MovePrevious() + * @see Tizen:Io::DataSetEnumerator::MoveLast() */ virtual result MoveFirst(void); /** * Moves the enumerator to the last position. * - * @since 2.1 + * @since 2.1 * - * @return An error code + * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. - * @exception E_OBJECT_LOCKED The DataSet instance is locked. + * @exception E_OBJECT_LOCKED The DataSet instance is locked. * @exception E_INVALID_FORMAT The in-memory data is malformed. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see Tizen:Io::DataSetEnumerator::MoveNext() - * @see Tizen:Io::DataSetEnumerator::MovePrevious() - * @see Tizen:Io::DataSetEnumerator::MoveFirst() + * @see Tizen:Io::DataSetEnumerator::MoveNext() + * @see Tizen:Io::DataSetEnumerator::MovePrevious() + * @see Tizen:Io::DataSetEnumerator::MoveFirst() */ virtual result MoveLast(void); /** - * Resets the calling %DataSetEnumerator instance back to its initial state. + * Resets the current %DataSetEnumerator instance to its initial state. * - * @since 2.1 + * @since 2.1 * - * @return An error code + * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. - * @exception E_OBJECT_LOCKED The DataSet instance is locked. + * @exception E_OBJECT_LOCKED The DataSet instance is locked. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks After this method is called, if MoveNext() is called the cursor goes to the first position. + * @remarks If MoveNext() is called after this method, the cursor goes to the first position. */ virtual result Reset(void); /** - * Gets an @c int value from the column whose index is specified. + * Gets the @c int value from the column with the specified index. * - * @since 2.1 + * @since 2.1 * - * @return An error code - * @param[in] columnIndex The index of the column whose value is required + * @return An error code + * @param[in] columnIndex The index of the column to get the value * @param[in,out] value The integer value obtained from the specified column * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. */ virtual result GetIntAt(int columnIndex, int& value) const; /** - * Gets a @c long @c long value from the column whose index is specified. + * Gets the @c long @c long value from the column with the specified index. * - * @since 2.1 + * @since 2.1 * - * @return An error code - * @param[in] columnIndex The index of the column whose value is required + * @return An error code + * @param[in] columnIndex The index of the column to get the value * @param[in,out] value The 64-bit integer value obtained from the specified column * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. */ virtual result GetInt64At(int columnIndex, long long& value) const; /** - * Gets a @c double value from the column whose index is specified. + * Gets the @c double value from the column with the specified index. * - * @since 2.1 + * @since 2.1 * - * @return An error code - * @param[in] columnIndex The index of the column whose value is required + * @return An error code + * @param[in] columnIndex The index of the column to get the value * @param[in,out] value The double value obtained from the specified column * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. */ virtual result GetDoubleAt(int columnIndex, double& value) const; /** - * Gets a Tizen::Base::String value from the column whose index is specified. + * Gets the Tizen::Base::String value from the column with the specified index. * - * @since 2.1 + * @since 2.1 * - * @return An error code - * @param[in] columnIndex The index of the column whose value is required - * @param[in,out] value The Tizen::Base::String value obtained from the specified column - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. - * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @return An error code + * @param[in] columnIndex The index of the column to get the value + * @param[in,out] value The Tizen::Base::String value obtained from the specified column + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. + * @exception E_INVALID_ARG The specified @c columnIndex is out of range. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. * @exception E_INVALID_ENCODING_RANGE The string conversion has failed due to invalid encoding range. */ virtual result GetStringAt(int columnIndex, Tizen::Base::String& value) const; /** - * Gets a Tizen::Base::ByteBuffer value from the column whose index is specified. + * Gets the Tizen::Base::ByteBuffer value from the column with the specified index. * - * @since 2.1 + * @since 2.1 * - * @return An error code - * @param[in] columnIndex The index of the column whose value is required + * @return An error code + * @param[in] columnIndex The index of the column to get the value * @param[in,out] value The Tizen::Base::ByteBuffer value obtained from the specified column @n - * The %Tizen::Base::ByteBuffer will be filled from the current position and data copy - * will be continued until %Tizen::Base::ByteBuffer limitation is reached or no more + * The %Tizen::Base::ByteBuffer will be filled from the current position and the data copying + * will be continued until the %Tizen::Base::ByteBuffer limitation is reached or no more * blob data remains. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. * @exception E_OVERFLOW The specified Tizen::Base::ByteBuffer @c value is insufficient to save the data. - * @see Tizen::Base::ByteBuffer + * @see Tizen::Base::ByteBuffer */ virtual result GetBlobAt(int columnIndex, Tizen::Base::ByteBuffer& value) const; /** - * Gets a blob data from the column whose index is specified. + * Gets the blob data from the column with the specified index. * - * @since 2.1 + * @since 2.1 * - * @return An error code - * @param[in] columnIndex The index of the column whose value is required - * @param[in,out] buffer The user-provided buffer used to receive the blob data - * @param[in] size The maximum buffer length in bytes + * @return An error code + * @param[in] columnIndex The index of the column to get the value + * @param[in,out] buffer The buffer to receive the blob data + * @param[in] size The maximum buffer length in bytes * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. * @exception E_INVALID_ARG Either the specified @c columnIndex is out of range or the specified @c size is invalid. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. * @exception E_OVERFLOW The specified @c buffer is insufficient to save the data. */ virtual result GetBlobAt(int columnIndex, void* buffer, int size) const; /** - * Gets a Tizen::Base::DateTime value from the column whose index is specified. + * Gets the Tizen::Base::DateTime value from the column with the specified index. * - * @since 2.1 + * @since 2.1 * - * @return An error code - * @param[in] columnIndex The index of the column whose value is required + * @return An error code + * @param[in] columnIndex The index of the column to get the value * @param[in,out] value The Tizen::Base::DateTime value obtained from the specified column * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. - * @exception E_INVALID_FORMAT The date is not correctly formatted, or the method is trying to access column of type String. @n - * The date format should be 'mm/dd/yyyy hh:mm:ss'. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. + * @exception E_INVALID_FORMAT Either of the following conditions has occurred: + * - The date is not correctly formatted. @n + * The date format should be 'mm/dd/yyyy hh:mm:ss'. + * - The method is trying to access column of type String. * @exception E_OUT_OF_RANGE Either the year, month, day, hour, minute, or second value is out of range, * or the method is trying to access a column of type String. */ @@ -286,64 +288,67 @@ public: * * @since 2.1 * - * @return The number of columns in the calling enumerator, @n + * @return The number of columns in the current enumerator, @n * else @c -1 if an exception occurs - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. - * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n - * The specific error code can be accessed using the GetLastResult() method. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. + * @remarks + * - The method must be called after MoveNext(), MoveFirst(), or MoveLast(). + * - The specific error code can be accessed using the GetLastResult() method. */ virtual int GetColumnCount(void) const; /** - * Gets the type of the column indicated by a specified index. + * Gets the type of the column specified by the index. * * @since 2.1 * - * @return The type of column, @n + * @return The column type, @n * else @c DB_COLUMNTYPE_UNDEFINED if an exception occurs - * @param[in] columnIndex The index of the destination column - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. - * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n - * Currently, @c DB_COLUMNTYPE_INT is returned for a 64-bit integer. @n - * The specific error code can be accessed using the GetLastResult() method. + * @param[in] columnIndex The column index + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. + * @exception E_INVALID_ARG The specified @c columnIndex is out of range. + * @remarks + * - This method must be called after MoveNext(), MoveFirst(), or MoveLast(). + * - Currently, @c DB_COLUMNTYPE_INT is returned for a 64-bit integer. + * - The specific error code can be accessed using the GetLastResult() method. */ virtual DbColumnType GetColumnType(int columnIndex) const; /** - * Gets the name of the column indicated by a specified index. + * Gets the name of the column specified by the index. * * @since 2.1 * * @return The name of the column, @n * else an empty string if an exception occurs - * @param[in] columnIndex The index of the destination column - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. - * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_INVALID_ENCODING_RANGE The string conversion has failed due to invalid encoding range. - * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n - * The specific error code can be accessed using the GetLastResult() method. + * @param[in] columnIndex The column index + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. + * @exception E_INVALID_ARG The specified @c columnIndex is out of range. + * @exception E_INVALID_ENCODING_RANGE The string conversion has failed due to invalid encoding range. + * @remarks + * - This method must be called after MoveNext(), MoveFirst(), or MoveLast(). + * - The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::String GetColumnName(int columnIndex) const; /** - * Gets the size of data in bytes. + * Gets the size of data in bytes of the column specified by the index. * * @since 2.1 * * @return The size of the data in bytes, @n * else @c -1 if an exception occurs - * @param[in] columnIndex The index of the destination column - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. - * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n - * If the destination column is of type String, this method returns the @c byte length excluding - * the @c null terminator character. @n - * The specific error code can be accessed using the GetLastResult() method. + * @param[in] columnIndex The column index + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_STATE The DataSet instance associated with this instance is deleted. + * @exception E_INVALID_ARG The specified @c columnIndex is out of range. + * @remarks + * - This method must be called after MoveNext(), MoveFirst(), or MoveLast(). + * - If the destination column is of type String, this method returns the @c byte length excluding the @c null terminator character. + * - The specific error code can be accessed using the GetLastResult() method. */ virtual int GetColumnSize(int columnIndex) const; diff --git a/inc/FIoDatabase.h b/inc/FIoDatabase.h index abbbf6d..eb0d5df 100644 --- a/inc/FIoDatabase.h +++ b/inc/FIoDatabase.h @@ -42,13 +42,13 @@ class DbEnumerator; /** * @class Database - * @brief This class provides the basic database and database entry management methods. + * @brief This class provides methods for database management. * * @since 2.0 * * @final This class is not intended for extension. * - * The %Database class provides the basic database and database entry management methods. + * The %Database class provides methods for database management. * All members of this class are guaranteed to be thread-safe. * * For more information on the class features, @@ -276,7 +276,8 @@ class _OSP_EXPORT_ Database public: /** - * 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. + * 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 */ @@ -310,26 +311,24 @@ public: * @param[in] createIfNotExist Set to @c true to create a database file, @n * else @c false to open an existing database file * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The length of the specified @c dbPath is invalid. @n - * - The specified @c dbPath is invalid or the path ends with '/'. @n - * - The directory name path is missing. @n - * - The parent directory does not exist. @n - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. - * @exception E_FILE_ALREADY_EXIST The specified database file already exists. @n - * Creation of database file has failed because the destination file already exists. @n - * Creation of the database file is attempted if the file does not exist and - * the specified @c createIfNotExist is @c true. - * However, at this moment another thread has been already created the database file - * with the same file path. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The length of the specified @c dbPath is invalid. + * - The specified @c dbPath is invalid or the path ends with '/'. + * - The directory name path is missing. + * - The parent directory does not exist. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. + * @exception E_FILE_ALREADY_EXIST Either of the following conditions has occurred: + * - The specified database file already exists. + * - The creation of the database file failed because the destination file already exists. + * - The creation of the database file is attempted if the file does not exist and the specified @c createIfNotExist is + * @c true. However, in this case, another thread has already created the database file with the same file path. @n * This is a rare case, however, it is possible if a race condition is present between several threads. * @exception E_FILE_NOT_FOUND The specified database file cannot be found or accessed. - * @exception E_DATABASE Either of the following conditions has occurred: @n - * - The method has failed to open or create a file. @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_DATABASE Either of the following conditions has occurred: + * - The method has failed to open or create a file. + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. - * @remarks To open the database file in the read-only mode, - * use the Database::Construct(const Tizen::Base::String& dbPath, const char* pOpenMode) method + * @remarks To open the database file in the read-only mode, use the Database::Construct(const Tizen::Base::String&, const char*) method * with "r" as the value for the open mode flag. * @endcond */ @@ -353,25 +352,25 @@ public: * * @return An error code * @param[in] dbPath The path of the database file to open - * @param[in] openMode An open mode flag @n + * @param[in] openMode The file opening mode flag @n * Currently, the following flags can be used in combination with the logical OR operator: @n * (1) DB_OPEN_READ_ONLY @n * (2) DB_OPEN_READ_WRITE @n * (3) DB_OPEN_READ_WRITE | DB_OPEN_CREATE * @param[in] option This argument is reserved for further use * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The length of the specified @c dbPath is invalid. @n - * - The specified @c openMode is invalid. @n - * - The specified @c dbPath is invalid or the path ends with '/'. @n - * - The directory name path is missing. @n - * - The parent directory does not exist. @n - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The length of the specified @c dbPath is invalid. + * - The specified @c openMode is invalid. + * - The specified @c dbPath is invalid or the path ends with '/'. + * - The directory name path is missing. + * - The parent directory does not exist. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_ALREADY_EXIST The specified database file already exists. * @exception E_FILE_NOT_FOUND The specified database file cannot be found or accessed. - * @exception E_DATABASE Either of the following conditions has occurred: @n - * - The method has failed to open or create a file. @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_DATABASE Either of the following conditions has occurred: + * - The method has failed to open or create a file. + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @endcond */ @@ -391,19 +390,19 @@ public: * - r+: Open for reading and writing. * - a+: Open for writing and reading. The database file is created if it does not exist. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The overall length of the specified @c dbPath is equal to @c 0 or - * exceeds system limitations. @n - * - The specified @c dbPath ends with '/'. @n - * - The combination of the specified @c pOpenMode is not allowed. @n - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * exceeds system limitations. + * - The specified @c dbPath ends with '/'. + * - The combination of the specified @c pOpenMode is not allowed. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_NOT_FOUND The specified @c dbPath cannot be found. * @exception E_INVALID_FORMAT The specified @c dbPath is not a database. * @exception E_STORAGE_FULL The disk space is full. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n - * - %File corruption is detected. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. + * - %File corruption is detected. */ result Construct(const Tizen::Base::String& dbPath, const char* pOpenMode); @@ -412,7 +411,7 @@ public: * This method opens an existing secure database file or creates a new one according to the specified file opening mode. * The contents written to the secure database file is automatically encrypted and the contents read from the secure database * file is automatically decrypted by the platform. @n - * Applications using this method can access the same secure database files that are created by other applications with the + * Applications using this method can access the secure database files that are created by other applications with an * identical key value in same device. However, the secure files created by this method cannot be accessed in other devices. * * @since 2.0 @@ -421,27 +420,27 @@ public: * @return An error code * @param[in] dbPath The path of the database file to open or create * @param[in] pOpenMode The file opening mode @n - * It can be one of the following: @n - * - r : Open for reading @n - * - r+: Open for reading and writing @n - * - a+: Open for writing and reading. The database file is created if it does not exist. @n - * @param[in] secretKey A key used to encrypt data of a database file or decrypt a secure database file @n - * If a secure database file is created with a specific key value, - * other applications can access the same secure database file with the identical key value. + * It can be one of the following: + * - r : Open for reading + * - r+: Open for reading and writing + * - a+: Open for writing and reading. The database file is created if it does not exist. + * @param[in] secretKey The key used to encrypt the data of the database file or decrypt the secure database file @n + * If the secure database file is created with a specific key value, + * other applications can access the secure database file with an identical key value. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The overall length of the specified @c dbPath is equal to @c 0 or - * exceeds system limitations. @n - * - The specified @c dbPath ends with '/'. @n - * - The combination of the specified @c pOpenMode is not allowed. @n - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * exceeds system limitations. + * - The specified @c dbPath ends with '/'. + * - The combination of the specified @c pOpenMode is not allowed. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_NOT_FOUND The specified @c dbPath cannot be found. * @exception E_INVALID_FORMAT The specified @c dbPath is not a database. * @exception E_STORAGE_FULL The disk space is full. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n - * - %File corruption is detected. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. + * - %File corruption is detected. * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. For more information, see * Application Filtering. * @remarks Before calling this method, check whether the feature is supported by Tizen::System::SystemInfo::GetValue(const Tizen::Base::String&, bool&). @@ -449,7 +448,7 @@ public: result Construct(const Tizen::Base::String& dbPath, const char* pOpenMode, const Tizen::Base::ByteBuffer& secretKey); /** - * Creates a SQL statement for the current database. + * Creates an SQL statement for the current database. * * @if OSPCOMPAT * @brief [Compatibility] @@ -464,7 +463,7 @@ public: * else @c null if an exception occurs * @param[in] sqlStatement The SQL statement to compile * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c sqlStatement is invalid SQL. + * @exception E_INVALID_ARG The specified @c sqlStatement is an invalid SQL. * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -473,11 +472,11 @@ public: DbStatement* CreateStatementN(const Tizen::Base::String& sqlStatement); /** - * Executes a statement in the calling %Database instance. @n + * Executes a statement in the current %Database instance. @n * If an application opens a database file using Database::Construct(const Tizen::Base::String& dbPath, * const char* pOpenMode, const Tizen::Base::ByteBuffer& secretKey), * the data set written by INSERT/UPDATE is automatically encrypted by the Tizen platform and - * the data set read by SELECT is also decrypted by itself. + * the data set read by SELECT is decrypted. * * @if OSPCOMPAT * @brief [Compatibility] @@ -493,27 +492,28 @@ public: * SELECT query, or if one of INSERT, UPDATE, and DELETE queries is executed. * @param[in] dbStatement The DbStatement instance to execute * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c dbStatement includes invalid SQL. + * @exception E_INVALID_ARG The specified @c dbStatement includes an invalid SQL. * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_INVALID_FORMAT The database file is malformed. * @exception E_STORAGE_FULL The disk space or database image is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks If @c dbStatement contains the SELECT query, the Reset() method of the DbEnumerator instance returned - * from this method should be called. The Reset() method should be called before re-binding the dbStatement + * @remarks + * - If @c dbStatement contains the SELECT query, the Reset() method of the DbEnumerator instance returned + * from this method should be called. The %Reset() method should be called before re-binding the dbStatement * with the bind methods of the DbStatement class. - * This method returns an enumerator if the result set is generated by the SELECT query. - * @c null is returned if no result set is available after the successful execution of the SELECT query. + * - This method returns an enumerator if the result set is generated by the SELECT query. + * @c null is returned if no result set is available after the successful execution of the SELECT query. @n * Note that, a return value of @c null does not mean that the statement execution has failed. - * The enumerator returned by the SELECT query does not indicate any row before it calls DbEnumerator::MoveNext(). - * The specific error code can be accessed using the GetLastResult() method. + * - The enumerator returned by the SELECT query does not indicate any row before it calls DbEnumerator::MoveNext(). + * - The specific error code can be accessed using the GetLastResult() method. */ DbEnumerator* ExecuteStatementN(const DbStatement& dbStatement); /** - * Executes SQL statement in this %Database instance. @n + * Executes the specified SQL statement in the current %Database instance. @n * Any SQL statement that does not give a result set can be run using this method; for example, CREATE, INSERT, UPDATE, DELETE. * The SELECT query cannot be executed using this method. @n * If an application opens a database file using Database::Construct(const Tizen::Base::String& dbPath, @@ -533,13 +533,13 @@ public: * @param[in] sqlStatement The SQL statement to execute * @param[in] option This argument is reserved for further use. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c sqlStatement is invalid SQL. + * @exception E_INVALID_ARG The specified @c sqlStatement is an invalid SQL. * @exception E_INVALID_OPERATION The specified @c sqlStatement is a SELECT query. * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_INVALID_FORMAT The database file is malformed. * @exception E_STORAGE_FULL The disk space or database image is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks Use QueryN() to execute SELECT query. @@ -548,7 +548,7 @@ public: result ExecuteSql(const Tizen::Base::String& sqlStatement, bool option); /** - * Executes a SELECT query in the calling %Database instance. @n + * Executes the specified SELECT query in the current %Database instance. @n * If an application opens a database file using Database::Construct(const Tizen::Base::String& dbPath, * const char* pOpenMode, const Tizen::Base::ByteBuffer& key), * the data set read by SELECT is automatically decrypted by the Tizen platform. @@ -566,20 +566,21 @@ public: * else @c null if an exception occurs or if no result set is generated after the successful execution of the SELECT query * @param[in] sqlStatement The SQL statement to execute * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c sqlStatement is invalid SQL. + * @exception E_INVALID_ARG The specified @c sqlStatement is an invalid SQL. * @exception E_INVALID_OPERATION The specified @c sqlStatement is not a SELECT query. * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_INVALID_FORMAT The database file is malformed. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks This method returns an enumerator if the result set is generated by the SELECT query. - * @c null is returned if no result set is available after the successful execution of the SELECT query. + * @remarks + * - This method returns an enumerator if the result set is generated by the SELECT query. + * @c null is returned if no result set is available after the successful execution of the SELECT query. @n * Note that, a return value of @c null does not mean that the statement execution has failed. - * The enumerator returned by the SELECT query does not indicate any row before it calls + * - The enumerator returned by the SELECT query does not indicate any row before it calls * DbEnumerator::MoveNext(). - * The specific error code can be accessed using the GetLastResult() method. + * - The specific error code can be accessed using the GetLastResult() method. * @see ExecuteSql() */ DbEnumerator* QueryN(const Tizen::Base::String& sqlStatement); @@ -606,7 +607,7 @@ public: result BeginTransaction(void); /** - * Commits a transaction within this %Database instance. + * Commits a transaction within the current %Database instance. * * @if OSPCOMPAT * @brief [Compatibility] @@ -623,18 +624,18 @@ public: * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_INVALID_FORMAT The database file is malformed. * @exception E_STORAGE_FULL The disk space or database image is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks Database::CommitTransaction() automatically resets not only all the DbStatement instances - * but also all the DbEnumerator instances obtained from the current %Database instance. - * As a result, the prepared statement of the %DbStatement instances are reset to its initial state, ready to be re-executed, - * and enumerator of the %DbEnumerator instances are reset to the first position. - * Therefore, the user should be careful when the same instance of the %Database class is shared across multiple threads. - * Further, access to the %DbStatement or %DbEnumerator instances resets due to commit operation. This will eventually lead to crash. - * To avoid a crash, the user can use multiple database instances for each thread. - * Sharing of the same database instance across multiple threads is not recommended. + * but also all the DbEnumerator instances obtained from the current %Database instance. @n + * As a result, the prepared statement of the %DbStatement instances are reset to its initial state, ready to be + * re-executed, and enumerator of the DbEnumerator instances are reset to the first position. @n + * Therefore, you should be careful when the same instance of the %Database class is shared across multiple + * threads. Further, access to the %DbStatement or %DbEnumerator instances resets due to a commit operation. @n + * This will eventually lead to a crash. To avoid a crash, you can use multiple database instances for each + * thread. Sharing of the same database instance across multiple threads is not recommended. * @see BeginTransaction() * @see RollbackTransaction() */ @@ -658,8 +659,8 @@ public: * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_INVALID_FORMAT The database file is malformed. * @exception E_STORAGE_FULL The disk space or database image is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @see BeginTransaction() @@ -668,11 +669,11 @@ public: result RollbackTransaction(void); /** - * Gets the database's filename. + * Gets the database file name. * * @since 2.0 * - * @return The filename of this %Database instance + * @return The file name of the current %Database instance */ Tizen::Base::String GetName(void) const; @@ -691,24 +692,24 @@ public: * @return An error code * @param[in] databasePath The path of the database file to delete * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The length of the specified @c databasePath is invalid. @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The length of the specified @c databasePath is invalid. * - The specified @c databasePath parameter contains an invalid path or - * the path ends with '/'. @n - * - The directory name path is missing. @n - * - The parent directory does not exist. @n + * the path ends with '/'. + * - The directory name path is missing. + * - The parent directory does not exist. * - An I/O security issue. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_NOT_FOUND The specified database file cannot be found. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n - * - %File corruption is detected. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. + * - %File corruption is detected. * - A system error has occurred. */ static result Delete(const Tizen::Base::String& databasePath); /** - * Checks whether the database file exists. + * Checks whether the specified database file exists. * * @if OSPCOMPAT * @brief [Compatibility] @@ -723,20 +724,20 @@ public: * else @c false * @param[in] databasePath The path of the database file to check * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The length of the specified @c databasePath is invalid. @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The length of the specified @c databasePath is invalid. * - The specified @c databasePath parameter contains an invalid path or - * the path ends with '/'. @n - * - The directory name path is missing. @n - * - The parent directory does not exist. @n + * the path ends with '/'. + * - The directory name path is missing. + * - The parent directory does not exist. * - An I/O security issue. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static bool Exists(const Tizen::Base::String& databasePath); /** - * Converts a normal database file to a secure database file. @n + * Converts the specified normal database file to a secure database file. @n * A secure database file, that is converted by this method, can be shared among applications with the same key value. * * @if OSPCOMPAT @@ -753,21 +754,21 @@ public: * @return An error code * @param[in] normalDbPath The normal (non-encrypted) database file path * @param[in] secureDbPath The secure (encrypted) database file path to create - * @param[in] secretKey A key to encrypt normal database file @n + * @param[in] secretKey The key to encrypt the normal database file @n * If the normal database file is converted with a specific key value, - * applications can access the same secure database file with the identical key value. + * applications can access the secure database file with an identical key value. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The length of the specified path is @c 0 or exceeds system limitations. @n - * - The specified path is invalid. @n - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The length of the specified path is @c 0 or exceeds system limitations. + * - The specified path is invalid. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_NOT_FOUND The specified @c normalDbPath does not exist. * @exception E_FILE_ALREADY_EXIST The specified @c secureDbPath already exists. * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_INVALID_FORMAlT The database file is malformed. * @exception E_STORAGE_FULL The disk space or database image is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @exception E_UNSUPPORTED_OPERATION The Emulator or target device does not support the required feature. For more information, see @@ -782,15 +783,16 @@ public: * * @since 2.0 * - * @return Row ID of the most recent successful insert, @n + * @return The row ID of the most recent successful insert, @n * else @c -1 if no successful INSERT operations have ever occurred on * the current opened database. - * @remarks The row ID is always available as an undeclared column named ROWID, OID, or _ROWID_ - * as long as those names are not also used by explicitly declared columns. - * If the table has a column of type INTEGER PRIMARY KEY then that column is another alias - * for the row ID. @n - * This method returns the row ID of the most recent successful INSERT operation - * for current %Database. + * @remarks + * - The row ID is always available as an undeclared column named ROWID, OID, or _ROWID_ + * as long as those names are not used by explicitly declared columns. + * - If the table has a column of type INTEGER PRIMARY KEY then that column is another alias + * for the row ID. + * - This method returns the row ID of the most recent successful INSERT operation + * for the current %Database instance. */ long long GetLastInsertRowId(void) const; diff --git a/inc/FIoDbEnumerator.h b/inc/FIoDbEnumerator.h index 30b3cac..c0fe805 100644 --- a/inc/FIoDbEnumerator.h +++ b/inc/FIoDbEnumerator.h @@ -81,23 +81,23 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to move the cursor position of the result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * - The Database or DbStatement instance associated with this instance is deleted. * @exception E_OUT_OF_RANGE The enumerator has reached out of the result set returned by the SELECT query. * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_INVALID_FORMAT The database file is malformed. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see Tizen::Io::Database::ExecuteStatementN() - * @see Tizen::Io::Database::QueryN() - * @see Tizen::Io::DbEnumerator::MovePrevious() - * @see Tizen::Io::DbEnumerator::MoveFirst() - * @see Tizen::Io::DbEnumerator::MoveLast() + * @see Tizen::Io::Database::ExecuteStatementN() + * @see Tizen::Io::Database::QueryN() + * @see Tizen::Io::DbEnumerator::MovePrevious() + * @see Tizen::Io::DbEnumerator::MoveFirst() + * @see Tizen::Io::DbEnumerator::MoveLast() */ virtual result MoveNext(void); @@ -108,23 +108,23 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to move the cursor position of the result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * - The Database or DbStatement instance associated with this instance is deleted. * @exception E_OUT_OF_RANGE The enumerator has reached out of the result set returned by the SELECT query. * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_INVALID_FORMAT The database file is malformed. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see Tizen::Io::Database::ExecuteStatementN() - * @see Tizen::Io::Database::QueryN() - * @see Tizen::Io::DbEnumerator::MoveNext() - * @see Tizen::Io::DbEnumerator::MoveFirst() - * @see Tizen::Io::DbEnumerator::MoveLast() + * @see Tizen::Io::Database::ExecuteStatementN() + * @see Tizen::Io::Database::QueryN() + * @see Tizen::Io::DbEnumerator::MoveNext() + * @see Tizen::Io::DbEnumerator::MoveFirst() + * @see Tizen::Io::DbEnumerator::MoveLast() */ virtual result MovePrevious(void); @@ -135,22 +135,22 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to move the cursor position of the result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * - The Database or DbStatement instance associated with this instance is deleted. * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_INVALID_FORMAT The database file is malformed. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see Tizen::Io::Database::ExecuteStatementN() - * @see Tizen::Io::Database::QueryN() - * @see Tizen::Io::DbEnumerator::MoveNext() - * @see Tizen::Io::DbEnumerator::MovePrevious() - * @see Tizen::Io::DbEnumerator::MoveLast() + * @see Tizen::Io::Database::ExecuteStatementN() + * @see Tizen::Io::Database::QueryN() + * @see Tizen::Io::DbEnumerator::MoveNext() + * @see Tizen::Io::DbEnumerator::MovePrevious() + * @see Tizen::Io::DbEnumerator::MoveLast() */ virtual result MoveFirst(void); @@ -161,27 +161,27 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to move the cursor position of the result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * - The Database or DbStatement instance associated with this instance is deleted. * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_INVALID_FORMAT The database file is malformed. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see Tizen::Io::Database::ExecuteStatementN() - * @see Tizen::Io::Database::QueryN() - * @see Tizen::Io::DbEnumerator::MoveNext() - * @see Tizen::Io::DbEnumerator::MovePrevious() - * @see Tizen::Io::DbEnumerator::MoveFirst() + * @see Tizen::Io::Database::ExecuteStatementN() + * @see Tizen::Io::Database::QueryN() + * @see Tizen::Io::DbEnumerator::MoveNext() + * @see Tizen::Io::DbEnumerator::MovePrevious() + * @see Tizen::Io::DbEnumerator::MoveFirst() */ virtual result MoveLast(void); /** - * Resets the calling %DbEnumerator instance back to its initial state. + * Resets the current %DbEnumerator instance to its initial state. * * @if OSPCOMPAT * @brief [Compatibility] @@ -194,161 +194,161 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to reset the enumerator of the result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * - The Database or DbStatement instance associated with this instance is deleted. * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks After this method is called, if MoveNext() is called the cursor goes to the first position. + * @remarks If MoveNext() is called after this method, the cursor goes to the first position. */ virtual result Reset(void); /** - * Gets an @c int value from the column whose index is specified. + * Gets the @c int value from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required - * @param[in,out] value The integer value obtained from the column + * @param[in] columnIndex The index of the column to get the value + * @param[in,out] value The integer value obtained from the specified column * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * - The Database or DbStatement instance associated with this instance is deleted. * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. */ virtual result GetIntAt(int columnIndex, int& value) const; /** - * Gets a @c long @c long value from the column whose index is specified. + * Gets the @c long @c long value from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required - * @param[in,out] value The 64-bit integer value obtained from the column + * @param[in] columnIndex The index of the column to get the value + * @param[in,out] value The 64-bit integer value obtained from the specified column * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * - The Database or DbStatement instance associated with this instance is deleted. * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. */ virtual result GetInt64At(int columnIndex, long long& value) const; /** - * Gets a @c double value from the column whose index is specified. + * Gets the @c double value from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required - * @param[in,out] value The value obtained from the column as a double + * @param[in] columnIndex The index of the column to get the value + * @param[in,out] value The double value obtained from the column * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * - The Database or DbStatement instance associated with this instance is deleted. * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. */ virtual result GetDoubleAt(int columnIndex, double& value) const; /** - * Gets a @c String value from the column whose index is specified. + * Gets the @c String value from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required - * @param[in,out] value The value obtained from the column as a String + * @param[in] columnIndex The index of the column to get the value + * @param[in,out] value The @c String value obtained from the column * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * - The Database or DbStatement instance associated with this instance is deleted. * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. - * @exception E_INVALID_ENCODING_RANGE The string conversion has failed due to invalid encoding range, or - * it is possible if the database file is corrupted. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. + * @exception E_INVALID_ENCODING_RANGE Either of the following conditions has occurred: + * - The string conversion has failed due to invalid encoding range. + * - The database file is corrupted. */ virtual result GetStringAt(int columnIndex, Tizen::Base::String& value) const; /** - * Gets a byte array value from the column whose index is specified. + * Gets the byte array value from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required - * @param[in,out] value The user-provided buffer used to receive the blob data as a stream of type ByteBuffer @n - * The buffer will be filled from the current position and data copy will be continued - * until buffer limitation is reached or no more blob data remains. @n + * @param[in] columnIndex The index of the column to get the value + * @param[in,out] value The buffer to receive the blob data as a stream of type ByteBuffer @n + * The buffer will be filled from the current position and the data copying will be continued + * until the buffer limitation is reached or no more blob data remains. @n * The maximum size available is limited to 100 MByte. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * - The Database or DbStatement instance associated with this instance is deleted. * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. * @exception E_OUT_OF_RANGE The byte buffer operation has failed. * @exception E_OVERFLOW The specified @c value of the byte buffer is insufficient to save the data. */ virtual result GetBlobAt(int columnIndex, Tizen::Base::ByteBuffer& value) const; /** - * Gets a blob data from the column whose index is specified. + * Gets the blob data from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required - * @param[in,out] buffer The user-provided buffer used to receive the blob data @n + * @param[in] columnIndex The index of the column to get the value + * @param[in,out] buffer The buffer to receive the blob data @n * The maximum size available is limited to 100 MByte. * @param[out] size The maximum buffer length in bytes * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * - The Database or DbStatement instance associated with this instance is deleted. * @exception E_INVALID_ARG The specified @c columnIndex is out of range, or the specified @c size is invalid. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. * @exception E_OVERFLOW The specified @c buffer is insufficient to save the data. */ virtual result GetBlobAt(int columnIndex, void* buffer, int size) const; /** - * Gets a @c DateTime value from the column whose index is specified. + * Gets the @c DateTime value from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required - * @param[in,out] value The value obtained from the column as a DateTime instance + * @param[in] columnIndex The index of the column to get the value + * @param[in,out] value The value obtained from the column as a %DateTime instance * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * - The Database or DbStatement instance associated with this instance is deleted. * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. - * @exception E_INVALID_FORMAT The date is not correctly formatted, or the method is trying to access column of type String. @n - * The date format should be 'mm/dd/yyyy hh:mm:ss'. - * @exception E_OUT_OF_RANGE Either the year, month, day, hour, minute, or second value is out of range, - * or the method is trying to access a column of type String. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. + * @exception E_INVALID_FORMAT The date is not correctly formatted. The date format should be 'mm/dd/yyyy hh:mm:ss'. + * @exception E_OUT_OF_RANGE Either the year, month, day, hour, minute, or second value is out of range, or the method is trying to access a column having an invalid value. + * */ virtual result GetDateTimeAt(int columnIndex, Tizen::Base::DateTime& value) const; @@ -357,80 +357,85 @@ public: * * @since 2.0 * - * @return The number of columns in the calling enumerator, @n + * @return The number of columns in the current enumerator, @n * else @c -1 if an exception occurs * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * - The Database or DbStatement instance associated with this instance is deleted. - * @remarks The method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - The method must be called after MoveNext(), MoveFirst(), or MoveLast(). + * - The specific error code can be accessed using the GetLastResult() method. */ virtual int GetColumnCount(void) const; /** - * Gets the type of the column indicated by the specified index. + * Gets the type of the column specified by the index. * * @since 2.0 * - * @return The type of column, @n + * @return The column type, @n * else DB_COLUMNTYPE_UNDEFINED if an exception occurs - * @param[in] columnIndex The index of the destination column + * @param[in] columnIndex The column index * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * - The Database or DbStatement instance associated with this instance is deleted. * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n - * Currently, DB_COLUMNTYPE_INT is returned for a 64-bit integer. @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - This method must be called after MoveNext(), MoveFirst(), or MoveLast(). + * - Currently, ::DB_COLUMNTYPE_INT is returned for a 64-bit integer. + * - The specific error code can be accessed using the GetLastResult() method. */ virtual DbColumnType GetColumnType(int columnIndex) const; /** - * Gets the name of the column indicated by the specified index. + * Gets the name of the column specified by the index. * * @since 2.0 * * @return The name of the column, @n * else an empty string if an exception occurs - * @param[in] columnIndex The index of the destination column + * @param[in] columnIndex The column index * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * - The Database or DbStatement instance associated with this instance is deleted. * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_INVALID_ENCODING_RANGE The string conversion has failed due to invalid encoding range, or - * it is possible if the database file is corrupted. - * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n - * The specific error code can be accessed using the GetLastResult() method. + * @exception E_INVALID_ENCODING_RANGE Either of the following conditions has occurred: + * - The string conversion has failed due to invalid encoding range. + * - The database file is corrupted. + * @remarks + * - This method must be called after MoveNext(), MoveFirst(), or MoveLast(). + * - The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::String GetColumnName(int columnIndex) const; /** - * Gets the size of data in bytes. + * Gets the size of data in bytes of the column specified by the index. * * @since 2.0 * * @return The size of the data in bytes, @n * else @c -1 if an exception occurs - * @param[in] columnIndex The index of the destination column + * @param[in] columnIndex The column index * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * - The Database or DbStatement instance associated with this instance is deleted. * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n - * If the destination column is of type String, this method returns the @c byte length excluding the @c null terminator character. @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - This method must be called after MoveNext(), MoveFirst(), or MoveLast(). + * - If the destination column is of type String, this method returns the @c byte length excluding the @c null terminator character. + * - The specific error code can be accessed using the GetLastResult() method. */ virtual int GetColumnSize(int columnIndex) const; diff --git a/inc/FIoDbStatement.h b/inc/FIoDbStatement.h index 869dfab..fba5973 100644 --- a/inc/FIoDbStatement.h +++ b/inc/FIoDbStatement.h @@ -34,14 +34,13 @@ namespace Tizen { namespace Io /** * @class DbStatement - * @brief This class provides a method for evaluating pre-compiled statements. + * @brief This class provides methods for evaluating pre-compiled statements. * * @since 2.0 * * @final This class is not intended for extension. * - * The %DbStatement class provides a method for evaluating pre-compiled statements. - * All members of this class are guaranteed to be thread-safe. + * The %DbStatement class provides methods for evaluating pre-compiled statements. * * For more information on the class features, see Database Operations. */ @@ -58,7 +57,7 @@ public: virtual ~DbStatement(void); /** - * Binds an integer value to the statement parameter. + * Binds the specified integer value to the statement parameter. * * @if OSPCOMPAT * @brief [Compatibility] @@ -70,20 +69,21 @@ public: * @endif * * @return An error code - * @param[in] columnIndex The index of the column whose value is bound + * @param[in] columnIndex The column index to bind the value * @param[out] value The integer value to bind * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE The instance has not been properly constructed, - * or the instance is finalized. + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - The instance has not been properly constructed. + * - The instance is finalized. * @exception E_INVALID_ARG The specified @c columnIndex is invalid. * @exception E_INVALID_OPERATION This method has failed to bind the parameter because the database state has not been reset - * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). + * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). @n * In this case DbEnumerator::Reset() should be invoked before calling this method. */ result BindInt(int columnIndex, int value); /** - * Binds a @c long @c long value to the statement parameter. + * Binds the specified @c long @c long value to the statement parameter. * * @if OSPCOMPAT * @brief [Compatibility] @@ -95,20 +95,21 @@ public: * @endif * * @return An error code - * @param[in] columnIndex The index of the column whose value is bound + * @param[in] columnIndex The column index to bind the value * @param[out] value The 64-bit integer value to bind * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE The instance has not been properly constructed, - * or the instance is finalized. + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - The instance has not been properly constructed. + * - The instance is finalized. * @exception E_INVALID_ARG The specified @c columnIndex is invalid. * @exception E_INVALID_OPERATION This method has failed to bind the parameter because the database state has not been reset - * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). + * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). @n * In this case DbEnumerator::Reset() should be invoked before calling this method. */ result BindInt64(int columnIndex, long long value); /** - * Binds a @c double value to the statement parameter. + * Binds the specified @c double value to the statement parameter. * * @if OSPCOMPAT * @brief [Compatibility] @@ -120,20 +121,21 @@ public: * @endif * * @return An error code - * @param[in] columnIndex The index of the column whose value is bound + * @param[in] columnIndex The column index to bind the value * @param[out] value The @c double value to bind * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE The instance has not been properly constructed, - * or the instance is finalized. + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - The instance has not been properly constructed. + * - The instance is finalized. * @exception E_INVALID_ARG The specified @c columnIndex is invalid. * @exception E_INVALID_OPERATION This method has failed to bind the parameter because the database state has not been reset - * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). + * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). @n * In this case DbEnumerator::Reset() should be invoked before calling this method. */ result BindDouble(int columnIndex, double value); /** - * Binds a String value to the statement parameter. + * Binds the specified string value to the statement parameter. * * @if OSPCOMPAT * @brief [Compatibility] @@ -145,20 +147,21 @@ public: * @endif * * @return An error code - * @param[in] columnIndex The index of the column whose value is bound + * @param[in] columnIndex The column index to bind the value * @param[out] value The string value to bind * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE The instance has not been properly constructed, - * or the instance is finalized. + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - The instance has not been properly constructed. + * - The instance is finalized. * @exception E_INVALID_ARG The specified @c value exceeds size limit. * @exception E_INVALID_OPERATION This method has failed to bind the parameter because the database state has not been reset - * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). + * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). @n * In this case DbEnumerator::Reset() should be invoked before calling this method. */ result BindString(int columnIndex, const Tizen::Base::String& value); /** - * Binds a value of type ByteBuffer to the statement parameter. + * Binds the specified ByteBuffer type value to the statement parameter. * * @if OSPCOMPAT * @brief [Compatibility] @@ -170,25 +173,26 @@ public: * @endif * * @return An error code - * @param[in] columnIndex The index of the column whose value is bound + * @param[in] columnIndex The column index to bind the value * @param[out] value The blob value to bind @n * The maximum available size is limited to 100 MBytes. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE The instance has not been properly constructed, - * or the instance is finalized. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The specified @c columnIndex is invalid. @n - * - The size of byte buffer is less than @c 0 or has @c null data. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - The instance has not been properly constructed. + * - The instance is finalized. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c columnIndex is invalid. + * - The size of the byte buffer is less than @c 0 or has @c null data. * - The specified @c value exceeds size limit. * @exception E_INVALID_OPERATION This method has failed to bind the parameter because the database state has not been reset - * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). + * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). @n * In this case DbEnumerator::Reset() should be invoked before calling this method. * @remarks The bound @c byte array size is from the current position of byte buffer to the limit. */ result BindBlob(int columnIndex, const Tizen::Base::ByteBuffer& value); /** - * Binds the raw blob data to the statement parameter. + * Binds the specified raw blob data to the statement parameter. * * @if OSPCOMPAT * @brief [Compatibility] @@ -200,26 +204,27 @@ public: * @endif * * @return An error code - * @param[in] columnIndex The index of the column whose value is bound + * @param[in] columnIndex The index of the column to bind the value * @param[in] buffer A pointer to the buffer where blob data is located @n * The maximum available size is limited to 100 MBytes. * @param[in] size The blob data length in bytes * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE The instance has not been properly constructed, - * or the instance is finalized. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The specified @c columnIndex is invalid. @n - * - The specified @c size is less than @c 0. @n - * - The pointer to the buffer is @c null. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - The instance has not been properly constructed. + * - The instance is finalized. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c columnIndex is invalid. + * - The specified @c size is less than @c 0. + * - The pointer to the buffer is @c null. * - The specified @c buffer exceeds size limit. * @exception E_INVALID_OPERATION This method has failed to bind the parameter because the database state has not been reset - * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). + * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). @n * In this case DbEnumerator::Reset() should be invoked before calling this method. */ result BindBlob(int columnIndex, const void* buffer, int size); /** - * Binds a DateTime value to the statement parameter. + * Binds the specified DateTime value to the statement parameter. * * @if OSPCOMPAT * @brief [Compatibility] @@ -231,15 +236,17 @@ public: * @endif * * @return An error code - * @param[in] columnIndex The index of the column whose value is bound + * @param[in] columnIndex The index of the column to bind the value * @param[out] value The date value to bind * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE The instance has not been properly constructed, - * or the instance is finalized. - * @exception E_INVALID_ARG The specified @c columnIndex is invalid, or - * the value is less than @c or a @c null pointer. + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - The instance has not been properly constructed. + * - The instance is finalized. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c columnIndex is invalid. + * - The value is less than @c or a @c null pointer. * @exception E_INVALID_OPERATION This method has failed to bind the parameter because the database state has not been reset - * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). + * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). @n * In this case DbEnumerator::Reset() should be invoked before calling this method. */ result BindDateTime(int columnIndex, const Tizen::Base::DateTime& value); @@ -257,13 +264,14 @@ public: * @endif * * @return An error code - * @param[in] columnIndex The index of the column whose value is bound + * @param[in] columnIndex The index of the column to bind the @c null value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE The instance has not been properly constructed, - * or the instance is finalized. + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - The instance has not been properly constructed. + * - The instance is finalized. * @exception E_INVALID_ARG The specified @c columnIndex is invalid. * @exception E_INVALID_OPERATION This method has failed to bind the parameter because the database state has not been reset - * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). + * after executing the SELECT query by using Database::ExecuteStatementN() or DbEnumerator::MoveNext(). @n * In this case DbEnumerator::Reset() should be invoked before calling this method. */ result BindNull(int columnIndex); diff --git a/inc/FIoDbTypes.h b/inc/FIoDbTypes.h index a2fd26f..b4f3096 100644 --- a/inc/FIoDbTypes.h +++ b/inc/FIoDbTypes.h @@ -18,7 +18,7 @@ * @file FIoDbTypes.h * @brief This is the header file for the %DbColumnType enumerator. * - * This header file contains the declarations of the %DbColumnType enumerator. + * This header file contains the declarations of the DbColumnType enumerator. */ #ifndef _FIO_DB_TYPES_H_ diff --git a/inc/FIoDirEntry.h b/inc/FIoDirEntry.h index 4980938..11dbf61 100644 --- a/inc/FIoDirEntry.h +++ b/inc/FIoDirEntry.h @@ -37,7 +37,7 @@ namespace Tizen { namespace Io /** * @class DirEntry - * @brief This class stores the information about each directory entry. + * @brief This class provides methods for the information about each directory entry. * * @since 2.0 * @@ -175,13 +175,13 @@ public: * * @since 2.0 * - * @return A reference to the calling instance + * @return A reference to the current instance * @param[in] rhs An instance of %DirEntry */ DirEntry& operator =(const DirEntry& rhs); /** - * Compares the specified instance of Object to the calling instance of %DirEntry. + * Compares the specified instance of Tizen::Base::Object to the calling instance of %DirEntry. * * @since 2.0 * diff --git a/inc/FIoDirEnumerator.h b/inc/FIoDirEnumerator.h index b39969f..46d76e2 100644 --- a/inc/FIoDirEnumerator.h +++ b/inc/FIoDirEnumerator.h @@ -42,7 +42,7 @@ class DirEntry; * * The %DirEnumerator class provides methods to access the collection of a specific directory entry list. * Generally, %DirEnumerator is instantiated by the Directory::ReadN() method, - * and used to get the %DirEntry instances that have information pertaining to the directory. + * and used to get the DirEntry instances that have information pertaining to the directory. * * For more information on the class features, * see Io Guide. @@ -129,13 +129,14 @@ public: * @return A reference to the DirEntry instance * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The current position of the collection is not valid. - * @remarks Use the MoveNext() method to get information from another file or directory to the currently accessed directory. @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - Use the MoveNext() method to get information from another file or directory to the currently accessed directory. + * - The specific error code can be accessed using the GetLastResult() method. */ DirEntry GetCurrentDirEntry(void) const; /** - * Gets the pointer to the object at the current position of a directory entry collection. + * Gets a pointer to the object at the current position of a directory entry collection. * * @since 2.0 * @@ -147,8 +148,8 @@ public: /** * Moves the current position of the collection to the next position in the currently accessed directory. @n - * When %DirEnumerator is instantiated, its initial position is set to @c -1. @n - * Therefore, calling the GetCurrentDirEntry() method without a call to MoveNext() throws an E_INVALID_STATE exception, + * When DirEnumerator is instantiated, its initial position is set to @c -1. @n + * Therefore, calling the GetCurrentDirEntry() method without a call to MoveNext() throws an @c E_INVALID_STATE exception, * and returns a reference to an empty DirEntry instance. @n * Similarly, calling the GetCurrent() method without a call to MoveNext() returns a @c null pointer to indicate an error condition. * @@ -156,17 +157,17 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The length of the specified path is @c 0 or exceeds - * system limitations. @n - * - The specified path is invalid. @n + * system limitations. + * - The specified path is invalid. * - The file handle is invalid (the file is closed by another method). * @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found. * @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit. * @exception E_END_OF_FILE There are no more directory entries to read. * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. */ virtual result MoveNext(void); diff --git a/inc/FIoDirectory.h b/inc/FIoDirectory.h index dceea62..d0c9634 100644 --- a/inc/FIoDirectory.h +++ b/inc/FIoDirectory.h @@ -37,13 +37,13 @@ namespace Tizen { namespace Io /** * @class Directory - * @brief This class provides methods to operate on directories. + * @brief This class provides methods for directory operations. * * @since 2.0 * * @final This class is not intended for extension. * - * The %Directory class provides methods to operate on directories. + * The %Directory class provides methods for directory operations. * * For more information on the class features, * see Io Guide. @@ -134,7 +134,8 @@ class _OSP_EXPORT_ Directory public: /** - * 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. + * 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 * @@ -165,15 +166,15 @@ public: * @return An error code * @param[in] dirPath The path to the directory to open * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The length of the specified path is @c 0 or exceeds system limitations. @n - * - The specified path contains prohibited character(s). @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The length of the specified path is @c 0 or exceeds system limitations. + * - The specified path contains prohibited character(s). * - The specified path is invalid. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found. * @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. */ result Construct(const Tizen::Base::String& dirPath); @@ -186,13 +187,14 @@ public: * @return A pointer to the DirEnumerator object that provides a way to access the collection of a directory entry list, @n * else @c null if an exception occurs * @exception E_SUCCESS The method is successful. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. - * @remarks The returned enumeration objects should be released by the caller. @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - The returned enumeration objects should be released by the caller. + * - The specific error code can be accessed using the GetLastResult() method. */ DirEnumerator* ReadN(void); @@ -209,20 +211,20 @@ public: * @endif * * @return An error code - * @param[in] dirPath The path at which the directory is created - * @param[in] createParentDirectories Set to @c true if the non-existing parent directories are created automatically + * @param[in] dirPath The path to create the directory + * @param[in] createParentDirectories Set to @c true to create the non-existing parent directories automatically * up to the destination, @n - * else @c false if an absent parent directory causes an exception + * else @c false to throw an exception in case of absent parent directory * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The length of the specified path is @c 0 or exceeds system limitations. @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The length of the specified path is @c 0 or exceeds system limitations. * - The specified path is invalid. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_ALREADY_EXIST The specified file already exists. * @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. */ static result Create(const Tizen::Base::String& dirPath, bool createParentDirectories = false); @@ -246,16 +248,16 @@ public: * @param[in] recursive Set to @c true to remove the sub-directories recursively, @n * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The length of the specified path is @c 0 or exceeds - * system limitations. @n + * system limitations. * - The specified @c dirPath is not directory path. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_NOT_FOUND The specified @c dirPath cannot be found. * @exception E_FILE_ALREADY_EXIST The specified directory already exists. * @exception E_MAX_EXCEEDED The number of opened directories has exceeded the maximum limit. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. */ static result Remove(const Tizen::Base::String& dirPath, bool recursive = false); @@ -279,16 +281,16 @@ public: * @param[in] orgDirPath The original directory path * @param[in] newDirPath The new directory path * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The length of the specified path is @c 0 or exceeds system limitations. @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The length of the specified path is @c 0 or exceeds system limitations. * - The specified path is invalid. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found. * @exception E_FILE_ALREADY_EXIST The specified file already exists. * @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. */ static result Rename(const Tizen::Base::String& orgDirPath, const Tizen::Base::String& newDirPath); diff --git a/inc/FIoFile.h b/inc/FIoFile.h index a769e00..50b179f 100644 --- a/inc/FIoFile.h +++ b/inc/FIoFile.h @@ -46,13 +46,13 @@ namespace Tizen { namespace Io enum FileSeekPosition { FILESEEKPOSITION_BEGIN, /**GetAppRootPath() + L"data" - * or Tizen::App::App::GetInstance()->GetAppDataPath(). - * - res - Used to read resource files that are delivered with the application package (read-only permission) @n - * To access this directory, use Tizen::App::App::GetInstance()->GetAppRootPath() + L"res" - * or Tizen::App::App::GetInstance()->GetAppResourcePath(). - * - shared - Used to share data and resource files with other applications @n - * There are data and res directories under the shared directory. - * Use Tizen::App::App::GetInstance()->GetAppRootPath() + L"shared" to access its own shared directory and - * use Tizen::App::AppManager::GetAppSharedPath() to access other application's shared directory. @n + * - data - Used to store and access private data of an application (read-write permission) @n + * To access this directory, use Tizen::App::App::GetInstance()->GetAppRootPath() + L"data" + * or Tizen::App::App::GetInstance()->GetAppDataPath(). + * - res - Used to read resource files that are delivered with the application package (read-only permission) @n + * To access this directory, use Tizen::App::App::GetInstance()->GetAppRootPath() + L"res" + * or Tizen::App::App::GetInstance()->GetAppResourcePath(). + * - shared - Used to share data and resource files with other applications @n + * Shared directory has data and res directories. + * Use Tizen::App::App::GetInstance()->GetAppRootPath() + L"shared" to access its own shared directory and + * use Tizen::App::AppManager::GetAppSharedPath() to access other application's shared directory. * * For more information on the path, * see I/O Overview. * - * For more information on class features, + * For more information on the class features, * see Io Guide. * * The following example demonstrates how to use the %File class. @@ -172,7 +172,7 @@ CATCH: * @if OSPCOMPAT * @page CompIoPathPage Compatibility for path * @section CompIoPathPageIssueSection Issues - * The path argument of this method in OSP compatible applications has the following issue: @n + * The path argument of this method in OSP compatible applications has the following issue: * * -# The path should begin with an allowed path prefix such as '/Home', '/Home/Share', '/Res', '/Share/[@e appid]', * '/Media', and '/Storagecard/Media'. @@ -201,7 +201,8 @@ class _OSP_EXPORT_ File public: /** - * 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. + * 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 */ @@ -244,25 +245,26 @@ public: * - a+: Open for appending and reading. The file is created if it does not exist. * @param[in] createParentDirectories Set to @c true to automatically create non-existent parent directories up to destination, @n * else @c false @n - * This parameter is useful only if the specified @c openMode allows creation of an absent - * file. For example, the following modes: "w", "w+", "a" and "a+". @n + * This parameter is useful only if the specified @c openMode is "w", "w+", "a" or "a+" + * that allows the creation of an absent file. @n * If the value of @c openMode is not any one of these, E_INVALID_ARG exception is thrown. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The overall length of the specified path is equal to @c 0 or - * exceeds system limitations. @n - * - The combination of the specified @c openMode is not allowed. @n - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. @n + * exceeds system limitations. + * - The combination of the specified @c openMode is not allowed. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. @n * For example, opening a read-only file in the write mode such as "w" or "a". * @exception E_FILE_NOT_FOUND The specified @c filePath cannot be found. * @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. - * @remarks The following file opening mode strings are recognized by this method: "w+", "wb+", "w+b", "w", "wb", "a+", - * "ab+", "a+b", "a", "ab", "r+", "rb+", "r+b", "r", "rb". @n - * Other strings lead to E_INVALID_ARG. However, "b"(binary) open mode is ignored internally. + * @remarks The valid file opening modes for this method are: "w+", "wb+", "w+b", "w", "wb", "a+", + * "ab+", "a+b", "a", "ab", "r+", "rb+", "r+b", "r", and "rb". @n + * If any other value is passed, this method throws @c E_INVALID_ARG. However, "b"(binary) open mode is ignored + * internally. * @endcond */ result Construct(const Tizen::Base::String& filePath, const Tizen::Base::String& openMode, bool createParentDirectories); @@ -293,22 +295,23 @@ public: * - a : Open for appending. The file is created if it does not exist. * - a+: Open for appending and reading. The file is created if it does not exist. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The overall length of the specified path is equal to @c 0 or - * exceeds system limitations. @n - * - The combination of the specified @c openMode is not allowed. @n - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. @n + * exceeds system limitations. + * - The combination of the specified @c openMode is not allowed. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. @n * For example, opening a read-only file in the write mode such as "w" or "a". * @exception E_FILE_NOT_FOUND The specified @c filePath cannot be found. * @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The following file opening mode strings are recognized by this method: "w+", "wb+", "w+b", "w", "wb", "a+", - * "ab+", "a+b", "a", "ab", "r+", "rb+", "r+b", "r", "rb". @n - * Other strings lead to E_INVALID_ARG. However, "b"(binary) open mode is ignored internally. + * @remarks The valid file opening modes for this method are: "w+", "wb+", "w+b", "w", "wb", "a+", + * "ab+", "a+b", "a", "ab", "r+", "rb+", "r+b", "r", and "rb". @n + * If any other value is passed, this method throws @c E_INVALID_ARG. However, "b"(binary) open mode is ignored + * internally. */ result Construct(const Tizen::Base::String& filePath, const Tizen::Base::String& openMode); @@ -331,22 +334,23 @@ public: * - a : Open for appending. The file is created if it does not exist. * - a+: Open for appending and reading. The file is created if it does not exist. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The overall length of the specified path is equal to @c 0 or - * exceeds system limitations. @n - * - The combination of the specified @c pOpenMode is not allowed. @n - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. @n + * exceeds system limitations. + * - The combination of the specified @c pOpenMode is not allowed. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. @n * For example, opening a read-only file in the write mode such as "w" or "a". * @exception E_FILE_NOT_FOUND The specified @c filePath cannot be found. * @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The following file opening mode strings are recognized by this method: "w+", "wb+", "w+b", "w", "wb", "a+", - * "ab+", "a+b", "a", "ab", "r+", "rb+", "r+b", "r", "rb". @n - * Other strings lead to E_INVALID_ARG. However, "b"(binary) open mode is ignored internally. + * @remarks The valid file opening modes for this method are: "w+", "wb+", "w+b", "w", "wb", "a+", + * "ab+", "a+b", "a", "ab", "r+", "rb+", "r+b", "r", and "rb". @n + * If any other value is passed, this method throws @c E_INVALID_ARG. However, "b"(binary) open mode is ignored + * internally. */ result Construct(const Tizen::Base::String& filePath, const char* pOpenMode); @@ -355,8 +359,8 @@ public: * This method opens an existing secure file or creates a new one according to the specified file opening mode. @n * The contents written to the secure file is automatically encrypted and the contents read from the secure file is automatically * decrypted by the platform. @n - * Applications using this method can access the secure files that are created by other applications with the identical key value - * in same device. However, the secure files created by this method cannot be accessed in other devices. + * Applications using this method can access the secure files that are created by other applications with an identical key value + * in the same device. However, the secure files created by this method cannot be accessed in other devices. * * @since 2.0 * @@ -372,210 +376,205 @@ public: * otherwise it is truncated to zero length. * - a : Open for appending. The file is created if it does not exist. * - a+: Open for appending and reading. The file is created if it does not exist. - * @param[in] secretKey A key used to encrypt data of a file or decrypt a secure file @n - * If a secure file is created with a specific key value, - * other applications can access the same secure file with the identical key value. + * @param[in] secretKey The key used to encrypt the data of the file or decrypt the secure file @n + * If the secure file is created with a specific key value, + * other applications can access the secure file with an identical key value. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The overall length of the specified path is equal to @c 0 or * exceeds system limitations. - * - The combination of the specified @c pOpenMode is not allowed. @n + * - The combination of the specified @c pOpenMode is not allowed. * - The specified @c secretKey is incorrect or the secure file is corrupted. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. @n + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. @n * For example, opening a read-only file in the write mode such as "w" or "a". * @exception E_FILE_NOT_FOUND The specified @c filePath cannot be found. * @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n - * - %File corruption is detected. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. + * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The following file opening mode strings are recognized by this method: "w+", "wb+", "w+b", "w", "wb", "a+", - * "ab+", "a+b", "a", "ab", "r+", "rb+", "r+b", "r", "rb". @n - * Other strings lead to E_INVALID_ARG. However, "b"(binary) open mode is ignored internally. + * @remarks The valid file opening modes for this method are: "w+", "wb+", "w+b", "w", "wb", "a+", + * "ab+", "a+b", "a", "ab", "r+", "rb+", "r+b", "r", and "rb". @n + * If any other value is passed, this method throws @c E_INVALID_ARG. However, "b"(binary) open mode is ignored + * internally. */ result Construct(const Tizen::Base::String& filePath, const char* pOpenMode, const Tizen::Base::ByteBuffer& secretKey); /** * Reads the byte data from the current file pointer. @n * The user-specified ByteBuffer is filled with the byte data from the current position in the file. - * The read operation continues until the specified ByteBuffer is filled or end-of-file is met. @n + * The read operation continues until the specified ByteBuffer is filled or the end of file is reached. @n * In the secure mode, the byte data read from the secure file is automatically decrypted by a platform security module. * * @since 2.0 * * @return An error code - * @param[in, out] buffer A reference to the buffer that is used to receive the byte data read from the file + * @param[in, out] buffer The reference to the buffer to copy the byte data * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c buffer has no space to store the read data. - * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n - * - The file is not opened for read operation. @n - * - Access is denied due to insufficient permission. - * @exception E_END_OF_FILE The file pointer has reached end-of-file. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: + * - The file is not opened for read operation. + * - The access is denied due to insufficient permission. + * @exception E_END_OF_FILE The file pointer has reached the end of file. + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. - * @remarks The ByteBuffer should be constructed before being passed to the method. + * @remarks The ByteBuffer should be constructed before being passed to this method. */ result Read(Tizen::Base::ByteBuffer& buffer); /** - * Reads the byte data from the current file pointer and copies it into the specified buffer. @n + * Reads the byte data from the current file pointer and copies it to the specified buffer. @n * In the secure mode, the byte data read from the secure file is automatically decrypted by a platform security module. * * @since 2.0 * * @return The length of the data read in bytes, @n * else @c 0 in case of failure - * @param[out] buffer A pointer to the user-supplied buffer where the read data is copied + * @param[out] buffer The pointer to the buffer to copy the byte data * @param[in] length The buffer length in bytes * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The specified @c buffer contains a @c null pointer. @n - * - The length of the specified @c buffer is equal to or smaller than @c 0. @n - * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n - * - The file is not opened for read operation. @n - * - Access is denied due to insufficient permission. - * @exception E_END_OF_FILE The file pointer has reached end-of-file. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c buffer contains a @c null pointer. + * - The length of the specified @c buffer is equal to or smaller than @c 0. + * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: + * - The file is not opened for read operation. + * - The access is denied due to insufficient permission. + * @exception E_END_OF_FILE The file pointer has reached the end of file. + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @remarks The specific error code can be accessed using the GetLastResult() method. */ int Read(void* buffer, int length); /** - * Reads the string data from the current file pointer and copies the string to the specified buffer (it is assumed that the - * file is in the UTF-8 format). @n - * The read operation continues until new line character or end-of-file is met. @n + * Reads the string data from the current file pointer and copies it to the specified buffer. @n + * It is assumed that the file is in the UTF-8 format. + * The read operation continues until a new line character or end-of-file is reached. @n * In the secure mode, the string data read from the secure file is automatically decrypted by a platform security module. * * @since 2.0 * * @return An error code - * @param[out] buffer A reference to the buffer where the data is copied + * @param[out] buffer A reference to the buffer to copy the string data * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c buffer is invalid. - * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n - * - The file is not opened for read operation. @n - * - Access is denied due to insufficient permission. - * @exception E_END_OF_FILE The file pointer reached end-of-file. + * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: + * - The file is not opened for read operation. + * - The access is denied due to insufficient permission. + * @exception E_END_OF_FILE The file pointer reached the end of file. * @exception E_IO Either of the following conditions has occurred: - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. - * @remarks To get the expected string value - * from a file, which is not in the UTF-8 format (Unicode or any other format), - * user should use other encoding or decoding methods of the Tizen::Text namespace after reading the content of - * a file in binary format. @n - * The maximum length of characters read by this method is defined as 4096. @n - * Therefore, if the length of a single line (considering new line character or end-of-file) from the current + * @remarks To get the expected string value from a file, which is not in the UTF-8 format + * (Unicode or any other format), the user should use other encoding or decoding methods of the + * Tizen::Text namespace after reading the content of the file in binary format. @n + * The maximum length of characters read by this method is defined as @c 4096. @n + * Therefore, if the length of a single line (till a new line character or end-of-file is reached) from the current * file position is longer than 4096, the rest of the characters remain as not read. @n - * 'ByteBuffer' or 'void*' version of the File::Read() API can be used to overcome this limitation. + * The 'ByteBuffer' or 'void*' version of the File::Read() API can be used to overcome this limitation. */ result Read(Tizen::Base::String& buffer); /** - * Writes the byte data from the specified ByteBuffer into a file beginning at the current position to the limit of the - * %ByteBuffer. @n - * In the secure mode, the byte data written by a user is automatically encrypted to the secure file by a platform security module. @n - * The size of a secure file can be greater than the size of a normal (original) file - * because of the encryption. - * However, the file pointer for the secure file is equal to the file pointer for the original file. + * Writes the byte data from the specified Tizen::Base::ByteBuffer beginning at the current position to the limit of the %Tizen::Base::ByteBuffer + * to a file . @n + * In the secure mode, the byte data written is automatically encrypted to a secure file by the platform security module. @n + * The size of a secure file can be greater than the size of a normal (original) file because of the encryption. + * However, the file pointer for a secure file is equal to the file pointer for an original file. * * @since 2.0 * * @return An error code - * @param[in] buffer A reference to the buffer that contains byte data to write + * @param[in] buffer A reference to the buffer that contains the byte data to write * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c buffer is invalid. - * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n - * - The file is not opened for write operation. @n - * - Access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: + * - The file is not opened for write operation. + * - The access is denied due to insufficient permission. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. */ result Write(const Tizen::Base::ByteBuffer& buffer); /** - * Writes the byte data into a file. @n - * In the secure mode, the byte data written by a user is automatically encrypted to the secure file by a platform security module. @n - * The size of a secure file can be greater than the size of a normal (original) file - * because of the encryption. - * However, the file pointer for the secure file is equal to the file pointer for the original file. + * Writes the byte data from the specified buffer to a file. @n + * In the secure mode, the byte data written is automatically encrypted to a secure file by the platform security module. @n + * The size of a secure file can be greater than the size of a normal (original) file because of the encryption. + * However, the file pointer for a secure file is equal to the file pointer for an original file. * * @since 2.0 * * @return An error code - * @param[in] buffer A pointer to the user-supplied buffer that contains @c byte data to write + * @param[in] buffer A pointer to the buffer that contains the @c byte data to write * @param[in] length The buffer length in bytes * @exception E_SUCCESS The method is successful. - * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n - * - The file is not opened for write operation. @n - * - Access is denied due to insufficient permission. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The specified @c buffer contains a @c null pointer. @n - * - The specified @c buffer length is equal or smaller than @c 0. @n + * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: + * - The file is not opened for write operation. + * - The access is denied due to insufficient permission. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c buffer contains a @c null pointer. + * - The specified @c buffer length is equal or smaller than @c 0. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. */ result Write(const void* buffer, int length); /** - * Writes the string data into a file. @n - * In the secure mode, the string data written by a user is automatically encrypted to the secure file by a platform security - * module. @n - * The size of a secure file can be greater than the size of a normal (original) file - * because of the encryption. - * However, the file pointer for the secure file is equal to the file pointer for the original file. + * Writes the string data from the specified buffer to a file. @n + * In the secure mode, the string data written is automatically encrypted to a secure file by the platform security module. @n + * The size of a secure file can be greater than the size of a normal (original) file because of the encryption. + * However, the file pointer for a secure file is equal to the file pointer for an original file. * * @since 2.0 * * @return An error code - * @param[in] buffer A reference to the buffer that contains string data to write + * @param[in] buffer A reference to the buffer that contains the string data to write * @exception E_SUCCESS The method is successful. - * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n - * - The file is not opened for write operation. @n - * - Access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: + * - The file is not opened for write operation. + * - The access is denied due to insufficient permission. * @exception E_INVALID_ARG The specified @c buffer contains an empty string. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. */ result Write(const Tizen::Base::String& buffer); /** - * Flushes the internally buffered data to kernel memory of the underlying operating system. + * Flushes the internally buffered data to the kernel memory of the underlying operating system. * * @since 2.0 * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. */ result Flush(void); /** * Gets the offset of the current file pointer relative to the beginning of the file. @n - * The size of a secure file can be greater than the size of a normal (original) file - * because of the encryption. - * However, the file pointer for the secure file is equal to the file pointer for the original file. + * The size of a secure file can be greater than the size of a normal (original) file because of the encryption. + * However, the file pointer for a secure file is equal to the file pointer for an original file. * * @since 2.0 * * @return The offset of the current file pointer, @n * else @c -1L if an error occurs * @exception E_SUCCESS The method is successful. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Seek() @@ -583,27 +582,26 @@ public: int Tell(void) const; /** - * Repositions the file pointer associated with an opened file. @n + * Repositions the file pointer associated with the opened file. @n * Each opened file has its own file pointer, and it points to the next byte to be read or written in the file. * The repositioning offset can be specified with respect to the beginning of file, current position, or end of the file. * If the file pointer is over the end-of-file, it expands the file size to the specified position and the expanded area is * filled with zero. @n - * The size of a secure file can be greater than the size of a normal (original) file - * because of the encryption. - * However, the file pointer for the secure file is equal to the file pointer for the original file. + * The size of a secure file can be greater than the size of a normal (original) file because of the encryption. + * However, the file pointer for a secure file is equal to the file pointer for an original file. * * @since 2.0 * * @return An error code - * @param[in] position The origin from where to start the repositioning a file pointer + * @param[in] position The starting position to reposition the file pointer * @param[in] offset The number of bytes to move a file pointer @n * A negative offset moves the pointer backwards. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c position or @c offset is invalid. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @see FileSeekPosition */ @@ -611,11 +609,9 @@ public: /** * Truncates the file size to the specified length. @n - * If the specified length is less than the length of file, the bytes present between the @c length and size of a file are - * removed. - * If the file size is small, its size is increased. @n - * The size of a secure file can be greater than the size of a normal (original) file - * because of the encryption. + * If the specified length is less than the length of file, the bytes present between the specified @c length and size of + * the file are removed. If the file size is small, its size is increased. @n + * The size of a secure file can be greater than the size of a normal (original) file because of the encryption. * However, the file pointer for a secure file is equal to the file pointer for an original file. * * @since 2.0 @@ -623,142 +619,146 @@ public: * @return An error code * @param[in] length The required file size in bytes after this method is executed * @exception E_SUCCESS The method is successful. - * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: @n - * - The file is not opened for write operation. @n - * - Access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: + * - The file is not opened for write operation. + * - The access is denied due to insufficient permission. * @exception E_INVALID_ARG The specified @c length has a negative value. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. */ result Truncate(int length); /** - * Gets the path associated with a constructed %File. + * Gets the path associated with the %File. * * @since 2.0 * - * @return The file path to the currently constructed %File if successful, @n + * @return The path of the currently constructed %File, @n * else an empty string in case of failure */ Tizen::Base::String GetName(void) const; /** - * Acquires the file lock on the current opened whole file if it is not acquired. + * Acquires the file lock on the current opened whole file if it is not acquired. @n * If the file lock is already acquired by another process, the current process is blocked until the file lock is * released. * * @since 2.1 * - * @return The pointer to %FileLock instance, @n - * else @c null pointer in case of failure - * @param[in] lockType The type of file lock to be created + * @return The pointer to the FileLock instance, @n + * else @c null pointer in case of failure + * @param[in] lockType The type of the file lock to be created * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c lockType is invalid. - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n - * - The specified @c lockType cannot be FILE_LOCK_SHARED if the current - * file is not open for reading. @n - * - The specified @c lockType cannot be FILE_LOCK_EXCLUSIVE if the current - * file is not open for writing. @n + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The specified @c lockType cannot be @c FILE_LOCK_SHARED if the current + * file is not open for reading. + * - The specified @c lockType cannot be @c FILE_LOCK_EXCLUSIVE if the current + * file is not open for writing. * @exception E_WOULD_DEADLOCK The method would cause a deadlock. @n - * The lock is blocked by a lock from another process, and putting the - * calling process to sleep to wait for that lock to become free would - * cause a deadlock. - * @exception E_MAX_EXCEEDED The number of file lock exceeds system limitations. + * The lock is blocked by a lock from another process, and putting the + * calling process to sleep to wait for that lock to become free would + * cause a deadlock. + * @exception E_MAX_EXCEEDED The number of file locks has exceeded system limitations. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The %FileLock instance is invalid if the associated %File instance is deleted. @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - The FileLock instance is invalid if the associated %File instance is deleted. + * - The specific error code can be accessed using the GetLastResult() method. */ FileLock* LockN(FileLockType lockType); /** - * Acquires the file lock on the specified region of the current opened file if it is not acquired. + * Acquires the file lock on the specified region of the current opened file if it is not acquired. @n * If the file lock is already acquired by another process, the current process is blocked until the file lock is * released. * * @since 2.1 * - * @return The pointer to %FileLock instance, @n - * else @c null pointer in case of failure + * @return The pointer to the FileLock instance, @n + * else @c null pointer in case of failure * @param[in] lockType The type of file lock to be created * @param[in] offset The starting offset for the locked region * @param[in] length The length of the locked region in bytes * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The specified @c lockType is invalid. * - The specified @c offset or @c length is negative or is greater than * the system limitation. - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n - * - The specified @c lockType cannot be FILE_LOCK_SHARED if the current - * file is not open for reading. @n - * - The specified @c lockType cannot be FILE_LOCK_EXCLUSIVE if the current - * file is not open for writing. @n + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The specified @c lockType cannot be @c FILE_LOCK_SHARED if the current + * file is not open for reading. + * - The specified @c lockType cannot be @c FILE_LOCK_EXCLUSIVE if the current + * file is not open for writing. * @exception E_WOULD_DEADLOCK The method would cause a deadlock. @n - * The lock is blocked by a lock from another process, and putting the - * calling process to sleep to wait for that lock to become free would - * cause a deadlock. - * @exception E_MAX_EXCEEDED The number of file lock exceeds system limitations. + * The lock is blocked by a lock from another process, and putting the + * calling process to sleep to wait for that lock to become free would + * cause a deadlock. + * @exception E_MAX_EXCEEDED The number of file locks has exceeded system limitations. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The %FileLock instance is invalid if the associated %File instance is deleted. @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - The FileLock instance is invalid if the associated %File instance is deleted. + * - The specific error code can be accessed using the GetLastResult() method. */ FileLock* LockN(FileLockType lockType, int offset, int length); /** - * Tries to acquire the file lock on the current opened whole file. - * If the file lock is already acquired by another process, E_OBJECT_LOCKED is returned. + * Tries to acquire the file lock on the current opened whole file. @n + * If the file lock is already acquired by another process, @c E_OBJECT_LOCKED is returned. * * @since 2.1 * - * @return The pointer to %FileLock instance, @n - * else @c null pointer in case of failure + * @return The pointer to the FileLock instance, @n + * else @c null pointer in case of failure * @param[in] lockType The type of file lock to be created * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c lockType is invalid. - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n - * - The specified @c lockType cannot be FILE_LOCK_SHARED if the current - * file is not open for reading. @n - * - The specified @c lockType cannot be FILE_LOCK_EXCLUSIVE if the current - * file is not open for writing. @n - * @exception E_OBJECT_LOCKED Either of the following conditions has occurred: @n - * - The file lock is already held by another process. @n - * - The file to be locked has been memory-mapped by another process. - * @exception E_MAX_EXCEEDED The number of file lock exceeds system limitations. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The specified @c lockType cannot be @c FILE_LOCK_SHARED if the current + * file is not open for reading. + * - The specified @c lockType cannot be @c FILE_LOCK_EXCLUSIVE if the current + * file is not open for writing. + * @exception E_OBJECT_LOCKED Either of the following conditions has occurred: + * - The file lock is already held by another process. + * - The file to be locked has been memory-mapped by another process. + * @exception E_MAX_EXCEEDED The number of file locks has exceeded system limitations. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The %FileLock instance is invalid if the associated %File instance is deleted. @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - The FileLock instance is invalid if the associated %File instance is deleted. + * - The specific error code can be accessed using the GetLastResult() method. */ FileLock* TryToLockN(FileLockType lockType); /** - * Tries to acquire the file lock on the specified region of the current opened file. - * If the file lock is already acquired by another process, E_OBJECT_LOCKED is returned. + * Tries to acquire the file lock on the specified region of the current opened file. @n + * If the file lock is already acquired by another process, @c E_OBJECT_LOCKED is returned. * * @since 2.1 * - * @return The pointer to %FileLock instance, @n - * else @c null pointer in case of failure + * @return The pointer to the FileLock instance, @n + * else @c null pointer in case of failure * @param[in] lockType The type of file lock to be created * @param[in] offset The starting offset for the locked region * @param[in] length The length of the locked region in bytes * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The specified @c lockType is invalid. - * - The specified @c offset or @c length is negative or is greater than - * the system limitation. - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n - * - The specified @c lockType cannot be FILE_LOCK_SHARED if the current - * file is not open for reading. @n - * - The specified @c lockType cannot be FILE_LOCK_EXCLUSIVE if the current - * file is not open for writing. @n - * @exception E_OBJECT_LOCKED Either of the following conditions has occurred: @n - * - The file lock is already held by another process. @n - * - The file to be locked has been memory-mapped by another process. - * @exception E_MAX_EXCEEDED The number of file lock exceeds system limitations. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c lockType is invalid. + * - The specified @c offset or @c length is negative or is greater than + * the system limitation. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The specified @c lockType cannot be @c FILE_LOCK_SHARED if the current + * file is not open for reading. + * - The specified @c lockType cannot be @c FILE_LOCK_EXCLUSIVE if the current + * file is not open for writing. + * @exception E_OBJECT_LOCKED Either of the following conditions has occurred: + * - The file lock is already held by another process. + * - The file to be locked has been memory-mapped by another process. + * @exception E_MAX_EXCEEDED The number of file locks has exceeded system limitations. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The %FileLock instance is invalid if the associated %File instance is deleted. @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - The FileLock instance is invalid if the associated %File instance is deleted. + * - The specific error code can be accessed using the GetLastResult() method. */ FileLock* TryToLockN(FileLockType lockType, int offset, int length); @@ -778,22 +778,22 @@ public: * @return An error code * @param[in] filePath The path of the file to delete * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The overall length of the specified path is equal to @c 0 or - * exceeds system limitations. @n + * exceeds system limitations. * - The specified path is invalid. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. @n + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. @n * For example, opening a read-only file in the write mode. * @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @remarks The opened file cannot be deleted. */ static result Remove(const Tizen::Base::String& filePath); /** - * Moves the specified file to another location. @n + * Moves the specified file to the specified location. @n * The opened files cannot be moved. This method is static. * * @if OSPCOMPAT @@ -809,26 +809,26 @@ public: * @param[in] oldFilePath The old file path * @param[in] newFilePath The new file path * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The overall length of the specified path is equal to @c 0 or - * exceeds system limitations. @n + * exceeds system limitations. * - The specified path is invalid. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. @n + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. @n * For example, opening a read-only file in the write mode. - * @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found. + * @exception E_FILE_NOT_FOUND The specified @c filePath cannot be found. * @exception E_FILE_ALREADY_EXIST The specified file already exists. * @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @see Copy() - * @see Remove() + * @see Remove() */ static result Move(const Tizen::Base::String& oldFilePath, const Tizen::Base::String& newFilePath); /** - * Copies the existing source file to the destined location. @n + * Copies the existing source file to the specified destination file path. @n * This method is static. * * @since 2.0 @@ -839,26 +839,26 @@ public: * @param[in] failIfExist Set to @c true to return an error if the destination file already exists, @n * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The overall length of the specified path is equal to @c 0 or - * exceeds system limitations. @n + * exceeds system limitations. * - The specified path is invalid. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. @n + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. @n * For example, opening a read-only file in the write mode. - * @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found. + * @exception E_FILE_NOT_FOUND The specified @c filePath cannot be found. * @exception E_FILE_ALREADY_EXIST The specified file already exists. * @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @see Move() - * @see Remove() + * @see Remove() */ static result Copy(const Tizen::Base::String& srcFilePath, const Tizen::Base::String& destFilePath, bool failIfExist); /** - * Reads the file information such as size, attribute, creation date, and so on. @n + * Gets the attributes of the specified file such as size, attribute, creation date, and so on. @n * This method is static. * * @if OSPCOMPAT @@ -871,23 +871,23 @@ public: * @endif * * @return An error code - * @param[in] filePath The path of the file @n + * @param[in] filePath The path of the file * @param[out] attribute A %File attribute instance * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The overall length of the specified path is equal to @c 0 or - * exceeds system limitations. @n + * exceeds system limitations. * - The specified path is invalid. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. - * @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. + * @exception E_FILE_NOT_FOUND The specified @c filePath cannot be found. + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. */ static result GetAttributes(const Tizen::Base::String& filePath, FileAttributes& attribute); /** - * Gets only the file name from the specified file path. @n + * Gets the file name from the specified file path. @n * For example, if the file path passed is 'xxx/file.txt', 'file.txt' is returned. * * @if OSPCOMPAT @@ -900,7 +900,7 @@ public: * @endif * * @return The file name of type String - * @param[in] filePath The path of the file + * @param[in] filePath The file path * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The length of the specified path is @c 0 or exceeds system limitations. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -922,7 +922,7 @@ public: * * @return The file extension, @n * else an empty string if the file has no extension - * @param[in] filePath The path of the file + * @param[in] filePath The file path * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The length of the specified path is @c 0 or exceeds system limitations. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -942,16 +942,17 @@ public: * For more information, see @ref CompIoPathPage "here". * @endif * - * @return @c true if file or directory exists, @n + * @return @c true if the file or directory exists, @n * else @c false * @param[in] filePath The path of the file or directory * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The overall length of the specified path is equal to @c 0 or - * exceeds system limitations. @n + * exceeds system limitations. * - The specified path is invalid. - * @exception E_ILLEGAL_ACCESS The specified path is not permitted, or - * access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS Either of the following conditions has occurred: + * - The specified path is not permitted. + * - Access is denied due to insufficient permission. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static bool IsFileExist(const Tizen::Base::String& filePath); @@ -973,21 +974,21 @@ public: * @return An error code * @param[in] plainFilePath The normal (non-encrypted) file path * @param[in] secureFilePath The secure (encrypted) file path to create - * @param[in] key A key that encrypts a secure file @n - * If the secure file is converted with a specific key value, - * applications can access the same secure file with the identical key value. + * @param[in] key The key that encrypts the secure file @n + * If the secure file is converted with the specific key value, + * applications can access the secure file with an identical key value. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The overall length of the specified path is equal to @c 0 or - * exceeds system limitations. @n - * - The specified path is invalid. @n - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * exceeds system limitations. + * - The specified path is invalid. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_ALREADY_EXIST The specified file already exists. - * @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found. + * @exception E_FILE_NOT_FOUND The specified @c filePath cannot be found. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n - * - %File corruption is detected. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. + * - %File corruption is detected. * - The number of opened files has exceeded the maximum limit. */ static result ConvertToSecureFile(const Tizen::Base::String& plainFilePath, const Tizen::Base::String& secureFilePath, const Tizen::Base::ByteBuffer& key); diff --git a/inc/FIoFileAttributes.h b/inc/FIoFileAttributes.h index aba4038..e386dc8 100644 --- a/inc/FIoFileAttributes.h +++ b/inc/FIoFileAttributes.h @@ -36,7 +36,7 @@ namespace Tizen { namespace Io /** * @class FileAttributes - * @brief This class provides a collection of basic file attributes. + * @brief This class provides methods for file attributes. * * @since 2.0 * @@ -133,7 +133,7 @@ public: FileAttributes(const FileAttributes& rhs); /** - * Assigns the value of the specified instance to the current instance of %FileAttributes. + * Assigns the specified value of the specified instance to the current instance of %FileAttributes. * * @since 2.0 * @@ -143,7 +143,7 @@ public: FileAttributes& operator =(const FileAttributes& rhs); /** - * Compares the specified instance of Object to the calling instance of %FileAttributes. + * Compares the specified instance of Tizen::Base::Object to the current instance of %FileAttributes. * * @since 2.0 * diff --git a/inc/FIoFileEventManager.h b/inc/FIoFileEventManager.h index d8043ec..d2a9d36 100644 --- a/inc/FIoFileEventManager.h +++ b/inc/FIoFileEventManager.h @@ -46,22 +46,22 @@ class _FileEventManagerImpl; */ enum FileEventType { - FILE_EVENT_TYPE_ACCESS = 0x01, /**<%File was accessed (read)*/ - FILE_EVENT_TYPE_ATTRIBUTE = 0x04, /** [Deprecated] This interface provides event handlers for any response events received through a channel. * -* @deprecated This class is deprecated. Instead of using this class, use the MessagePortManager class. +* @deprecated This interface is deprecated. Instead of using this interface, use the MessagePortManager class. * @since 2.0 * * The %IChannelResponseEventListener interface provides event handlers for receiving the channel response events. @@ -50,7 +50,8 @@ class _OSP_EXPORT_ IChannelResponseEventListener { public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ diff --git a/inc/FIoIDbEnumerator.h b/inc/FIoIDbEnumerator.h index 7e222d5..12b5924 100644 --- a/inc/FIoIDbEnumerator.h +++ b/inc/FIoIDbEnumerator.h @@ -45,7 +45,8 @@ class _OSP_EXPORT_ IDbEnumerator public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -58,15 +59,15 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to move the cursor position of the result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_OUT_OF_RANGE The enumerator has reached out of the result set returned by the SELECT query. * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_INVALID_FORMAT The database file is malformed. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ @@ -79,15 +80,15 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to move the cursor position of the result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_OUT_OF_RANGE The enumerator has reached out of the result set returned by the SELECT query. * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_INVALID_FORMAT The database file is malformed. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ @@ -100,14 +101,14 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to move the cursor position of the result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_INVALID_FORMAT The database file is malformed. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ @@ -120,173 +121,172 @@ public: * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to move the cursor position of the result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_INVALID_FORMAT The database file is malformed. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ virtual result MoveLast(void) = 0; /** - * Resets the calling %IDbEnumerator instance back to its initial state. + * Resets the calling %IDbEnumerator instance to its initial state. * * @since 2.0 * * @return An error code * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to reset the enumerator of the result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_OBJECT_LOCKED The database instance is locked. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks After this method is called, if MoveNext() is called the cursor goes to the first position. + * @remarks If MoveNext() is called after this method, the cursor goes to the first position. */ virtual result Reset(void) = 0; /** - * Gets an @c int value from the column whose index is specified. + * Gets the @c int value from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required + * @param[in] columnIndex The index of the column to get the value * @param[in,out] value The integer value obtained from the column * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. */ virtual result GetIntAt(int columnIndex, int& value) const = 0; /** - * Gets a @c long @c long value from the column whose index is specified. + * Gets the @c long @c long value from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required + * @param[in] columnIndex The index of the column to get the value * @param[in,out] value The 64-bit integer value obtained from the column * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. */ virtual result GetInt64At(int columnIndex, long long& value) const = 0; /** - * Gets a @c double value from the column whose index is specified. + * Gets the @c double value from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required - * @param[in,out] value The value obtained from the column as a double + * @param[in] columnIndex The index of the column to get the value + * @param[in,out] value The double value obtained from the column * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. */ virtual result GetDoubleAt(int columnIndex, double& value) const = 0; /** - * Gets a @c String value from the column whose index is specified. + * Gets the @c String value from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required - * @param[in,out] value The value obtained from the column as a String + * @param[in] columnIndex The index of the column to get the value + * @param[in,out] value The @c String value obtained from the column * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. - * @exception E_INVALID_ENCODING_RANGE The string conversion has failed due to invalid encoding range, or - * it is possible if the database file is corrupted. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. + * @exception E_INVALID_ENCODING_RANGE Either of the following conditions has occurred: + * - The string conversion has failed due to invalid encoding range. + * - The database file is corrupted. */ virtual result GetStringAt(int columnIndex, Tizen::Base::String& value) const = 0; /** - * Gets a byte array value from the column whose index is specified. + * Gets the byte array value from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required - * @param[in,out] value The user-provided buffer used to receive the blob data as a stream of type ByteBuffer @n - * The buffer will be filled from the current position and data copy will be continued - * until buffer limitation is reached or no more blob data remains. @n + * @param[in] columnIndex The index of the column to get the value + * @param[in,out] value The buffer used to receive the blob data as a stream of type ByteBuffer @n + * The buffer will be filled from the current position and the data copying will be continued + * until the buffer limitation is reached or no more blob data remains. @n * The maximum size available is limited to 100 MByte. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. * @exception E_OUT_OF_RANGE The byte buffer operation has failed. * @exception E_OVERFLOW The specified @c value of the byte buffer is insufficient to save the data. */ virtual result GetBlobAt(int columnIndex, Tizen::Base::ByteBuffer& value) const = 0; /** - * Gets a blob data from the column whose index is specified. + * Gets the blob data from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required - * @param[in,out] buffer The user-provided buffer used to receive the blob data @n + * @param[in] columnIndex The index of the column to get the value + * @param[in,out] buffer The buffer used to receive the blob data @n * The maximum size available is limited to 100 MByte. * @param[out] size The maximum buffer length in bytes * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_INVALID_ARG The specified @c columnIndex is out of range, or the specified @c size is invalid. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. * @exception E_OVERFLOW The specified @c buffer is insufficient to save the data. */ virtual result GetBlobAt(int columnIndex, void* buffer, int size) const = 0; /** - * Gets a @c DateTime value from the column whose index is specified. + * Gets the @c DateTime value from the column with the specified index. * * @since 2.0 * * @return An error code - * @param[in] columnIndex The index of the column whose value is required + * @param[in] columnIndex The index of the column to get the value * @param[in,out] value The value obtained from the column as a DateTime instance * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_TYPE_MISMATCH The operation has attempted to access columns of different types. - * @exception E_INVALID_FORMAT The date is not correctly formatted, or the method is trying to access column of type String. @n - * The date format should be 'mm/dd/yyyy hh:mm:ss'. - * @exception E_OUT_OF_RANGE Either the year, month, day, hour, minute, or second value is out of range, - * or the method is trying to access a column of type String. + * @exception E_TYPE_MISMATCH The column type accessed by the method do not match. + * @exception E_INVALID_FORMAT The date is not correctly formatted. The date format should be 'mm/dd/yyyy hh:mm:ss'. + * @exception E_OUT_OF_RANGE Either the year, month, day, hour, minute, or second value is out of range, or the method is trying to access a column having an invalid value. */ virtual result GetDateTimeAt(int columnIndex, Tizen::Base::DateTime& value) const = 0; @@ -295,76 +295,81 @@ public: * * @since 2.0 * - * @return The number of columns in the calling enumerator, @n + * @return The number of columns in the current enumerator, @n * else @c -1 if an exception occurs * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n - * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n - * The specific error code can be accessed using the GetLastResult() method. + * (the query did not yield any result). + * @remarks + * - The method must be called after MoveNext(), MoveFirst(), or MoveLast(). + * - The specific error code can be accessed using the GetLastResult() method. */ virtual int GetColumnCount(void) const = 0; /** - * Gets the type of the column indicated by the specified index. + * Gets the type of the column specified by the index. * * @since 2.0 * - * @return The type of column, @n - * else DB_COLUMNTYPE_UNDEFINED if an exception occurs - * @param[in] columnIndex The index of the destination column + * @return The column type, @n + * else @c DB_COLUMNTYPE_UNDEFINED if an exception occurs + * @param[in] columnIndex The column index * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n - * Currently, DB_COLUMNTYPE_INT is returned for a 64-bit integer. @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - This method must be called after MoveNext(), MoveFirst(), or MoveLast(). + * - Currently, @c DB_COLUMNTYPE_INT is returned for a 64-bit integer. + * - The specific error code can be accessed using the GetLastResult() method. */ virtual DbColumnType GetColumnType(int columnIndex) const = 0; /** - * Gets the name of the column indicated by the specified index. + * Gets the name of the column specified by the index. * * @since 2.0 * * @return The name of the column, @n * else an empty string if an exception occurs - * @param[in] columnIndex The index of the destination column + * @param[in] columnIndex The column index * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @exception E_INVALID_ENCODING_RANGE The string conversion has failed due to invalid encoding range, or - * it is possible if the database file is corrupted. - * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n - * The specific error code can be accessed using the GetLastResult() method. + * @exception E_INVALID_ENCODING_RANGE Either of the following conditions has occurred: + * - The string conversion has failed due to invalid encoding range. + * - The database file is corrupted. + * @remarks + * - This method must be called after MoveNext(), MoveFirst(), or MoveLast(). + * - The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::String GetColumnName(int columnIndex) const = 0; /** - * Gets the size of data in bytes. + * Gets the size of data in bytes of the column specified by the index. * * @since 2.0 * * @return The size of the data in bytes, @n * else @c -1 if an exception occurs - * @param[in] columnIndex The index of the destination column + * @param[in] columnIndex The column index * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE Either of the following conditions has occurred: @n - * - This instance has not been properly constructed. @n + * @exception E_INVALID_STATE Either of the following conditions has occurred: + * - This instance has not been properly constructed. * - The method has tried to fetch the column data of a result set that is not activated - * (the query did not yield any result). @n + * (the query did not yield any result). * @exception E_INVALID_ARG The specified @c columnIndex is out of range. - * @remarks This method must be called after MoveNext(), MoveFirst(), or MoveLast(). @n - * If the destination column is of type %String, this method returns the @c byte length excluding the @c null terminator character. @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - This method must be called after MoveNext(), MoveFirst(), or MoveLast(). + * - If the destination column is of type String, this method returns the @c byte length excluding the @c null terminator character. + * - The specific error code can be accessed using the GetLastResult() method. */ virtual int GetColumnSize(int columnIndex) const = 0; diff --git a/inc/FIoIFileEventListener.h b/inc/FIoIFileEventListener.h index bd5af16..d131c0d 100644 --- a/inc/FIoIFileEventListener.h +++ b/inc/FIoIFileEventListener.h @@ -32,11 +32,11 @@ namespace Tizen { namespace Io /** * @interface IFileEventListener -* @brief This listener interface is used for receiving file event. +* @brief This listener interface is used for receiving file events. * * @since 2.0 * -* The %IFileEventListener interface is used for receiving file event. +* The %IFileEventListener interface is used for receiving file events. */ class _OSP_EXPORT_ IFileEventListener : virtual public Tizen::Base::Runtime::IEventListener @@ -50,8 +50,8 @@ public: * * @return An error code * @param[in] events The file event type @n - * Multiple event type can be combined using bitwise OR (see Tizen::Io::FileEventType). @n - * Tizen::Io::FILE_EVENT_TYPE_ALL is provided for all file event type. + * Multiple event type can be combined using bitwise OR (see Tizen::Io::FileEventType). @n + * ::FILE_EVENT_TYPE_ALL is provided for all file event type. * @param[in] path The path to the directory or file where the event has occurred * @param[in] eventId The event ID associating related events for single operation such as File::Move(), Directory::Rename() */ diff --git a/inc/FIoIMessagePortListener.h b/inc/FIoIMessagePortListener.h index d473154..acc29ec 100644 --- a/inc/FIoIMessagePortListener.h +++ b/inc/FIoIMessagePortListener.h @@ -46,7 +46,8 @@ class _OSP_EXPORT_ IMessagePortListener { public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -54,10 +55,11 @@ public: /** * Called when a message is received from a remote application. @n - * This method will be called only if the remote application uses bidirectional communication method - RemoteMessagePort::SendMessage(const LocalMessagePort* pLocalMessagePort, const Tizen::Base::Collection::IMap* pMessagee). + * This method will be called only if the remote application uses bidirectional communication method - + * RemoteMessagePort::SendMessage(const LocalMessagePort* pLocalMessagePort, const Tizen::Base::Collection::IMap* pMessagee). * The RemoteMessagePort instance can be used to send a response message to the message port of the remote application. * - * @since 2.0 + * @since 2.0 * * @param[in] pRemoteMessagePort The message port of a remote application which has sent this message * @param[in] pMessage A pointer to an argument map of key (String) and value (String or ByteBuffer) pair @@ -66,7 +68,8 @@ public: /** * Called when a message is received from a remote application. @n - * This method will be called only if the remote application uses unidirectional communication method - RemoteMessagePort::SendMessage(const Tizen::Base::Collection::IMap* pMessage). + * This method will be called only if the remote application uses unidirectional communication method - + * RemoteMessagePort::SendMessage(const Tizen::Base::Collection::IMap* pMessage). * * @since 2.0 * diff --git a/inc/FIoIMmcStorageFormatListener.h b/inc/FIoIMmcStorageFormatListener.h index 51f569f..80b041b 100644 --- a/inc/FIoIMmcStorageFormatListener.h +++ b/inc/FIoIMmcStorageFormatListener.h @@ -30,9 +30,9 @@ namespace Tizen { namespace Io { /** -* @interface IMmcStorageFormatListener -* @brief This interface is the listener to receive the result of external MMC format operations. -* @since 2.0 +* @interface IMmcStorageFormatListener +* @brief This interface is the listener to receive the result of external MMC format operations. +* @since 2.0 * * The %IMmcStorageFormatListener interface must be registered and implemented by an application to receive the result of * external MMC format operations. @@ -44,18 +44,19 @@ class _OSP_EXPORT_ IMmcStorageFormatListener { public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface called. * * @since 2.0 */ virtual ~IMmcStorageFormatListener(void) {} /** - * Called when external MMC format operation is done. + * Called when an external MMC format operation is completed. * * @since 2.0 * - * @param[in] r The result of external MMC format operation + * @param[in] r The result of an external MMC format operation * @exception E_SUCCESS The format operation is successful. * @exception E_IO An unexpected device failure has occurred as the media ejected suddenly. * @exception E_SYSTEM The method cannot proceed due to a severe system error. diff --git a/inc/FIoIMmcStorageMountListener.h b/inc/FIoIMmcStorageMountListener.h index 77516e4..c5e5664 100644 --- a/inc/FIoIMmcStorageMountListener.h +++ b/inc/FIoIMmcStorageMountListener.h @@ -44,28 +44,29 @@ class _OSP_EXPORT_ IMmcStorageMountListener { public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface called. * * @since 2.0 */ virtual ~IMmcStorageMountListener(void) {} /** - * Called when external MMC mount operation is done. + * Called when the external MMC mount operation is completed. * * @since 2.0 * * @param[in] r The result of external MMC mount operation * @exception E_SUCCESS The mount operation is successful. - * @exception E_IO Either of the following conditions has occurred: @n - * - The file system to be mounted has an invalid superblock. - * - An unexpected device failure has occurred as the media ejected suddenly. + * @exception E_IO Either of the following conditions has occurred: + * - The file system to be mounted has an invalid superblock. + * - An unexpected device failure has occurred as the media ejected suddenly. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ virtual void OnMmcStorageMounted(result r) = 0; /** - * Called when external MMC unmount operation is done. + * Called when external MMC unmount operation is completed. * * @since 2.0 * diff --git a/inc/FIoISerialPortEventListener.h b/inc/FIoISerialPortEventListener.h index 890d0f1..a8d1eb0 100644 --- a/inc/FIoISerialPortEventListener.h +++ b/inc/FIoISerialPortEventListener.h @@ -54,7 +54,7 @@ public: * @since 2.0 * * @param[in] byteBuffer A byte buffer that contains the received data - * @remarks The ByteBuffer instance needs to be deleted by the application. + * @remarks The ByteBuffer instance needs to be deleted by the application. */ virtual void OnSerialPortDataReceivedN(Tizen::Base::ByteBuffer& byteBuffer) = 0; @@ -63,9 +63,9 @@ public: * * @since 2.0 * - * @param[in] r The error code + * @param[in] r The error code * @exception E_INVALID_DATA The data is invalid. - * @exception E_SYSTEM A system error has occurred. + * @exception E_SYSTEM A system error has occurred. */ virtual void OnSerialPortErrorOccured(result r) = 0; diff --git a/inc/FIoLocalMessagePort.h b/inc/FIoLocalMessagePort.h index b5ea461..b78207c 100644 --- a/inc/FIoLocalMessagePort.h +++ b/inc/FIoLocalMessagePort.h @@ -118,8 +118,8 @@ public: * @since 2.0 * * @return An error code - * @param[in] listener The message port listener - * @exception E_SUCCESS The method is successful. + * @param[in] listener The message port listener + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_ALREADY_EXIST The listener instance already exists. */ result AddMessagePortListener(IMessagePortListener& listener); @@ -130,23 +130,23 @@ public: * @since 2.0 * * @return An error code - * @param[in] listener The message port listener + * @param[in] listener The message port listener * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The listener instance is not found. */ result RemoveMessagePortListener(IMessagePortListener& listener); /** - * Gets the name of a local message port. + * Gets the name of the local message port. * * @since 2.0 * - * @return The name of a local message port + * @return The name of the local message port */ Tizen::Base::String GetName(void) const; /** - * Checks whether an instance is a trusted message port or not. + * Checks whether the instance is a trusted message port or not. * * @since 2.0 * diff --git a/inc/FIoMemoryMappedFile.h b/inc/FIoMemoryMappedFile.h index 0171984..857e0ee 100644 --- a/inc/FIoMemoryMappedFile.h +++ b/inc/FIoMemoryMappedFile.h @@ -39,9 +39,9 @@ namespace Tizen { namespace Io */ enum MemoryMappedFileFlag { - MEMORY_MAPPED_FILE_FLAG_SHARED = 0x01, /**< Changes are shared with other processes mapping the same file */ - MEMORY_MAPPED_FILE_FLAG_PRIVATE = 0x02, /**< Changes are not visible to other processes mapping the same file */ - MEMORY_MAPPED_FILE_FLAG_FIXED = 0x10 /**< This forces the system to use the specified mapping address exactly, + MEMORY_MAPPED_FILE_FLAG_SHARED = 0x01, /**< The changes are shared with other processes mapping the same file */ + MEMORY_MAPPED_FILE_FLAG_PRIVATE = 0x02, /**< The changes are not visible to other processes mapping the same file */ + MEMORY_MAPPED_FILE_FLAG_FIXED = 0x10 /**< The system is forced to use the specified mapping address exactly, which should be a multiple of the page size */ }; @@ -60,13 +60,13 @@ enum MemoryMappedFileSyncFlag /** * @class MemoryMappedFile - * @brief This class provides features mapping a file to virtual address space. + * @brief This class provides methods for mapping a file to virtual address space. * * @since 2.0 * * @final This class is not intended for extension. * - * The %MemoryMappedFile class provides features for using a memory mapped file, + * The %MemoryMappedFile class provides methods for using a memory mapped file, * which maps the data of a file to an application's virtual address space. * * @code @@ -110,7 +110,8 @@ class _OSP_EXPORT_ MemoryMappedFile public: /** - * 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. + * 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 */ @@ -124,7 +125,7 @@ public: ~MemoryMappedFile(void); /** - * Initializes this instance of %MemoryMappedFile with a specified file. + * Initializes this instance of %MemoryMappedFile with the specified file. * * @since 2.0 * @@ -133,7 +134,7 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c file is not opened for reading. @n * The opening mode should not be "w" or "a". - * @remarks The specified @c file should be initialized by the Io::File::Construct() method. + * @remarks The specified @c file should be initialized by the Tizen::Io::File::Construct() method. * @see Tizen::Io::File */ result Construct(const File& file); @@ -144,8 +145,8 @@ public: * @since 2.0 * * @return The mapped address space, @n - * else @c null pointer if this method fails - * @param[in] address A starting address of the mapping @n + * else @c null pointer if it fails + * @param[in] address The starting address of the mapping @n * If the specified @c address is @c null, the system chooses the address. * It should be a multiple of the page size. * @param[in] length The length of the mapping space @@ -157,27 +158,28 @@ public: * @param[in] offset The start offset of the specified file @n * It should be a multiple of the page size. * @exception E_SUCCESS The method is successful. - * @exception E_ILLEGAL_ACCESS The specified @c flag is MEMORY_MAPPED_FILE_FLAG_SHARED and the specified @c - * protection is MEMORY_PROTECTION_MODE_WRITE, but the specified file of + * @exception E_ILLEGAL_ACCESS The specified @c flag is ::MEMORY_MAPPED_FILE_FLAG_SHARED and the specified @c + * protection is Base::Runtime::MEMORY_PROTECTION_MODE_WRITE, but the specified file of * MemoryMappedFile::Construct() is not opened with read-write mode. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The specified @c address or @c offset is not aligned on a page boundary. @n - * - The specified @c length is not positive. @n - * - The specified @c protection, @c flag, or @c offset @ is invalid. @n - * - The specified @c flag cannot contain both MEMORY_MAPPED_FILE_FLAG_PRIVATE and - * MEMORY_MAPPED_FILE_FLAG_SHARED. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c address or @c offset is not aligned on a page boundary. + * - The specified @c length is not positive. + * - The specified @c protection, @c flag, or @c offset is invalid. + * - The specified @c flag cannot contain both ::MEMORY_MAPPED_FILE_FLAG_PRIVATE and + * ::MEMORY_MAPPED_FILE_FLAG_SHARED. * @exception E_MAX_EXCEEDED The number of mapped regions has exceeded the maximum limit. * @exception E_OBJECT_LOCKED The mapped file has been locked. - * @exception E_OUT_OF_MEMORY Either of the following conditions has occurred: @n - * - The memory is insufficient. @n - * - The specified @c flag is MEMORY_MAPPED_FILE_FLAG_FIXED, and the specified address - * range exceeds that allowed for the address space of a current process. - * @exception E_IO Either of the following conditions has occurred: @n - * - The underlying file system does not support memory mapping. @n - * - The specified @c protection is MEMORY_PROTECTION_MODE_EXEC, but the mapped file - * exists on a file system that has been mounted no-exec. - * @remarks The specific error code can be accessed using the GetLastResult() method. @n - * When this instance is destructed, all mappings are deleted automatically. + * @exception E_OUT_OF_MEMORY Either of the following conditions has occurred: + * - The memory is insufficient. + * - The specified @c flag is ::MEMORY_MAPPED_FILE_FLAG_FIXED, and the specified @c address + * range exceeds that allowed for the address space of a current process. + * @exception E_IO Either of the following conditions has occurred: + * - The underlying file system does not support memory mapping. + * - The specified @c protection is Base::Runtime::MEMORY_PROTECTION_MODE_EXEC, but the mapped file + * exists on a file system that has been mounted no-exec. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - When this instance is destructed, all mappings are deleted automatically. * @see Tizen::Base::Runtime::MemoryManager */ void* Map(void* address, long long length, unsigned long protection, unsigned long flag, long long offset); @@ -185,7 +187,7 @@ public: /** * Deletes the mapping of the specified address space. @n * Further references to the addresses within the range result in generation of an invalid memory access. @n - * This method flushes all changes of a shared mapping to the correlated file on the permanent storage. + * This method flushes all the changes of a shared mapping to the correlated file on the permanent storage. * * @since 2.0 * @@ -193,16 +195,16 @@ public: * @param[in] address The memory mapping address to unmap * @param[in] length The length of the mapping space * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The specified @c address is not aligned on a page boundary. @n - * - The specified @c length is not positive. @n - * - The specified address range is out of the valid address space of a current process. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c address is not aligned on a page boundary. + * - The specified @c length is not positive. + * - The specified address range is out of the valid address space of the current process. * @remarks When this instance is destructed, all mappings of the instance are not unmapped automatically. */ result Unmap(void* address, long long length); /** - * Flushes all changes of an address range to the correlated file on the permanent storage. + * Flushes all the changes of an address range to the correlated file on the permanent storage. * * @since 2.0 * @@ -211,13 +213,13 @@ public: * @param[in] length The length of the mapping space * @param[in] syncFlag The synchronization option * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The specified @c address is not aligned on a page boundary. @n - * - The specified @c length is not positive. @n - * - The specified @c syncFlag is invalid. @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c address is not aligned on a page boundary. + * - The specified @c length is not positive. + * - The specified @c syncFlag is invalid. * - The specified @c address space is not mapped. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @remarks The specific page size of a current file system is provided by Tizen::System::SystemInfo class with * "StorageInfo" key. diff --git a/inc/FIoMessagePortManager.h b/inc/FIoMessagePortManager.h index 0cd9cbb..50d4d0c 100644 --- a/inc/FIoMessagePortManager.h +++ b/inc/FIoMessagePortManager.h @@ -54,24 +54,27 @@ class _OSP_EXPORT_ MessagePortManager public: /** * Requests for a LocalMessagePort instance with the specified message port name. @n - * This method returns the same %LocalMessagePort instance if it has already been called with the same message port name. @n + * This method returns the same %LocalMessagePort instance if it has already been called with the same message port name. * * @since 2.0 * * @return A pointer to the LocalMessagePort instance, @n * else @c null if it fails - * @param[in] localMessagePortName The name of a local message port - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The @c localMessagePortName is empty. - * @exception E_SYSTEM The method has failed due to a severe system error. - * @remarks It is not recommended to use the message port names that start with "http://tizen.org/messageport". @c E_INVALID_ARG may be returned because they are reserved by platform. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @param[in] localMessagePortName The name of a local message port + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The @c localMessagePortName is empty. + * @exception E_SYSTEM The method has failed due to a severe system error. + * @remarks + * - It is not recommended to use the message port names that start with "http://tizen.org/messageport". + * @c E_INVALID_ARG may be returned because they are reserved by platform. + * - The specific error code can be accessed using the GetLastResult() method. */ static LocalMessagePort* RequestLocalMessagePort(const Tizen::Base::String& localMessagePortName); /** - * Requests the RemoteMessagePort instance with the specified remote application ID and message port name. @n - * This method returns the same %RemoteMessagePort instance if it has already been called with the same remote application ID and message port name. + * Requests for a RemoteMessagePort instance with the specified remote application ID and message port name. @n + * This method returns the same %RemoteMessagePort instance if it has already been called with the same remote application ID + * and message port name. * * @since 2.0 * @@ -79,10 +82,10 @@ public: * else @c null if it fails * @param[in] remoteAppId The remote application ID * @param[in] remoteMessagePortName The remote message port name - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The remote application ID or the remote message port name is empty. - * @exception E_OBJ_NOT_FOUND The message port of the target application is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The remote application ID or the remote message port name is empty. + * @exception E_OBJ_NOT_FOUND The message port of the target application is not found. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static RemoteMessagePort* RequestRemoteMessagePort(const Tizen::App::AppId& remoteAppId, const Tizen::Base::String& remoteMessagePortName); @@ -90,38 +93,43 @@ public: /** * Requests for a trusted LocalMessagePort instance with the specified message port name. @n * This method returns the same %LocalMessagePort instance if it has already been called with the same message port name. @n - * Communications over a trusted message port is allowed only if both the applications are signed with a certificate that is uniquely assigned to the developer. + * Communications over a trusted message port is allowed only if both the applications are signed with a certificate that is + * uniquely assigned to the developer. * * @since 2.0 * * @return A pointer to the trusted LocalMessagePort instance, @n * else @c null if it fails - * @param[in] localMessagePortName The name of a local message port - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The @c localMessagePortName is empty. - * @exception E_SYSTEM The method has failed due to a severe system error. - * @remarks It is not recommended to use the message port names that start with "http://tizen.org/messageport". @c E_INVALID_ARG may be returned because they are reserved by platform. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @param[in] localMessagePortName The name of a local message port + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The @c localMessagePortName is empty. + * @exception E_SYSTEM The method has failed due to a severe system error. + * @remarks + * - It is not recommended to use the message port names that start with "http://tizen.org/messageport". + * @c E_INVALID_ARG may be returned because they are reserved by platform. + * - The specific error code can be accessed using the GetLastResult() method. */ static LocalMessagePort* RequestTrustedLocalMessagePort(const Tizen::Base::String& localMessagePortName); /** - * Requests the trusted RemoteMessagePort instance with the specified message port name. @n - * This method returns the same %RemoteMessagePort instance if it has already been called with the same remote application ID and message port name. @n - * This message port allows communications only if the applications are signed with the same certificate which is uniquely assigned to the developer. + * Requests for a trusted RemoteMessagePort instance with the specified message port name. @n + * This method returns the same %RemoteMessagePort instance if it has already been called with the same remote application ID + * and message port name. @n + * This message port allows communications only if the applications are signed with the same certificate which is uniquely + * assigned to the developer. * * @since 2.0 * * @return A pointer to the trusted RemoteMessagePort instance, @n * else @c null if it fails - * @param[in] remoteAppId The remote application ID - * @param[in] remoteMessagePortName The name of a remote message port - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either @c remoteAppId or @c remoteMessagePortName is empty. - * @exception E_OBJ_NOT_FOUND The message port of the target application is not found. - * @exception E_CERTIFICATE_VERIFICATION_FAILED The target application is not signed with the same certificate. - * @exception E_SYSTEM The method has failed due to a severe system error. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @param[in] remoteAppId The remote application ID + * @param[in] remoteMessagePortName The name of a remote message port + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either @c remoteAppId or @c remoteMessagePortName is empty. + * @exception E_OBJ_NOT_FOUND The message port of the target application is not found. + * @exception E_CERTIFICATE_VERIFICATION_FAILED The target application is not signed with the same certificate. + * @exception E_SYSTEM The method has failed due to a severe system error. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ static RemoteMessagePort* RequestTrustedRemoteMessagePort(const Tizen::App::AppId& remoteAppId, const Tizen::Base::String& remoteMessagePortName); diff --git a/inc/FIoMmcStorageManager.h b/inc/FIoMmcStorageManager.h index e30a068..52ca436 100644 --- a/inc/FIoMmcStorageManager.h +++ b/inc/FIoMmcStorageManager.h @@ -96,11 +96,11 @@ class _OSP_EXPORT_ MmcStorageManager public: /** - * Gets the MMC storage manager instance. + * Gets the pointer to the %MmcStorageManager instance. * * @since 2.0 * - * @return A pointer to %MmcStorageManager instance if this method is successful, @n + * @return The pointer to %MmcStorageManager instance if this method is successful, @n * else @c null * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -109,7 +109,7 @@ public: static MmcStorageManager* GetInstance(void); /** - * Mounts file system of external MMC. + * Mounts the file system of the external MMC. * * @since 2.0 * @privlevel platform @@ -117,7 +117,7 @@ public: * (%http://tizen.org/privilege/systemsetting.read is deprecated.) * * @return An error code - * @exception E_SUCCESS Mount operation is successfully started. + * @exception E_SUCCESS The mount operation is successfully started. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_INVALID_OPERATION The external MMC has already been mounted. * @exception E_SERVICE_BUSY One of mount, unmount and format operations is ongoing. @@ -128,7 +128,7 @@ public: result Mount(void); /** - * Unmounts file system of external MMC. + * Unmounts the file system of the external MMC. * * @since 2.0 * @privlevel platform @@ -136,7 +136,7 @@ public: * (%http://tizen.org/privilege/systemsetting.read is deprecated.) * * @return An error code - * @exception E_SUCCESS Unmount operation is successfully started. + * @exception E_SUCCESS The unmount operation is successfully started. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_INVALID_OPERATION The external MMC has already been unmounted. * @exception E_SERVICE_BUSY One of mount, unmount and format operations is ongoing. @@ -145,7 +145,7 @@ public: result Unmount(void); /** - * Formats file system of external MMC. + * Formats the file system of the external MMC. * * @since 2.0 * @privlevel platform @@ -153,7 +153,7 @@ public: * (%http://tizen.org/privilege/systemsetting.read is deprecated.) * * @return An error code - * @exception E_SUCCESS Format operation is successfully started. + * @exception E_SUCCESS The format operation is successfully started. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_INVALID_OPERATION The external MMC should be unmounted for format operation. * @exception E_SERVICE_BUSY One of mount, unmount and format operations is ongoing. diff --git a/inc/FIoRegistry.h b/inc/FIoRegistry.h index 780b7fa..14ef6f0 100644 --- a/inc/FIoRegistry.h +++ b/inc/FIoRegistry.h @@ -47,13 +47,13 @@ static const long REG_OPEN_CREATE = 0x00000004L; /** * @class Registry - * @brief This class provides a mechanism to access and manipulate registry files. + * @brief This class provides methods to access and manipulate registry files. * * @since 2.0 * * @final This class is not intended for extension. * - * The %Registry class provides a mechanism to access and manipulate registry files. + * The %Registry class provides methods to access and manipulate registry files. * * For more information on the class features, * see Io Guide. @@ -148,7 +148,8 @@ class _OSP_EXPORT_ Registry public: /** - * 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. + * 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 */ @@ -182,24 +183,24 @@ public: * @param[in] createIfNotExist Set to @c true to create a registry file, @n * else @c false to open an existing registry file * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The length of the specified string of a file path is less - * than or equal to @c 0. @n - * - The translated overall length of the specified path exceeds the - * system limitation. @n - * - The specified path is invalid. @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The length of the specified file path string is less + * than or equal to @c 0. + * - The overall length of the specified file path exceeds the + * system limitation. + * - The specified file path is invalid. * @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found. * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. - * @exception E_END_OF_FILE The file pointer has reached end-of-file. + * @exception E_END_OF_FILE The file pointer has reached the end of file. * @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_INVALID_FORMAT The input registry file contains '0x00' in the middle of the file. * @exception E_PARSING_FAILED The method has failed to parse the registry file. * @remarks To load the registry in read-only mode, use the Registry::Construct(const Tizen::Base::String& regPath, - * long openMode, long option) method with REG_OPEN_READ_ONLY as a value for the open mode flag. + * long openMode, long option) method with ::REG_OPEN_READ_ONLY as value for the open mode flag. * @endcond */ result Construct(const Tizen::Base::String& regPath, bool createIfNotExist); @@ -222,27 +223,27 @@ public: * * @return An error code * @param[in] regPath The path of the registry file to open or create - * @param[in] openMode An open mode flag @n + * @param[in] openMode The flag specifying the file opening mode @n * Currently, the following flags can be used in combination with * the logical OR operator: @n * (1) REG_OPEN_READ_ONLY @n * (2) REG_OPEN_READ_WRITE @n * (3) REG_OPEN_READ_WRITE | REG_OPEN_CREATE - * @param[in] option This argument is reserved for further use @n It is recommended to use @c 0. + * @param[in] option This argument is reserved for future use. @n It is recommended to use @c 0. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The length of the specified string of a file path is less - * than or equal to @c 0. @n - * - The translated overall length of the specified path exceeds the - * system limitation. @n - * - The specified path is invalid. @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The length of the specified file path string is less + * than or equal to @c 0. + * - The overall length of the specified file path exceeds the + * system limitation. + * - The specified file path is invalid. * @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. - * @exception E_END_OF_FILE The file pointer has reached end-of-file. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. + * @exception E_END_OF_FILE The file pointer has reached the end of file. * @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_INVALID_FORMAT The input registry file contains '0x00' in the middle of the file. * @exception E_PARSING_FAILED The method has failed to parse the registry file. @@ -252,8 +253,8 @@ public: /** * Initializes this instance of %Registry with the specified parameters. @n - * This method opens an existing registry file or creates a new one according to the specified file opening mode. - * And this method loads data of the registry file to system memory and flushes the data to the storage when this instance + * This method opens an existing registry file or creates a new one according to the specified file opening mode, + * loads the data of the registry file to system memory, and flushes the data to the storage when this instance * is released or Registry::Flush() is called. * * @since 2.0 @@ -271,21 +272,21 @@ public: * - a : Open for writing. The registry file is created if it does not exist. * - a+: Open for writing and reading. The registry file is created if it does not exist. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The overall length of the specified @c regPath is equal to @c 0 or - * exceeds system limitations. @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The length of the specified file path string is less than or equal to @c 0. + * - The overall length of the specified file path exceeds the system limitation. * - The combination of the specified @c pOpenMode is not allowed. @n - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_NOT_FOUND The specified @c regPath cannot be found. - * @exception E_INVALID_FORMAT Either of the following conditions has occurred: @n + * @exception E_INVALID_FORMAT Either of the following conditions has occurred: * - The section or entry name of the registry file includes one of the following characters: - * '\0', '\n', '#' and '='. + * '\0', '\\n', '#' and '='. * - The entry value of the registry file includes one of the following characters: - * '\0' and '\n'. + * '\0' and '\\n'. * @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ @@ -293,13 +294,13 @@ public: /** * Initializes this instance of %Registry with the specified parameters. @n - * This method opens an existing secure registry file or creates a new one according to the specified file opening mode. - * And this method loads data of the secure registry file to system memory and flushes the data to the storage when this instance + * This method opens an existing secure registry file or creates a new one according to the specified file opening mode, + * loads the data of the secure registry file to system memory and flushes the data to the storage when this instance * is released or Registry::Flush() is called. * The contents written to the secure registry file is automatically encrypted and the contents read from the secure registry * file is automatically decrypted by the platform. @n - * Applications using this method can access the same secure registry files that are created by other applications with the - * identical key value in same device. However, the secure registry files created by this method cannot be accessed in other devices. + * Applications that use this method can access the secure registry files that are created by other applications with + * an identical key value in the same device. However, the secure registry files created by this method cannot be accessed in other devices. * * @since 2.0 * @@ -315,34 +316,34 @@ public: * otherwise it is truncated to zero length. * - a : Open for writing. The registry file is created if it does not exist. * - a+: Open for writing and reading. The registry file is created if it does not exist. - * @param[in] secretKey A key used to encrypt data of a registry file or decrypt a secure registry file @n - * If a secure registry file is created with a specific key value, - * other applications can access the same secure registry file with the identical key value. + * @param[in] secretKey The key to encrypt the data of the registry file or to decrypt the secure registry file @n + * If the secure registry file is created with a specific key value, + * other applications can access the secure registry file with an identical key value. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The overall length of the specified path is equal to @c 0 or * exceeds system limitations. - * - The combination of the specified @c pOpenMode is not allowed. @n + * - The combination of the specified @c pOpenMode is not allowed. * - The specified @c secretKey is incorrect or the secure registry file is corrupted. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_NOT_FOUND The specified @c regPath cannot be found. - * @exception E_INVALID_FORMAT Either of the following conditions has occurred: @n + * @exception E_INVALID_FORMAT Either of the following conditions has occurred: * - The section or entry name of the registry file includes one of the following characters: - * '\0', '\n', '#' and '='. + * '\0', '\\n', '#' and '='. * - The entry value of the registry file includes one of the following characters: - * '\0' and '\n'. + * '\0' and '\\n'. * @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n - * - %File corruption is detected. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. + * - %File corruption is detected. * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ result Construct(const Tizen::Base::String& regPath, const char* pOpenMode, const Tizen::Base::ByteBuffer& secretKey); /** - * Flushes the current contents of a registry in memory. @n - * If the secure mode is set to be @c true, the contents of the registry are automatically encrypted + * Flushes the current contents of the registry in memory. @n + * If the secure mode is set, the contents of the registry are automatically encrypted * and saved by the platform. * * @since 2.0 @@ -350,81 +351,78 @@ public: * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_MAX_EXCEEDED The number of opened files has exceeded the maximum limit. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n - * - %File corruption is detected. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. + * - %File corruption is detected. */ result Flush(void); /** - * Creates the specified section then adds it into the registry. + * Creates the specified section and adds it to the registry. * * @since 2.0 * * @return An error code * @param[in] sectionName The section name * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The length of the specified string for a section name is less than - * or equal to @c 0. - * @exception E_SECTION_ALREADY_EXIST A section with the specified name already exists. + * @exception E_INVALID_ARG The length of the specified string for a section name is less than or equal to @c 0. + * @exception E_SECTION_ALREADY_EXIST The section with the specified name already exists. */ result AddSection(const Tizen::Base::String& sectionName); /** - * Removes the section from %Registry. + * Removes the section from the registry. * * @since 2.0 * * @return An error code - * @param[in] sectionName The section name to remove + * @param[in] sectionName The name of the section to remove * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The length of the specified string for a section is less than - * or equal to @c 0. + * @exception E_INVALID_ARG The length of the specified string for a section is less than or equal to @c 0. * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. */ result RemoveSection(const Tizen::Base::String& sectionName); /** - * Gets all section names in the registry. + * Gets all the section names in the registry. * * @since 2.0 * - * @return A list of section names @n + * @return The list of all section names in the registry @n * If this method fails, @c null value is returned. @n - * The specific error code can be accessed using the GetLastResult() method. @n - * When there are no sections at all, the method returns an empty list instance. @n + * When there are no sections, the method returns an empty list instance. @n * Use the Tizen::Base::Collection::ICollection::GetCount() method to check the number of elements in the list. * @exception E_SUCCESS The method is successful. - * @remarks Do not forget to delete not only the returned IList instance, but also its - * contents by invoking IList::RemoveAll(). @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - Do not forget to delete not only the returned Tizen::Base::Collection::IList instance, but also its contents by invoking IList::RemoveAll(). + * - The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* GetAllSectionNamesN(void) const; /** - * Gets all entry names in the specified section of the registry. + * Gets all the entry names in the specified section of the registry. * * @since 2.0 * - * @return A list of entry names @n + * @return The list of entry names @n * If this method fails, @c null value is returned. @n - * When there are no entries at all, the method returns an empty list instance. @n + * When there are no entries, the method returns an empty list instance. @n * Use the Tizen::Base::Collection::ICollection::GetCount() method to check the number of element in the list. * @param[in] sectionName The section name * @exception E_SUCCESS The method is successful. - * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. + * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry. * @exception E_IO A system error has occurred. - * @remarks Do not forget to delete not only the returned IList instance, but also its - * contents by invoking IList::RemoveAll(). @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - Do not forget to delete not only the returned Tizen::Base::Collection::IList instance, but also its contents by invoking IList::RemoveAll(). + * - The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* GetAllEntryNamesN(const Tizen::Base::String& sectionName) const; /** - * Adds the name-value pair of type integer as an entry of the specific section. + * Adds the name and integer value as an entry of the specific section. * * @since 2.0 * @@ -433,19 +431,14 @@ public: * @param[in] entryName The entry name * @param[in] value The @c int value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either the length of the specified string for a section - * or an entry is less than or equal to @c 0, - * or a @c null value is passed. @n - * Note that, it is also possible that the data inside a registry instance is - * corrupted due to its usage in a multi-threaded environment without - * synchronization. - * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. + * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0. + * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry. * @exception E_KEY_ALREADY_EXIST The specified @c entryName already exists in this section. */ result AddValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, int value); /** - * Adds the name-value pair of type double as an entry of the specific section. + * Adds the name and double value as an entry of the specific section. * * @since 2.0 * @@ -454,21 +447,16 @@ public: * @param[in] entryName The entry name * @param[in] value The @c double value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either the length of the specified string for a section - * or an entry is less than or equal to @c 0, - * or a @c null value is passed. @n - * Note that, it is also possible that the data inside a registry instance is - * corrupted due to its usage in a multi-threaded environment without - * synchronization. - * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. + * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0. + * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry. * @exception E_KEY_ALREADY_EXIST The specified @c entryName already exists in this section. - * @remarks This method converts the specified double type @c value to string value using "%lg" format specifier. @n - * Also, it does not depend on system locale. + * @remarks This method converts the specified double type @c value to string value using the "%lg" format specifier. @n + * It does not depend on the system locale. */ result AddValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, double value); /** - * Adds the name-value pair of type float as an entry of the specific section. + * Adds the name and float value as an entry of the specific section. * * @since 2.0 * @@ -477,21 +465,16 @@ public: * @param[in] entryName The entry name * @param[in] value The @c float value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either the length of the specified string for a section - * or an entry is less than or equal to @c 0, - * or a @c null value is passed. @n - * Note that, it is also possible that the data inside a registry instance is - * corrupted due to its usage in a multi-threaded environment without - * synchronization. - * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. + * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0. + * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry. * @exception E_KEY_ALREADY_EXIST The specified @c entryName already exists in this section. - * @remarks This method converts the specified float type @c value to string value using "%g" format specifier. @n - * Also, it does not depend on system locale. + * @remarks This method converts the specified float type @c value to string value using the "%g" format specifier. @n + * It does not depend on the system locale. */ result AddValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, float value); /** - * Adds the name-value pair of type String as an entry of the specific section. + * Adds the name and String value as an entry of the specific section. * * @since 2.0 * @@ -500,18 +483,14 @@ public: * @param[in] entryName The entry name * @param[in] value The String value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either the length of the specified string for a section - * or an entry is less than or equal to @c 0. - * Note that, it is also possible that the data inside a registry instance is - * corrupted due to its usage in a multi-threaded environment without - * synchronization. - * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. + * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0. + * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry. * @exception E_KEY_ALREADY_EXIST The specified @c entryName already exists in this section. */ result AddValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, const Tizen::Base::String& value); /** - * Adds the name-value pair of type UuId as an entry for the specified section. + * Adds the name and UuId value as an entry for the specified section. * * @since 2.0 * @@ -520,38 +499,27 @@ public: * @param[in] entryName The entry name * @param[in] value The UuId value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either the length of the specified string for a section - * or an entry is less than or equal to @c 0, - * or a @c null value is passed. @n - * Note that, it is also possible that the data inside a registry instance is - * corrupted due to its usage in a multi-threaded environment without - * synchronization. - * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. + * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0. + * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry. * @exception E_KEY_ALREADY_EXIST The specified @c entryName already exists in this section. */ result AddValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, const Tizen::Base::UuId& value); /** - * Adds the name-value pair of type ByteBuffer as an entry for the specified section. + * Adds the name and ByteBuffer value as an entry for the specified section. * * @since 2.0 * * @return An error code * @param[in] sectionName The section name * @param[in] entryName The entry name - * @param[in] value The @c ByteBuffer value @n + * @param[in] value The ByteBuffer value @n * Note that, it should be constructed before being passed to the method. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either the length of the specified string for a section - * or an entry is less than or equal to @c 0, - * or a @c null value is passed. @n - * Note that, it is also possible that the data inside a registry instance is - * corrupted due to its usage in a multi-threaded environment without - * synchronization. - * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. + * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0. + * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry. * @exception E_KEY_ALREADY_EXIST The specified @c entryName already exists in this section. - * @remarks Note that all the contents of @c ByteBuffer are saved as an entry value. - * That is, byte data from @c 0 up to the buffer limit is saved. + * @remarks All the contents of @c ByteBuffer are saved as an entry value. That is, byte data from @c 0 up to the buffer limit is saved. * @see Tizen::Base::ByteBuffer */ result AddValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, const Tizen::Base::ByteBuffer& value); @@ -563,19 +531,18 @@ public: * * @return An error code * @param[in] sectionName The section name - * @param[in] entryName The name of entry where its value will be fetched + * @param[in] entryName The entry name to get the value * @param[out] retVal The return value obtained from the registry * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either the length of the specified string for a section - * or an entry is less than or equal to @c 0, - * or a @c null value is passed. @n - * Note that, it is also possible that the data inside a registry instance is - * corrupted due to its usage in a multi-threaded environment without - * synchronization. - * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. - * @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry. - * @exception E_PARSING_FAILED The method has failed to parse the encoded entry value string, or the value is retrieved by using an incorrect data type. - * @exception E_DATA_NOT_FOUND The name-value pair has no value assigned (if the value is retrieved using the REGTYPE_STRING type, an empty string is returned even if no value is assigned). + * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0. + * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry. + * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry. + * @exception E_PARSING_FAILED Either of the following conditions has occurred: + * - The method has failed to parse the encoded entry value string. + * - The specified data type of the value and the data type of the retrieved value are different. + * @exception E_DATA_NOT_FOUND There is no value assigned for the specified entry name. @n + * If the value is retrieved using the REGTYPE_STRING type, + * an empty string is returned even if no value is assigned. */ result GetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, int& retVal) const; @@ -586,20 +553,19 @@ public: * * @return An error code * @param[in] sectionName The section name - * @param[in] entryName The name of entry where its value will be fetched + * @param[in] entryName The entry name to get the value * @param[out] retVal The return value obtained from the registry * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either the length of the specified string for a section - * or an entry is less than or equal to @c 0, - * or a @c null value is passed. @n - * Note that, it is also possible that the data inside a registry instance is - * corrupted due to its usage in a multi-threaded environment without - * synchronization. - * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. - * @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry. - * @exception E_PARSING_FAILED The method has failed to parse the encoded entry value string, or the value is retrieved by using an incorrect data type. - * @exception E_DATA_NOT_FOUND The name-value pair has no value assigned (if the value is retrieved using the REGTYPE_STRING type, an empty string is returned even if no value is assigned). - * @remarks This method does not depend on system locale. + * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0. + * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry. + * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry. + * @exception E_PARSING_FAILED Either of the following conditions has occurred: + * - The method has failed to parse the encoded entry value string. + * - The specified data type of the value and the data type of the retrieved value are different. + * @exception E_DATA_NOT_FOUND There is no value assigned for the specified entry name. @n + * If the value is retrieved using the REGTYPE_STRING type, + * an empty string is returned even if no value is assigned. + * @remarks This method does not depend on the system locale. */ result GetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, double& retVal) const; @@ -610,20 +576,19 @@ public: * * @return An error code * @param[in] sectionName The section name - * @param[in] entryName The name of entry where its value will be fetched + * @param[in] entryName The entry name to get the value * @param[out] retVal The return value obtained from the registry * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either the length of the specified string for a section - * or an entry is less than or equal to @c 0, - * or a @c null value is passed. @n - * Note that, it is also possible that the data inside a registry instance is - * corrupted due to its usage in a multi-threaded environment without - * synchronization. - * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. - * @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry. - * @exception E_PARSING_FAILED The method has failed to parse the encoded entry value string, or the value is retrieved by using an incorrect data type. - * @exception E_DATA_NOT_FOUND The name-value pair has no value assigned (if the value is retrieved using the REGTYPE_STRING type, an empty string is returned even if no value is assigned). - * @remarks This method does not depend on system locale. + * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0. + * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry. + * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry. + * @exception E_PARSING_FAILED Either of the following conditions has occurred: + * - The method has failed to parse the encoded entry value string. + * - The specified data type of the value and the data type of the retrieved value are different. + * @exception E_DATA_NOT_FOUND There is no value assigned for the specified entry name. @n + * If the value is retrieved using the REGTYPE_STRING type, + * an empty string is returned even if no value is assigned. + * @remarks This method does not depend on the system locale. */ result GetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, float& retVal) const; @@ -634,19 +599,18 @@ public: * * @return An error code * @param[in] sectionName The section name - * @param[in] entryName The name of entry where its value will be fetched + * @param[in] entryName The entry name to get the value * @param[out] retVal The return value obtained from the registry * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either the length of the specified string for a section - * or an entry is less than or equal to @c 0, - * or a @c null value is passed. @n - * Note that, it is also possible that the data inside a registry instance is - * corrupted due to its usage in a multi-threaded environment without - * synchronization. - * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. - * @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry. - * @exception E_PARSING_FAILED The method has failed to parse the encoded entry value string, or the value is retrieved by using an incorrect data type. - * @exception E_DATA_NOT_FOUND The name-value pair has no value assigned (if the value is retrieved using the REGTYPE_STRING type, an empty string is returned even if no value is assigned). + * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0. + * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry. + * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry. + * @exception E_PARSING_FAILED Either of the following conditions has occurred: + * - The method has failed to parse the encoded entry value string. + * - The specified data type of the value and the data type of the retrieved value are different. + * @exception E_DATA_NOT_FOUND There is no value assigned for the specified entry name. @n + * If the value is retrieved using the REGTYPE_STRING type, + * an empty string is returned even if no value is assigned. */ result GetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, Tizen::Base::String& retVal) const; @@ -657,19 +621,18 @@ public: * * @return An error code * @param[in] sectionName The section name - * @param[in] entryName The name of entry where its value will be fetched + * @param[in] entryName The entry name to get the value * @param[out] retVal The return value obtained from the registry * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either the length of the specified string for a section - * or an entry is less than or equal to @c 0, - * or a @c null value is passed. @n - * Note that, it is also possible that the data inside a registry instance is - * corrupted due to its usage in a multi-threaded environment without - * synchronization. - * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. - * @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry. - * @exception E_PARSING_FAILED The method has failed to parse the encoded entry value string, or the value is retrieved by using an incorrect data type. - * @exception E_DATA_NOT_FOUND The name-value pair has no value assigned (if the value is retrieved using the REGTYPE_STRING type, an empty string is returned even if no value is assigned). + * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0. + * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry. + * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry. + * @exception E_PARSING_FAILED Either of the following conditions has occurred: + * - The method has failed to parse the encoded entry value string. + * - The specified data type of the value and the data type of the retrieved value are different. + * @exception E_DATA_NOT_FOUND There is no value assigned for the specified entry name. @n + * If the value is retrieved using the REGTYPE_STRING type, + * an empty string is returned even if no value is assigned. */ result GetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, Tizen::Base::UuId& retVal) const; @@ -680,184 +643,156 @@ public: * * @return An error code * @param[in] sectionName The section name - * @param[in] entryName The name of entry where its value will be fetched + * @param[in] entryName The entry name to get * @param[out] retVal The return value obtained from the registry * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either the length of the specified string for a section - * or an entry is less than or equal to @c 0, - * or a @c null value is passed. @n - * Note that, it is also possible that the data inside a registry instance is - * corrupted due to its usage in a multi-threaded environment without - * synchronization. - * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. - * @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry. - * @exception E_PARSING_FAILED The method has failed to parse the encoded entry value string, or the value is retrieved by using an incorrect data type. - * @exception E_DATA_NOT_FOUND The name-value pair has no value assigned (if the value is retrieved using the REGTYPE_STRING type, an empty string is returned even if no value is assigned). - * @remarks The ByteBuffer should be constructed before passing it to the method. - * That is, the size of the binary data to be fetched should be decided beforehand. - * When the %ByteBuffer capacity is less than the actual binary data stored in the registry, - * this method reads the data as much as the %ByteBuffer capacity. The position of the %ByteBuffer and - * limit are not changed. When the %ByteBuffer capacity is greater than the actual data size, + * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0. + * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry. + * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry. + * @exception E_PARSING_FAILED Either of the following conditions has occurred: + * - The method has failed to parse the encoded entry value string. + * - The specified data type of the value and the data type of the retrieved value are different. + * @exception E_DATA_NOT_FOUND There is no value assigned for the specified entry name. @n + * If the value is retrieved using the REGTYPE_STRING type, + * an empty string is returned even if no value is assigned. + * @remarks Decide the size of the byte data to be fecthed and construct the Tizen::Base::ByteBuffer before passing it to the method. @n + * When the %Tizen::Base::ByteBuffer capacity is less than the actual binary data stored in the registry, + * this method reads data that fits the %Tizen::Base::ByteBuffer capacity. The position of the %Tizen::Base::ByteBuffer and + * limit are not changed. @n + * When the %Tizen::Base::ByteBuffer capacity is greater than the actual data size, * the method reads the whole data and adjusts the limit of the buffer accordingly. * @see Tizen::Base::ByteBuffer */ result GetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, Tizen::Base::ByteBuffer& retVal) const; /** - * Modifies the value of the specified entry using the specified @c int value. + * Sets the @c int value for the specified entry. * * @since 2.0 * * @return An error code * @param[in] sectionName The section name - * @param[in] entryName The entry name to modify + * @param[in] entryName The entry name to set the value * @param[in] newValue The @c int value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either the length of the specified string for a section - * or an entry is less than or equal to @c 0, - * or a @c null value is passed. @n - * Note that, it is also possible that the data inside a registry instance is - * corrupted due to its usage in a multi-threaded environment without - * synchronization. - * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. - * @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry. - * @remarks This method will not add a name-value pair as an entry of a specific section - * if no entry with the specified name exists. - * In such a case, it returns E_KEY_NOT_FOUND. Use AddValue() to insert a new entry. + * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0. + * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry. + * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry. + * @remarks This method will not set the specified value as an entry of the specific section + * if no entry with the specified name exists. @n + * In such a case, it returns @c E_KEY_NOT_FOUND. Use AddValue() to insert a new entry. * @see AddValue() */ result SetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, int newValue); /** - * Modifies the value of the specified entry using the specified @c double value. + * Sets the @c double value for the specified entry. * * @since 2.0 * * @return An error code * @param[in] sectionName The section name - * @param[in] entryName The entry name to modify + * @param[in] entryName The entry name to set the value * @param[in] newValue The @c double value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either the length of the specified string for a section - * or an entry is less than or equal to @c 0, - * or a @c null value is passed. @n - * Note that, it is also possible that the data inside a registry instance is - * corrupted due to its usage in a multi-threaded environment without - * synchronization. - * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. - * @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry. - * @remarks This method will not add a name-value pair as an entry of a specific section - * if no entry with the specified name exists. - * In such a case, it returns E_KEY_NOT_FOUND. Use AddValue() to insert a new entry. - * @remarks This method converts the specified double type @c newValue to string value using "%lg" format specifier. @n - * Also, it does not depend on system locale. + * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0. + * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry. + * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry. + * @remarks + * - This method will not set the specified value as an entry of the specific section + * if no entry with the specified name exists. @n + * In such a case, it returns @c E_KEY_NOT_FOUND. Use AddValue() to insert a new entry. + * - This method converts the specified double type @c newValue to string value using the "%lg" format specifier. @n + * It does not depend on the system locale. * @see AddValue() */ result SetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, double newValue); /** - * Modifies the value of the specified entry using the specified @c float value. + * Sets the @c float value for the specified entry. * * @since 2.0 * * @return An error code * @param[in] sectionName The section name - * @param[in] entryName The entry name to modify + * @param[in] entryName The entry name to set the value * @param[in] newValue The @c float value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either the length of the specified string for a section - * or an entry is less than or equal to @c 0, - * or a @c null value is passed. @n - * Note that, it is also possible that the data inside a registry instance is - * corrupted due to its usage in a multi-threaded environment without - * synchronization. - * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. - * @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry. - * @remarks This method will not add a name-value pair as an entry of a specific section - * if no entry with the specified name exists. - * In such a case, it returns E_KEY_NOT_FOUND. Use AddValue() to insert a new entry. - * @remarks This method converts the specified float type @c newValue to string value using "%g" format specifier. @n - * Also, it does not depend on system locale. + * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0. + * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry. + * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry. + * @remarks + * - This method will not set the specified value as an entry of the specific section + * if no entry with the specified name exists. @n + * In such a case, it returns @c E_KEY_NOT_FOUND. Use AddValue() to insert a new entry. + * - This method converts the specified float type @c newValue to string value using the "%g" format specifier. @n + * It does not depend on the system locale. * @see AddValue() */ result SetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, float newValue); /** - * Modifies the value of the specified entry using the specified String value. + * Sets the String value for the specified entry. * * @since 2.0 * * @return An error code * @param[in] sectionName The section name - * @param[in] entryName The entry name to modify + * @param[in] entryName The entry name to set the value * @param[in] newValue The String value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either the length of the specified string for a section - * or an entry is less than or equal to @c 0. - * Note that, it is also possible that the data inside a registry instance is - * corrupted due to its usage in a multi-threaded environment without - * synchronization. - * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. - * @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry. - * @remarks This method will not add a name-value pair as an entry of a specific section - * if no entry with the specified name exists. - * In such a case, it returns E_KEY_NOT_FOUND. Use AddValue() to insert a new entry. + * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0. + * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry. + * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry. + * @remarks This method will not set the specified value as an entry of the specific section + * if no entry with the specified name exists. @n + * In such a case, it returns @c E_KEY_NOT_FOUND. Use AddValue() to insert a new entry. * @see AddValue() */ result SetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, const Tizen::Base::String& newValue); /** - * Modifies the value of the specified entry using the specified UuID value. + * Sets the UuId value for the specified entry. * * @since 2.0 * * @return An error code * @param[in] sectionName The section name - * @param[in] entryName The entry name to modify + * @param[in] entryName The entry name to set the value * @param[in] newValue The UuId value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either the length of the specified string for a section - * or an entry is less than or equal to @c 0, - * or a @c null value is passed. @n - * Note that, it is also possible that the data inside a registry instance is - * corrupted due to its usage in a multi-threaded environment without - * synchronization. - * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. - * @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry. - * @remarks This method will not add a name-value pair as an entry of a specific section if no - * entry with the specified name exists. - * In such a case, it returns E_KEY_NOT_FOUND. Use AddValue() to insert a new entry. + * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0. + * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry. + * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry. + * @remarks This method will not set the specified value as an entry of the specific section + * if no entry with the specified name exists. @n + * In such a case, it returns E_KEY_NOT_FOUND. Use AddValue() to insert a new entry. * @see AddValue() */ result SetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, const Tizen::Base::UuId& newValue); /** - * Modifies the value of the specified entry using the specified ByteBuffer value. + * Sets the ByteBuffer value for the specified entry. * * @since 2.0 * * @return An error code * @param[in] sectionName The section name - * @param[in] entryName The entry name to modify + * @param[in] entryName The entry name to set the value * @param[in] newValue The @c ByteBuffer value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either the length of the specified string for a section - * or an entry is less than or equal to @c 0, - * or a @c null value is passed. @n - * Note that, it is also possible that the data inside a registry instance is - * corrupted due to its usage in a multi-threaded environment without - * synchronization. - * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. - * @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry. - * @remarks This method will not add a name-value pair as an entry of a specific section - * if no entry with the specified name exists. - * In such a case, it returns E_KEY_NOT_FOUND. Use AddValue() to insert a new entry. + * @exception E_INVALID_ARG The length of the specified section name or entry name is less than or equal to @c 0. + * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry. + * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry. + * @remarks This method will not set the specified value as an entry of the specific section + * if no entry with the specified name exists. @n + * In such a case, it returns E_KEY_NOT_FOUND. Use AddValue() to insert a new entry. * @see AddValue() */ result SetValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName, const Tizen::Base::ByteBuffer& newValue); /** - * Removes the name-value pair entry from specific section. + * Removes the name-value pair entry from specified section. * * @since 2.0 * @@ -867,8 +802,8 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The length of the specified string for a section or entry is less * than or equal to @c 0. - * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found within the registry. - * @exception E_KEY_NOT_FOUND The specified @c entryName is not found within the registry. + * @exception E_SECTION_NOT_FOUND The specified @c sectionName is not found in the registry. + * @exception E_KEY_NOT_FOUND The specified @c entryName is not found in the registry. */ result RemoveValue(const Tizen::Base::String& sectionName, const Tizen::Base::String& entryName); @@ -879,50 +814,52 @@ public: * * @since 2.1 * - * @return The pointer to %FileLock instance, @n - * else @c null pointer in case of failure - * @param[in] lockType The type of file lock to be created + * @return The pointer to the FileLock instance, @n + * else @c null pointer in case of failure + * @param[in] lockType The file lock type to be created * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c lockType is invalid. - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n - * - The specified @c lockType cannot be FILE_LOCK_SHARED if the current - * file is not open for reading. @n - * - The specified @c lockType cannot be FILE_LOCK_EXCLUSIVE if the current - * file is not open for writing. @n + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The specified @c lockType cannot be @c FILE_LOCK_SHARED if the current + * file is not open for reading. + * - The specified @c lockType cannot be @c FILE_LOCK_EXCLUSIVE if the current + * file is not open for writing. * @exception E_WOULD_DEADLOCK The method would cause a deadlock. @n - * The lock is blocked by a lock from another process, and putting the - * calling process to sleep to wait for that lock to become free would - * cause a deadlock. - * @exception E_MAX_EXCEEDED The number of file lock exceeds system limitations. + * The lock is blocked by a lock from another process, and putting the + * calling process to sleep to wait for that lock to become free would + * cause a deadlock. + * @exception E_MAX_EXCEEDED The number of file locks has exceeded system limitations. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The %FileLock instance is invalid if the associated %File instance is deleted. @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - The FileLock instance is invalid if the associated %File instance is deleted. + * - The specific error code can be accessed using the GetLastResult() method. */ FileLock* LockN(FileLockType lockType); /** * Tries to acquire the file lock on the current opened whole file. - * If the file lock is already acquired by another process, E_OBJECT_LOCKED is returned. + * If the file lock is already acquired by another process, @c E_OBJECT_LOCKED is returned. * * @since 2.1 * - * @return The pointer to %FileLock instance, @n - * else @c null pointer in case of failure + * @return The pointer to the FileLock instance, @n + * else @c null pointer in case of failure * @param[in] lockType The type of file lock to be created * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c lockType is invalid. - * @exception E_INVALID_OPERATION Either of the following conditions has occurred: @n - * - The specified @c lockType cannot be FILE_LOCK_SHARED if the current - * file is not open for reading. @n - * - The specified @c lockType cannot be FILE_LOCK_EXCLUSIVE if the current - * file is not open for writing. @n - * @exception E_OBJECT_LOCKED Either of the following conditions has occurred: @n - * - The file lock is already held by another process. @n - * - The file to be locked has been memory-mapped by another process. - * @exception E_MAX_EXCEEDED The number of file lock exceeds system limitations. + * @exception E_INVALID_OPERATION Either of the following conditions has occurred: + * - The specified @c lockType cannot be @c FILE_LOCK_SHARED if the current + * file is not open for reading. + * - The specified @c lockType cannot be @c FILE_LOCK_EXCLUSIVE if the current + * file is not open for writing. + * @exception E_OBJECT_LOCKED Either of the following conditions has occurred: + * - The file lock is already held by another process. + * - The file to be locked has been memory-mapped by another process. + * @exception E_MAX_EXCEEDED The number of file locks has exceeded system limitations. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The %FileLock instance is invalid if the associated %File instance is deleted. @n - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - The FileLock instance is invalid if the associated %File instance is deleted. + * - The specific error code can be accessed using the GetLastResult() method. */ FileLock* TryToLockN(FileLockType lockType); @@ -941,16 +878,16 @@ public: * @return An error code * @param[in] regPath The path of the registry file to remove * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The length of the specified string of a file path is less - * than or equal to @c 0. @n - * - The translated overall length of the specified path exceeds the - * system limitation. @n - * - The specified path is invalid. @n + * than or equal to @c 0. + * - The overall length of the specified path exceeds the + * system limitation. + * - The specified path is invalid. * @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found. - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. * - %File corruption is detected. */ static result Remove(const Tizen::Base::String& regPath); @@ -971,25 +908,25 @@ public: * @return An error code * @param[in] plainRegPath The normal (non-encrypted) registry file path * @param[in] secureRegPath The secure (encrypted) registry file path to create - * @param[in] key A key that encrypts a secure registry file @n - * If the secure registry file is converted with a specific key value, - * applications can access the same secure registry file with the identical key value. + * @param[in] key The key that encrypts the secure registry file @n + * If the secure registry file is converted with the specific key value, + * applications can access the same secure registry file with an identical key value. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * @exception E_INVALID_ARG Either of the following conditions has occurred: * - The length of the specified string of a file path is less - * than or equal to @c 0. @n - * - The translated overall length of the specified path exceeds the - * system limitation. @n - * - The specified path is invalid. @n - * @exception E_ILLEGAL_ACCESS Access is denied due to insufficient permission. + * than or equal to @c 0. + * - The overall length of the specified path exceeds the + * system limitation. + * - The specified path is invalid. + * @exception E_ILLEGAL_ACCESS The access is denied due to insufficient permission. * @exception E_FILE_ALREADY_EXIST The specified file already exists. * @exception E_FILE_NOT_FOUND An entry for the specified file or path cannot be found. * @exception E_INVALID_FORMAT The input registry file contains '0x00' in the middle of the file. * @exception E_PARSING_FAILED The method has failed to parse the registry file. * @exception E_STORAGE_FULL The disk space is full. - * @exception E_IO Either of the following conditions has occurred: @n - * - An unexpected device failure has occurred as the media ejected suddenly. @n - * - %File corruption is detected. @n + * @exception E_IO Either of the following conditions has occurred: + * - An unexpected device failure has occurred as the media ejected suddenly. + * - %File corruption is detected. * - The number of opened files has exceeded the maximum limit. */ static result ConvertToSecureRegistry(const Tizen::Base::String& plainRegPath, const Tizen::Base::String& secureRegPath, const Tizen::Base::ByteBuffer& key); diff --git a/inc/FIoRemoteMessagePort.h b/inc/FIoRemoteMessagePort.h index e1b9c37..d4163b5 100644 --- a/inc/FIoRemoteMessagePort.h +++ b/inc/FIoRemoteMessagePort.h @@ -112,25 +112,25 @@ class _OSP_EXPORT_ RemoteMessagePort public: /** - * Gets the name of a remote message port. + * Gets the name of the remote message port. * * @since 2.0 * - * @return The name of a remote message port + * @return The name of the remote message port */ Tizen::Base::String GetName(void) const; /** - * Gets the ID of a remote application. + * Gets the ID of the remote application. * * @since 2.0 * - * @return The ID of a remote application + * @return The ID of the remote application */ Tizen::App::AppId GetAppId(void) const; /** - * Checks whether an instance is a trusted message port or not. + * Checks whether an instance is a trusted message port. * * @since 2.0 * @@ -144,36 +144,41 @@ public: * * @since 2.0 * - * @return An error code - * @param[in] pMessage A pointer to an argument map of key (String) and value (String or ByteBuffer) pair @n - * The recommended message size is under 4KB. - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The message argument is not a map of key (String) and value (String or ByteBuffer) pair. - * @exception E_OBJ_NOT_FOUND The message port of the target application is not found. - * @exception E_MAX_EXCEEDED The size of @c pMessage has exceeded the maximum limit. - * @exception E_SYSTEM The method has failed due to a severe system error. - * @remarks The recommended message size is under 4KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 4KB size. + * @return An error code + * @param[in] pMessage A pointer to an argument map of key (String) and value (String or ByteBuffer) pair @n + * The recommended message size is under 4KB. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The message argument is not a map of key (String) and value (String or ByteBuffer) pair. + * @exception E_OBJ_NOT_FOUND The message port of the target application is not found. + * @exception E_MAX_EXCEEDED The size of @c pMessage has exceeded the maximum limit. + * @exception E_SYSTEM The method has failed due to a severe system error. + * @remarks The recommended message size is under 4KB because severe system performance degradation may occur for large + * messages. @n + * @c E_MAX_EXCEEDED may be returned for messages over 4KB size. */ result SendMessage(const Tizen::Base::Collection::IMap* pMessage); /** - * Sends a message to the message port of a remote application. This method is used for the bidirectional communication. + * Sends a message to the message port of a remote application. @n + * This method is used for the bidirectional communication. * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] pLocalMessagePort The local message port - * @param[in] pMessage A pointer to an argument map of key (String) and value (String or ByteBuffer) pair @n - * The recommended message size is under 4KB. - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG Either of the following conditions has occurred: @n - * - The local message port is @c null. @n - * - The message argument is not a map of key (String) and value (String or ByteBuffer) pair. - * @exception E_OBJ_NOT_FOUND The message port of the target application is not found. - * @exception E_MAX_EXCEEDED The size of @c pMessage has exceeded the maximum limit. - * @exception E_SYSTEM The method has failed due to a severe system error. - * @remarks The recommended message size is under 4KB because severe system performance degradation may occur for large messages. @c E_MAX_EXCEEDED may be returned for messages over 4KB size. + * @return An error code + * @param[in] pLocalMessagePort The local message port + * @param[in] pMessage A pointer to an argument map of key (String) and value (String or ByteBuffer) pair @n + * The recommended message size is under 4KB. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The local message port is @c null. + * - The message argument is not a map of key (String) and value (String or ByteBuffer) pair. + * @exception E_OBJ_NOT_FOUND The message port of the target application is not found. + * @exception E_MAX_EXCEEDED The size of @c pMessage has exceeded the maximum limit. + * @exception E_SYSTEM The method has failed due to a severe system error. + * @remarks The recommended message size is under 4KB because severe system performance degradation may occur for large + * messages. @n + * @c E_MAX_EXCEEDED may be returned for messages over 4KB size. */ result SendMessage(const LocalMessagePort* pLocalMessagePort, const Tizen::Base::Collection::IMap* pMessage); diff --git a/inc/FIoSerialPort.h b/inc/FIoSerialPort.h index 312524f..25f75d8 100644 --- a/inc/FIoSerialPort.h +++ b/inc/FIoSerialPort.h @@ -101,7 +101,8 @@ class _OSP_EXPORT_ SerialPort public: /** - * 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. + * 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 */ @@ -115,28 +116,28 @@ public: virtual ~SerialPort(void); /** - * Constructs a new serial port connection. @n - * If the specified port is open, E_SYSTEM is returned. + * Constructs a new serial port connection with the specified serial port event listener. @n + * If the specified port is open, @c E_SYSTEM is returned. * * @since 2.0 * - * @return An error code + * @return An error code * @param[in] listener The serial port event listener * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. + * @exception E_SYSTEM A system error has occurred. */ result Construct(ISerialPortEventListener& listener); /** - * Writes data to the output buffer synchronously. + * Writes the specified data synchronously. * * @since 2.0 * * @return An error code - * @param[in] byteBuffer A reference to the buffer that contains the string data to write - * @exception E_SUCCESS The method is successful. - * @exception E_MAX_EXCEEDED The buffer size has exceeded the maximum limit of the current device. - * @exception E_SYSTEM A system error has occurred. + * @param[in] byteBuffer A reference to the buffer that contains the string data to write + * @exception E_SUCCESS The method is successful. + * @exception E_MAX_EXCEEDED The buffer size has exceeded the maximum limit of the current device. + * @exception E_SYSTEM A system error has occurred. * @see GetWriteBufferSize() */ result Write(const Tizen::Base::ByteBuffer& byteBuffer); @@ -144,9 +145,9 @@ public: /** * Gets the size of the write buffer. * - * @since 2.0 + * @since 2.0 * - * @return The size of the write buffer + * @return The size of the write buffer * @remarks The size of the write buffer depends on the device. */ int GetWriteBufferSize(void) const; diff --git a/inc/FIoServerChannel.h b/inc/FIoServerChannel.h index 0111068..135cde4 100644 --- a/inc/FIoServerChannel.h +++ b/inc/FIoServerChannel.h @@ -42,7 +42,9 @@ namespace Tizen { namespace Io * * @final This class is not intended for extension. * -* The %ServerChannel class provides methods to receive a request from a client application. An application can receive a request from another application using the %ServerChannel class. The instance of %ServerChannel is retrieved using ServerChannel::GetInstance(). +* The %ServerChannel class provides methods to receive a request from a client application. An application can receive a +* request from another application using the %ServerChannel class. The instance of %ServerChannel is retrieved using +* ServerChannel::GetInstance(). * * The following example demonstrates how to use the %ServerChannel class. * @@ -135,7 +137,7 @@ public: * * @since 2.0 * - * @return A pointer to the %ServerChannel instance, @n + * @return The pointer to the %ServerChannel instance, @n * else @c null if it fails * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -149,7 +151,7 @@ public: * * @since 2.0 * - * @return A pointer to the %ServerChannel instance, @n + * @return The pointer to the %ServerChannel instance, @n * else @c null if it fails * @param[in] channelName The channel name * @exception E_SUCCESS The method is successful. diff --git a/inc/FIoSqlStatementBuilder.h b/inc/FIoSqlStatementBuilder.h index 6e7196f..47e3c30 100644 --- a/inc/FIoSqlStatementBuilder.h +++ b/inc/FIoSqlStatementBuilder.h @@ -41,13 +41,13 @@ namespace Tizen { namespace Io /** * @class SqlStatementBuilder - * @brief This class provides methods for building SQL statement. + * @brief This class provides methods for building an SQL statement. * * @since 2.0 * * @final This class is not intended for extension. * - * The %SqlStatementBuilder class provides methods for building SQL statement. + * The %SqlStatementBuilder class provides methods for building an SQL statement. */ class _OSP_EXPORT_ SqlStatementBuilder : public Tizen::Base::Object @@ -55,27 +55,27 @@ class _OSP_EXPORT_ SqlStatementBuilder public: /** - * Creates SQL SELECT statement. + * Creates an SQL SELECT statement. * * @since 2.0 * - * @return A created SQL SELECT statement, @n + * @return The SQL SELECT statement, @n * else an empty string in case of failure - * @param[in] table A table name to query from - * @param[in] pColumnList A list of column names to query @n + * @param[in] table The table name to query from + * @param[in] pColumnList The list of column names to query @n * The type of objects contained in the specified @c pColumnList must be * Tizen::Base::String class. * If it is @c null, all columns are returned in result set. - * @param[in] pWhere A filter to select desired rows to query @n + * @param[in] pWhere The filter to select the desired rows to query @n * It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as * column1 = 'stringValue' AND column2 = numericValue. - * @param[in] pOrder Sorting order of rows to query @n + * @param[in] pOrder The sorting order of rows to query @n * It is an SQL 'ORDER BY' clause excluding the 'ORDER BY' itself. - * @param[in] pLimit Limitation of the number of rows to query @n + * @param[in] pLimit The limit of the number of rows to query @n * It is the SQL 'LIMIT' clause excluding the 'LIMIT' itself. - * @param[in] pGroup A filter to select a column grouping rows to query @n + * @param[in] pGroup The filter to select a column grouping rows to query @n * It is the SQL 'GROUP BY' clause excluding the 'GROUP BY' itself. - * @param[in] pHaving A filter for the group @n + * @param[in] pHaving The filter for the group @n * It is the SQL 'HAVING' clause excluding the 'HAVING' itself. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG Either of the following conditions has occurred: @@ -83,80 +83,84 @@ public: * - The specified @c pOrder is @c null and @c pLimit is not @c null. * - The specified @c pGroup is @c null and @c pHaving is not @c null. * @exception E_SYSTEM A system error has occurred. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks If the value specified in the @c pWhere is string, the value must be wrapped in - * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes. - * For more information on the SQL statement, see SQLite SQL documents. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - If the value specified in the @c pWhere is string, the value must be wrapped in + * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes. + * For more information on the SQL statement, see SQLite SQL documents. */ static Tizen::Base::String CreateSelectStatement(const Tizen::Base::String& table, const Tizen::Base::Collection::IList* pColumnList, const Tizen::Base::String* pWhere, const Tizen::Base::String* pOrder = null, const Tizen::Base::String* pLimit = null, const Tizen::Base::String* pGroup = null, const Tizen::Base::String* pHaving = null); /** - * Creates SQL INSERT statement. + * Creates an SQL INSERT statement. * * @since 2.0 * - * @return A created SQL INSERT statement, @n + * @return The SQL INSERT statement, @n * else an empty string in case of failure @n - * @param[in] table A table name to insert - * @param[in] insertMap Column-value pairs to insert @n + * @param[in] table The table name to insert + * @param[in] insertMap The column-value pairs to insert @n * The type of objects contained in the specified @c insertMap must be * Tizen::Base::String class. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c insertMap is empty. * @exception E_SYSTEM A system error has occurred. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks If the value specified in the @c insertMap is string, the value must be wrapped in - * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes. - * For more information on the SQL statement, see SQLite SQL documents. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - If the value specified in the @c insertMap is string, the value must be wrapped in + * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes. + * For more information on the SQL statement, see SQLite SQL documents. */ static Tizen::Base::String CreateInsertStatement(const Tizen::Base::String& table, const Tizen::Base::Collection::IMap& insertMap); /** - * Creates SQL UPDATE statement. + * Creates an SQL UPDATE statement. * * @since 2.0 * - * @return A created SQL UPDATE statement, @n + * @return The SQL UPDATE statement, @n * else an empty string in case of failure @n - * @param[in] table A table name to update - * @param[in] updateMap Column-value pairs to update @n + * @param[in] table The table name to update + * @param[in] updateMap The column-value pairs to update @n * The type of objects contained in the specified @c updateMap must be * Tizen::Base::String class. - * @param[in] pWhere A filter to select desired rows to update @n + * @param[in] pWhere The filter to select desired rows to update @n * It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as * column1 = 'stringValue' AND column2 = numericValue. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c updateMap is empty. * @exception E_SYSTEM A system error has occurred. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks If the value specified in the @c pWhere or @c updateMap is string, the value must be wrapped in - * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes. - * For more information on the SQL statement, see SQLITE SQL documents. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - If the value specified in the @c pWhere or @c updateMap is string, the value must be wrapped in + * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes. + * For more information on the SQL statement, see SQLITE SQL documents. */ static Tizen::Base::String CreateUpdateStatement(const Tizen::Base::String& table, const Tizen::Base::Collection::IMap& updateMap, const Tizen::Base::String* pWhere); /** - * Creates SQL DELETE statement. + * Creates an SQL DELETE statement. * * @since 2.0 * - * @return A created SQL DELETE statement, @n + * @return The SQL DELETE statement, @n * else an empty string in case of failure @n - * @param[in] table A table name to query - * @param[in] pWhere A filter to select desired rows to delete @n + * @param[in] table The table name to query + * @param[in] pWhere The filter to select desired rows to delete @n * It is an SQL 'WHERE' clause excluding the 'WHERE' itself such as * column1 = 'stringValue' AND column2 = numericValue. * If it is @c null, all rows are deleted. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified parameter is invalid. * @exception E_SYSTEM A system error has occurred. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks If the value specified in the @c pWhere is string, the value must be wrapped in - * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes. - * For more information on the SQL statement, see SQLITE SQL documents. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - If the value specified in the @c pWhere is string, the value must be wrapped in + * single quotes. Otherwise it is not needed to wrap the numeric value in single quotes. + * For more information on the SQL statement, see SQLITE SQL documents. */ static Tizen::Base::String CreateDeleteStatement(const Tizen::Base::String& table, const Tizen::Base::String* pWhere); diff --git a/inc/FLclCalendar.h b/inc/FLclCalendar.h index 45d3e66..9f8c216 100644 --- a/inc/FLclCalendar.h +++ b/inc/FLclCalendar.h @@ -101,7 +101,7 @@ enum TimeField TIME_FIELD_MILLISECOND, /**< Millisecond : 0-based (0~999) */ TIME_FIELD_ZONE_OFFSET, /**< Time Zone Offset : 0-based (-43200000~54000000 in milliseconds) */ TIME_FIELD_DST_OFFSET, /**< Daylight Saving Offset : 0-based (0~3600000 in milliseconds)*/ - TIME_FIELD_FIELD_COUNT /**< The number of time field */ + TIME_FIELD_FIELD_COUNT /**< The number of time fields */ }; class _OSP_EXPORT_ Calendar @@ -117,8 +117,8 @@ public: virtual ~Calendar(void); /** - * Adds the specified amount to the given time field, based on the calendar rules. @n - * It is equivalent to calling SetTimeField(field, GetTimeField(field)+amount) with two adjustments. @n + * Adds the specified amount to the specified time field, based on the calendar rules. @n + * It is equivalent to calling SetTimeField(field, GetTimeField(field)+amount) with the following two adjustments: @n * * @b Add @b Rule1: The value of the time field @c field after the call minus the value of the field * before the call is delta modulo any overflow that has occurred in the field. @@ -129,48 +129,48 @@ public: * equal to its prior value because of changes in its minimum or maximum value after the time field @c field * is changed, then its value is adjusted to be as close as possible to its expected value. @n * - * A smaller field represents a smaller unit of time. TIME_FIELD_HOUR is a smaller field than TIME_FIELD_DAY_OF_MONTH. + * A smaller field represents a smaller unit of time. @c TIME_FIELD_HOUR is a smaller field than @c TIME_FIELD_DAY_OF_MONTH. * No adjustment is made to smaller fields that are not expected to be invariant. - * The calendar system determines what fields are expected to be invariant. + * The calendar system determines the fields that are expected to be invariant. * * In addition, this method forces re-computation of the calendar's milliseconds and * all time fields immediately. @n * * For example, consider a GregorianCalendar set to Oct 31, 2004. - * Calling AddTimeField(TIME_FIELD_MONTH, 13) sets the calendar to Nov 30, 2005. @n - * The TIME_FIELD_MONTH field is set to NOVEMBER by @b Rule1, since adding 13 months to October gives the + * Calling AddTimeField(@c TIME_FIELD_MONTH, 13) sets the calendar to Nov 30, 2005. @n + * The @c TIME_FIELD_MONTH field is set to NOVEMBER by @b Rule1, since adding 13 months to October sets the month as * November of the next year. - * Since, the TIME_FIELD_DAY_OF_MONTH cannot be 31 in November in a %GregorianCalendar, the TIME_FIELD_DAY_OF_MONTH is set to 30 by @b Rule2. + * Since, the @c TIME_FIELD_DAY_OF_MONTH cannot be 31 in November in a %GregorianCalendar, the @c TIME_FIELD_DAY_OF_MONTH is set to 30 by @b Rule2. * * @if OSPCOMPAT * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompCalendarAddTimeFieldPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompCalendarAddTimeFieldPage "here". * @endif * * @return An error code * @param[in] field The time field * @param[in] amount The amount to add * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c field is invalid. + * @exception E_INVALID_ARG The specified @c field is invalid. */ virtual result AddTimeField(TimeField field, int amount) = 0; /** * @if OSPCOMPAT - * @page CompCalendarAddTimeFieldPage Compatibility for AddTimeField() - * @section CompCalendarAddTimeFieldIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_INVALID_STATE if the time field is invalid. - * - * @section CompCalendarAddTimeFieldSolutionSection Resolutions - * This issue has been resolved in Tizen. + * @page CompCalendarAddTimeFieldPage Compatibility for AddTimeField() + * @section CompCalendarAddTimeFieldIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_INVALID_STATE if the time field is invalid. + * + * @section CompCalendarAddTimeFieldSolutionSection Resolutions + * This issue has been resolved in Tizen. * * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the time field is invalid. + * -# The method returns @c E_INVALID_ARG if the time field is invalid. * @endif */ @@ -180,41 +180,41 @@ public: * @if OSPCOMPAT * @brief [Compatibility] * @endif - * @since 2.0 + * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompCalendarAfterPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompCalendarAfterPage "here". * @endif * - * @return An error code - * @param[in] otherCalendar The instance of %Calendar to compare - * @param[out] after Set to @c true if the current instance of %Calendar is after the specified instance of %Calendar, @n + * @return An error code + * @param[in] otherCalendar The instance of %Calendar to compare + * @param[out] after Set to @c true if the current instance of %Calendar is after the specified instance of %Calendar, @n * else @c false - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c otherCalendar is invalid. - * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified @c otherCalendar is invalid. + * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n * If any time field value previously set is invalid, this exception is returned. - * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n - * If the value of the time fields goes out of range, this exception is returned. + * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n + * If the value of the time fields goes out of range, this exception is returned. */ result After(const Calendar& otherCalendar, bool& after); /** * @if OSPCOMPAT - * @page CompCalendarAfterPage Compatibility for After() - * @section CompCalendarAfterIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_INVALID_STATE and E_OUT_OF_RANGE if the instance of %Calendar to be compared is invalid. - * - * @section CompCalendarAfterSolutionSection Resolutions - * This issue has been resolved in Tizen. + * @page CompCalendarAfterPage Compatibility for After() + * @section CompCalendarAfterIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_INVALID_STATE and @c E_OUT_OF_RANGE if the instance of %Calendar to be compared is invalid. + * + * @section CompCalendarAfterSolutionSection Resolutions + * This issue has been resolved in Tizen. * * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the instance of %Calendar to be compared is invalid. - * -# The method returns E_INVALID_STATE if any time field value previously set is invalid. - * -# The method returns E_OUT_OF_RANGE if the value of the time fields goes out of range. + * -# The method returns @c E_INVALID_ARG if the instance of %Calendar to be compared is invalid. + * -# The method returns @c E_INVALID_STATE if any time field value previously set is invalid. + * -# The method returns @c E_OUT_OF_RANGE if the value of the time fields goes out of range. * @endif - */ + */ /** * Compares the current instance of %Calendar with the specified instance. @@ -222,45 +222,45 @@ public: * @if OSPCOMPAT * @brief [Compatibility] * @endif - * @since 2.0 + * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompCalendarBeforePage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompCalendarBeforePage "here". * @endif * - * @return An error code - * @param[in] otherCalendar The instance of %Calendar to compare - * @param[out] before Set to @c true if the current instance of %Calendar is before the specified instance of %Calendar, @n - * else @c false + * @return An error code + * @param[in] otherCalendar The instance of %Calendar to compare + * @param[out] before Set to @c true if the current instance of %Calendar is before the specified instance of %Calendar, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c otherCalendar is invalid. - * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n - * If any time field value previously set is invalid, this exception is returned. - * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n - * If the value of the time fields goes out of range, this exception is returned. + * @exception E_INVALID_ARG The specified @c otherCalendar is invalid. + * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n + * If any time field value previously set is invalid, this exception is returned. + * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n + * If the value of the time fields goes out of range, this exception is returned. */ result Before(const Calendar& otherCalendar, bool& before); /** * @if OSPCOMPAT - * @page CompCalendarBeforePage Compatibility for Before() - * @section CompCalendarBeforeIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_INVALID_STATE and E_OUT_OF_RANGE if the instance of %Calendar to be compared is invalid. - * - * @section CompCalendarBeforeSolutionSection Resolutions - * This issue has been resolved in Tizen. + * @page CompCalendarBeforePage Compatibility for Before() + * @section CompCalendarBeforeIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_INVALID_STATE and @c E_OUT_OF_RANGE if the instance of %Calendar to be compared is invalid. + * + * @section CompCalendarBeforeSolutionSection Resolutions + * This issue has been resolved in Tizen. * * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the instance of %Calendar to be compared is invalid. - * -# The method returns E_INVALID_STATE if any time field value previously set is invalid. - * -# The method returns E_OUT_OF_RANGE if the value of the time fields goes out of range. - * @endif - */ + * -# The method returns @c E_INVALID_ARG if the instance of %Calendar to be compared is invalid. + * -# The method returns @c E_INVALID_STATE if any time field value previously set is invalid. + * -# The method returns @c E_OUT_OF_RANGE if the value of the time fields goes out of range. + * @endif + */ /** * Clears all the time fields and sets it to @c 0. @n - * Zero is not the default value for each field. It means the field is cleared. + * Zero is not the default value for each field. It means that the field is cleared. * * @since 2.0 * @@ -271,7 +271,7 @@ public: /** * Clears the specified time field and sets it to @c 0. @n - * Zero is not the default value for each field. It means the field is cleared. + * Zero is not the default value for each field. It means that the field is cleared. * * @since 2.0 * @@ -288,7 +288,7 @@ public: * * @return @c true if the value of the specified instance of Tizen::Base::Object is equal to the value of the current instance of %Calendar, @n * else @c false - * @param[in] obj An instance of Tizen::Base::Object to compare + * @param[in] obj An instance of Tizen::Base::Object to compare */ virtual bool Equals(const Tizen::Base::Object& obj) const; @@ -302,43 +302,45 @@ public: virtual int GetHashCode(void) const; /** - * Rolls up or down as per the specified @c amount in the specified time field without changing the larger fields (for example, TIME_FIELD_YEAR field cannot be changed when the input field is TIME_FIELD_MONTH). @n + * Rolls up or down as per the specified @c amount in the specified time field without changing the larger fields + * (for example, @c TIME_FIELD_YEAR field cannot be changed when the input field is @c TIME_FIELD_MONTH). @n * If the specified @c amount is negative, the amount value is deducted from the specified time field value. - * In this method, the time field of this instance is operated upon. If the value of the specified @c field goes out of range, E_OUT_OF_RANGE is returned. + * In this method, the time field of this instance is operated upon. If the value of the specified @c field goes out of range, + * @c E_OUT_OF_RANGE is returned. * * @if OSPCOMPAT * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompCalendarRollPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompCalendarRollPage "here". * @endif * * @return An error code - * @param[in] field The time field to roll - * @param[in] amount The amount to add to the time field - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c field is invalid (for example, TIME_FIELD_DST_OFFSET, TIME_FIELD_ZONE_OFFSET). - * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n - * If the value of the time fields goes out of range, this exception is returned. + * @param[in] field The time field to roll + * @param[in] amount The amount to add to the time field + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified @c field is invalid (for example, @c TIME_FIELD_DST_OFFSET, @c TIME_FIELD_ZONE_OFFSET). + * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n + * If the value of the time fields goes out of range, this exception is returned. */ virtual result Roll(TimeField field, int amount); /** * @if OSPCOMPAT - * @page CompCalendarRollPage Compatibility for Roll() - * @section CompCalendarRollIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_INVALID_STATE if the time field is invalid. - * - * @section CompCalendarRollSolutionSection Resolutions - * This issue has been resolved in Tizen. + * @page CompCalendarRollPage Compatibility for Roll() + * @section CompCalendarRollIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_INVALID_STATE if the time field is invalid. + * + * @section CompCalendarRollSolutionSection Resolutions + * This issue has been resolved in Tizen. * * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the time field is invalid. + * -# The method returns @c E_INVALID_ARG if the time field is invalid. * @endif - */ + */ /** * Sets the specified time field with the specified @c value. @n @@ -347,13 +349,13 @@ public: * until GetTimeField(), GetTime(), or GetTimeInMillisec() is called. * Thus, even if you call this method several times, unnecessary multiple computations are not triggered. @n * - * As a result of changing a field using SetTimeField(), other fields may also change + * When a field is changed using SetTimeField(), other fields may also change * depending on the field, the field value, and the calendar system. @n * * For example, consider a GregorianCalendar set to Oct. 31, 2004. - * Calling SetTimeField(TIME_FIELD_MONTH, NOVEMBER) sets the calendar to Nov 31, 2004. @n + * Calling SetTimeField(@c TIME_FIELD_MONTH, NOVEMBER) sets the calendar to Nov 31, 2004. @n * But, if you call GetTime(), then Dec 1, 2004 is returned because Nov 31, 2004 does not exist. - * However, a call to SetTimeField(TIME_FIELD_MONTH, SEPTEMBER) before a call to GetTime() sets the calendar + * However, a call to SetTimeField(@c TIME_FIELD_MONTH, SEPTEMBER) before a call to GetTime() sets the calendar * to Sep 30, 2004, since no re-computation has occurred after the first call to SetTimeField(). * * The value of field is not affected by it being local time or UTC time. @@ -407,25 +409,25 @@ public: /** * Sets the value of year, month, day, hour, minute, and seconds. @n - * The date and time are local time. + * The date and time are the local date and time. * * @since 2.0 * * @return An error code - * @param[in] year The value to set for year - * @param[in] month The value to set for month @n + * @param[in] year The year to set + * @param[in] month The month to set @n * The indexing is 1-based. Therefore, 1 means January. - * @param[in] day The value to set for day - * @param[in] hour The value to set for hour - * @param[in] minute The value to set for minute - * @param[in] second The value to set for second + * @param[in] day The day to set + * @param[in] hour The hour to set + * @param[in] minute The minute to set + * @param[in] second The second to set * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE A time field or its value is out of range in lenient mode. + * @exception E_OUT_OF_RANGE A time field or its value is out of range in lenient mode. */ result SetTime(int year, int month, int day, int hour = 0, int minute = 0, int second = 0); /** - * Sets the calendar's current time with the specified Tizen::Base::DateTime. + * Sets the current time of this %Calendar instance with the specified Tizen::Base::DateTime. * * @since 2.0 * @@ -461,30 +463,29 @@ public: /** * Gets the actual maximum value that the specified field can have, given the current date. @n - * For example, if the current date is "Feb 10, 2004" and the time field specified is TIME_FIELD_DAY_OF_MONTH, then the actual - * maximum value for this time field is 29. + * For example, if the current date is "Feb 10, 2004" and the time field specified is @c TIME_FIELD_DAY_OF_MONTH, then the actual + * maximum value for this time field is @c 29. * * @since 2.0 * * @return An integer value indicating the actual maximum value - * @param[in] field The time field + * @param[in] field The time field * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c field is invalid. + * @exception E_INVALID_ARG The specified @c field is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual int GetActualMaxTimeField(TimeField field) const; /** * Gets the actual minimum value that the specified time field can have, given the current date. @n - * For the Gregorian calendar, this is the same as GetMinTimeField() and - * GetGreatestMinTimeField(). + * For the Gregorian calendar, this is the same as GetMinTimeField() and GetGreatestMinTimeField(). * * @since 2.0 * * @return An integer value indicating the actual minimum value - * @param[in] field The time field + * @param[in] field The time field * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c field is invalid. + * @exception E_INVALID_ARG The specified @c field is invalid. * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -492,12 +493,12 @@ public: /** * Gets the value of the first day of the week. @n - * For example, in USA, the first day of the week is SUNDAY. But, it is MONDAY in France. + * For example, in USA, the first day of the week is SUNDAY. But, in France, it is MONDAY. * - * @since 2.0 + * @since 2.0 * - * @return An integer value indicating the first day of the week, @n - * else @c -1 if the method fails + * @return An integer value indicating the first day of the week, @n + * else @c -1 if it fails */ int GetFirstDayOfWeek(void) const; @@ -507,9 +508,9 @@ public: * @since 2.0 * * @return An integer value indicating the greatest minimum value for the specified time field - * @param[in] field The time field + * @param[in] field The time field * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c field is invalid. + * @exception E_INVALID_ARG The specified @c field is invalid. * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -521,9 +522,9 @@ public: * @since 2.0 * * @return An integer value indicating the least maximum value for the specified time field - * @param[in] field The time field + * @param[in] field The time field * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c field is invalid. + * @exception E_INVALID_ARG The specified @c field is invalid. * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -535,9 +536,9 @@ public: * @since 2.0 * * @return An integer value indicating the maximum value for the specified time field - * @param[in] field The time field + * @param[in] field The time field * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c field is invalid. + * @exception E_INVALID_ARG The specified @c field is invalid. * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -549,9 +550,9 @@ public: * @since 2.0 * * @return An integer value indicating the minimum value for the specified time field - * @param[in] field The time field + * @param[in] field The time field * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c field is invalid. + * @exception E_INVALID_ARG The specified @c field is invalid. * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -574,7 +575,7 @@ public: * @since 2.0 * * @return An instance of Tizen::Base::DateTime with the current time in local time - * @remarks The time specified is local time. + * @remarks The time specified is the local time. */ Tizen::Base::DateTime GetTime(void) const; @@ -585,13 +586,14 @@ public: * * @return An integer value indicating the value of the specified time field * - * @param[in] field The given time field + * @param[in] field The given time field * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c field is invalid. + * @exception E_INVALID_ARG The specified @c field is invalid. * @exception E_SYSTEM A system error has occurred. - * @remarks This method is semantically const, but may alter the instance in memory. - * All fields are re-computed if any field is invalid. - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - This method is semantically const, but may alter the instance in memory. + * - All fields are re-computed if any field is invalid. + * - The specific error code can be accessed using the GetLastResult() method. */ int GetTimeField(TimeField field) const; @@ -601,11 +603,11 @@ public: * @since 2.0 * * @return An error code - * @param[out] millisec The current time in milliseconds from starting day (Jan 1, 1.) - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n - * If any time field value previously set is invalid, this exception is returned. - * @exception E_OUT_OF_RANGE The value of the argument is out of the valid range defined by the method. + * @param[out] millisec The current time in milliseconds from starting day (Jan 1, 1.) + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n + * If any time field value previously set is invalid, this exception is returned. + * @exception E_OUT_OF_RANGE The value of the argument is out of the valid range defined by the method. */ result GetTimeInMillisec(long long& millisec) const; @@ -615,7 +617,8 @@ public: * @since 2.0 * * @return The TimeZone instance associated with the current instance of %Calendar - * @remarks The returned reference is valid only until the SetTimeZone() method is called or this instance of %Calendar is destroyed. + * @remarks The returned reference is valid only until the SetTimeZone() method is called or + * this instance of %Calendar is destroyed. * @see SetTimeZone() */ TimeZone GetTimeZone(void) const; @@ -626,7 +629,7 @@ public: * @since 2.0 * * @return An instance of CalendarType representing the calendar type of the current instance of %Calendar @n - * For example, CALENDAR_GREGORIAN. + * For example, @c CALENDAR_GREGORIAN. */ virtual CalendarType GetType(void) const = 0; @@ -636,13 +639,14 @@ public: * @since 2.0 * * @return An error code - * @param[out] isInDst Set to @c true if the current date is in DST, @n - * else @c false - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n - * If any time field value previously set is invalid, this exception is returned. - * @exception E_OUT_OF_RANGE A time field or its value is out of range. @n - * In this method, the time fields of this instance are calculated. If the value of the time fields goes out of range, this exception is returned. + * @param[out] isInDst Set to @c true if the current date is in DST, @n + * else @c false + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n + * If any time field value previously set is invalid, this exception is returned. + * @exception E_OUT_OF_RANGE A time field or its value is out of range. @n + * In this method, the time fields of this instance are calculated. + * If the value of the time fields goes out of range, this exception is returned. */ virtual result IsInDst(bool& isInDst) const = 0; @@ -669,15 +673,15 @@ public: /** * Creates an instance of %Calendar of the specified type with the GMT time zone and the system locale. @n - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease. - * The weekdata are set as default values by the locale. + * The instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease. + * The weekdata is set to default values by the locale. * * @since 2.0 * * @return A pointer to the created %Calendar instance, @n - * else @c null if the method fails + * else @c null if it fails * @param[in] calendarType The type of calendar @n - * Default calendar is the Gregorian calendar (CALENDAR_GREGORIAN). + * The default calendar is the Gregorian calendar (@c CALENDAR_GREGORIAN). * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. @@ -688,16 +692,16 @@ public: /** * Creates an instance of %Calendar of the specified type with the specified time zone and the system locale. @n * The @c timeZone is used for the zone offset and the DST offset. - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease. - * The weekdata are set as default values by the locale. + * The instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease. + * The weekdata is set to default values by the locale. * * @since 2.0 * * @return A pointer to the created %Calendar instance, @n - * else @c null if the method fails + * else @c null if it fails * @param[in] timeZone An instance of TimeZone * @param[in] calendarType The type of calendar @n - * Default calendar is the Gregorian calendar (CALENDAR_GREGORIAN). + * The default calendar is the Gregorian calendar (@c CALENDAR_GREGORIAN). * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. @@ -707,27 +711,27 @@ public: /** * Creates an instance of %Calendar of the specified type with the specified @c locale and the GMT time zone. @n - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease. - * The weekdata are set as default values by the specified @c locale. + * The instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease. + * The weekdata is set to default values by the specified @c locale. * * @if OSPCOMPAT * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompCalendarCreateInstanceNPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompCalendarCreateInstanceNPage "here". * @endif * * @return A pointer to the created %Calendar instance, @n - * else @c null if the method fails + * else @c null if it fails * @param[in] locale The locale for whose country the %Calendar instance is needed * @param[in] calendarType The type of calendar @n - * Default calendar is the Gregorian calendar (CALENDAR_GREGORIAN). + * The default calendar is the Gregorian calendar (@c CALENDAR_GREGORIAN). * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c locale is invalid. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG The specified @c locale is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static Calendar* CreateInstanceN(const Locale& locale, CalendarType calendarType = CALENDAR_GREGORIAN); @@ -735,52 +739,52 @@ public: /** * Creates an instance of %Calendar of the specified type with the specified time zone and @c locale. @n * The @c timeZone is used for the zone offset and the DST offset. - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease. - * The weekdata are set as default values by the specified @c locale. + * The instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease. + * The weekdata is set to default values by the specified @c locale. * * @if OSPCOMPAT * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompCalendarCreateInstanceNPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompCalendarCreateInstanceNPage "here". * @endif * * @return A pointer to the created %Calendar instance, @n - * else @c null if the method fails + * else @c null if it fails * @param[in] timeZone An instance of TimeZone - * @param[in] locale The locale for whose country the %Calendar instance is needed - * @param[in] calendarType The type of calendar @n - * Default calendar is the Gregorian calendar (CALENDAR_GREGORIAN). + * @param[in] locale The locale for the country the %Calendar instance is created + * @param[in] calendarType The calendar type @n + * The default calendar is the Gregorian calendar (@c CALENDAR_GREGORIAN). * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c locale is invalid. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG The specified @c locale is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static Calendar* CreateInstanceN(const TimeZone& timeZone, const Locale& locale, CalendarType calendarType = CALENDAR_GREGORIAN); /** * @if OSPCOMPAT - * @page CompCalendarCreateInstanceNPage Compatibility for CreateInstanceN() - * @section CompCalendarCreateInstanceNIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the locale is invalid. - * - * @section CompCalendarCreateInstanceNSolutionSection Resolutions - * This issue has been resolved in Tizen. - * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the locale is invalid. + * @page CompCalendarCreateInstanceNPage Compatibility for CreateInstanceN() + * @section CompCalendarCreateInstanceNIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_UNSUPPORTED_OPERATION if the locale is invalid. + * + * @section CompCalendarCreateInstanceNSolutionSection Resolutions + * This issue has been resolved in Tizen. + * @par When working in Tizen: + * -# The method returns @c E_INVALID_ARG if the locale is invalid. * @endif - */ + */ protected: /** * @enum AmPm * * Defines the AM/PM mode. @n - * This is a.m./p.m. The indexing is 0-based. + * The indexing is 0-based. * * @since 2.0 */ @@ -793,7 +797,7 @@ protected: /** * @enum CalendarLimitType * - * Defines the calendar limitations. + * Defines the calendar limits. * * @since 2.0 */ @@ -815,99 +819,97 @@ protected: */ enum StampValue { - UNSET = 0, /**< Unset */ - COMPUTED, /**< Computed */ - MINIMUM_USER_STAMP /**< Minimum user stamp */ + UNSET = 0, /**< The stamp is unset */ + COMPUTED, /**< The stamp is computed */ + MINIMUM_USER_STAMP /**< The minimum user stamp */ }; /** - * This is the default constructor for this class. @n - * 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. - * - * @since 2.0 - * - * @see Construct() - */ + * This is the default constructor for this class. @n + * 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. + * + * @since 2.0 + */ Calendar(void); /** - * Initializes this instance of %Calendar. - * - * @since 2.0 - * - * @return An error code - * @exception E_SUCCESS The method is successful. - */ + * Initializes this instance of %Calendar. + * + * @since 2.0 + * + * @return An error code + * @exception E_SUCCESS The method is successful. + */ result Construct(void); /** - * Initializes this instance of %Calendar with the specified parameter. - * - * @since 2.0 - * - * @return An error code - * @param[in] calendar The %Calendar instance to copy - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. - * - */ + * Initializes this instance of %Calendar with the specified %Calendar instance. + * + * @since 2.0 + * + * @return An error code + * @param[in] calendar The %Calendar instance to copy + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM A system error has occurred. + * + */ result Construct(const Calendar& calendar); /** - * Initializes this instance of %Calendar with the specified time zone and @c locale. @n - * The @c timeZone is used for the zone offset and the DST offset. - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease. - * The weekdata are set as default values by the specified @c locale. - * - * @if OSPCOMPAT - * @brief [Compatibility] - * @endif - * @since 2.0 - * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompCalendarConstructPage "here". - * @endif - * - * @return An error code - * @param[in] timeZone An instance of TimeZone - * @param[in] locale An instance of Locale - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c locale is invalid. - */ + * Initializes this instance of %Calendar with the specified time zone and @c locale. @n + * The @c timeZone is used for the zone offset and the DST offset. + * The instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease. + * The weekdata is set to default values by the specified @c locale. + * + * @if OSPCOMPAT + * @brief [Compatibility] + * @endif + * @since 2.0 + * @if OSPCOMPAT + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompCalendarConstructPage "here". + * @endif + * + * @return An error code + * @param[in] timeZone An instance of TimeZone + * @param[in] locale An instance of Locale + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified @c locale is invalid. + */ result Construct(const Tizen::Locales::TimeZone& timeZone, const Locale& locale); /** - * @if OSPCOMPAT - * @page CompCalendarConstructPage Compatibility for Construct() - * @section CompCalendarConstructIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the locale is invalid. - * - * @section CompCalendarConstructSolutionSection Resolutions - * This issue has been resolved in Tizen. - * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the locale is invalid. - * @endif - */ + * @if OSPCOMPAT + * @page CompCalendarConstructPage Compatibility for Construct() + * @section CompCalendarConstructIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_UNSUPPORTED_OPERATION if the locale is invalid. + * + * @section CompCalendarConstructSolutionSection Resolutions + * This issue has been resolved in Tizen. + * @par When working in Tizen: + * -# The method returns @c E_INVALID_ARG if the locale is invalid. + * @endif + */ /** - * Rolls up or down with a single unit of time on a given time field without changing larger fields. @n - * When rolling on the MONTH field, other fields such as DATE field might conflict - * and needs to be changed. + * Rolls up or down with a single unit of time on the specified time field without changing the larger fields. @n + * When rolling on the MONTH field, other fields such as DATE field might conflict and need to be changed. * * @since 2.0 * * @return An error code - * @param[in] field The time field to change - * @param[in] up Set to @c true if the time field must be rolled upwards, @n - * else @c false - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n - * If any time field value previously set is invalid, this exception is returned. - * @exception E_INVALID_ARG The specified @c field is invalid (for example, TIME_FIELD_DST_OFFSET, TIME_FIELD_ZONE_OFFSET). - * @exception E_OUT_OF_RANGE A time field or its value is out of range. @n - * In this method, the time fields of this instance are calculated. - * If the value of the time fields goes out of range, this exception is returned. + * @param[in] field The time field to change + * @param[in] up Set to @c true if the time field must be rolled upwards, @n + * else @c false + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_STATE In this method, the time fields of this instance are calculated. @n + * If any time field value previously set is invalid, this exception is returned. + * @exception E_INVALID_ARG The specified @c field is invalid (for example, @c TIME_FIELD_DST_OFFSET, @c TIME_FIELD_ZONE_OFFSET). + * @exception E_OUT_OF_RANGE A time field or its value is out of range. @n + * In this method, the time fields of this instance are calculated. + * If the value of the time fields goes out of range, this exception is returned. */ virtual result RollWithSingleUnit(TimeField field, bool up) = 0; @@ -918,7 +920,7 @@ protected: * * @return @c true if the current instance of %Calendar is equivalent to the specified %Calendar instance, @n * else @c false - * @param[in] calendar The instance of %Calendar to compare with + * @param[in] calendar The instance of %Calendar to compare * @remarks If the specified %Calendar instance is equivalent to the current instance, the two instances behave * exactly the same, but they may be set to different times. */ @@ -927,14 +929,15 @@ protected: /** * Computes the time field value. @n * Converts the current millisecond time value to TimeField. @n - * This allows synching up the time field values with a new time that is set for the calendar. + * This allows syncing up the time field values with a new time that is set for the calendar. * * @since 2.0 * * @return An error code - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The time fields contain an invalid value. @n - * In this method, the time fields of this instance are calculated. If the value of the time fields goes out of range, this exception is returned. + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_RANGE The time fields contain an invalid value. @n + * In this method, the time fields of this instance are calculated. + * If the value of the time fields goes out of range, this exception is returned. */ virtual result ComputeTimeFields(void) = 0; @@ -962,11 +965,11 @@ protected: virtual int GetMonthLength(int extendedYear, int month) const = 0; /** - * Handles the limits of different types. @n + * Handle the limits of the specified time field that depend on the type of limit. @n * Derived classes must implement this method for the following fields: - * TIME_FIELD_ERA, TIME_FIELD_YEAR, TIME_FIELD_MONTH, TIME_FIELD_WEEK_OF_YEAR, TIME_FIELD_WEEK_OF_MONTH, - * TIME_FIELD_DAY_OF_MONTH, TIME_FIELD_DAY_OF_YEAR, TIME_FIELD_DAY_OF_WEEK_IN_MONTH, TIME_FIELD_YEAR_WOY, - * TIME_FIELD_EXTENDED_YEAR. + * @c TIME_FIELD_ERA, @c TIME_FIELD_YEAR, @c TIME_FIELD_MONTH, @c TIME_FIELD_WEEK_OF_YEAR, @c TIME_FIELD_WEEK_OF_MONTH, + * @c TIME_FIELD_DAY_OF_MONTH, @c TIME_FIELD_DAY_OF_YEAR, @c TIME_FIELD_DAY_OF_WEEK_IN_MONTH, @c TIME_FIELD_YEAR_WOY, + * @c TIME_FIELD_EXTENDED_YEAR. * * @since 2.0 * @@ -976,7 +979,7 @@ protected: */ virtual int HandleGetLimit(TimeField field, CalendarLimitType limitType) const = 0; - /* + /** * Creates and returns a polymorphic copy of this calendar. * * @since 2.0 @@ -1050,35 +1053,35 @@ private: public: /** - * Millisecond constants for one day. + * One day in milliseconds. * * @since 2.0 */ static const int ONE_DAY_IN_MILLISEC = 86400000; /** - * Millisecond constants for one hour. + * One hour in milliseconds. * * @since 2.0 */ static const int ONE_HOUR_IN_MILLISEC = 60 * 60 * 1000; /** - * Millisecond constants for one minute. + * One minute in milliseconds. * * @since 2.0 */ static const int ONE_MINUTE_IN_MILLISEC = 60000; /** - * Millisecond constants for one second. + * One second in milliseconds. * * @since 2.0 */ static const int ONE_SECOND_IN_MILLISEC = 1000; /** - * Millisecond constants for one week. + * One week in milliseconds. * * @since 2.0 */ diff --git a/inc/FLclCurrency.h b/inc/FLclCurrency.h index ecb1466..200fb40 100644 --- a/inc/FLclCurrency.h +++ b/inc/FLclCurrency.h @@ -35,7 +35,7 @@ class Locale; /** * @class Currency - * @brief This class represents currencies. + * @brief This class provides methods for currencies. * * @since 2.0 * @@ -54,11 +54,10 @@ public: /** * This is the default constructor for this class. @n - * 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. + * 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. * * @since 2.0 - * - * @see Construct() */ Currency(void); @@ -80,13 +79,13 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompCurrencyConstructPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompCurrencyConstructPage "here". * @endif * * @return An error code - * @param[in] locale The specified @c locale to get the currency symbol - * @exception E_SUCCESS The method is successful. + * @param[in] locale The specified @c locale to get the currency symbol + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c locale is not supported. */ result Construct(const Locale& locale); @@ -94,37 +93,38 @@ public: /** * Initializes this instance of %Currency with the specified currency code. @n - * Currencies are enumerated as defined by ISO 4217. For example, if the locale is Korean (language) and Korea (country), the currency code is "KRW". + * The currencies are enumerated as defined by ISO 4217. For example, if the locale is Korean (language) and Korea (country), + * the currency code is "KRW". * * @if OSPCOMPAT * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompCurrencyConstructPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompCurrencyConstructPage "here". * @endif * * @return An error code - * @param[in] currencyCode The specified currency code to get the currency symbol - * @exception E_SUCCESS The method is successful. + * @param[in] currencyCode The specified currency code to get the currency symbol + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c currencyCode is not supported. - * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_OUT_OF_MEMORY The memory is insufficient. */ result Construct(const Tizen::Base::String& currencyCode); /** * @if OSPCOMPAT - * @page CompCurrencyConstructPage Compatibility for Construct() - * @section CompCurrencyConstructIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the argument is invalid. - * - * @section CompCurrencyConstructSolutionSection Resolutions - * This issue has been resolved in Tizen. + * @page CompCurrencyConstructPage Compatibility for Construct() + * @section CompCurrencyConstructIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns E_UNSUPPORTED_OPERATION if the argument is invalid. + * + * @section CompCurrencyConstructSolutionSection Resolutions + * This issue has been resolved in Tizen. * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the argument is invalid. + * -# The method returns E_INVALID_ARG if the argument is invalid. * @endif - */ + */ /** @@ -158,7 +158,7 @@ public: * * @return @c true if the value of the specified instance is equal to that of the current instance, @n * else @c false - * @param[in] obj The object to compare with the current instance + * @param[in] obj The object to compare with the current instance */ virtual bool Equals(const Tizen::Base::Object& obj) const; @@ -180,7 +180,7 @@ public: * else a @c null pointer is returned if there is no currency available or there is some failure @n * The array is a list of all the available currencies. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Base::Collection::IList* GetAvailableCurrenciesN(void); diff --git a/inc/FLclDateTimeFormatter.h b/inc/FLclDateTimeFormatter.h index e965050..101e77b 100644 --- a/inc/FLclDateTimeFormatter.h +++ b/inc/FLclDateTimeFormatter.h @@ -48,12 +48,12 @@ class _DateTimeFormatterImpl; */ enum DateTimeStyle { - DATE_TIME_STYLE_NONE = -1, /**< The date time style: None */ - DATE_TIME_STYLE_FULL = 0, /**< The date time style: FULL is pretty completely specified, such as Tuesday, April 12, 1952 AD or 3:30:42PM PST */ - DATE_TIME_STYLE_LONG = 1, /**< The date time style: LONG is longer, such as July 18, 2012 or 3:30:32PM */ - DATE_TIME_STYLE_MEDIUM = 2, /**< The date time style: MEDIUM is a little longer, such as Jan 12, 1952 */ - DATE_TIME_STYLE_SHORT = 3, /**< The date time style: SHORT is completely numeric, such as 12/13/52 or 3:30PM */ - DATE_TIME_STYLE_DEFAULT = DATE_TIME_STYLE_MEDIUM /**< The default date time style: Medium */ + DATE_TIME_STYLE_NONE = -1, /**< No date time style */ + DATE_TIME_STYLE_FULL = 0, /**< The full date time style @n For example, Tuesday, April 12, 1952 AD or 3:30:42PM PST */ + DATE_TIME_STYLE_LONG = 1, /**< The long date time style @n For example, July 18, 2012 or 3:30:32PM */ + DATE_TIME_STYLE_MEDIUM = 2, /**< The medium date time style @n For example, Jan 12, 1952 */ + DATE_TIME_STYLE_SHORT = 3, /**< The short date time style @n This style is completely numeric. For example, 12/13/52 or 3:30PM */ + DATE_TIME_STYLE_DEFAULT = DATE_TIME_STYLE_MEDIUM /**< The default date time style @n This is set to Medium */ }; /** @@ -138,11 +138,11 @@ public: * @return A pointer to the system locale date formatter, @n * else @c null if an error occurs * @param[in] style The formatting style @n - * For example, "M/d/yy" is the short form for displaying only date in the US locale. + * For example, "M/d/yy" is the short form for displaying only the date in the US locale. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_UNSUPPORTED_OPERATION The current locale is not supported. - * @exception E_INVALID_ARG The specified @c style is an invalid value. + * @exception E_INVALID_ARG The specified @c style is an invalid value. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static DateTimeFormatter* CreateDateFormatterN(DateTimeStyle style = DATE_TIME_STYLE_DEFAULT); @@ -152,39 +152,39 @@ public: * Creates the date formatter with the specified formatting style for the specified locale. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompDateTimeFormatterCreateDateFormatterNPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompDateTimeFormatterCreateDateFormatterNPage "here". * @endif * * @return A pointer to the specified locale date formatter, @n * else @c null if an error occurs * @param[in] locale The locale * @param[in] style The formatting style @n - * For example, "M/d/yy" is the short form for displaying only date in the US locale. + * For example, "M/d/yy" is the short form for displaying only the date in the US locale. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c locale or @c style is invalid. + * @exception E_INVALID_ARG The specified @c locale or @c style is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static DateTimeFormatter* CreateDateFormatterN(const Locale& locale, DateTimeStyle style = DATE_TIME_STYLE_DEFAULT); /** * @if OSPCOMPAT - * @page CompDateTimeFormatterCreateDateFormatterNPage Compatibility for CreateDateFormatterN() - * @section CompDateTimeFormatterCreateDateFormatterNIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid. - * - * @section CompDateTimeFormatterCreateDateFormatterNtSolutionSection Resolutions - * This issue has been resolved in Tizen. + * @page CompDateTimeFormatterCreateDateFormatterNPage Compatibility for CreateDateFormatterN() + * @section CompDateTimeFormatterCreateDateFormatterNIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid. + * + * @section CompDateTimeFormatterCreateDateFormatterNtSolutionSection Resolutions + * This issue has been resolved in Tizen. * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the @c locale or @c style is invalid. + * -# The method returns E_INVALID_ARG if the @c locale or @c style is invalid. * @endif - */ + */ /** @@ -199,7 +199,7 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_UNSUPPORTED_OPERATION The current locale is not supported. - * @exception E_INVALID_ARG The specified @c style is invalid. + * @exception E_INVALID_ARG The specified @c style is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static DateTimeFormatter* CreateTimeFormatterN(DateTimeStyle style = DATE_TIME_STYLE_DEFAULT); @@ -209,12 +209,12 @@ public: * Creates the time formatter with the specified formatting style for the specified @c locale. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompDateTimeFormatterCreateTimeFormatterNPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompDateTimeFormatterCreateTimeFormatterNPage "here". * @endif * * @return A pointer to the specified locale time formatter, @n @@ -224,24 +224,24 @@ public: * For example, "h:mm a" is the short form for displaying the 12-hour time format in the US locale. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c locale or @c style is invalid. + * @exception E_INVALID_ARG The specified @c locale or @c style is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static DateTimeFormatter* CreateTimeFormatterN(const Locale& locale, DateTimeStyle style = DATE_TIME_STYLE_DEFAULT); /** * @if OSPCOMPAT - * @page CompDateTimeFormatterCreateTimeFormatterNPage Compatibility for CreateTimeFormatterN() - * @section CompDateTimeFormatterCreateTimeFormatterNIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid. - * - * @section CompGrDateTimeFormatterCreateTimeFormatterNSolutionSection Resolutions - * This issue has been resolved in Tizen. - * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the @c locale or @c style is invalid. + * @page CompDateTimeFormatterCreateTimeFormatterNPage Compatibility for CreateTimeFormatterN() + * @section CompDateTimeFormatterCreateTimeFormatterNIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid. + * + * @section CompGrDateTimeFormatterCreateTimeFormatterNSolutionSection Resolutions + * This issue has been resolved in Tizen. + * @par When working in Tizen: + * -# The method returns E_INVALID_ARG if the @c locale or @c style is invalid. * @endif - */ + */ /** * Creates the date/time formatter with the specified formatting style for the system locale. @@ -251,13 +251,13 @@ public: * @return A pointer to the system locale date/time formatter, @n * else @c null if an error occurs * @param[in] dateStyle The date formatting style @n - * For example, "M/d/yy" is the short form for displaying only date in the US locale. + * For example, "M/d/yy" is the short form for displaying only the date in the US locale. * @param[in] timeStyle The time formatting style @n * For example, "h:mm a" is the short form for displaying the 12-hour time format in the US locale. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_UNSUPPORTED_OPERATION The current locale is not supported. - * @exception E_INVALID_ARG The specified @c dateStyle or @c timeStyle is invalid. + * @exception E_INVALID_ARG The specified @c dateStyle or @c timeStyle is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static DateTimeFormatter* CreateDateTimeFormatterN(DateTimeStyle dateStyle = DATE_TIME_STYLE_DEFAULT, DateTimeStyle timeStyle = DATE_TIME_STYLE_DEFAULT); @@ -277,22 +277,21 @@ public: * For example, "h:mm a" is the short form for displaying the 12-hour time format in the US locale. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c locale is not supported, or the @c dateStyle or the @c timeStyle is invalid. + * @exception E_INVALID_ARG The specified @c locale is not supported, or the @c dateStyle or the @c timeStyle is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static DateTimeFormatter* CreateDateTimeFormatterN(const Locale& locale, DateTimeStyle dateStyle = DATE_TIME_STYLE_DEFAULT, DateTimeStyle timeStyle = DATE_TIME_STYLE_DEFAULT); /** - * Formats a Tizen::Base::DateTime object into a date/time string and appends the resulting string to the specified string buffer. + * Formats a Tizen::Base::DateTime object into a date/time string and appends the resulting string to the specified string. * * @since 2.0 * * @return An error code * @param[in] date The Tizen::Base::DateTime object to format - * @param[out] str The string to append to the resultant string + * @param[out] str The string to which formatted string is appended * @exception E_SUCCESS The method is successful. * @remarks This method does not handle the time zone information, so "z" pattern always returns "GMT+00:00". - * @see Tizen::Base::DateTime */ virtual result Format(const Tizen::Base::DateTime& date, Tizen::Base::String& str) const; @@ -304,9 +303,9 @@ public: * * @return An error code * @param[in] calendar The Calendar object to format - * @param[out] str The string to append to the resultant string + * @param[out] str The string to which formatted string is appended * @exception E_SUCCESS The method is successful. - * @see Tizen::Base::DateTime + * @see Tizen::Base::DateTime */ virtual result Format(const Calendar& calendar, Tizen::Base::String& str) const; @@ -316,7 +315,7 @@ public: * * @since 2.0 * - * @param[in] pattern The new date and time pattern for the date format + * @param[in] pattern The date and time pattern for the date format * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The length of the specified @c pattern is @c 0. */ @@ -324,11 +323,11 @@ public: /** - * Gets a pattern string describing the date format. + * Gets the pattern string describing the date format. * * @since 2.0 * - * @return A string describing the date format + * @return The date format pattern string */ Tizen::Base::String GetPattern(void) const; @@ -338,18 +337,18 @@ public: * * @since 2.0 * - * @return A pointer to DateTimeSymbols for the formatter instance + * @return A pointer to DateTimeSymbols of the formatter * @see SetDateTimeSymbols() */ const DateTimeSymbols* GetDateTimeSymbols(void) const; /** - * Sets the date and time format symbols of the date format. + * Sets the date and time format symbols of the formatter. * * @since 2.0 * - * @param[in] newSymbols The new date and time format symbols + * @param[in] newSymbols The date and time format symbols * @see GetDateTimeSymbols() */ void SetDateTimeSymbols(const DateTimeSymbols& newSymbols); diff --git a/inc/FLclDateTimeSymbols.h b/inc/FLclDateTimeSymbols.h index e89cd81..f3f1abb 100644 --- a/inc/FLclDateTimeSymbols.h +++ b/inc/FLclDateTimeSymbols.h @@ -33,13 +33,14 @@ namespace Tizen { namespace Locales /** * @class DateTimeSymbols - * @brief This class provides methods that help in providing date and time symbols. + * @brief This class provides methods for date and time symbols. * * @since 2.0 * - * The %DateTimeSymbols class is used for encapsulating localizable date-time formatting data, such as the names of the months, the days of the week, and the time zone data. - * It is also used by DateTimeFormatter. - * %DateTimeSymbols specifies the exact character strings to use for various parts of a date or time. For example, the names of the months and days of the week, the strings for AM and PM, and the day of the week considered to be the first day of the week. + * The %DateTimeSymbols class is used for encapsulating localizable date-time formatting data, such as the names of the months, + * the days of the week, and the time zone data. It is also used by DateTimeFormatter. + * %DateTimeSymbols specifies the exact character strings to use for various parts of a date or time. For example, the names of + * the months and days of the week, the strings for AM and PM, and the day of the week considered to be the first day of the week. * * For more information on the class features, see Date and Time Formatter. * @@ -53,11 +54,10 @@ class _OSP_EXPORT_ DateTimeSymbols public: /** * This is the default constructor for this class. @n - * 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. + * 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. * * @since 2.0 - * - * @see Construct() */ DateTimeSymbols(void); @@ -74,12 +74,12 @@ public: * Initializes this instance of %DateTimeSymbols with the specified @c locale and @c calendarType. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompDateTimeSymbolsConstructPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompDateTimeSymbolsConstructPage "here". * @endif * * @return An error code @@ -87,7 +87,7 @@ public: * @param[in] calendarType The calendar type * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c locale or @c calendarType is invalid. + * @exception E_INVALID_ARG The specified @c locale or @c calendarType is invalid. */ result Construct(const Locale& locale, CalendarType calendarType = CALENDAR_GREGORIAN); @@ -101,31 +101,31 @@ public: * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompDateTimeSymbolsConstructPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompDateTimeSymbolsConstructPage "here". * @endif * * @return An error code * @param[in] calendarType The calendar type * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c calendarType is invalid. + * @exception E_INVALID_ARG The specified @c calendarType is invalid. */ result Construct(CalendarType calendarType); /** * @if OSPCOMPAT - * @page CompDateTimeSymbolsConstructPage Compatibility for Construct() - * @section CompDateTimeSymbolsConstructIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the @c calendarType is invalid. - * - * @section CompDateTimeSymbolsConstructSolutionSection Resolutions - * This issue has been resolved in Tizen. - * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the @c calendarType is invalid. + * @page CompDateTimeSymbolsConstructPage Compatibility for Construct() + * @section CompDateTimeSymbolsConstructIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns E_UNSUPPORTED_OPERATION if the @c calendarType is invalid. + * + * @section CompDateTimeSymbolsConstructSolutionSection Resolutions + * This issue has been resolved in Tizen. + * @par When working in Tizen: + * -# The method returns E_INVALID_ARG if the @c calendarType is invalid. * @endif - */ + */ /** @@ -156,12 +156,12 @@ public: /** * Sets the era strings. @n - * Multiple strings can be concatenated by '|'. For example: "AD|BC". + * Multiple strings can be concatenated using '|'. For example: "AD|BC". * * @since 2.0 * * @return An error code - * @param[in] eras The era strings concatenated by '|' + * @param[in] eras The era strings concatenated using '|' * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c eras contains an invalid value. * @see GetEras() @@ -171,7 +171,7 @@ public: /** * Gets the list of the month name strings. @n - * For example: "January", "February", etc. + * For example: "January", "February". * * @since 2.0 * @@ -183,13 +183,13 @@ public: /** - * Sets the month name strings concatenated by '|'. @n + * Sets the month name strings concatenated using '|'. @n * For example: "January|February|March|April|May|June|July|August|September|October|November|December". * * @since 2.0 * * @return An error code - * @param[in] months The new month strings concatenated by '|' + * @param[in] months The month strings concatenated using '|' * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c months contains an invalid value. * @see GetMonths() @@ -199,7 +199,7 @@ public: /** * Gets the list of the short month name strings. @n - * For example: "Jan", "Feb", etc. + * For example: "Jan", "Feb". * * @since 2.0 * @@ -211,22 +211,23 @@ public: /** - * Sets the short month name strings concatenated by '|'. @n + * Sets the short month name strings concatenated using '|'. @n * For example: "Jan|Feb|Mar|Apr|May|Jun|Jul|Aug|Sep|Oct|Nov|Dec". * - * @since 2.0 + * @since 2.0 * @return An error code - * @param[in] shortMonths The new short month name strings concatenated by '|' + * @param[in] shortMonths The short month name strings concatenated using '|' * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c shortMonths contains an invalid value. @n See the valid string in the description of the method. - * @see GetShortMonths() + * @exception E_INVALID_ARG The specified @c shortMonths contains an invalid value. @n + * See the valid string in the description of the method. + * @see GetShortMonths() */ result SetShortMonths(const Tizen::Base::String& shortMonths); /** * Gets the list of the weekday name strings. @n - * For example: "Sunday", "Monday", etc. + * For example: "Sunday", "Monday". * * @since 2.0 * @@ -244,7 +245,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] weekdays The new weekday name strings concatenated by '|' + * @param[in] weekdays The weekday name strings concatenated using '|' * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c weekdays contains an invalid value. * @see GetWeekdays() @@ -254,7 +255,7 @@ public: /** * Gets the list of the short weekday name strings. @n - * For example: "Sun", "Mon", etc. + * For example: "Sun", "Mon". * * @since 2.0 * @@ -266,13 +267,13 @@ public: /** - * Sets the weekday name strings concatenated by '|'. @n + * Sets the weekday name strings concatenated using '|'. @n * For example: "Sun|Mon|Tue|Wed|Thu|Fri|Sat". * * @since 2.0 * * @return An error code - * @param[in] shortWeekdays The new short weekday strings concatenated by '|' + * @param[in] shortWeekdays The short weekday strings concatenated using '|' * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c shortWeekdays contains an invalid value. * @see GetShortWeekdays() @@ -294,13 +295,13 @@ public: /** - * Sets the AM/PM strings concatenated by '|'. @n + * Sets the AM/PM strings concatenated using '|'. @n * For example: "AM|PM". * * @since 2.0 * * @return An error code - * @param[in] amPm The new AM/PM strings concatenated by '|' + * @param[in] amPm The AM/PM strings concatenated using '|' * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c amPm contains an invalid value. * @see GetAmPm() @@ -312,11 +313,11 @@ public: * Gets the name of the time zone. @n * For example: "Eastern European Time (EET)", "Eastern European Summer Time (EEST)". * - * @since 2.0 + * @since 2.0 * - * @return The time zone name, @n - * else an empty string if @c timeZoneId is not found @n - * or the time zone name of @c timeZoneStyle is not found. + * @return The time zone name, @n + * else an empty string if @c timeZoneId is not found @n + * or the time zone name of @c timeZoneStyle is not found. * @param[in] timeZoneId The time zone ID * @param[in] timeZoneStyle The parameter may contain one of the following time zone styles: * @li The normal time zone (0) @@ -337,19 +338,19 @@ public: * @return An error code * @param[in] timeZoneId The time zone ID @n * For example: "Europe/Helsinki". - * @param[in] concatenatedTimeZoneName The new concatenated time zone name @n + * @param[in] concatenatedTimeZoneName The concatenated time zone name @n * For example, "Eastern European Time|EET|Eastern European Summer Time|EEST". * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c timeZoneId or @c concatenatedTimeZoneName contains an invalid value. * @exception E_OBJ_NOT_FOUND The specified @c timeZoneId is not found. - * @see GetTimeZoneName() - * @see AddTimeZoneName() + * @see GetTimeZoneName() + * @see AddTimeZoneName() */ result SetTimeZoneName(const Tizen::Base::String& timeZoneId, const Tizen::Base::String& concatenatedTimeZoneName); /** - * Adds a new time zone name string that is related to time zone ID. + * Adds the time zone name that is related to time zone ID. * * @since 2.0 * diff --git a/inc/FLclGregorianCalendar.h b/inc/FLclGregorianCalendar.h index eabbaa9..a249a4d 100644 --- a/inc/FLclGregorianCalendar.h +++ b/inc/FLclGregorianCalendar.h @@ -34,11 +34,12 @@ namespace Tizen { namespace Locales /** * @class GregorianCalendar - * @brief This class is a concrete subclass of calendar and provides the Gregorian calendar that is the most commonly used standard calendar. + * @brief This class is a concrete subclass of calendar and provides the Gregorian calendar that is the most commonly used + * standard calendar. * * @since 2.0 * - * @final This class is not intended for extension. + * @final This class is not intended for extension. * * The %GregorianCalendar class is a concrete subclass of calendar and provides the Gregorian calendar that is the most commonly used standard calendar. * @@ -84,11 +85,10 @@ class _OSP_EXPORT_ GregorianCalendar public: /** * This is the default constructor for this class. @n - * 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. + * 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. * * @since 2.0 - * - * @see Construct() */ GregorianCalendar(void); @@ -103,17 +103,17 @@ public: /** - * Initializes this instance of %GregorianCalendar with the current GMT time zone and the system locale. - * The time zone is used for the zone offset and the DST offset. - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set and weekend cease. - * The weekdata are set as default values by the locale. - * - * @since 2.0 - * - * @return An error code - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - */ + * Initializes this instance of %GregorianCalendar with the current GMT time zone and the system locale. @n + * The time zone is used for the zone offset and the DST offset. + * An instance has weekdata which is the first of week, minimal days in the first week, weekend on set and weekend cease. + * The weekdata is set to default values by the locale. + * + * @since 2.0 + * + * @return An error code + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + */ result Construct(void); @@ -133,8 +133,8 @@ public: /** * Initializes this instance of %GregorianCalendar based on the current time in the specified time zone with the system locale. @n * The @c timeZone is used for the zone offset and the DST offset. - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease. - * The weekdata are set as default values by the locale. + * An instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease. + * The weekdata is set to default values by the locale. * * @since 2.0 * @@ -149,23 +149,23 @@ public: /** * Initializes this instance of %GregorianCalendar based on the current time in the GMT time zone with the specified @c locale. * The time zone is used for the zone offset and the DST offset. - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease. - * The weekdata are set as default values by the specified @c locale. + * An instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease. + * The weekdata is set to default values by the specified @c locale. * * @if OSPCOMPAT * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompGregorianCalendarConstructPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompGregorianCalendarConstructPage "here". * @endif * * @return An error code - * @param[in] locale An instance of Locale - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c locale is invalid. + * @param[in] locale An instance of Locale + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG The specified @c locale is invalid. */ result Construct(const Locale& locale); @@ -173,16 +173,16 @@ public: /** * Initializes this instance of %GregorianCalendar based on the current time in the specified time zone with the specified system locale. @n * The @c timeZone is used for the zone offset and the DST offset. - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease. - * The weekdata are set as default values by the specified @c locale. + * An instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease. + * The weekdata is set to default values by the specified @c locale. * * @if OSPCOMPAT * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompGregorianCalendarConstructPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompGregorianCalendarConstructPage "here". * @endif * * @return An error code @@ -190,21 +190,21 @@ public: * @param[in] locale An instance of Locale * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c locale is invalid. + * @exception E_INVALID_ARG The specified @c locale is invalid. */ result Construct(const TimeZone& timeZone, const Locale& locale); /** * @if OSPCOMPAT - * @page CompGregorianCalendarConstructPage Compatibility for Construct() - * @section CompGregorianCalendarConstructIssueSection Issues + * @page CompGregorianCalendarConstructPage Compatibility for Construct() + * @section CompGregorianCalendarConstructIssueSection Issues * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid. + * -# The method returns @c E_UNSUPPORTED_OPERATION if the @c locale is invalid. * - * @section CompGregorianCalendarConstructSolutionSection Resolutions + * @section CompGregorianCalendarConstructSolutionSection Resolutions * This issue has been resolved in Tizen. * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the @c locale is invalid. + * -# The method returns @c E_INVALID_ARG if the @c locale is invalid. * @endif */ @@ -212,25 +212,25 @@ public: * Initializes this instance of %GregorianCalendar based on the specified @c year, @c month, @c day, @c hour, @c minute, and @c second * in the GMT time zone with the system locale. @n * The time zone is used for the zone offset and the DST offset. - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease. - * The weekdata are set as default values by the locale. - * The Gregorian calendar is lenient: time fields are normalized when the user calls the Calendar::GetTimeField() method. + * An instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease. + * The weekdata is set to default values by the locale. + * The Gregorian calendar is lenient; time fields are normalized when the user calls the Calendar::GetTimeField() method. * * @since 2.0 * * @return An error code - * @param[in] year An integer value used to set the year time field - * @param[in] month An integer value used to set the month time field @n + * @param[in] year The year value + * @param[in] month The month value @n * The indexing is 1-based. Therefore, 1 means January. - * @param[in] day An integer value used to set the date time field - * @param[in] hour An integer value used to set the hour time field - * @param[in] minute An integer value used to set the minute time field - * @param[in] second An integer value used to set the second time field + * @param[in] day The date value + * @param[in] hour The hour value + * @param[in] minute The minute value + * @param[in] second The second value * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG An argument is invalid. + * @exception E_INVALID_ARG A specified argument is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n - * If the value of the time fields goes out of range, this exception is returned. + * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n + * If the value of the time fields go out of range, this exception is returned. */ result Construct(int year, int month, int day, int hour = 0, int minute = 0, int second = 0); @@ -238,8 +238,8 @@ public: /** * Initializes this instance of %GregorianCalendar based on the specified date and time in the GMT time zone with the system locale. @n * The time zone is used for the zone offset and the DST offset. - * An instance has weekdata which are the first of week, minimal days in the first week, weekend on set, and weekend cease. - * The weekdata are set as default values by the locale. + * An instance has weekdata which is the first of week, minimal days in the first week, weekend on set, and weekend cease. + * The weekdata is set to default values by the locale. * * @since 2.0 * @@ -247,43 +247,46 @@ public: * @param[in] dateTime An instance of Tizen::Base::DateTime * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c dateTime is invalid. - * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n - * If the value of the time fields goes out of range, this exception is returned. + * @exception E_INVALID_ARG The specified @c dateTime is invalid. + * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n + * If the value of the time fields go out of range, this exception is returned. */ result Construct(const Tizen::Base::DateTime& dateTime); /** * Adds the specified amount to the specified time field, based on the calendar rules. @n - * It is equivalent to calling Set(field, GetTimeField(field)+amount) with two adjustments. @n + * It is equivalent to calling Set(field, GetTimeField(field)+amount) with the following two adjustments: @n * - * @b Add @b Rule1: The value of @c field after the call minus the value of @c field before the call is delta, modulo any overflow that has occurred in @c field. - * Overflow occurs when the @c field value exceeds its range and, as a result, the next larger field is incremented or decremented and the @c field value is adjusted back into its range. @n + * @b Add @b Rule1: The value of @c field after the call minus the value of @c field before the call is delta, modulo any + * overflow that has occurred in @c field. Overflow occurs when the @c field value exceeds its range and, as a result, + * the next larger field is incremented or decremented and the @c field value is adjusted back into its range. @n * - * @b Add @b Rule2: If a smaller field is expected to be invariant, but it is impossible for it to be equal to its prior value because of - * changes in its minimum or maximum value after the @c field value is changed, then its value is adjusted to the closest possible value. @n + * @b Add @b Rule2: If a smaller field is expected to be invariant, but it is impossible for it to be equal to its prior + * value because of changes in its minimum or maximum value after the @c field value is changed, then its value is adjusted + * to the closest possible value. @n * - * A smaller field represents a smaller unit of time. The TIME_FIELD_HOUR field is smaller than the TIME_FIELD_DAY_OF_MONTH field. + * A smaller field represents a smaller unit of time. The @c TIME_FIELD_HOUR field is smaller than the @c TIME_FIELD_DAY_OF_MONTH field. * No adjustment is made to smaller fields that are not expected to be invariant. * The calendar system determines what fields are expected to be invariant. @n * - * In addition, this method forces re-computation of the calendar's milliseconds and all time fields immediately. + * In addition, this method forces re-computation of the calendar's milliseconds and all the time fields immediately. * @n - * For example, consider a %GregorianCalendar set to Oct. 31. 2004. Calling AddTimeField(TIME_FIELD_MONTH, 13) sets the calendar to Nov. 30. 2005. - * The TIME_FIELD_MONTH field is set to TIME_FIELD_NOVEMBER by @b Rule1, since adding 13 months to October gives November of the next year. Since - * the TIME_FIELD_DAY_OF_MONTH cannot be 31 in November in a %GregorianCalendar, TIME_FIELD_DAY_OF_MONTH is set to 30 by @b Rule2. + * For example, consider a %GregorianCalendar set to Oct. 31. 2004. Calling AddTimeField(@c TIME_FIELD_MONTH, 13) sets the calendar to Nov. 30. 2005. + * The @c TIME_FIELD_MONTH field is set to @c TIME_FIELD_NOVEMBER by @b Rule1, since adding 13 months to October gives the month + * value as November of the next year. Since the @c TIME_FIELD_DAY_OF_MONTH cannot be 31 in November in a %GregorianCalendar, + * @c TIME_FIELD_DAY_OF_MONTH is set to 30 by @b Rule2. * * @since 2.0 * * @return An error code - * @param[in] field The time field - * @param[in] amount The amount to add - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c field is invalid. - * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n - * If the value of the time fields goes out of range, this exception is returned. - * @remarks The TIME_FIELD_EXTENDED_YEAR and TIME_FIELD_YEAR_WOY fields cannot be added. + * @param[in] field The time field + * @param[in] amount The amount to add + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified @c field is invalid. + * @exception E_OUT_OF_RANGE In this method, the time fields of this instance are calculated. @n + * If the value of the time fields go out of range, this exception is returned. + * @remarks The @c TIME_FIELD_EXTENDED_YEAR and @c TIME_FIELD_YEAR_WOY fields cannot be added. */ virtual result AddTimeField(TimeField field, int amount); @@ -295,10 +298,10 @@ public: * @since 2.0 * * @return An integer value indicating the actual minimum value - * @param[in] field The time field - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified time field is invalid. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @param[in] field The time field + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified time field is invalid. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual int GetActualMinTimeField(TimeField field) const; @@ -310,23 +313,22 @@ public: * @since 2.0 * * @return An integer value indicating the actual maximum value - * @param[in] field The time field - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified time field is invalid. - - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @param[in] field The time field + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified time field is invalid. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual int GetActualMaxTimeField(TimeField field) const; - /* + /** * Gets the Gregorian Calendar change date. @n * This is the point when the switch from Julian dates to Gregorian dates occurred. - * Default is 00:00:00 local time, October 15, 1582. Previous to this the time and date are Julian dates. + * Default is 00:00:00 local time, October 15, 1582. Previous to this, the time and date are Julian dates. * * @since 2.0 * - * @return The milliseconds which is the Gregorian cutover time for this calendar + * @return The Gregorian cutover time for this calendar in milliseconds */ long long GetGregorianChange(void) const; @@ -337,7 +339,7 @@ public: * @since 2.0 * * @return An instance of CalendarType representing the calendar type of the current instance of Calendar @n - * In this case, CALENDAR_GREGORIAN. + * In this case, @c CALENDAR_GREGORIAN. */ virtual CalendarType GetType(void) const; @@ -350,10 +352,10 @@ public: * @param[out] isInDst Set to @c true if the current date is in DST, @n * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n - * If the value of the time fields goes out of range, this exception is returned. - * @exception E_INVALID_STATE In this method, time fields of this instance are calculated. @n - * If any time field value previously set is invalid, this exception is returned. + * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n + * If the value of the time fields go out of range, this exception is returned. + * @exception E_INVALID_STATE In this method, time fields of this instance are calculated. @n + * If any time field value previously set is invalid, this exception is returned. */ virtual result IsInDst(bool& isInDst) const; @@ -370,18 +372,18 @@ public: bool IsLeapYear(int year) const; - /* + /** * Sets the Gregorian Calendar change date. @n * This is the point when the switch from Julian dates to Gregorian dates occurred. * Default is 00:00:00 local time, Oct 15, 1582. Previous to this, dates are in the Julian calendar. * - * To obtain a pure Julian calendar, set the change @c change to MAX_MILLISECOND. - * To obtain a pure Gregorian calendar, set the change @c change to MIN_MILLISECOND. + * To obtain a pure Julian calendar, set @c change to @c MAX_MILLISECOND. + * To obtain a pure Gregorian calendar, set @c change to @c MIN_MILLISECOND. * * @since 2.0 * * @return An error code - * @param[in] change The given Gregorian cutover date + * @param[in] change The Gregorian cutover date * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. */ @@ -389,7 +391,7 @@ public: /** * Rolls up or down as per the specified amount in the specified field. @n - * This method overrides Calendar(). @n + * This method overrides Calendar().Roll(TimeField, int). @n * For more details, refer to Tizen::Locales::Calendar::Roll(TimeField, int). * * @since 2.0 @@ -399,37 +401,37 @@ public: * @param[in] amount The amount to roll up/down * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE In this method, time fields of this instance are calculated. @n - * If any time field value previously set is invalid, this exception is returned. - * @exception E_INVALID_ARG The specified @c field is invalid (for example, TIME_FIELD_DST_OFFSET, TIME_FIELD_ZONE_OFFSET). - * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n - * If the value of the time fields goes out of range, this exception is returned. + * If any time field value previously set is invalid, this exception is returned. + * @exception E_INVALID_ARG The specified @c field is invalid (for example, @c TIME_FIELD_DST_OFFSET, @c TIME_FIELD_ZONE_OFFSET). + * @exception E_OUT_OF_RANGE In this method, time fields of this instance are calculated. @n + * If the value of the time fields go out of range, this exception is returned. */ virtual result Roll(TimeField field, int amount); - /* - * Gets the millisecond which is midnight, local time at or before the Gregorian cutover. + /** + * Gets the midnight, local time at or before the Gregorian cutover in milliseconds. * * @since 2.0 * - * @return The millisecond which is midnight, local time at or before the Gregorian cutover - * If this method fails, @c -1 is returned. + * @return The midnight, local time at or before the Gregorian cutover in milliseconds. @n + * If this method fails, @c -1 is returned. @n * The specific error code can be accessed using the GetLastResult() method. */ long long GetNormalizedGregorianCutover(void) const; - /* + /** * Gets the year of the Gregorian cutover, with @c 0 representing 1 BC, @c -1 representing 2 BC, and so on. * * @since 2.0 * - * @return The year of the Gregorian cutover - * If this method fails, @c -1 is returned. + * @return The year of the Gregorian cutover @n + * If this method fails, @c -1 is returned. @n * The specific error code can be accessed using the GetLastResult() method. */ int GetGregorianCutoverYear(void) const; - /* + /** * Gets the Julian day number of the Gregorian cutover. * * @since 2.0 @@ -439,7 +441,7 @@ public: int GetCutoverJulianDay(void) const; - /* + /** * Checks whether the current calendar is a Gregorian calendar or not. * * @since 2.0 @@ -527,14 +529,14 @@ private: public: /* - * Defines the length of months. + * The length of months. * * @since 2.0 */ static const int MONTH_LENGTH[24]; /* - * Defines the days of a year. + * The days of a year. * * @since 2.0 */ diff --git a/inc/FLclLocale.h b/inc/FLclLocale.h index 058ab1b..5f8c396 100644 --- a/inc/FLclLocale.h +++ b/inc/FLclLocale.h @@ -60,7 +60,7 @@ enum CalendarType * @enum LanguageCode * * Defines the ISO 639-2 language code. @n - * The LanguageCode enumerator represents the ISO 639-2 language codes. @n + * This enum represents the ISO 639-2 language codes. @n * The specific LanguageCode represents the language code with the locale's ISO-15924 abbreviation script code. @n * The supported ISO-15924 script codes are Arabic, Cyrillic, Latin, Hans, Hant and Gurmukhi. * @@ -579,8 +579,8 @@ enum LanguageCode * @enum CountryCode * * Defines the ISO 3166-1 alpha-2 country code. @n - * The CountryCode enumerator represents the ISO 3166-1 alpha-2 country codes. - * The area code for Latin america and the Caribbean represents the ISO 3166-1 numeric-3. + * This enum represents the ISO 3166-1 alpha-2 country codes. + * The area code for Latin america and the Caribbean represents the ISO 3166-1 numeric-3 code. * * @since 2.0 */ @@ -843,7 +843,7 @@ enum CountryCode * * @final This class is not intended for extension. * - * @remarks For more information on the example codes for %Locale class, see LocaleManager. + * @remarks For more information on the example codes for the %Locale class, see LocaleManager. * * The %Locale class represents a specific geographical, political, or cultural region. @n * A %Locale object has three attributes: @@ -877,10 +877,10 @@ public: * * @since 2.0 * - * @param[in] languageCode The language code - * @param[in] countryCode The country code - * @param[in] pVariantCodeString A pointer to the variant code string @n - * It is converted to a uppercase letter if it is written in a lowercase letter. + * @param[in] languageCode The language code + * @param[in] countryCode The country code + * @param[in] pVariantCodeString A pointer to the variant code string @n + * It is converted to upper case letters if it is written in lower case letters. */ Locale(LanguageCode languageCode, CountryCode countryCode, const Tizen::Base::String* pVariantCodeString = null); @@ -888,10 +888,10 @@ public: * Assigns the value of the specified instance to the current instance of %Locale. @n * Copying of objects using this copy assignment operator is allowed. * - * @since 2.0 + * @since 2.0 * * @return A reference to the current instance of %Locale - * @param[in] otherLocale An instance of %Locale + * @param[in] otherLocale An instance of %Locale */ Locale& operator =(const Locale& otherLocale); @@ -906,11 +906,11 @@ public: /** * Compares the current instance of %Locale with the specified instance of %Locale. * - * @since 2.0 + * @since 2.0 * * @return @c true if the value of the specified instance is equal to the value of the current instance, @n * else @c false - * @param[in] otherLocale An instance of %Locale + * @param[in] otherLocale An instance of %Locale */ bool operator ==(const Locale& otherLocale) const; @@ -926,14 +926,14 @@ public: bool operator !=(const Locale& otherLocale) const; /** - * Converts the operand @c obj to an object of the %Locale type and then compares it with the current instance of %Locale. + * Converts the operand @c obj to an object of the %Locale type and compares it with the current instance of %Locale. * * @since 2.0 * * @return @c true if the value of the current instance is equal to the value of the specified Tizen::Base::Object, @n * else @c false - * @param[in] obj The object to compare with the current instance - * @see Tizen::Base::Object::Equals() + * @param[in] obj The object to compare with the current instance + * @see Tizen::Base::Object::Equals() */ virtual bool Equals(const Object& obj) const; @@ -972,7 +972,7 @@ public: * @since 2.0 * * @return The language code, @n - * The specific language code string has the locale's ISO-15924 abbreviation script code. + * The specific language code string has the locale's ISO-15924 abbreviation script code. */ Tizen::Base::String GetLanguageCodeString(void) const; @@ -991,7 +991,7 @@ public: * * @since 2.0 * - * @return The variant code string written in a uppercase letter even if it was set to a lowercase letter, @n + * @return The variant code string in upper case letters even if it was set to lower case letters, @n * else an empty string if the variant is not specified * @see SetVariantCodeString() */ @@ -1002,32 +1002,29 @@ public: * Gets the string representing the current instance of %Locale. @n * The string consists of the values returned by GetLanguageCodeString(), GetCountryCodeString(), and GetVariantCodeString() assembled into a string. * - * @since 2.0 + * @since 2.0 * - * @return A concatenated string with the language code string, country code string, and variant string @n - * For example, if the language code is LANGUAGE_ENG, country code is COUNTRY_US, and variant string is empty, @n + * @return The concatenated string with the language code string, country code string, and variant string @n + * For example, if the language code is ::LANGUAGE_ENG, country code is ::COUNTRY_US, and variant string is empty, @n * the locale code string is "eng_US". - * @see GetLanguageCodeString() - * @see GetCountryCodeString() - * @see GetVariantCodeString() */ Tizen::Base::String GetLocaleCodeString(void) const; /** - * Gets the country name of the current instance of %Locale that is appropriate for display to the user. @n + * Gets the country name of the current instance of %Locale that is appropriate for display. @n * The name is localized for this locale. For example, if this locale is eng_US, the name is "United States". * * @since 2.0 * * @return An error code - * @param[out] countryName The country name of the locale - * @exception E_SUCCESS The method is successful. - * @exception E_UNSUPPORTED_OPERATION The current @c locale does not have country name entry in the database. + * @param[out] countryName The country name of the locale + * @exception E_SUCCESS The method is successful. + * @exception E_UNSUPPORTED_OPERATION The current @c locale does not have a country name entry in the database. */ result GetCountryName(Tizen::Base::String& countryName) const; /** - * Gets the country name of the current instance of %Locale that is appropriate for display to the user in the specified %Locale. @n + * Gets the country name of the current instance of %Locale that is appropriate for display in the specified %Locale. @n * The country name is localized for the specified locale(@c otherLocale). For example, if * the current instance of %Locale is fra_FR and the @c otherLocale is eng_US, the name is "France"; * if the current instance is eng_US and the @c otherLocale is fra_FR, the name returned is "Etats-Unis". @@ -1035,29 +1032,28 @@ public: * @since 2.0 * * @return An error code - * @param[in] otherLocale An instance of %Locale according to which the country name of the specified %Locale is displayed - * @param[out] countryName The country name of the locale - * @exception E_SUCCESS The method is successful. - * @exception E_UNSUPPORTED_OPERATION The specified @c locale is not supported, or the current @c locale does not have country name entry in the database. + * @param[in] otherLocale An instance of %Locale to display the country name + * @param[out] countryName The country name of the locale + * @exception E_SUCCESS The method is successful. + * @exception E_UNSUPPORTED_OPERATION The specified @c locale is not supported, or the current @c locale does not have a country name entry in the database. */ result GetCountryName(const Locale& otherLocale, Tizen::Base::String& countryName) const; /** - * Gets the language name of the current instance of %Locale that is appropriate for display to the user. @n - * The name is localized for the locale. For example, if this locale is - * eng_US, the name is "English". + * Gets the language name of the current instance of %Locale that is appropriate for display. @n + * The name is localized for the locale. For example, if this locale is eng_US, the name is "English". * * @since 2.0 * * @return An error code - * @param[out] languageName The language name of the locale - * @exception E_SUCCESS The method is successful. - * @exception E_UNSUPPORTED_OPERATION The current @c locale does not have country name entry in the database. + * @param[out] languageName The language name of the locale + * @exception E_SUCCESS The method is successful. + * @exception E_UNSUPPORTED_OPERATION The current @c locale does not have a country name entry in the database. */ result GetLanguageName(Tizen::Base::String& languageName) const; /** - * Gets the language name of the current instance of %Locale that is appropriate for display to the user in the specified %Locale. @n + * Gets the language name of the current instance of %Locale that is appropriate for display in the specified %Locale. @n * The name is localized for the specified locale (@c otherLocale). For example, if * the current instance is fra_FR and the @c otherLocale is eng_US, the name is "French"; * if the current instance is engUS and the @c otherLocale is fra_FR, the name returned is "anglais". @@ -1065,20 +1061,20 @@ public: * @since 2.0 * * @return An error code - * @param[in] otherLocale An instance of %Locale according to which the language name of the specified %Locale is displayed - * @param[out] languageName The language name of the locale - * @exception E_SUCCESS The method is successful. + * @param[in] otherLocale An instance of %Locale to display the language name + * @param[out] languageName The language name of the locale + * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_OPERATION The specified @c locale is not supported, or the current @c locale does not have country name entry in the database. */ result GetLanguageName(const Locale& otherLocale, Tizen::Base::String& languageName) const; /** * Sets the variant code with the specified variant code string. @n - * The variant code string is converted to a uppercase letter even if it is set to a lowercase letter. + * The variant code string is converted to upper case letters even if it is set to lower case letters. * * @since 2.0 * - * @param[in] pVariantCode A pointer to the variant code + * @param[in] pVariantCode The pointer to the variant code */ void SetVariantCodeString(const Tizen::Base::String* pVariantCode = null); @@ -1088,92 +1084,93 @@ public: * @since 2.0 * * @param[in] languageCodeString The language 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. - * @return An instance of LanguageCode associated with the @c languageCodeString. + * To get the specified language code with the locale's ISO-15924 abbreviation script code, + * the form of @c 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", + * the @c languageCodeString is "aze-latn", and the language code is @c LANGUAGE_AZE_LATIN. + * @return An instance of LanguageCode associated with @c languageCodeString. */ static LanguageCode StringToLanguageCode(const Tizen::Base::String& languageCodeString); /** - * Gets the country code equivalent to the specified country code string. + * Gets the country code equivalent of the specified country code string. * * @since 2.0 * * @param[in] countryCodeString The country code - * @return An instance of CountryCode associated with the @c countryCodeString. + * @return An instance of CountryCode associated with the @c countryCodeString. */ static CountryCode StringToCountryCode(const Tizen::Base::String& countryCodeString); /** - * Gets the language code string equivalent to the specified @c languageCode. + * Gets the language code string equivalent of the specified @c languageCode. * * @since 2.0 * * @param[in] languageCode The language code - * @return The language code string associated with the @c languageCode, @n - * else an empty string if languageCode is invalid. - * @see StringToLanguageCode() + * @return The language code string associated with @c languageCode, @n + * else an empty string if @c languageCode is invalid. + * @see StringToLanguageCode() */ static Tizen::Base::String LanguageCodeToString(LanguageCode languageCode); /** - * Gets the country code string equivalent to the specified @c countryCode. + * Gets the country code string equivalent of the specified @c countryCode. * * @since 2.0 * * @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 invalid. + * @return The ISO 3166-1 alpha-2 country code string associated with @c countryCode, @n + * else an empty string if @c countryCode is invalid. */ static Tizen::Base::String CountryCodeToString(CountryCode countryCode); /** - * Gets the 2-letter language code string equivalent to the specified @c languageCode. + * Gets the 2-letter language code string equivalent of the specified @c languageCode. * * @since 2.0 * * @param[in] languageCode The language code - * @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 invalid. + * @return The ISO 639-2 language code string associated with @c languageCode, @n + * or the ISO 639-2 language code string with the ISO-15924 script code if the @c languageCode represents + * the ISO 639-2 language code with the ISO-15924 script code, @n + * else an empty string if @c languageCode is invalid. */ static Tizen::Base::String LanguageCodeToTwoLetterLanguageCodeString(LanguageCode languageCode); /** - * Gets the language code equivalent to the specified 2-letter language code string. + * Gets the language code equivalent of the specified 2-letter language code string. * * @since 2.0 * * @param[in] languageCodeString The language code string - * @return An instance of LanguageCode associated with the @c languageCodeString. - * @see StringToLanguageCode() + * @return An instance of LanguageCode associated with @c languageCodeString. + * @see StringToLanguageCode() */ static LanguageCode TwoLetterLanguageCodeStringToLanguageCode(const Tizen::Base::String& languageCodeString); /** - * Gets the 3-letter country code string equivalent to the specified @c countryCode. + * Gets the 3-letter country code string equivalent of the specified @c countryCode. * * @since 2.0 * * @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 invalid - * @see CountryCodeToString() - * @remarks COUNTRY_AREA_419 returns an empty string, since it is not defined in the ISO 3166-1 alpha-3. + * @return The ISO 3166-1 alpha-3 country code string associated with @c countryCode, @n + * else an empty string if @c countryCode is invalid + * @remarks @c COUNTRY_AREA_419 returns an empty string, since it is not defined in the ISO 3166-1 alpha-3. + * @see CountryCodeToString() */ static Tizen::Base::String CountryCodeToThreeLetterCountryCodeString(CountryCode countryCode); /** - * Gets the country code equivalent to the specified 3-letter country code string. + * Gets the country code equivalent of the specified 3-letter country code string. * * @since 2.0 * * @param[in] countryCodeString The country code string - * @return An instance of CountryCode associated with the @c countryCodeString. - * @see StringToCountryCode() + * @return An instance of CountryCode associated with @c countryCodeString. + * @see StringToCountryCode() */ static CountryCode ThreeLetterCountryCodeStringToCountryCode(const Tizen::Base::String& countryCodeString); diff --git a/inc/FLclLocaleManager.h b/inc/FLclLocaleManager.h index f835d1b..54b5f16 100644 --- a/inc/FLclLocaleManager.h +++ b/inc/FLclLocaleManager.h @@ -34,13 +34,14 @@ namespace Tizen { namespace Locales /** * @class LocaleManager - * @brief This class is used for the %LocaleManager identification. + * @brief This class provides methods for %LocaleManager identification. * * @since 2.0 * * @final This class is not intended for extension. * - * The %LocaleManager class helps application programmers handle the system locale information of the device. Each device system has at least one installed locale and often has many locales from which the user can choose. + * The %LocaleManager class provides methods for the system locale information of the device. Each device system has at least + * one installed locale and often has many locales from which the user can choose. * * For more information on the class features, see Retrieving Language and Country Codes. @@ -140,12 +141,11 @@ class _OSP_EXPORT_ LocaleManager public: /** * This is the default constructor for this class. @n - * 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. + * 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. * * @since 2.0 * - * @see Construct() - * */ LocaleManager(void); @@ -174,27 +174,29 @@ public: * * @since 2.0 * - * @return An instance of Locale + * @return The system locale * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * The resulting Locale instance is Locale (LANGUAGE_INVALID, COUNTRY_INVALID). + * @exception E_SYSTEM A system error has occurred. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - The resulting Locale instance is Locale(@c LANGUAGE_INVALID, @c COUNTRY_INVALID). */ Locale GetSystemLocale(void) const; /** - * Gets a list of all the available locales. + * Gets the list of all the available locales. * * @since 2.0 * - * @return A list of Locale instances, @n - * else @c null if the method fails + * @return The list of available locales, @n + * else @c null if it fails * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. - * @remarks The IList returned contains the list of all the locales installed on the system. - * The specific error code can be accessed using the GetLastResult() method. + * @remarks + * - The Tizen::Base::Collection::IList returned contains the list of all the locales installed on the system. + * - The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* GetAvailableLocalesN(void) const; @@ -204,7 +206,7 @@ public: * * @since 2.0 * - * @return An instance of Tizen::Base::String (ISO 639-2 code format), @n + * @return The user selected language as an instance of Tizen::Base::String (ISO 639-2 code format), @n * else empty string if the method fails * @exception E_SUCCESS The method is successful. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -213,12 +215,13 @@ public: /** - * Gets a list of all the available languages supported by the device, which can be different according to the target country/region of the device. + * Gets the list of all the available languages supported by the device, which can be different according to the target + * country/region of the device. * * @since 2.0 * - * @return A list of Tizen::Base::String instances (ISO 639-2 code format), @n - * else @c null if the method fails + * @return The list of all available languages as Tizen::Base::String instances (ISO 639-2 code format), @n + * else @c null if it fails * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. @@ -228,12 +231,12 @@ public: /** - * Gets a list of all the available time zone IDs. + * Gets the list of all the available time zone IDs. * * @since 2.0 * - * @return A list of Tizen::Base::String instances, @n - * else @c null if the method fails + * @return The list of all available time zone IDs as Tizen::Base::String instances, @n + * else @c null if it fails * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. @@ -243,19 +246,20 @@ public: /** - * Gets a list of all the available time zone IDs with the specified Greenwich Mean Time (GMT) offset for this time zone. + * Gets the list of all the available time zone IDs with the specified Greenwich Mean Time (GMT) offset for this time zone. * * @since 2.0 * - * @return A list of Tizen::Base::String instances, @n - * else @c null if the method fails + * @return The list of all availabke time zone IDs with the GMT offset as Tizen::Base::String instances, @n + * else @c null if it fails * @param[in] rawOffset The specified GMT offset for this time zone (Daylight Saving Time (DST) is not considered) @n * The value of @c rawOffset is in minutes. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_SYSTEM A system error has occurred. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * If there are no time zones for the specified GMT offset, an empty list is returned. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - If there are no time zones for the specified GMT offset, an empty list is returned. */ Tizen::Base::Collection::IList* GetAvailableTimeZonesN(int rawOffset) const; diff --git a/inc/FLclNumberFormatter.h b/inc/FLclNumberFormatter.h index b6037c1..77c0d4e 100644 --- a/inc/FLclNumberFormatter.h +++ b/inc/FLclNumberFormatter.h @@ -36,7 +36,10 @@ namespace Tizen { namespace Locales * * @since 2.0 * - * The %NumberFormatter class is used to format all number formats, including decimal and real numbers, currency, and percentage for any locale. It also provides methods to determine the locales that have number formats and their names. You can write codes completely independent of the locale conventions for decimal points, thousand separators as well as of the specific decimal digits used or whether the number format is a decimal. A normal decimal number can also be displayed as a currency or as a percentage. + * The %NumberFormatter class is used to format all number formats, including decimal and real numbers, currency, and percentage + * for any locale. It also provides methods to determine the locales that have number formats and their names. You can write + * codes completely independent of the locale conventions for decimal points, thousand separators, the specific + * decimal digits used, or the number format. A normal decimal number can also be displayed as a currency or as a percentage. * * For more information on the class features, see Number Formatters. * @@ -119,44 +122,44 @@ public: * Creates a number formatter for the specified locale. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompNumberFormatterCreateNumberFormatterNPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompNumberFormatterCreateNumberFormatterNPage "here". * @endif * - * @return A pointer to a general number formatter for the specified @c locale, @n + * @return A pointer to the general number formatter for the specified @c locale, @n * else @c null if an error occurs * @param[in] locale An instance of Locale * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c locale is invalid. + * @exception E_INVALID_ARG The specified @c locale is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static NumberFormatter* CreateNumberFormatterN(const Locale& locale); /** * @if OSPCOMPAT - * @page CompNumberFormatterCreateNumberFormatterNPage Compatibility for CreateNumberFormatterN() - * @section CompNumberFormatterCreateNumberFormatterNIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid. - * - * @section CompNumberFormatterCreateNumberFormatterNSolutionSection Resolutions - * This issue has been resolved in Tizen. - * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the @c locale is invalid. + * @page CompNumberFormatterCreateNumberFormatterNPage Compatibility for CreateNumberFormatterN() + * @section CompNumberFormatterCreateNumberFormatterNIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_UNSUPPORTED_OPERATION if the @c locale is invalid. + * + * @section CompNumberFormatterCreateNumberFormatterNSolutionSection Resolutions + * This issue has been resolved in Tizen. + * @par When working in Tizen: + * -# The method returns @c E_INVALID_ARG if the @c locale is invalid. * @endif - */ + */ /** * Creates a currency formatter for the default locale. * * @since 2.0 * - * @return A pointer to a currency formatter for the default locale, @n + * @return A pointer to the currency formatter for the default locale, @n * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -170,44 +173,44 @@ public: * Creates a currency formatter for the specified @c locale. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompNumberFormatterCreateCurrencyFormatterNPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompNumberFormatterCreateCurrencyFormatterNPage "here". * @endif * - * @return A pointer to a currency formatter for the specified @c locale, @n + * @return A pointer to the currency formatter for the specified @c locale, @n * else @c null if an error occurs - * @param[in] locale An instance of Locale - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c locale is invalid. + * @param[in] locale An instance of Locale + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG The specified @c locale is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static NumberFormatter* CreateCurrencyFormatterN(const Locale& locale); /** * @if OSPCOMPAT - * @page CompNumberFormatterCreateCurrencyFormatterNPage Compatibility for CreateCurrencyFormatterN() - * @section CompNumberFormatterCreateCurrencyFormatterNIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid. - * - * @section CompNumberFormatterCreateCurrencyFormatterNSolutionSection Resolutions - * This issue has been resolved in Tizen. + * @page CompNumberFormatterCreateCurrencyFormatterNPage Compatibility for CreateCurrencyFormatterN() + * @section CompNumberFormatterCreateCurrencyFormatterNIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_UNSUPPORTED_OPERATION if the @c locale is invalid. + * + * @section CompNumberFormatterCreateCurrencyFormatterNSolutionSection Resolutions + * This issue has been resolved in Tizen. * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the @c locale is invalid. + * -# The method returns @c E_INVALID_ARG if the @c locale is invalid. * @endif - */ + */ /** * Creates a percentage formatter for the system locale. * * @since 2.0 * - * @return A pointer to a percentage formatter for the default locale, @n + * @return A pointer to the percentage formatter for the default locale, @n * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -221,37 +224,37 @@ public: * Creates a percentage formatter for the specified @c locale. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompNumberFormatterCreatePercentFormatterNPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompNumberFormatterCreatePercentFormatterNPage "here". * @endif * - * @return A pointer to a percentage formatter for the specified @c locale, @n + * @return A pointer to the percentage formatter for the specified @c locale, @n * else @c null if an error occurs - * @param[in] locale An instance of Locale - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @param[in] locale An instance of Locale + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c locale is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ static NumberFormatter* CreatePercentFormatterN(const Locale& locale); - /** + /** * @if OSPCOMPAT - * @page CompNumberFormatterCreatePercentFormatterNPage Compatibility for CreatePercentFormatterN() - * @section CompNumberFormatterCreatePercentFormatterNIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid. - * - * @section CompNumberFormatterCreatePercentFormatterNSolutionSection Resolutions - * This issue has been resolved in Tizen. + * @page CompNumberFormatterCreatePercentFormatterNPage Compatibility for CreatePercentFormatterN() + * @section CompNumberFormatterCreatePercentFormatterNIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_UNSUPPORTED_OPERATION if the @c locale is invalid. + * + * @section CompNumberFormatterCreatePercentFormatterNSolutionSection Resolutions + * This issue has been resolved in Tizen. * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the @c locale is invalid. + * -# The method returns @c E_INVALID_ARG if the @c locale is invalid. * @endif - */ + */ @@ -262,7 +265,7 @@ public: * * @return An error code * @param[in] number The number of type Tizen::Base::Long to format - * @param[out] str The string to append to the resultant string + * @param[out] str The string to append * @exception E_SUCCESS The method is successful. */ virtual result Format(long number, Tizen::Base::String& str) const; @@ -275,7 +278,7 @@ public: * * @return An error code * @param[in] number The number of type Tizen::Base::Double to format - * @param[out] str The string to append to the resultant string + * @param[out] str The string to append * @exception E_SUCCESS The method is successful. */ virtual result Format(double number, Tizen::Base::String& str) const; @@ -290,19 +293,18 @@ public: * @remarks The initial value is derived in a locale dependent way. @n * The returned value may be @c null if no valid currency is determined * or no currency has been set using the SetCurrency() method. - * @see SetCurrency() */ virtual const Currency* GetCurrency(void) const; /** - * Sets the currency used by the current number format when formatting currency values. + * Sets the currency to be used by the current number format when formatting currency values. * - * @since 2.0 + * @since 2.0 * - * @param[in] currency The new currency to use by the current number format + * @param[in] currency The currency to set * @remarks This does not update the minimum or maximum number of fractional digits used by the number format. - * @see GetCurrency() + * @see GetCurrency() */ virtual void SetCurrency(const Currency& currency); @@ -325,7 +327,7 @@ public: * * @param[in] newValue The maximum number of integer digits allowed in the integer portion of a number, @n * If less than zero, @c 0 is used. - * @remarks The maximum integer digits must be greater than or equal to the minimum integer digits. + * @remarks The maximum integer digits must be greater than or equal to the minimum integer digits.@n * If the new value for the maximum integer digits is less than the current value of the minimum integer digits, * the minimum integer digits are also set to the new value. * @see GetMaxIntegerDigits() @@ -338,7 +340,7 @@ public: * * @since 2.0 * - * @return An integer value representing the minimum number of digits allowed in the integer portion of a number + * @return An integer value representing the minimum number of digits * @see SetMinIntegerDigits() */ virtual int GetMinIntegerDigits(void) const; @@ -349,9 +351,9 @@ public: * * @since 2.0 * - * @param[in] newValue The minimum number of integer digits allowed in the integer portion of a number @n - * If less than zero, @c 0 is used. - * @remarks The minimum integer digits must be less than or equal to the maximum integer digits. + * @param[in] newValue The minimum number of integer digits allowed in the integer portion of a number @n + * If less than zero, @c 0 is used. + * @remarks The minimum integer digits must be less than or equal to the maximum integer digits. @n * If the new value for the minimum integer digits exceeds the current value of the maximum integer digits, * the maximum integer digits are also set to the new value. * @see GetMinIntegerDigits() @@ -364,7 +366,7 @@ public: * * @since 2.0 * - * @return An integer value representing the maximum number of digits allowed in the fractional portion of a number + * @return An integer value representing the maximum number of digits * @see SetMaxFractionDigits() */ virtual int GetMaxFractionDigits(void) const; @@ -377,7 +379,7 @@ public: * * @param[in] newValue The maximum number of fractional digits allowed in the fractional portion of a number @n * If less than zero, @c 0 is used. - * @remarks The maximum fractional digits must be greater than or equal to the minimum fractional digits. + * @remarks The maximum fractional digits must be greater than or equal to the minimum fractional digits. @n * If the new value for the maximum fractional digits is less than the current value of the minimum fractional digits, * the minimum fractional digits are also set to the new value. * @see GetMaxFractionDigits() @@ -403,7 +405,7 @@ public: * * @param[in] newValue The minimum number of fractional digits allowed in the fractional portion of a number @n * If less than zero, @c 0 is used. - * @remarks The minimum fractional digits must be less than or equal to the maximum fractional digits. + * @remarks The minimum fractional digits must be less than or equal to the maximum fractional digits. @n * If the new value for the minimum fractional digits exceeds the current value of the maximum fraction digits, * the maximum fraction digits are also set to the new value. * @see GetMinFractionDigits() @@ -418,9 +420,10 @@ public: * * @return @c true if grouping is used in the current instance of %NumberFormatter, @n * else @c false - * @remarks For example, in the English locale, with grouping on, the number 1234567 + * @remarks + * - For example, in the English locale, with grouping on, the number 1234567 * might be formatted as "1,234,567". - * The grouping separator as well as the size of each group is locale dependent + * - The grouping separator as well as the size of each group is locale dependent * and is determined by subclasses of %NumberFormatter. * @see SetGroupingUsed() */ @@ -428,11 +431,11 @@ public: /** - * Sets the current instance of %NumberFormatter to use or not to use grouping. + * Sets the use of grouping in the current instance of %NumberFormatter. * * @since 2.0 * - * @param[in] newValue Set to @c true if grouping is used in the current formatter, @n + * @param[in] newValue Set to @c true to use grouping in the current formatter, @n * else @c false * @see IsGroupingUsed() */ @@ -440,15 +443,15 @@ public: /** - * Applies the specified pattern to the current instance of %NumberFormatter. + * Applies the pattern to the current instance of %NumberFormatter. * * @since 2.0 * * @return An error code - * @param[in] pattern The new pattern - * @param[in] localized The localization On/Off flag @n + * @param[in] pattern The pattern to apply + * @param[in] localized The flag to set the localization on or off @n * Set to @c true if the pattern is applied with the localized symbols, @n - * else @c false. + * else @c false * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c pattern is invalid or its length is @c 0. */ @@ -468,11 +471,11 @@ public: /** - * Sets a new value for the positive prefix of the current instance of %NumberFormatter. + * Sets the positive prefix of the current instance of %NumberFormatter. * * @since 2.0 * - * @param[in] newValue The new positive prefix + * @param[in] newValue The positive prefix to set * @see GetPositivePrefix() */ void SetPositivePrefix(const Tizen::Base::String& newValue); @@ -491,11 +494,11 @@ public: /** - * Sets a new value for the negative prefix of the current instance of %NumberFormatter. + * Sets the negative prefix of the current instance of %NumberFormatter. * * @since 2.0 * - * @param[in] newValue The new negative prefix + * @param[in] newValue The negative prefix to set * @see GetNegativePrefix() */ void SetNegativePrefix(const Tizen::Base::String& newValue); @@ -514,11 +517,11 @@ public: /** - * Sets a new value for the positive suffix of the current instance of %NumberFormatter. + * Sets the positive suffix of the current instance of %NumberFormatter. * * @since 2.0 * - * @param[in] newValue The new positive suffix + * @param[in] newValue The positive suffix to set * @see GetPositiveSuffix() */ void SetPositiveSuffix(const Tizen::Base::String& newValue); @@ -537,11 +540,11 @@ public: /** - * Sets a new value for the negative suffix of the current instance of %NumberFormatter. + * Sets the negative suffix of the current instance of %NumberFormatter. * * @since 2.0 * - * @param[in] newValue The new negative suffix + * @param[in] newValue The negative suffix to set * @see GetNegativeSuffix() */ void SetNegativeSuffix(const Tizen::Base::String& newValue); @@ -560,11 +563,11 @@ public: /** - * Sets a new value for the multiplier for use in percent, per mill, and so on. + * Sets the multiplier for use in percent, per mill, and so on. * * @since 2.0 * - * @param[in] newValue The new value for the multiplier + * @param[in] newValue The multiplier to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * @remarks For example, in percentage, set the suffixes to have "%" and the multiplier to be 100. @@ -579,8 +582,8 @@ public: * @since 2.0 * * @return An integer value representing the grouping size - * @remarks Grouping size is the number of digits between grouping separators in the integer portion of a number. @n - * For example, in the number "123,456.78", the grouping size is 3. + * @remarks The grouping size is the number of digits between the grouping separators in the integer portion of a number. @n + * For example, in the number "123,456.78", the grouping size is 3. * @see SetGroupingSize() * @see IsGroupingUsed() */ @@ -588,11 +591,11 @@ public: /** - * Sets a new value for the grouping size. + * Sets the grouping size. * * @since 2.0 * - * @param[in] newValue The new value for the grouping size + * @param[in] newValue The grouping size to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * @see GetGroupingSize() @@ -615,12 +618,12 @@ public: /** - * Sets the behavior of the decimal separator. @n + * Sets the visibility behavior of the decimal separator. @n * The decimal separator can be set to always appear using this method. * * @since 2.0 * - * @param[in] newValue Set to @c true if the decimal separator is always shown, @n + * @param[in] newValue Set to @c true to always show the decimal separator, @n * else @c false * @see IsDecimalSeparatorAlwaysShown() */ @@ -641,12 +644,12 @@ public: /** - * Sets the behavior of the plus sign. @n + * Sets the visibility behavior of the plus sign. @n * The plus sign can be set to always appear using this method. * * @since 2.0 * - * @param[in] newValue Set to @c true if the plus sign is always shown, @n + * @param[in] newValue Set to @c true to always show the plus sign, @n * else @c false * @see IsPositiveSignAlwaysShown() */ diff --git a/inc/FLclNumberSymbols.h b/inc/FLclNumberSymbols.h index 98bb43d..983cff4 100644 --- a/inc/FLclNumberSymbols.h +++ b/inc/FLclNumberSymbols.h @@ -61,12 +61,14 @@ enum NumberSymbol /** * @class NumberSymbols - * @brief This class provides methods that help in providing number symbols. + * @brief This class provides methods for number symbols. * * @since 2.0 * - * The %NumberSymbols class represents the set of symbols (such as the decimal separator and the grouping separator) needed by NumberFormatter to format numbers. - * %NumberFormatter creates its own instance of %NumberSymbols from its locale data. %NumberSymbols can be adopted by a %NumberFormatter instance, or it can be specified when a %NumberFormatter is created. If you need to change any of these symbols, you can get the %NumberSymbols instance from your %NumberFormatter and then modify it. + * The %NumberSymbols class represents the set of symbols (such as the decimal separator and the grouping separator) needed by + * NumberFormatter to format numbers. %NumberFormatter creates its own instance of %NumberSymbols from its locale data. + * %NumberSymbols can be adapted by a %NumberFormatter instance, or it can be specified when a %NumberFormatter is created. + * If you need to change any of these symbols, you can get the %NumberSymbols instance from your %NumberFormatter and then modify it. * * For more information on the class features, see Number Symbols and Currencies. */ @@ -76,11 +78,10 @@ class _OSP_EXPORT_ NumberSymbols public: /** * This is the default constructor for this class. @n - * 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. + * 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. * - * @since 2.0 - * - * @see Construct() + * @since 2.0 */ NumberSymbols(void); @@ -97,35 +98,35 @@ public: * Initializes this instance of %NumberSymbols with the specified @c locale. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif - * @since 2.0 + * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompNumberSymbolsConstructPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompNumberSymbolsConstructPage "here". * @endif * * @return An error code - * @param[in] locale An instance of Locale - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @param[in] locale An instance of Locale + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c locale is invalid. */ result Construct(const Locale& locale); /** * @if OSPCOMPAT - * @page CompNumberSymbolsConstructPage Compatibility for Construct() - * @section CompNumberSymbolsConstructIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the @c locale is invalid. - * - * @section CompNumberSymbolsConstructSolutionSection Resolutions - * This issue has been resolved in Tizen. + * @page CompNumberSymbolsConstructPage Compatibility for Construct() + * @section CompNumberSymbolsConstructIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_UNSUPPORTED_OPERATION if the @c locale is invalid. + * + * @section CompNumberSymbolsConstructSolutionSection Resolutions + * This issue has been resolved in Tizen. * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the @c locale is invalid. + * -# The method returns @c E_INVALID_ARG if the @c locale is invalid. * @endif - */ + */ /** * Gets the character used for number format. @@ -135,7 +136,7 @@ public: * @return The character used for number format, @n * else an empty string if the @c symbol is invalid * @param[in] symbol The number format symbol instance - * @see SetNumberSymbol() + * @see SetNumberSymbol() */ Tizen::Base::String GetNumberSymbol(NumberSymbol symbol) const; @@ -149,7 +150,7 @@ public: * @param[in] symbol A symbol to set * @param[in] str The new string for symbol * @exception E_SUCCESS The method is successful. - * @see GetNumberSymbol() + * @see GetNumberSymbol() */ result SetNumberSymbol(NumberSymbol symbol, const Tizen::Base::String& str); @@ -160,7 +161,7 @@ public: * @since 2.0 * * @return A pointer to the current instance of Locale, @n - * else @c null if this method fails + * else @c null if it fails * @remarks The specific error code can be accessed using the GetLastResult() method. */ const Locale* GetLocale(void) const; diff --git a/inc/FLclTimeRule.h b/inc/FLclTimeRule.h index 838aa60..8002ff3 100644 --- a/inc/FLclTimeRule.h +++ b/inc/FLclTimeRule.h @@ -31,7 +31,7 @@ namespace Tizen { namespace Locales /** * @class TimeRule - * @brief This class is for setting and getting the time rule. + * @brief This class provides methods for setting and getting the time rule. * * @since 2.0 * @@ -153,7 +153,7 @@ public: * @param[in] day The day * @param[in] hour The hour * @param[in] minute The minute - * @param[in] timeMode The time mode - TIME_MODE_UTC, TIME_MODE_STANDARD, or TIME_MODE_WALL + * @param[in] timeMode The time mode - @c TIME_MODE_UTC, @c TIME_MODE_STANDARD, or @c TIME_MODE_WALL */ TimeRule(Month month, int day, int hour = 0, int minute = 0, Tizen::System::TimeMode timeMode = Tizen::System::TIME_MODE_WALL); @@ -168,7 +168,7 @@ public: * @param[in] dayOfWeek The day of the week * @param[in] hour The hour * @param[in] minute The minute - * @param[in] timeMode The time mode - TIME_MODE_UTC, TIME_MODE_STANDARD, or TIME_MODE_WALL + * @param[in] timeMode The time mode - @c TIME_MODE_UTC, @c TIME_MODE_STANDARD, or @c TIME_MODE_WALL */ TimeRule(Month month, Week week, DayOfWeek dayOfWeek, int hour = 0, int minute = 0, Tizen::System::TimeMode timeMode = Tizen::System::TIME_MODE_WALL); @@ -188,7 +188,7 @@ public: * @b on @b or @b before @c day * @param[in] hour The hour * @param[in] minute The minute - * @param[in] timeMode The time mode - TIME_MODE_UTC, TIME_MODE_STANDARD, or TIME_MODE_WALL + * @param[in] timeMode The time mode - @c TIME_MODE_UTC, @c TIME_MODE_STANDARD, or @c TIME_MODE_WALL */ TimeRule(Month month, int day, DayOfWeek dayOfWeek, bool onOrAfterDay, int hour = 0, int minute = 0, Tizen::System::TimeMode timeMode = Tizen::System::TIME_MODE_WALL); @@ -274,8 +274,8 @@ public: * @since 2.0 * * @return @c true if the value of the specified instance is equal to that of the current instance, @n - * else @c false - * @param[in] obj The object to compare with the current instance + * else @c false + * @param[in] obj The object to compare with the current instance */ virtual bool Equals(const Tizen::Base::Object& obj) const; @@ -297,13 +297,13 @@ private: * @param[in] day The day * @param[in] week The week * @param[in] dayOfWeek The day of week - * @param[in] beforeAfter If @c after is ON_OR_AFTER_DAY, this rule selects the first @c dayOfWeek + * @param[in] beforeAfter If @c after is @c ON_OR_AFTER_DAY, this rule selects the first @c dayOfWeek * @b on @b or @b after @c day. - * If @c after is ON_OR_BEFORE_DAY, this rule selects the last @c dayOfWeek + * If @c after is @c ON_OR_BEFORE_DAY, this rule selects the last @c dayOfWeek * @b on @b or @b before @c day. * @param[in] hour The hour * @param[in] minute The minute - * @param[in] timeMode The time mode - TIME_MODE_UTC, TIME_MODE_STANDARD, TIME_MODE_WALL + * @param[in] timeMode The time mode - @c TIME_MODE_UTC, @c TIME_MODE_STANDARD, @c TIME_MODE_WALL */ void SetValue(Month month, int day, Week week, DayOfWeek dayOfWeek, bool onOrAfterDay, int hour, diff --git a/inc/FLclTimeZone.h b/inc/FLclTimeZone.h index bfddbe9..7a93546 100644 --- a/inc/FLclTimeZone.h +++ b/inc/FLclTimeZone.h @@ -40,15 +40,14 @@ namespace Tizen { namespace Locales * * @final This class is not intended for extension. * - * The %TimeZone class represents a time zone offset and figures out Daylight Saving Time (DST). + * The %TimeZone class represents the time zones and offers methods for time zone offset and Daylight Saving Time (DST). + * The time zone ID format is "Area/Location". @n + * However, the specialized time zone IDs have a different format, such as CST6CDT, EST5EDT and so on. @n * - * The form of time zone ID is "Area/Location". @n + * For more information on IDs, see Time Zone Database. @n * - * However, the specialized time zone IDs have the different form, such as CST6CDT, EST5EDT and so on. @n - * - * For more information on IDs, refer Time Zone Database. @n - * - * The supported time zone list depends on the device. Therefore, it must be checked by using LocaleManager::GetAvailableTimeZonesN(). + * The supported time zone list depends on the device. Therefore, you must call LocaleManager::GetAvailableTimeZonesN() to get + * the supported time zones. * * For more information on the class features, see Time Zones. * @@ -136,15 +135,16 @@ public: * * @param[in] rawOffset The base time zone offset to GMT in minutes * @param[in] id The time zone ID - * @remarks The form of time zone @c id is "Area/Location". @n For more information on IDs, refer here. @n - * However, the supported time zone list depends on the device. Therefore, it must be checked before using this method. - * @see LocaleManager::GetAvailableTimeZonesN() + * @remarks The format of time zone @c id is "Area/Location". @n + * For more information on IDs, refer here. @n + * However, the supported time zone list depends on the device. Therefore, you must call + * LocaleManager::GetAvailableTimeZonesN() to get the supported time zones. */ TimeZone(int rawOffset, const Tizen::Base::String& id); /** * Initializes this instance of %TimeZone with the specified raw GMT offset, - * the ID of the time zone, the rules for starting/ending DST, and the DST offset. + * the time zone ID, the rules for starting/ending DST, and the DST offset. * * @since 2.0 * @@ -153,15 +153,16 @@ public: * @param[in] startRule The DST starting rule * @param[in] endRule The DST end rule * @param[in] dstOffset The amount of time in minutes saved during DST - * @remarks The form of time zone @c id is "Area/Location". @n For more information on IDs, refer here. @n - * However, the supported time zone list depends on the device. Therefore, it must be checked before using this method. - * @see LocaleManager::GetAvailableTimeZonesN() + * @remarks The form of time zone @c id is "Area/Location". @n + * For more information on IDs, refer here. @n + * However, the supported time zone list depends on the device. Therefore, you must call + * LocaleManager::GetAvailableTimeZonesN() to get the supported time zones. */ TimeZone(int rawOffset, const Tizen::Base::String& id, const TimeRule& startRule, const TimeRule& endRule, int dstOffset); /** - * Checks whether the specified instance of %TimeZone equals the value of the current instance. + * Checks whether the specified %TimeZone instance is equal to the current instance. * * @since 2.0 * @@ -172,7 +173,7 @@ public: bool operator ==(const TimeZone& otherTimeZone) const; /** - * Checks whether the %TimeZone instance is equal to the current instance. + * Checks whether the specified %TimeZone instance is equal to the current instance. * * @since 2.0 * @@ -188,8 +189,8 @@ public: * @since 2.0 * * @return @c true if the value of the specified instance is equal to that of the current instance, @n - * else @c false - * @param[in] obj The object to compare with the current instance + * else @c false + * @param[in] obj The object to compare with the current instance */ virtual bool Equals(const Tizen::Base::Object& obj) const; @@ -275,7 +276,7 @@ public: /** * Converts the Coordinated Universal Time (UTC) time to the standard time. * - * @since 2.0 + * @since 2.0 * * @return The standard time * @param[in] utcTime The UTC time @@ -305,7 +306,7 @@ public: /** * Converts the wall time to the UTC time. * - * @since 2.0 + * @since 2.0 * * @return The UTC time * @param[in] wallTime The wall time @@ -336,13 +337,13 @@ public: /** * Gets the raw and GMT offset for the specified instance of Tizen::Base::DateTime in the current time zone. * - * @if OSPCOMPAT - * @brief [Compatibility] + * @if OSPCOMPAT + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompTimeZoneGetOffsetPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompTimeZoneGetOffsetPage "here". * @endif * * @return An error code @@ -353,22 +354,23 @@ public: * @param[out] dstOffset The offset to add to @c rawOffset to obtain the total offset between the local and GMT time @n * If DST is not in effect, it is zero. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c date is invalid. - * @remarks Local millisecond = GMT milliseconds + rawOffset(in milliseconds) + dstOffset(in milliseconds). - * All computations are performed in Gregorian calendar. + * @exception E_INVALID_ARG The specified @c date is invalid. + * @remarks Local millisecond = GMT milliseconds + rawOffset(in milliseconds) + dstOffset(in milliseconds). @n + * All computations are performed in Gregorian calendar. */ result GetOffset(const Tizen::Base::DateTime& date, bool local, int& rawOffset, int& dstOffset) const; /** - * Gets the difference in minutes between the local standard time and GMT, taking into consideration both the raw offset and the effect of DST. + * Gets the difference in minutes between the local standard time and GMT, taking into consideration both the raw offset + * and the effect of DST. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompTimeZoneGetOffsetPage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompTimeZoneGetOffsetPage "here". * @endif * * @return An error code @@ -376,24 +378,24 @@ public: * The value is GMT time from starting day (Jan 1, 1.). * @param[out] offset The offset between the local standard time and GMT, taking into consideration DST * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c ticks is invalid. - * @see Base::DateTime::GetTicks() + * @exception E_INVALID_ARG The specified @c ticks is invalid. + * @see Base::DateTime::GetTicks() */ result GetOffset(long long ticks, int& offset) const; - /** + /** * @if OSPCOMPAT - * @page CompTimeZoneGetOffsetPage Compatibility for GetOffset() - * @section CompTimeZoneGetOffsetIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_OUT_OF_RANGE if an argument is invalid. - * - * @section CompTimeZoneGetOffsetSolutionSection Resolutions - * This issue has been resolved in Tizen. - * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if an argument is invalid. + * @page CompTimeZoneGetOffsetPage Compatibility for GetOffset() + * @section CompTimeZoneGetOffsetIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_OUT_OF_RANGE if an argument is invalid. + * + * @section CompTimeZoneGetOffsetSolutionSection Resolutions + * This issue has been resolved in Tizen. + * @par When working in Tizen: + * -# The method returns @c E_INVALID_ARG if an argument is invalid. * @endif - */ + */ /** * Gets the difference in minutes between the local standard time and GMT, without including DST (that is, raw offset). @@ -406,11 +408,11 @@ public: int GetRawOffset(void) const; /** - * Gets the ID of the time zone. + * Gets the time zone ID. * * @since 2.0 * - * @return The ID of the time zone + * @return The time zone ID */ Tizen::Base::String GetId(void) const; @@ -455,38 +457,38 @@ public: static TimeZone GetGmtTimeZone(void); /** - * Gets the time zone instance from the given ID. + * Gets the time zone instance for the specified ID. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompTimeZoneGetTimeZonePage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompTimeZoneGetTimeZonePage "here". * @endif * * @return An error code * @param[in] id The time zone ID - * @param[out] timeZone The time zone for the given ID + * @param[out] timeZone The time zone for the specified ID * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c id is invalid. - * @remarks The %TimeZone instance for the specified @c id does not contain the DST information. - * The supported time zone list depends on the device. Therefore, it should be checked before using this method. - * @see LocaleManager::GetAvailableTimeZonesN() + * @exception E_INVALID_ARG The specified @c id is invalid. + * @remarks The %TimeZone instance for the specified @c id does not contain the DST information.@n + * The supported time zone list depends on the device. Therefore, you must call + * LocaleManager::GetAvailableTimeZonesN() to get the supported time zones. */ static result GetTimeZone(const Tizen::Base::String& id, Tizen::Locales::TimeZone& timeZone); /** - * Gets the %TimeZone instance from the specified ID and UTC time. + * Gets a %TimeZone instance from the specified ID and UTC time. * * @if OSPCOMPAT - * @brief [Compatibility] + * @brief [Compatibility] * @endif * @since 2.0 * @if OSPCOMPAT - * @compatibility This method has compatibility issues with OSP compatible applications. @n - * For more information, see @ref CompTimeZoneGetTimeZonePage "here". + * @compatibility This method has compatibility issues with OSP compatible applications. @n + * For more information, see @ref CompTimeZoneGetTimeZonePage "here". * @endif * * @return An error code @@ -494,26 +496,26 @@ public: * @param[in] utcTime The UTC time * @param[out] timeZone The time zone for the specified ID and UTC time * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c id is invalid. - * @remarks The %TimeZone instance for the specified ID and UTC time contains the DST information. - * The supported time zone list depends on the device. Therefore, it should be checked before using this method. - * @see LocaleManager::GetAvailableTimeZonesN() + * @exception E_INVALID_ARG The specified @c id is invalid. + * @remarks The %TimeZone instance for the specified ID and UTC time contains the DST information. @n + * The supported time zone list depends on the device. Therefore, you must call + * LocaleManager::GetAvailableTimeZonesN() to get the supported time zones. */ static result GetTimeZone(const Tizen::Base::String& id, const Tizen::Base::DateTime& utcTime, Tizen::Locales::TimeZone& timeZone); - /** + /** * @if OSPCOMPAT - * @page CompTimeZoneGetTimeZonePage Compatibility for GetTimeZone() - * @section CompTimeZoneGetTimeZoneIssueSection Issues - * Implementation of this method in OSP compatible applications has the following issue: @n - * -# The method returns E_UNSUPPORTED_OPERATION if the time zone ID is invalid. - * - * @section CompTimeZoneGetTimeZoneSolutionSection Resolutions - * This issue has been resolved in Tizen. + * @page CompTimeZoneGetTimeZonePage Compatibility for GetTimeZone() + * @section CompTimeZoneGetTimeZoneIssueSection Issues + * Implementation of this method in OSP compatible applications has the following issue: @n + * -# The method returns @c E_UNSUPPORTED_OPERATION if the time zone ID is invalid. + * + * @section CompTimeZoneGetTimeZoneSolutionSection Resolutions + * This issue has been resolved in Tizen. * @par When working in Tizen: - * -# The method returns E_INVALID_ARG if the time zone ID is invalid. + * -# The method returns @c E_INVALID_ARG if the time zone ID is invalid. * @endif - */ + */ /** * Converts the UTC time to the standard time. @@ -532,7 +534,7 @@ public: * @since 2.0 * * @return The UTC time - * @param[in] standardTime The standard time + * @param[in] standardTime The standard time * @param[in] rawOffset The time zone's raw offset in minutes */ static Tizen::Base::DateTime StandardTimeToUtcTime(const Tizen::Base::DateTime& standardTime, int rawOffset); @@ -543,7 +545,7 @@ public: * @since 2.0 * * @return The wall time - * @param[in] utcTime The UTC time + * @param[in] utcTime The UTC time * @param[in] rawOffset The time zone's raw offset in minutes * @param[in] dstOffset The amount of time in minutes saved during DST */ @@ -555,7 +557,7 @@ public: * @since 2.0 * * @return The UTC time - * @param[in] wallTime The wall time + * @param[in] wallTime The wall time * @param[in] rawOffset The time zone's raw offset in minutes * @param[in] dstOffset The amount of time in minutes saved during DST */ diff --git a/inc/FLocales.h b/inc/FLocales.h index 2f2784e..1fdc48b 100644 --- a/inc/FLocales.h +++ b/inc/FLocales.h @@ -46,9 +46,11 @@ * @b Library: @b osp-appfw * * - * The %Locales namespace contains classes representing a specific cultural region (locale) and the classes for manipulating and formatting locale-sensitive information, such as dates, times, numbers, and time zones. + * The %Locales namespace contains classes representing a specific cultural region (locale) and the classes for manipulating and + * formatting locale-sensitive information, such as dates, times, numbers, and time zones. * - * Even if the list of all the available languages supported by the device is different, the localized information by the %Locales namespace should be represented properly. + * Even if the list of all the available languages supported by the device is different, the localized information by + * the %Locales namespace should be represented properly. * * For more information on the %Locales namespace features, see Locales Guide. * diff --git a/inc/FSecAccessController.h b/inc/FSecAccessController.h index 3d66c65..d07843b 100644 --- a/inc/FSecAccessController.h +++ b/inc/FSecAccessController.h @@ -34,10 +34,10 @@ class _PrivilegeManager; /** * @class AccessController - * @brief This class provides a way to check the privilege of privileged API. + * @brief This class provides methods to check the privilege of privileged API. * @since 2.0 * - * The %AccessController class provides a way to check the privilege of privileged API. + * The %AccessController class provides methods to check the privilege of privileged API. */ class _OSP_EXPORT_ AccessController { @@ -54,7 +54,7 @@ public: * @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 this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. * @exception E_SYSTEM An unexpected system error has occurred. */ static result CheckPrivilege(int privilege); @@ -69,27 +69,27 @@ public: * @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 this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the 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); /** - * Checks whether the client application which has @c packageId has a privilege to invoke the privileged API. + * Checks whether the client application with the specified @c packageId has a privilege to invoke the privileged API. * * @since 2.1 * @privlevel partner * @privilege %http://tizen.org/privilege/privilegemanager.read * * @return An error code - * @param[in] packageId The package ID + * @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 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 this method. - * @exception E_USER_NOT_CONSENTED The user blocks an application from calling this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the 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); diff --git a/inc/FSecAesSecureRandom.h b/inc/FSecAesSecureRandom.h index 03641ac..f49b0f6 100644 --- a/inc/FSecAesSecureRandom.h +++ b/inc/FSecAesSecureRandom.h @@ -15,7 +15,7 @@ // /** - * @file FSecAesSecureRandom.h + * @file FSecAesSecureRandom.h * @brief This is the header file for the %AesSecureRandom class. * * This header file contains the declarations of the %AesSecureRandom class. @@ -70,12 +70,12 @@ public: * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class, @n - * else @c null if an error occurs + * else @c null if an error occurs * @param[in] numBytes The number of random bytes to generate * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c numBytes is @c 0 or negative. - * @exception E_SYSTEM A system error has occurred. + * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GenerateRandomBytesN(int numBytes); diff --git a/inc/FSecCert.h b/inc/FSecCert.h index 704a82e..e4a5344 100644 --- a/inc/FSecCert.h +++ b/inc/FSecCert.h @@ -15,7 +15,7 @@ // /** - * @file FSecCert.h + * @file FSecCert.h * @brief This is the header file for the %Cert namespace. * * This header file contains the declarations and descriptions of the %Cert namespace. @@ -39,7 +39,7 @@ * @since 2.0 * * @remarks @b Header @b %file: @b \#include @b @n - * @b Library : @b osp-appfw + * @b Library: @b osp-appfw * * The %Cert namespace contains classes and interfaces for managing certificates, by getting information from security certificates and validating their paths. @n * diff --git a/inc/FSecCertICertificate.h b/inc/FSecCertICertificate.h index 68e481c..dd17a75 100755 --- a/inc/FSecCertICertificate.h +++ b/inc/FSecCertICertificate.h @@ -33,31 +33,31 @@ namespace Tizen { namespace Security { namespace Cert /** * @enum CertificateType * - * Defines the type of certificate. + * Defines the type of security certificate. * * @since 2.0 */ enum CertificateType { ROOT_CA, /**< The Factory-supplied certificates for SSL: ROOT CA */ - OPERATOR_DOMAIN, /**< The Operator Domain */ - TRUSTED_THIRD_PARTY_DOMAIN, /**< The Trusted Third Party Domain */ - USER_CERT, /**< The User Certificates */ - UNKNOWN_TYPE = 10, /**< The unknown type */ + OPERATOR_DOMAIN, /**< The operator domain certificate */ + TRUSTED_THIRD_PARTY_DOMAIN, /**< The trusted third party domain certificate*/ + USER_CERT, /**< The user certificate */ + UNKNOWN_TYPE = 10, /**< The unknown type certificate*/ }; //CertificateType /** * @enum ValidityPeriod * - * Defines the validity period. + * Defines the certificate validity period. * * @since 2.0 */ enum ValidityPeriod { - VALIDITY_PERIOD_VALID, /**< The validity period */ - VALIDITY_PERIOD_EXPIRED, /**< The expiry period */ - VALIDITY_PERIOD_NOT_YET_VALID, /**< The period that is not yet valid */ + VALIDITY_PERIOD_VALID, /**< The certificate is valid */ + VALIDITY_PERIOD_EXPIRED, /**< The certificate has expired */ + VALIDITY_PERIOD_NOT_YET_VALID, /**< The certificate period is not yet valid */ }; //ValidityPeriod /** @@ -66,8 +66,9 @@ enum ValidityPeriod * * @since 2.0 * - * The %ICertificate interface is an abstraction for certificates having different formats. For example, different types of certificates, such as X.509 and PGP, share - * general functionalities, namely encoding and verifying, and some type of information like public keys. Despite containing different sets of information and having different ways for storing, and retrieving them, + * The %ICertificate interface is an abstraction for certificates having different formats. For example, different types of + * certificates, such as X.509 and PGP, share general functionalities, namely encoding and verifying, and information like + * public keys. Despite containing different sets of information and having different ways for storing and retrieving them, * the X.509, X.968, and WTLS certificates can all be implemented by using the %ICertificate interface. * * An identity certificate is a binding of a principal to a public key, which is vouched for by another principal. @@ -184,7 +185,7 @@ public: * * @since 2.0 * - * @return The format of this certificate + * @return The certificate format */ virtual Tizen::Base::String GetFormat(void) const = 0; @@ -193,11 +194,12 @@ public: * * @since 2.0 * - * @return The type of this certificate + * @return The certificate type * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual CertificateType GetType(void) const = 0; @@ -211,16 +213,17 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation or the - * Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetEncodedDataN(void) const = 0; /** * Gets the fingerprint of the certificate. @n - * It is the hashed value of the encoding of the certificate. + * It is the hash value of the encoding of the certificate. * * @since 2.0 * @@ -228,10 +231,11 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate parsing operation or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate parsing operation has failed. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetFingerprintN(void) const = 0; @@ -246,9 +250,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c publicKey is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate parsing operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate parsing operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual bool Verify(const Tizen::Security::IPublicKey& publicKey) = 0; @@ -262,16 +267,17 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The key is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::IPublicKey* GetPublicKeyN(void) const = 0; /** - * Gets the @c serialNumber value from the certificate. @n - * The serial number is an integer assigned by the Certification Authority (CA) to each certificate. It is unique for each certificate issued by a - * given CA (that is, the issuer name and serial number must identify a unique certificate). @n + * Gets the serial number of the certificate. @n + * The serial number is a unique integer assigned by the Certification Authority (CA) to each certificate (that is, the issuer name and serial number + * must identify a unique certificate). @n * * This is defined in ASN.1 as demonstrated in the following code: * @@ -281,23 +287,25 @@ public: * CertificateSerialNumber ::= INTEGER * @endcode * - * Since the serial number can be greater than the system's maximum value for @c int, the output parameter type is @c ByteBuffer, instead of @c int. + * Since the serial number can be greater than the system's maximum defined value for @c int, the output parameter type + * is @c ByteBuffer, instead of @c int. * * @since 2.0 * * @return The serial number of the certificate * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to get the certificate serial number information. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to get the certificate serial number information. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::String GetSerialNumber(void) const = 0; /** * Checks whether the certificate is currently valid. @n - * It is valid if the current date and time are within the validity period given in the certificate. @n - * The validity period consists of two date and time values: the initial date and time, and the final date and time until the validity of the certificate. @n + * It is valid if the current date and time are within the validity period of the certificate. The validity period consists + * of two date and time values: the initial date and time, and the final date and time for the validity of the certificate. @n * * This is defined in ASN.1 as demonstrated in the following code: * @@ -313,29 +321,31 @@ public: * generalTime GeneralizedTime } * @endcode * - * @since 2.0 + * @since 2.0 * * @return The validity period of the certificate * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual ValidityPeriod CheckValidityPeriod(void) = 0; /** * Gets the notBefore value of Tizen::Base::String type from the validity period of the certificate. @n - * This value represents the date and time before which the certificate is not valid. + * This value represents the date and time before which the certificate is not valid. * * @since 2.0 * * @return A string representing the date and time value before which the certificate is not valid * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to get the certificate validity information. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to get the certificate validity information. + * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Security::Cert::X509Certificate::CheckValidityPeriod() for relevant ASN.1 definitions */ virtual Tizen::Base::String GetNotBefore(void) const = 0; @@ -343,16 +353,17 @@ public: /** * Gets the notAfter value of Tizen::Base::String type from the validity period of the certificate. @n - * This value represents the date and time after which the certificate is not valid. + * This value represents the date and time after which the certificate is not valid. * * @since 2.0 * * @return A string representing the date and time value after which the certificate is not valid * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to get the certificate validity information. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to get the certificate validity information. + * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Security::Cert::X509Certificate::CheckValidityPeriod() for relevant ASN.1 definitions */ virtual Tizen::Base::String GetNotAfter(void) const = 0; @@ -365,9 +376,10 @@ public: * @return The name of the issuer of the certificate * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to get the certificate issuer information. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to get the certificate issuer information. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::String GetIssuer(void) const = 0; @@ -379,9 +391,10 @@ public: * @return The subject name of the certificate * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to get the certificate issuer information. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to get the certificate issuer information. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::String GetSubject(void) const = 0; @@ -394,10 +407,11 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetSignatureN(void) const = 0; diff --git a/inc/FSecCertICertificatePath.h b/inc/FSecCertICertificatePath.h index 5df9bac..89204b0 100644 --- a/inc/FSecCertICertificatePath.h +++ b/inc/FSecCertICertificatePath.h @@ -15,7 +15,7 @@ // /** - * @file FSecCertICertificatePath.h + * @file FSecCertICertificatePath.h * @brief This is the header file for the %ICertificatePath interface. * * This header file contains the declarations of the %ICertificatePath interface. @@ -33,11 +33,11 @@ namespace Tizen { namespace Security { namespace Cert class ICertificatePathValidationResult; /** * @interface ICertificatePath - * @brief This interface validates the certificate path and gets more information about it. + * @brief This interface provides methods for validating the certificate path and get information about it. * * @since 2.0 * - * The %ICertificatePath interface validates the certificate path and gets more information about it. @n + * The %ICertificatePath interface provides methods for validating the certificate path and get information about it. @n * * For more information on the class features, see Certificates. @n * @@ -212,7 +212,7 @@ public: virtual Tizen::Base::String GetFormat(void) const = 0; /** - * Adds a certificate to the certificate chain. + * Adds the specified certificate to the certificate chain. * The order of certificates should be as follows: @n * 1. User certificate. * 2. Intermediate certificate. @@ -221,25 +221,27 @@ public: * @since 2.0 * * @return An error code - * @param[in] certificate A reference to a certificate + * @param[in] certificate A reference to the certificate to add * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c certificate or the certificate data is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. */ virtual result AddCertificate(const Tizen::Security::Cert::ICertificate& certificate) = 0; /** * Validates the specified certificate path. * - * @since 2.0 + * @since 2.0 * - * @return The result of the certificate path validation + * @return The result of the certificate path validation * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::Cert::ValidationResult Validate(void) = 0; @@ -249,20 +251,21 @@ public: * @since 2.0 * * @return The result of the certificate path validation - * @param[in] trustAnchor The most trusted Certificate Authority (CA) + * @param[in] trustAnchor The trusted Certificate Authority (CA) * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::Cert::ValidationResult Validate(const Tizen::Security::Cert::ICertificate& trustAnchor) = 0; /** * Gets the trust anchor for the certificate path. * - * @since 2.0 + * @since 2.0 * * @return The root certificate, @n * else @c null if an error occurs @@ -270,9 +273,10 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OBJ_NOT_FOUND The certificate is not found. * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * Either of the following conditions has occurred: + * - The certificate link list operation. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::Cert::ICertificate* GetTrustAnchorN(void) const = 0; @@ -284,15 +288,16 @@ public: * @return The length of the certificate path, @n * else @c -1 if an error occurs * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate list is empty. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate list is empty. */ virtual int GetLength(void) const = 0; /** * Gets the list of certificates in this certificate path. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the ICertificate interface, @n * else @c null if an error occurs @@ -302,9 +307,10 @@ public: * @exception E_INVALID_ARG The value of the specified @c nth is out of the valid range. @n * It must be less than the value retrieved by the GetLength() method. * @exception E_OBJ_NOT_FOUND The certificate is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate list is empty. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate list is empty. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::Cert::ICertificate* GetCertificateN(int nth) const = 0; diff --git a/inc/FSecCertICertificateSelector.h b/inc/FSecCertICertificateSelector.h index 5afd6b6..13cccc4 100644 --- a/inc/FSecCertICertificateSelector.h +++ b/inc/FSecCertICertificateSelector.h @@ -31,12 +31,12 @@ namespace Tizen { namespace Security { namespace Cert /** * @interface ICertificateSelector - * @brief This interface is a selector that defines a set of criterion for selecting certificates. + * @brief This interface is a selector that defines a set of criterion for selecting certificates. * * @since 2.0 * * The %ICertificateSelector interface is a selector that defines a set of criterion for selecting certificates. - * The classes that implement this interface are used to specify the certificates, which must be retrieved from a certificate store. @n + * The classes that implement this interface are used to specify the certificates, which must be retrieved from a certificate store. @n * * For more information on the class features, see Certificates. * diff --git a/inc/FSecCertICertificateStore.h b/inc/FSecCertICertificateStore.h index 897ffe0..e964ec4 100644 --- a/inc/FSecCertICertificateStore.h +++ b/inc/FSecCertICertificateStore.h @@ -36,7 +36,7 @@ namespace Tizen { namespace Security { namespace Cert /** * @interface ICertificateStore - * @brief This is the interface for retrieving and managing the certificates from a repository. + * @brief This interface provides methods for retrieving and managing the certificates from a repository. * * @since 2.0 * @@ -71,11 +71,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] selector A selector that defines a set of criterion for selecting certificates + * @param[in] selector The selector that defines a set of criterion for selecting certificates * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The IPC operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The IPC operation has failed. * @exception E_INVALID_ARG The specified @c selector is invalid. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ @@ -94,18 +95,19 @@ public: virtual result GetCertificateCount(int& count) const = 0; /** - * Gets each certificate that matches the specified selector. + * Gets the certificate that matches the specified selector. * * @since 2.0 * - * @return The certificates that match the specified selector + * @return The certificate that matches the specified selector * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OBJ_NOT_FOUND The certificate is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The Tizen::Base::ByteBuffer operation has failed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::Cert::ICertificate* GetNextCertificateN(void) const = 0; @@ -119,10 +121,12 @@ public: * @param[in] certificate A reference to the certificate to insert * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c certificate or the certificate data is invalid, or - * the specified @c certificateType is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * Either the IPC operation or the file operation or the DB operation has failed. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c certificate or the certificate data is invalid. + * - The specified @c certificateType is invalid. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - Either the IPC operation or the file operation or the DB operation has failed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ virtual result Insert(CertificateType certificateType, const Tizen::Security::Cert::ICertificate& certificate) = 0; @@ -138,11 +142,13 @@ public: * @param[in] newCert A reference to the new certificate * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c certificate or the certificate data is invalid, or - * the specified @c certificateType is invalid. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c certificate or the certificate data is invalid. + * - The specified @c certificateType is invalid. * @exception E_OBJ_NOT_FOUND The certificate is not found. - * @exception E_SYSTEM A system error has occurred. @n - * Either the IPC operation or the file operation or the DB operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - Either the IPC operation or the file operation or the DB operation has failed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ virtual result Update(CertificateType certificateType, const Tizen::Security::Cert::ICertificate& oldCert, const Tizen::Security::Cert::ICertificate& newCert) = 0; @@ -157,11 +163,13 @@ public: * @param[in] certificate A reference to the certificate to remove * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c certificate or the certificate data is invalid, or - * the specified @c certificateType is invalid. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c certificate or the certificate data is invalid. + * - The specified @c certificateType is invalid. * @exception E_OBJ_NOT_FOUND The certificate is not found. - * @exception E_SYSTEM A system error has occurred. @n - * Either the IPC operation or the file operation or the DB operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - Either the IPC operation or the file operation or the DB operation has failed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ virtual result Remove(CertificateType certificateType, const Tizen::Security::Cert::ICertificate& certificate) = 0; diff --git a/inc/FSecCertTypes.h b/inc/FSecCertTypes.h index 79c904f..e7c80c8 100644 --- a/inc/FSecCertTypes.h +++ b/inc/FSecCertTypes.h @@ -15,7 +15,7 @@ // /** - * @file FSecCertTypes.h + * @file FSecCertTypes.h * @brief This is the header file for the %CertTypes definitions. * * This header file contains the %CertTypes definitions. @@ -35,12 +35,12 @@ namespace Tizen { namespace Security { namespace Cert */ enum ValidationResult { - VALIDATION_SUCCESS = 0, /**< Success */ + VALIDATION_SUCCESS = 0, /**< The validation is a success */ VALIDATION_ERROR_INVALID_PATH, /**< The certificate path does not validate */ - VALIDATION_ERROR_NO_ROOT, /**< The root certificate is not found */ + VALIDATION_ERROR_NO_ROOT, /**< The root certificate is not found */ VALIDATION_ERROR_CERT_EXPIRED, /**< The certificate date falls outside the validity period */ VALIDATION_ERROR_CERT_REVOKED, /**< The certificate has been revoked */ - VALIDATION_ERROR_INVALID_SIGNATURE, /**< The signature is not valid */ + VALIDATION_ERROR_INVALID_SIGNATURE, /**< The signature is not valid */ }; //ValidationResult diff --git a/inc/FSecCertX509Certificate.h b/inc/FSecCertX509Certificate.h index dca0d2c..b1dfee8 100755 --- a/inc/FSecCertX509Certificate.h +++ b/inc/FSecCertX509Certificate.h @@ -15,7 +15,7 @@ // /** - * @file FSecCertX509Certificate.h + * @file FSecCertX509Certificate.h * @brief This is the header file for the %X509Certificate class. * * This header file contains the declarations of the %X509Certificate class. @@ -31,11 +31,11 @@ namespace Tizen { namespace Security { namespace Cert /** * @class X509Certificate - * @brief This class is used for managing a variety of identity certificates. + * @brief This class provides methods for managing identity certificates. * * @since 2.0 * - * The %X509Certificate class is used for managing a variety of identity certificates. @n + * The %X509Certificate class provides methods for managing identity certificates. @n * * For more information on the class features, see Certificates. * @@ -70,17 +70,18 @@ public: * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The Tizen::Base::ByteBuffer operation has failed. */ result Construct(const Tizen::Base::ByteBuffer& input); /** - * Gets the format name for this certificate. + * Gets the format of this certificate. * * @since 2.0 * - * @return The format of this certificate + * @return The certificate format */ virtual Tizen::Base::String GetFormat(void) const; @@ -91,15 +92,17 @@ public: * * @return The certificate type * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual CertificateType GetType(void) const; /** * Gets the encoded form of the certificate. @n - * It is assumed that each certificate type will have only a single form of encoding. For example, X.509 certificates will be encoded as ASN.1 DER. + * It is assumed that each certificate type will have only a single form of encoding. For example, X.509 certificates will + * be encoded as ASN.1 DER. * * @since 2.0 * @@ -107,16 +110,17 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetEncodedDataN(void) const; /** * Gets the fingerprint of the certificate. @n - * It is the hashed value of the encoding of the certificate. + * It is the hash value of the encoding of the certificate. * * @since 2.0 * @@ -124,10 +128,11 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate parsing operation or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate parsing operation has failed. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetFingerprintN(void) const; @@ -142,9 +147,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c publicKey is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate parsing operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate parsing operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual bool Verify(const Tizen::Security::IPublicKey& publicKey); @@ -158,9 +164,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The key is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::IPublicKey* GetPublicKeyN(void) const; @@ -182,9 +189,9 @@ public: int GetSpecVersion(void) const; /** - * Gets the serial number value from the certificate. @n - * The serial number is an integer assigned by the Certification Authority (CA) to each certificate. It is unique for each certificate issued by a given - * CA (that is, the issuer name and serial number must identify a unique certificate). @n + * Gets the serial number of the certificate. @n + * The serial number is a unique integer assigned by the Certification Authority (CA) to each certificate (that is, + * the issuer name and serial number must identify a unique certificate). @n * * This is defined in ASN.1 as demonstrated in the following code: * @@ -194,21 +201,22 @@ public: * CertificateSerialNumber ::= INTEGER * @endcode * - * This serial number can be greater than the system's maximum defined value for @c int, the output parameter type is @c ByteBuffer, instead of @c int. + * Since the serial number can be greater than the system's maximum defined value for @c int, the output parameter type + * is @c ByteBuffer, instead of @c int. * - * @since 2.0 + * @since 2.0 * * @return The serial number of the certificate * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::String GetSerialNumber(void) const; /** * Checks whether the certificate is currently valid. @n - * It is valid if the current date and time are within the validity period given in the certificate. The validity period consists of two date and time - * values: the initial date and time, and the final date and time until the validity of the certificate. @n + * It is valid if the current date and time are within the validity period of the certificate. The validity period consists + * of two date and time values: the initial date and time, and the final date and time for the validity of the certificate. @n * * This is defined in ASN.1 as demonstrated in the following code: * @@ -228,9 +236,10 @@ public: * * @return The validity period of the certificate * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual ValidityPeriod CheckValidityPeriod(void); @@ -238,15 +247,16 @@ public: * Gets the notBefore value of @c String type from the validity period of the certificate. @n * This value represents the date and time before which the certificate is not valid. * - * @since 2.0 + * @since 2.0 * * @return A string representing the date and time value before which the certificate is not valid * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to get the certificate validity information. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to get the certificate validity information. + * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Security::Cert::X509Certificate::CheckValidityPeriod(void) for relevant ASN.1 definitions. - * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::String GetNotBefore(void) const; @@ -255,43 +265,46 @@ public: * Gets the notAfter value of @c String type from the validity period of the certificate. @n * This value represents the date and time after which the certificate is not valid. * - * @since 2.0 + * @since 2.0 * * @return A string representing the date and time value after which the certificate is not valid * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to get the certificate validity information. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to get the certificate validity information. + * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Tizen::Security::Cert::X509Certificate::CheckValidityPeriod(void) for relevant ASN.1 definitions. - * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::String GetNotAfter(void) const; /** * Gets the name of the issuer of the certificate. * - * @since 2.0 + * @since 2.0 * * @return The name of the issuer of the certificate * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to get the certificate issuer information. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to get the certificate issuer information. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::String GetIssuer(void) const; /** * Gets the subject name of the certificate. * - * @since 2.0 + * @since 2.0 * * @return The subject name of the certificate * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to get the certificate issuer information. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to get the certificate issuer information. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::String GetSubject(void) const; @@ -310,30 +323,32 @@ public: * * The algorithm name is determined from the algorithm OID string. * - * @since 2.0 + * @since 2.0 * * @return The signature algorithm of the certificate * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::String GetSignatureAlgorithm(void) const; /** * Gets the signature of the certificate. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n - * else @c null if an error occurs + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetSignatureN(void) const; diff --git a/inc/FSecCertX509CertificatePath.h b/inc/FSecCertX509CertificatePath.h index 6b3cf8b..d025738 100644 --- a/inc/FSecCertX509CertificatePath.h +++ b/inc/FSecCertX509CertificatePath.h @@ -35,11 +35,11 @@ class _CertMgrSvcProxy; /** * @class X509CertificatePath - * @brief This class provides the certificate path. + * @brief This class provides methods for the certificate path. * * @since 2.0 * - * The %X509CertificatePath class provides the certificate path. @n + * The %X509CertificatePath class provides methods for the certificate path. @n * * For more information on the class features, see Certificates. */ @@ -86,8 +86,9 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c certificate or the certificate data is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. */ virtual result AddCertificate(const Tizen::Security::Cert::ICertificate& certificate); @@ -98,9 +99,10 @@ public: * * @return The result of the certificate path validation * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. - * The certificate link list operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::Cert::ValidationResult Validate(void); @@ -114,9 +116,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::Cert::ValidationResult Validate(const Tizen::Security::Cert::ICertificate& trustAnchor); @@ -128,8 +131,9 @@ public: * @return The length of the certificate path, @n * else @c -1 if an error occurs * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. */ virtual int GetLength(void) const; @@ -140,15 +144,16 @@ public: * * @return A pointer to the ICertificate interface, @n * else @c null if an error occurs - * @param[in] nth The nth certificate in the certificate path (starts from @c 0) + * @param[in] nth The nth certificate in the certificate path (starts from @c 0) * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The value of the specified @c nth is out of the valid range. @n * It must be less than the value retrieved by the GetLength() method. * @exception E_OBJ_NOT_FOUND The certificate is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::Cert::ICertificate* GetCertificateN(int nth) const; @@ -158,14 +163,15 @@ public: * @since 2.0 * * @return The root certificate, @n - * else @c null if an error occurs + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OBJ_NOT_FOUND The certificate is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The certificate link list operation or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The certificate link list operation has failed. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::Cert::ICertificate* GetTrustAnchorN(void) const; diff --git a/inc/FSecCertX509CertificateSelector.h b/inc/FSecCertX509CertificateSelector.h index 72f2645..9950cc6 100644 --- a/inc/FSecCertX509CertificateSelector.h +++ b/inc/FSecCertX509CertificateSelector.h @@ -31,7 +31,7 @@ namespace Tizen { namespace Security { namespace Cert /** * @class X509CertificateSelector - * @brief This class is used for managing a variety of identity certificates. + * @brief This class provides methods for managing a variety of identity certificates. * * @since 2.0 * @@ -40,7 +40,7 @@ namespace Tizen { namespace Security { namespace Cert * For more information on the class features, see Certificates. * * @see ICertificate - * @see Tizen::Security::Cert::ICertificateSelector + * @see ICertificateSelector */ class _OSP_EXPORT_ X509CertificateSelector : public virtual ICertificateSelector diff --git a/inc/FSecCertX509CertificateStore.h b/inc/FSecCertX509CertificateStore.h index 61dcf20..e88fc93 100644 --- a/inc/FSecCertX509CertificateStore.h +++ b/inc/FSecCertX509CertificateStore.h @@ -36,7 +36,7 @@ class _CertMgrSvcProxy; /** * @class X509CertificateStore - * @brief This class is used for retrieving and managing certificates from a repository. + * @brief This class provides methods for retrieving and managing certificates from a repository. * * @since 2.0 * @@ -86,18 +86,19 @@ public: * @privilege %http://tizen.org/privilege/certificate.read * * @return An error code - * @param[in] selector A selector that defines a set of criterion for selecting certificates + * @param[in] selector The selector that defines a set of criterion for selecting certificates * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The IPC operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The IPC operation has failed. * @exception E_INVALID_ARG The specified @c selector is invalid. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ virtual result SetCertificateSelector(const Tizen::Security::Cert::ICertificateSelector& selector); /** - * Gets a count of certificates that match the specified selector. + * Gets the count of certificates that match the specified selector. * * @since 2.0 * @@ -112,19 +113,20 @@ public: virtual result GetCertificateCount(int& count) const; /** - * Gets each certificate that matches the specified selector. + * Gets the certificate that matches the specified selector. * * @since 2.0 * * @privlevel partner * @privilege %http://tizen.org/privilege/certificate.read * - * @return The certificates that matches the specified selector + * @return The certificate that matches the specified selector * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OBJ_NOT_FOUND The certificate is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The Tizen::Base::ByteBuffer operation has failed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ virtual Tizen::Security::Cert::ICertificate* GetNextCertificateN(void) const; @@ -142,16 +144,18 @@ public: * @param[in] certificate A reference to the certificate to insert * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c certificate or the certificate data is invalid, or - * the specified @c certificateType is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * Either the IPC operation or the file operation or the DB operation has failed. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c certificate or the certificate data is invalid. + * - The specified @c certificateType is invalid. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - Either the IPC operation or the file operation or the DB operation has failed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ virtual result Insert(CertificateType certificateType, const Tizen::Security::Cert::ICertificate& certificate); /** - * Updates the certificate in the certificate store. + * Updates the certificate in the certificate store. * * @since 2.0 * @@ -164,17 +168,19 @@ public: * @param[in] newCert A reference to the new certificate * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c certificate or the certificate data is invalid, or - * the specified @c certificateType is invalid. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c certificate or the certificate data is invalid. + * - The specified @c certificateType is invalid. * @exception E_OBJ_NOT_FOUND The certificate is not found. - * @exception E_SYSTEM A system error has occurred. @n - * Either the IPC operation or the file operation or the DB operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - Either the IPC operation or the file operation or the DB operation has failed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ virtual result Update(CertificateType certificateType, const Tizen::Security::Cert::ICertificate& oldCert, const Tizen::Security::Cert::ICertificate& newCert); /** - * Removes the certificate from the certificate store. + * Removes the certificate from the certificate store. * * @since 2.0 * @@ -186,11 +192,13 @@ public: * @param[in] certificate A reference to the certificate to remove * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c certificate or the certificate data is invalid, or - * the specified @c certificateType is invalid. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c certificate or the certificate data is invalid. + * - The specified @c certificateType is invalid. * @exception E_OBJ_NOT_FOUND The certificate is not found. - * @exception E_SYSTEM A system error has occurred. @n - * Either the IPC operation or the file operation or the DB operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - Either the IPC operation or the file operation or the DB operation has failed. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. */ virtual result Remove(CertificateType certificateType, const Tizen::Security::Cert::ICertificate& certificate); @@ -204,8 +212,8 @@ public: * @privilege %http://tizen.org/privilege/certificate.write * * @return An error code - * @param[in] filePath The file path of PKCS 12 certificate to insert - * @param[in] password The password string to decrypt PKCS 12 certificate + * @param[in] filePath The file path of PKCS 12 certificate to insert + * @param[in] password The password string to decrypt PKCS 12 certificate * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c certificate or the certificate data is invalid. * @exception E_SYSTEM The method cannot proceed due to a severe system error. diff --git a/inc/FSecCrypto.h b/inc/FSecCrypto.h index 2312423..fad754b 100644 --- a/inc/FSecCrypto.h +++ b/inc/FSecCrypto.h @@ -56,9 +56,10 @@ * @since 2.0 * * @remarks @b Header @b %file: @b \#include @b @n - * @b Library : @b osp-appfw + * @b Library: @b osp-appfw * - * The %Crypto namespace provides classes and methods to handle encryption and decryption using hashing, symmetric and asymmetric ciphers. It also provides a mechanism for sending messages over an insecure channel using a key pair (public and private keys). @n + * The %Crypto namespace provides classes and methods to handle encryption and decryption using hashing, symmetric and asymmetric + * ciphers. It also provides a mechanism for sending messages over an insecure channel using a key pair (public and private keys). @n * * For more information on the %Crypto namespace features, see Crypto Guide. @n * diff --git a/inc/FSecCryptoAesCipher.h b/inc/FSecCryptoAesCipher.h index 50059b2..1b94289 100644 --- a/inc/FSecCryptoAesCipher.h +++ b/inc/FSecCryptoAesCipher.h @@ -36,13 +36,13 @@ class _SymmetricCipher; * @class AesCipher * @brief This class provides methods for encryption and decryption using the Advanced Encryption Standard (AES) method. * - * @since 2.0 + * @since 2.0 * * The %AesCipher class provides a symmetric cipher using the Advanced Encryption Standard (AES) method. - * Set appropriate values for the requested mode/key bit/padding scheme and cipher operation mode (::CIPHER_ENCRYPT, ::CIPHER_DECRYPT, ::CIPHER_WRAP, - * or ::CIPHER_UNWRAP) parameters. @n + * This class allows to set appropriate values for the requested mode/key bit/padding scheme and cipher operation mode (::CIPHER_ENCRYPT, ::CIPHER_DECRYPT, + * ::CIPHER_WRAP, or ::CIPHER_UNWRAP) parameters. @n * - * For more information on the class features, see Ciphers. + * For more information on the class features, see Ciphers. * * @see ISymmetricCipher * @see DesCipher @@ -55,8 +55,8 @@ class _OSP_EXPORT_ AesCipher public: /** - * The object is not fully constructed after this constructor is called. For full construction, @n - * the Construct() method must be called right after calling this constructor. + * 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 */ @@ -75,20 +75,23 @@ public: * @since 2.0 * * @return An error code - * @param[in] transformation The name of the requested mode/key bit/padding scheme @n + * @param[in] transformation The requested mode/key bit/padding scheme @n * For example, "CBC/128/NOPADDING" or "CBC/192/NOPADDING". * @param[in] opMode The cipher operation mode @n * For example, @c CIPHER_ENCRYPT, @c CIPHER_DECRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c opMode does not contain a valid value for the cipher operation. - * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n - * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() method is used, then the result obtained is @c null and an exception is returned. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c opMode does not contain a valid value for the cipher operation. + * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n + * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() + * method is used, then the result obtained is @c null and an exception is returned. */ virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode); /** - * Sets a symmetric key for encryption or decryption. + * Sets the symmetric key for encryption or decryption. * * @since 2.0 * @@ -101,7 +104,7 @@ public: virtual result SetKey(const Tizen::Security::ISecretKey& key); /** - * Sets the initial vector. + * Sets the specified initial vector. * * @since 2.0 * @@ -114,24 +117,25 @@ public: virtual result SetInitialVector(const Tizen::Base::ByteBuffer& initialVector); /** - * Encrypts the data (single-part). + * Encrypts the specified data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs - * @param[in] input An instance of Tizen::Base::ByteBuffer + * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input); @@ -139,25 +143,26 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input); /** - * Initializes a multiple-part encryption or decryption operation. + * Initializes the instance of %AesCipher for the multiple-part encryption or decryption. * * @since 2.0 * @@ -166,13 +171,14 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. */ virtual result Initialize(void); /** - * Updates a multiple-part encryption or decryption operation. + * Updates the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -183,15 +189,16 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* UpdateN(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part encryption or decryption operation. + * Finalizes the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -200,9 +207,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* FinalizeN(void); @@ -211,7 +219,7 @@ public: * Wraps a key. * * @since 2.0 - * @pre Before calling this method, a secret key should be set using SetKey(). + * @pre Before calling this method, set a secret key using SetKey(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] secretKey The secret key to wrap @@ -221,8 +229,9 @@ public: * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_UNSUPPORTED_ALGORITHM The specified cipher algorithm for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey); @@ -231,7 +240,7 @@ public: * Unwraps a previously wrapped key. * * @since 2.0 - * @pre Before calling this method, a secret key should be set using SetKey(). + * @pre Before calling this method, set a secret key using SetKey(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] wrappedKey The wrapped key to unwrap @@ -241,8 +250,9 @@ public: * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_UNSUPPORTED_ALGORITHM The specified cipher algorithm for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey); diff --git a/inc/FSecCryptoCastCipher.h b/inc/FSecCryptoCastCipher.h index 4048ccb..94a42dc 100644 --- a/inc/FSecCryptoCastCipher.h +++ b/inc/FSecCryptoCastCipher.h @@ -36,10 +36,10 @@ class _SymmetricCipher; * @class CastCipher * @brief This class provides methods for encryption and decryption using the CAST-128 algorithm. * - * @since 2.0 + * @since 2.0 * * The %CastCipher class provides a symmetric cipher using the CAST-128 algorithm. - * Set appropriate values for the requested mode/key bit/padding scheme and cipher operation mode (::CIPHER_ENCRYPT + * This class allows to set appropriate values for the requested mode/key bit/padding scheme and cipher operation mode (::CIPHER_ENCRYPT * or ::CIPHER_DECRYPT) parameters. @n * * For more information on the class features, see Ciphers. @@ -75,20 +75,23 @@ public: * @since 2.0 * * @return An error code - * @param[in] transformation The name of the requested key bit/padding scheme @n + * @param[in] transformation The requested key bit/padding scheme @n * The valid values for %CastCipher are "128/PKCS7PADDING" and "128/NOPADDING". * @param[in] opMode The cipher operation mode @n * The valid values for %CastCipher are @c CIPHER_ENCRYPT and @c CIPHER_DECRYPT. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c opMode does not contain a valid value for the cipher operation. - * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n - * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() method is used, then the result obtained is @c null and an exception is returned. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c opMode does not contain a valid value for the cipher operation. + * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n + * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() + * method is used, then the result obtained is @c null and an exception is returned. */ virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode); /** - * Sets a symmetric key for encryption or decryption. + * Sets the symmetric key for encryption or decryption. * * @since 2.0 * @@ -117,20 +120,21 @@ public: * Encrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input); @@ -138,40 +142,42 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input); /** - * Initializes a multiple-part encryption or decryption operation. + * Initializes the instance of %CastCipher for the multiple-part encryption or decryption. * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. */ virtual result Initialize(void); /** - * Updates a multiple-part encryption or decryption operation. + * Updates the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -181,16 +187,17 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* UpdateN(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part encryption or decryption operation. + * Finalizes the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -199,9 +206,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* FinalizeN(void); @@ -214,9 +222,10 @@ public: * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] secretKey The secret key to wrap - * @remarks This operation is not supported in the %CastCipher class. + * @remarks + * - This operation is not supported in the %CastCipher class. * Therefore, this method always returns @c null. - * @remarks The @c E_UNSUPPORTED_ALGORITHM exception is returned if the GetLastResult() method is called. + * - The @c E_UNSUPPORTED_ALGORITHM exception is returned if the GetLastResult() method is called. */ virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey); @@ -228,9 +237,10 @@ public: * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] wrappedKey The wrapped key to unwrap - * @remarks This operation is not supported in the %CastCipher class. + * @remarks + * - This operation is not supported in the %CastCipher class. * Therefore, this method always returns @c null. - * @remarks The @c E_UNSUPPORTED_ALGORITHM exception is returned if the GetLastResult() method is called. + * - The @c E_UNSUPPORTED_ALGORITHM exception is returned if the GetLastResult() method is called. */ virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey); diff --git a/inc/FSecCryptoDesCipher.h b/inc/FSecCryptoDesCipher.h index a875a01..e99b82e 100644 --- a/inc/FSecCryptoDesCipher.h +++ b/inc/FSecCryptoDesCipher.h @@ -36,10 +36,10 @@ class _SymmetricCipher; * @class DesCipher * @brief This class provides methods for encryption and decryption using the Data Encryption Standard (DES) method. * - * @since 2.0 + * @since 2.0 * * The %DesCipher class provides a symmetric cipher using the Data Encryption Standard (DES) method. - * Sets appropriate values for the requested mode/key bit/padding scheme and cipher operation mode + * This class allows to set appropriate values for the requested mode/key bit/padding scheme and cipher operation mode * (::CIPHER_ENCRYPT or ::CIPHER_DECRYPT) parameters. @n * * For more information on the class features, see Ciphers. @@ -75,20 +75,23 @@ public: * @since 2.0 * * @return An error code - * @param[in] transformation The name of the requested mode/key bit/padding scheme @n + * @param[in] transformation The requested mode/key bit/padding scheme @n * For example, "CBC/NOPADDING" or "CBC/PKCS7PADDING". * @param[in] opMode The cipher operation mode @n * The valid values for %DesCipher are @c CIPHER_ENCRYPT and @c CIPHER_DECRYPT. * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c opMode does not contain a valid value for the cipher operation. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c opMode does not contain a valid value for the cipher operation. * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n - * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() method is used, then the result obtained is @c null and an exception is returned. + * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() + * method is used, then the result obtained is @c null and an exception is returned. */ virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode); /** - * Sets a symmetric key for encryption or decryption. + * Sets the symmetric key for encryption or decryption. * * @since 2.0 * @@ -117,20 +120,21 @@ public: * Encrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input); @@ -138,40 +142,42 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs - * @param[in] input An instance of Tizen::Base::ByteBuffer + * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input); /** - * Initializes a multiple-part encryption or decryption operation. + * Initializes the instance of %DesCipher for the multiple-part encryption or decryption. * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. */ virtual result Initialize(void); /** - * Updates a multiple-part encryption or decryption operation. + * Updates the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -181,16 +187,17 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* UpdateN(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part encryption or decryption operation. + * Finalizes the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -199,9 +206,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* FinalizeN(void); diff --git a/inc/FSecCryptoDesEdeCipher.h b/inc/FSecCryptoDesEdeCipher.h index f2b4400..7e6b288 100644 --- a/inc/FSecCryptoDesEdeCipher.h +++ b/inc/FSecCryptoDesEdeCipher.h @@ -36,10 +36,10 @@ class _SymmetricCipher; * @class DesEdeCipher * @brief This class provides methods for encryption and decryption using the Data Encryption Standard in the Encrypt-Decrypt-Encrypt (DES-EDE) mode. * - * @since 2.0 + * @since 2.0 * * The %DesEdeCipher class provides symmetric cipher using the Data Encryption Standard in the Encrypt-Decrypt-Encrypt (DES-EDE) mode. - * Sets appropriate values for the requested mode/key bit/padding scheme and cipher operation (::CIPHER_ENCRYPT or ::CIPHER_DECRYPT) parameters. @n + * This class allows to set appropriate values for the requested mode/key bit/padding scheme and cipher operation (::CIPHER_ENCRYPT or ::CIPHER_DECRYPT) parameters. @n * * For more information on the class features, see Ciphers. * @@ -74,19 +74,22 @@ public: * @since 2.0 * * @return An error code - * @param[in] transformation The name of the requested mode/key bit/padding scheme @n + * @param[in] transformation The requested mode/key bit/padding scheme @n * For example, "CBC/NOPADDING" or "CBC/PKCS7PADDING". * @param[in] opMode The cipher operation mode @n * The valid values for %DesEdeCipher are @c CIPHER_ENCRYPT and @c CIPHER_DECRYPT. * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c opMode does not contain a valid value for the cipher operation. - * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n - * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() method is used, then the result obtained is @c null and an exception is returned. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c opMode does not contain a valid value for the cipher operation. + * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n + * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() + * method is used, then the result obtained is @c null and an exception is returned. */ virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode); /** - * Sets a symmetric key for encryption or decryption. + * Sets the symmetric key for encryption or decryption. * * @since 2.0 * @@ -115,20 +118,21 @@ public: * Encrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input); @@ -136,40 +140,42 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input); /** - * Initializes a multiple-part encryption or decryption operation. + * Initializes the instance of %DesEdeCipher for the multiple-part encryption or decryption. * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. */ virtual result Initialize(void); /** - * Updates a multiple-part encryption or decryption operation. + * Updates the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -179,16 +185,17 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* UpdateN(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part encryption or decryption operation. + * Finalizes the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -197,9 +204,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* FinalizeN(void); diff --git a/inc/FSecCryptoDhKeyExchange.h b/inc/FSecCryptoDhKeyExchange.h index ec82246..b040594 100644 --- a/inc/FSecCryptoDhKeyExchange.h +++ b/inc/FSecCryptoDhKeyExchange.h @@ -15,7 +15,7 @@ // /** - * @file FSecCryptoDhKeyExchange.h + * @file FSecCryptoDhKeyExchange.h * @brief This is the header file for the %DhKeyExchange class. * * This header file contains the declarations of the %DhKeyExchange class. @@ -33,7 +33,7 @@ namespace Tizen { namespace Security { namespace Crypto * @class DhKeyExchange * @brief This class provides methods for a key exchange mechanism using the Diffie-Hellman (DH) algorithm. * - * @since 2.0 + * @since 2.0 * * The %DhKeyExchange class provides a DH key exchange between two communicating users. @n * @@ -214,11 +214,11 @@ public: * @since 2.0 * * @return An error code - * @param[in] keyParameters The domain parameters ('p' prime number and 'g' generator) of DH - * algorithm that needs to instantiate - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified input parameter is invalid, or the specified @c keyParameters does not contain a valid value. */ + * @param[in] keyParameters The domain parameters ('p' prime number and 'g' generator) of DH algorithm + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG The specified input parameter is invalid, or the specified @c keyParameters does not contain a valid value. + */ virtual result Construct(const Tizen::Security::IKeyParameters& keyParameters); /** @@ -233,10 +233,11 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GenerateSecretN(Tizen::Security::IPrivateKey& privateKey, Tizen::Security::IPublicKey& publicKey); diff --git a/inc/FSecCryptoIAsymmetricCipher.h b/inc/FSecCryptoIAsymmetricCipher.h index aff8197..855ed69 100644 --- a/inc/FSecCryptoIAsymmetricCipher.h +++ b/inc/FSecCryptoIAsymmetricCipher.h @@ -36,7 +36,7 @@ namespace Tizen { namespace Security { namespace Crypto /** * @interface IAsymmetricCipher - * @brief This interface provides the functionality of an asymmetric cryptographic cipher for encryption and decryption. + * @brief This interface provides methods for the functionality of an asymmetric cryptographic cipher for encryption and decryption. * * @since 2.0 * @@ -163,7 +163,7 @@ public: virtual ~IAsymmetricCipher(void) {} /** - * Sets an asymmetric private key for encryption or decryption. + * Sets the asymmetric private key for encryption or decryption. * * @since 2.0 * @@ -176,7 +176,7 @@ public: virtual result SetPrivateKey(const Tizen::Security::IKey& key) = 0; /** - * Sets an asymmetric public key for encryption or decryption. + * Sets the asymmetric public key for encryption or decryption. * * @since 2.0 * @@ -193,7 +193,7 @@ public: * * @since 2.0 * - * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n + * @return A pointer to the Tizen::Base::ByteBuffer instance that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. @@ -201,9 +201,10 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. * @exception E_KEY_NOT_FOUND The specified key is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred.n + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. */ virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input) = 0; @@ -212,7 +213,7 @@ public: * * @since 2.0 * - * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n + * @return A pointer to the Tizen::Base::ByteBuffer instance that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. @@ -220,9 +221,10 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. * @exception E_KEY_NOT_FOUND The specified key is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. */ virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input) = 0; diff --git a/inc/FSecCryptoIHash.h b/inc/FSecCryptoIHash.h index cdf7eeb..90f0b58 100644 --- a/inc/FSecCryptoIHash.h +++ b/inc/FSecCryptoIHash.h @@ -39,8 +39,8 @@ namespace Tizen { namespace Security { namespace Crypto * * For more information on the class features, see Hashing. @n * - * The following example demonstrates how to use the %IHash interface. - * @code + * The following example demonstrates how to use the %IHash interface. + * @code * * result * MyClass::TestHashSample(void) @@ -195,8 +195,8 @@ class _OSP_EXPORT_ IHash public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -204,12 +204,12 @@ public: /** * Sets the hash algorithm. @n - * Only supported in Secure Hash Algorithm-2 (SHA-2). + * This method is only supported in Secure Hash Algorithm-2 (SHA-2). * * @since 2.0 * * @return An error code - * @param[in] algorithm The name of the hash algorithm @n + * @param[in] algorithm The hash algorithm name @n * For example, "SHA2/224", "SHA2/256", "SHA2/384", or "SHA2/512". * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. @@ -223,31 +223,33 @@ public: * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs - * @param[in] input An instance of Tizen::Base::ByteBuffer + * @param[in] input An instance of Tizen::Base::ByteBuffer containing the data * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. */ virtual Tizen::Base::ByteBuffer* GetHashN(const Tizen::Base::ByteBuffer& input) const = 0; /** - * Initializes a multiple-part hash operation. + * Initializes the multiple-part hash operation. * * @since 2.0 * * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. */ virtual result Initialize(void) = 0; /** - * Updates a multiple-part hash operation while processing another data part. + * Updates the multiple-part hash operation while processing another data part. * * @since 2.0 * @@ -256,14 +258,15 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. */ virtual result Update(const Tizen::Base::ByteBuffer& input) = 0; /** - * Finalizes a multiple-part hash operation. + * Finalizes the multiple-part hash operation. * * @since 2.0 * @@ -271,9 +274,10 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. */ virtual Tizen::Base::ByteBuffer* FinalizeN(void) = 0; @@ -292,4 +296,4 @@ protected: } } } //Tizen::Security::Crypto -#endif //_FSEC_CRYPTO_IHASH_H_ +#endif //_FSEC_CRYPTO_IHASH_H_ diff --git a/inc/FSecCryptoIHmac.h b/inc/FSecCryptoIHmac.h index b8e4c77..241639b 100755 --- a/inc/FSecCryptoIHmac.h +++ b/inc/FSecCryptoIHmac.h @@ -289,8 +289,8 @@ class _OSP_EXPORT_ IHmac public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -302,7 +302,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] algorithm The name of the HMAC algorithm @n + * @param[in] algorithm The HMAC algorithm @n * For example, "HMACSHA2/224", "HMACSHA2/256", "HMACSHA2/384", or "HMACSHA2/512". * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. @@ -323,9 +323,9 @@ public: virtual result SetKey(const Tizen::Security::ISecretKey& key) = 0; /** - * Gets the HMAC with a given input. + * Gets the HMAC for the specified input. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs @@ -334,14 +334,15 @@ public: * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The key is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. */ virtual Tizen::Base::ByteBuffer* GetHmacN(const Tizen::Base::ByteBuffer& input) const = 0; /** - * Initializes a multiple-part HMAC operation. + * Initializes the multiple-part HMAC operation. * * @since 2.0 * @@ -349,13 +350,14 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The key is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. */ virtual result Initialize(void) = 0; /** - * Updates a multiple-part HMAC operation while processing another data part. + * Updates the multiple-part HMAC operation while processing another data part. * * @since 2.0 * @@ -364,24 +366,26 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. */ virtual result Update(const Tizen::Base::ByteBuffer& input) = 0; /** - * Finalizes a multiple-part HMAC operation. + * Finalizes the multiple-part HMAC operation. * * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n - * else @c null if an error occurs + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. */ virtual Tizen::Base::ByteBuffer* FinalizeN(void) = 0; diff --git a/inc/FSecCryptoIKeyExchange.h b/inc/FSecCryptoIKeyExchange.h index fdcfc87..5a7aeba 100644 --- a/inc/FSecCryptoIKeyExchange.h +++ b/inc/FSecCryptoIKeyExchange.h @@ -48,8 +48,8 @@ class _OSP_EXPORT_ IKeyExchange public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -61,7 +61,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] keyParameters The domain parameters of the key exchange algorithm that needs to instantiate + * @param[in] keyParameters The domain parameters of the key exchange algorithm * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -81,9 +81,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GenerateSecretN(Tizen::Security::IPrivateKey& privateKey, Tizen::Security::IPublicKey& publicKey) = 0; diff --git a/inc/FSecCryptoISignature.h b/inc/FSecCryptoISignature.h index 2a9f1f5..a376b85 100755 --- a/inc/FSecCryptoISignature.h +++ b/inc/FSecCryptoISignature.h @@ -15,7 +15,7 @@ // /** - * @file FSecCryptoISignature.h + * @file FSecCryptoISignature.h * @brief This is the header file for the %ISignature interface. * * This header file contains the declarations of the %ISignature interface. @@ -32,7 +32,7 @@ namespace Tizen { namespace Security { namespace Crypto /** * @interface ISignature - * @brief This interface provides the functionality of a digital signature algorithm. + * @brief This interface provides methods for a digital signature algorithm. * * @since 2.0 * @@ -42,7 +42,7 @@ namespace Tizen { namespace Security { namespace Crypto * * The following example demonstrates how to use the %ISignature interface. * - * @code + * @code * * void * MyClass::TestSignatureSample(void) @@ -130,14 +130,14 @@ namespace Tizen { namespace Security { namespace Crypto * * r = E_SUCCESS; * - * CATCH: + * CATCH: * delete pSignature; * delete pOutput; * delete pKeyPairGen; * delete pKeyPair; - * } + * } * - * @endcode + * @endcode */ class _OSP_EXPORT_ ISignature @@ -145,15 +145,15 @@ class _OSP_EXPORT_ ISignature public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ virtual ~ISignature(void) {} /** - * Sets an asymmetric private key for signature. + * Sets the asymmetric private key for signature. * * @since 2.0 * @@ -166,7 +166,7 @@ public: virtual result SetPrivateKey(const Tizen::Security::IKey& key) = 0; /** - * Sets an asymmetric public key for verification. + * Sets the asymmetric public key for verification. * * @since 2.0 * @@ -190,14 +190,15 @@ public: * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. */ virtual Tizen::Base::ByteBuffer* SignN(const Tizen::Base::ByteBuffer& input) = 0; /** - * Verifies the data. @n + * Verifies the specified data. @n * The verification is done by comparing the @c signedData to the signature created by the @c data. * * @since 2.0 @@ -210,9 +211,10 @@ public: * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. */ virtual bool Verify(const Tizen::Base::ByteBuffer& data, const Tizen::Base::ByteBuffer& signedData) = 0; diff --git a/inc/FSecCryptoISymmetricCipher.h b/inc/FSecCryptoISymmetricCipher.h index d6108e4..7f344dc 100644 --- a/inc/FSecCryptoISymmetricCipher.h +++ b/inc/FSecCryptoISymmetricCipher.h @@ -15,7 +15,7 @@ // /** - * @file FSecCryptoISymmetricCipher.h + * @file FSecCryptoISymmetricCipher.h * @brief This is the header file for the %ISymmetricCipher interface. * * This header file contains the declarations of the %ISymmetricCipher interface. @@ -223,8 +223,8 @@ class _OSP_EXPORT_ ISymmetricCipher public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -236,7 +236,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] transformation The name of the requested mode or key bit or padding scheme + * @param[in] transformation The requested mode or key bit or padding scheme * @param[in] opMode The cipher operation mode @n * For example, @c CIPHER_ENCRYPT, @c CIPHER_DECRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP. * @exception E_SUCCESS The method is successful. @@ -247,12 +247,12 @@ public: virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode = Tizen::Security::Crypto::CIPHER_ENCRYPT) = 0; /** - * Sets a symmetric key for encryption or decryption. + * Sets the symmetric key for encryption or decryption. * * @since 2.0 * * @return An error code - * @param[in] key An instance of ISecretKey + * @param[in] key An instance of ISecretKey to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c key is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -265,7 +265,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] initialVector The initial vector + * @param[in] initialVector The initial vector to set * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -286,9 +286,10 @@ public: * @exception E_KEY_NOT_FOUND The key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. */ virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input) = 0; @@ -306,14 +307,16 @@ public: * @exception E_KEY_NOT_FOUND The key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. */ virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input) = 0; /** - * Initializes a multiple-part encryption or decryption operation. + * Initializes the instance of %ISymmetricCipher for the multiple-part encryption or decryption operation. + * * * @since 2.0 * @@ -322,13 +325,14 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. */ virtual result Initialize(void) = 0; /** - * Updates a multiple-part encryption or decryption operation. + * Updates the instance of %ISymmetricCipher for the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -339,15 +343,16 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* UpdateN(const Tizen::Base::ByteBuffer& input) = 0; /** - * Finalizes a multiple-part encryption or decryption operation. + * Finalizes the instance of %ISymmetricCipher for the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -356,15 +361,16 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* FinalizeN(void) = 0; /** - * Wraps the specified key. + * Wraps a key. * * @since 2.0 * @@ -376,11 +382,12 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks - * - The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. * - This operation is only supported in AesCipher. */ virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey) = 0; @@ -398,9 +405,10 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks * - The specific error code can be accessed using the GetLastResult() method. * - This operation is only supported in AesCipher. diff --git a/inc/FSecCryptoKeaKeyExchange.h b/inc/FSecCryptoKeaKeyExchange.h index 1a50489..e969c07 100644 --- a/inc/FSecCryptoKeaKeyExchange.h +++ b/inc/FSecCryptoKeaKeyExchange.h @@ -33,17 +33,17 @@ namespace Tizen { namespace Security { namespace Crypto * @class KeaKeyExchange * @brief This class provides methods for performing the key exchange mechanism using Key Exchange Algorithm (KEA). * - * @since 2.0 + * @since 2.0 * * The %KeaKeyExchange class provides a KEA key exchange between two communicating users. @n * - * For more information on the class features, see Key exchanging. + * For more information on the class features, see Key exchanging. * - * @see IKeyExchange - * @see KeyPairGenerator + * @see IKeyExchange + * @see KeyPairGenerator * - * The following example demonstrates how to use the %KeaKeyExchange class. - * @code + * The following example demonstrates how to use the %KeaKeyExchange class. + * @code * * void KeaGenerateSecretExample(void) * { @@ -292,7 +292,7 @@ public: * This parameter needs to be instantiated. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_OUT_OF_MEMORY The memory is insufficient. */ virtual result Construct(const Tizen::Security::IKeyParameters& keyParameters); @@ -308,9 +308,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GenerateSecretN(Tizen::Security::IPrivateKey& privateKey, Tizen::Security::IPublicKey& publicKey); diff --git a/inc/FSecCryptoMd5Hash.h b/inc/FSecCryptoMd5Hash.h index b752b35..65baec2 100644 --- a/inc/FSecCryptoMd5Hash.h +++ b/inc/FSecCryptoMd5Hash.h @@ -61,7 +61,7 @@ public: /** * This destructor overrides Tizen::Base::Object::~Object(). * - * @since 2.0 + * @since 2.0 */ virtual ~Md5Hash(void); @@ -92,28 +92,30 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetHashN(const Tizen::Base::ByteBuffer& input) const; /** - * Initializes a multiple-part hash operation. + * Initializes the multiple-part hash operation. * * @since 2.0 * * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the openssl library. */ virtual result Initialize(void); /** - * Updates a multiple-part hash operation while processing another data part. + * Updates the multiple-part hash operation while processing another data part. * * @since 2.0 * @@ -122,14 +124,15 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. */ virtual result Update(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part hash operation. + * Finalizes the multiple-part hash operation. * * @since 2.0 * @@ -137,9 +140,10 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the openssl library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* FinalizeN(void); diff --git a/inc/FSecCryptoMd5Hmac.h b/inc/FSecCryptoMd5Hmac.h index 0b1504e..04743d0 100644 --- a/inc/FSecCryptoMd5Hmac.h +++ b/inc/FSecCryptoMd5Hmac.h @@ -37,7 +37,8 @@ namespace Tizen { namespace Security { namespace Crypto * * @since 2.0 * - * The %Md5Hmac class implements the basic hash procedure to encrypt messages using the Hash Message Authentication Code (HMAC) algorithm, which provides a hash with a secret key. @n + * The %Md5Hmac class implements the basic hash procedure to encrypt messages using the Hash Message Authentication Code (HMAC) + * algorithm, which provides a hash with a secret key. * * For more information on the class features, see Hashing. * @@ -61,7 +62,7 @@ public: /** * This destructor overrides Tizen::Base::Object::~Object(). * - * @since 2.0 + * @since 2.0 */ virtual ~Md5Hmac(void); @@ -73,18 +74,18 @@ public: * @since 2.0 * * @return An error code - * @param[in] algorithm The name of the HMAC algorithm @n + * @param[in] algorithm The HMAC algorithm name @n * For example, "HMACSHA2/224", "HMACSHA2/256", "HMACSHA2/384", or "HMACSHA2/512". * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. - * @remarks Do not call this method. It is not supported. + * @remarks Do not call this method. It is not supported. */ virtual result SetAlgorithm(const Tizen::Base::String& algorithm); /** * Sets the secret key. * - * @since 2.0 + * @since 2.0 * * @return An error code * @param[in] key An instance of ISecretKey @@ -95,7 +96,7 @@ public: virtual result SetKey(const Tizen::Security::ISecretKey& key); /** - * Gets the HMAC with the specified input. + * Gets the HMAC for the specified input. * * @since 2.0 * @@ -106,15 +107,16 @@ public: * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetHmacN(const Tizen::Base::ByteBuffer& input) const; /** - * Initializes a multiple-part HMAC operation. + * Initializes the multiple-part HMAC operation. * * @since 2.0 * @@ -128,7 +130,7 @@ public: virtual result Initialize(void); /** - * Updates a multiple-part HMAC operation while processing another data part. + * Updates the multiple-part HMAC operation while processing another data part. * * @since 2.0 * @@ -137,9 +139,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. */ virtual result Update(const Tizen::Base::ByteBuffer& input); @@ -152,9 +155,10 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* FinalizeN(void); diff --git a/inc/FSecCryptoRc2Cipher.h b/inc/FSecCryptoRc2Cipher.h index 005f6c6..309058c 100644 --- a/inc/FSecCryptoRc2Cipher.h +++ b/inc/FSecCryptoRc2Cipher.h @@ -37,14 +37,14 @@ class _SymmetricCipher; * * @since 2.0 * - * The %Rc2Cipher class provides a symmetric cipher using the RC2 algorithm. - * It sets appropriate values for the requested mode/key bit/padding scheme and cipher operation (CIPHER_ENCRYPT or CIPHER_DECRYPT) parameters. @n + * The %Rc2Cipher class provides a symmetric cipher using the RC2 algorithm. @n + * This class allows to set appropriate values for the requested mode/key bit/padding scheme and cipher operation (CIPHER_ENCRYPT or CIPHER_DECRYPT) parameters. @n * * For more information on the class features, see Ciphers. * * @see ISymmetricCipher - * @see DesCipher - * @see DesEdeCipher + * @see DesCipher + * @see DesEdeCipher */ class _OSP_EXPORT_ Rc2Cipher : public virtual ISymmetricCipher @@ -73,7 +73,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] transformation The name of the requested mode/padding scheme @n + * @param[in] transformation The requested mode/padding scheme @n * The RC2 support variable length key ranges from 8 bits to 128 bits, in steps of 8 bits. * The key bits are not required to be mentioned in the transformation. * There are four valid transformations for RC2, "CBC/NOPADDING", @@ -81,16 +81,19 @@ public: * @param[in] opMode The cipher operation mode @n * The valid values for %Rc2Cipher are @c CIPHER_ENCRYPT and @c CIPHER_DECRYPT. * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c opMode does not contain a valid value for the cipher operation. - * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n - * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() method is used, then the result obtained is @c null and an exception is returned. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c opMode does not contain a valid value for the cipher operation. + * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n + * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() method is used, then the + * result obtained is @c null and an exception is returned. */ virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode); /** - * Sets a symmetric key for encryption or decryption. @n - * The variable length key ranges from 8 bits to 128 bits, in steps of 8 bits. + * Sets the symmetric key for encryption or decryption. @n + * The variable length key ranges from 8 bits to 128 bits, in steps of 8 bits. * * @since 2.0 * @@ -119,20 +122,21 @@ public: * Encrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input); @@ -140,40 +144,42 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input); /** - * Initializes a multiple-part encryption or decryption operation. + * Initializes the instance of %Rc2Cipher for the multiple-part encryption or decryption. * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. */ virtual result Initialize(void); /** - * Updates a multiple-part encryption or decryption operation. + * Updates the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -183,16 +189,17 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* UpdateN(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part encryption or decryption operation. + * Finalizes the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -201,9 +208,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* FinalizeN(void); diff --git a/inc/FSecCryptoRc4Cipher.h b/inc/FSecCryptoRc4Cipher.h index d2bd3e1..bb10601 100644 --- a/inc/FSecCryptoRc4Cipher.h +++ b/inc/FSecCryptoRc4Cipher.h @@ -38,14 +38,14 @@ class _SymmetricCipher; * * @since 2.0 * - * The %Rc4Cipher class provides a symmetric cipher using the RC4 algorithm. - * It sets appropriate values for the requested mode/key bit/padding scheme and cipher operation (CIPHER_ENCRYPT or CIPHER_DECRYPT) parameters. @n + * The %Rc4Cipher class provides a symmetric cipher using the RC4 algorithm. @n + * This class allows to set appropriate values for the requested mode/key bit/padding scheme and cipher operation (CIPHER_ENCRYPT or CIPHER_DECRYPT) parameters. @n * * For more information on the class features, see Ciphers. * * @see ISymmetricCipher - * @see DesCipher - * @see DesEdeCipher + * @see DesCipher + * @see DesEdeCipher */ class _OSP_EXPORT_ Rc4Cipher : public virtual ISymmetricCipher @@ -78,16 +78,17 @@ public: * @param[in] opMode The cipher operation mode @n * The valid values for %Rc4Cipher are @c CIPHER_ENCRYPT and @c CIPHER_DECRYPT. * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG A specified input parameter is invalid. * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n - * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() method is used, then the result obtained is @c null and an exception is returned. + * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() + * method is used, then the result obtained is @c null and an exception is returned. */ virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode); /** - * Sets a symmetric key for encryption or decryption operation. @n - * The variable length key ranges from 40 bits to 256 bits, in steps of 8 bits. + * Sets the symmetric key for encryption or decryption operation. @n + * The variable length key ranges from 40 bits to 256 bits, in steps of 8 bits. * * @since 2.0 * @@ -116,20 +117,21 @@ public: * Encrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input); @@ -137,40 +139,42 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input); /** - * Initializes a multiple-part encryption or decryption operation. + * Initializes the instance of %Rc4Cipher for the multiple-part encryption or decryption. * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - The method has failed to operate with the OpenSSL library. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. */ virtual result Initialize(void); /** - * Updates a multiple-part encryption or decryption operation. + * Updates the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -180,17 +184,18 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_INVALID_ARG The specified Tizen::Base::ByteBuffer instance is invalid or empty. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* UpdateN(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part encryption or decryption operation. + * Finalizes the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -199,9 +204,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks This operation is not required for RC4. Always return @c null if this method is called. */ virtual Tizen::Base::ByteBuffer* FinalizeN(void); diff --git a/inc/FSecCryptoRsaCipher.h b/inc/FSecCryptoRsaCipher.h index b0bf9aa..431081d 100755 --- a/inc/FSecCryptoRsaCipher.h +++ b/inc/FSecCryptoRsaCipher.h @@ -68,7 +68,7 @@ public: virtual ~RsaCipher(void); /** - * Sets an asymmetric private key for encryption or decryption. + * Sets the asymmetric private key for encryption or decryption. * * @since 2.0 * @@ -82,7 +82,7 @@ public: virtual result SetPrivateKey(const Tizen::Security::IKey& key); /** - * Sets an asymmetric public key for encryption or decryption. + * Sets the asymmetric public key for encryption or decryption. * * @since 2.0 * @@ -109,10 +109,11 @@ public: * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. * @exception E_OVERFLOW This operation has caused the memory to overflow. * @exception E_KEY_NOT_FOUND The specified key is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input); @@ -123,17 +124,18 @@ public: * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs - * @param[in] input An instance of Tizen::Base::ByteBuffer + * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. * @exception E_OVERFLOW This operation has caused the memory to overflow. * @exception E_KEY_NOT_FOUND The specified key is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input); diff --git a/inc/FSecCryptoRsaSignature.h b/inc/FSecCryptoRsaSignature.h index eb60157..067e98f 100755 --- a/inc/FSecCryptoRsaSignature.h +++ b/inc/FSecCryptoRsaSignature.h @@ -38,7 +38,7 @@ namespace Tizen { namespace Security { namespace Crypto * * The %RsaSignature class implements the Rivest Shamir Adleman (RSA) signatures. @n * - * For more information on the class features, see Ciphers. + * For more information on the class features, see Ciphers. * * @see ISignature * @see IKeyPairGenerator @@ -69,13 +69,13 @@ public: virtual ~RsaSignature(void); /** - * Sets an asymmetric private key for signature. + * Sets the asymmetric private key for signature. * * @since 2.0 * * @return An error code - * @param[in] key An instance of IKey. - * Key can be in PEM/DER/PKCS8 format only. + * @param[in] key An instance of IKey + * The key can be in PEM/DER/PKCS8 format only. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c key is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -83,13 +83,13 @@ public: virtual result SetPrivateKey(const Tizen::Security::IKey& key); /** - * Sets an asymmetric public key for verification. + * Sets the asymmetric public key for verification. * * @since 2.0 * * @return An error code * @param[in] key An instance of IKey - * Key can be in PEM/DER/X509 public key format only. + * The key can be in PEM/DER/X509 public key format only. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c key is invalid. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -101,40 +101,42 @@ public: * The %SignN() method only supports sha1withRsa for signing the data * @since 2.0 * - * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n + * @return A pointer to the Tizen::Base::ByteBuffer instance that contains the output, @n * else @c null if an error occurs - * @param[in] input An instance of Tizen::Base::ByteBuffer + * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* SignN(const Tizen::Base::ByteBuffer& input); /** * Signs the data. @n - * The %SignN() method provides the additional option to developer for setting digest algorithm that is needed for signing the data + * The %SignN() method provides the additional option for setting the digest algorithm that is needed for signing the data * * @since 2.0 * - * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n + * @return A pointer to the Tizen::Base::ByteBuffer instance that contains the output, @n * else @c null if an error occurs - * @param[in] input An instance of Tizen::Base::ByteBuffer - * @param[in] algorithm An instance of Tizen::Base::String that contains the digest algorithm, - * valid values are MD5, MD5WITHSHA1, SHA1, SHA2/224, SHA2/256, SHA2/384, SHA2/512. + * @param[in] input An instance of Tizen::Base::ByteBuffer + * @param[in] algorithm The Tizen::Base::String instance that contains the digest algorithm. @n + * The valid values are MD5, MD5WITHSHA1, SHA1, SHA2/224, SHA2/256, SHA2/384, SHA2/512. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_UNSUPPORTED_ALGORITHM The specified algorithm is not supported. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::ByteBuffer* SignN(const Tizen::Base::ByteBuffer& input, const Tizen::Base::String& algorithm); @@ -148,40 +150,42 @@ public: * @return @c true if the signed data is correct, @n * else @c false * @param[in] data An instance of Tizen::Base::ByteBuffer that contains the original data - * @param[in] signedData A instance of Tizen::Base::ByteBuffer that contains the signed data + * @param[in] signedData An instance of Tizen::Base::ByteBuffer that contains the signed data * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual bool Verify(const Tizen::Base::ByteBuffer& data, const Tizen::Base::ByteBuffer& signedData); /** * Verifies the data. @n * The verification is done by comparing the @c signedData to the signature created by the @c data. @n - * The %Verify() method provides the additional option to developer for setting digest algorithm that is needed for verifying the signed data + * The %Verify() method provides the additional option for setting the digest algorithm that is needed for verifying the signed data * * @since 2.0 * * @return @c true if the signed data is correct, @n * else @c false * @param[in] data An instance of Tizen::Base::ByteBuffer that contains the original data - * @param[in] signedData A instance of Tizen::Base::ByteBuffer that contains the signed data - * @param[in] algorithm An instance of Tizen::Base::String that contains the digest algorithm, - * valid values are MD5, MD5WITHSHA1, SHA1, SHA2/224, SHA2/256, SHA2/384, SHA2/512. + * @param[in] signedData An instance of Tizen::Base::ByteBuffer that contains the signed data + * @param[in] algorithm The Tizen::Base::String instance that contains the digest algorithm. @n + * The valid values are MD5, MD5WITHSHA1, SHA1, SHA2/224, SHA2/256, SHA2/384, SHA2/512. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_UNSUPPORTED_ALGORITHM The specified algorithm is not supported. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ bool Verify(const Tizen::Base::ByteBuffer& data, const Tizen::Base::ByteBuffer& signedData, const Tizen::Base::String& algorithm); diff --git a/inc/FSecCryptoSha1Hash.h b/inc/FSecCryptoSha1Hash.h index a376b30..451311f 100644 --- a/inc/FSecCryptoSha1Hash.h +++ b/inc/FSecCryptoSha1Hash.h @@ -39,7 +39,7 @@ namespace Tizen { namespace Security { namespace Crypto * * The %Sha1Hash class implements the SHA-1 hash algorithm. @n * - * For more information on the class features, see Hashing. + * For more information on the class features, see Hashing. * * @see IHash * @see Md5Hash @@ -73,7 +73,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] algorithm The name of the hash algorithm @n + * @param[in] algorithm The hash algorithm name @n * For example "SHA2/224", "SHA2/256", "SHA2/384", or "SHA2/512". * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. @@ -82,7 +82,7 @@ public: virtual result SetAlgorithm(const Tizen::Base::String& algorithm); /** - * Gets the hashes of a data (single-part). + * Gets the hashes of the specified data (single-part). * * @since 2.0 * @@ -92,15 +92,16 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetHashN(const Tizen::Base::ByteBuffer& input) const; /** - * Initializes a multiple-part hash operation. + * Initializes the multiple-part hash operation. * * @since 2.0 * @@ -113,7 +114,7 @@ public: virtual result Initialize(void); /** - * Updates a multiple-part hash operation while processing another data part. + * Updates the multiple-part hash operation while processing another data part. * * @since 2.0 * @@ -122,14 +123,15 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. */ virtual result Update(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part hash operation. + * Finalizes the multiple-part hash operation. * * @since 2.0 * @@ -137,9 +139,10 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* FinalizeN(void); diff --git a/inc/FSecCryptoSha1Hmac.h b/inc/FSecCryptoSha1Hmac.h index 0861f55..1f814d3 100644 --- a/inc/FSecCryptoSha1Hmac.h +++ b/inc/FSecCryptoSha1Hmac.h @@ -39,7 +39,7 @@ namespace Tizen { namespace Security { namespace Crypto * * The %Sha1Hmac class implements the SHA-1 HMAC algorithm. @n * - * For more information on the class features, see Hashing. + * For more information on the class features, see Hashing. * * @see IHmac * @see Md5Hmac @@ -54,14 +54,14 @@ public: /** * This is the default constructor for this class. * - * @since 2.0 + * @since 2.0 */ Sha1Hmac(void); /** - * This destructor overrides Tizen::Base::Object::~Object(). + * This destructor overrides Tizen::Base::Object::~Object(). * - * @since 2.0 + * @since 2.0 */ virtual ~Sha1Hmac(void); @@ -73,7 +73,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] algorithm The name of the HMAC algorithm @n + * @param[in] algorithm The HMAC algorithm name @n * For example, "HMACSHA2/224", "HMACSHA2/256", "HMACSHA2/384", or "HMACSHA2/512". * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. @@ -95,7 +95,7 @@ public: virtual result SetKey(const Tizen::Security::ISecretKey& key); /** - * Gets HMAC with the given input. + * Gets the HMAC for the specified input. * * @since 2.0 * @@ -106,14 +106,15 @@ public: * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetHmacN(const Tizen::Base::ByteBuffer& input) const; /** - * Initializes a multiple-part HMAC operation. + * Initializes the multiple-part HMAC operation. * * @since 2.0 * @@ -121,13 +122,14 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. */ virtual result Initialize(void); /** - * Updates a multiple-part HMAC operation while processing another data part. + * Updates the multiple-part HMAC operation while processing another data part. * * @since 2.0 * @@ -136,14 +138,15 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. */ virtual result Update(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part HMAC operation. + * Finalizes the multiple-part HMAC operation. * * @since 2.0 * @@ -151,10 +154,11 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* FinalizeN(void); diff --git a/inc/FSecCryptoSha2Hash.h b/inc/FSecCryptoSha2Hash.h index 705db99..12910fb 100755 --- a/inc/FSecCryptoSha2Hash.h +++ b/inc/FSecCryptoSha2Hash.h @@ -39,7 +39,7 @@ namespace Tizen { namespace Security { namespace Crypto * * The %Sha2Hash class implements the SHA-2 hash algorithm. @n * - * For more information on the class features, see Hashing. + * For more information on the class features, see Hashing. * * @see Tizen::Security::Crypto::IHash * @see Tizen::Security::Crypto::Md5Hash @@ -59,7 +59,7 @@ public: Sha2Hash(void); /** - * This destructor overrides Tizen::Base::Object::~Object(). + * This destructor overrides Tizen::Base::Object::~Object(). * * @since 2.0 */ @@ -71,7 +71,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] algorithm The name of the hash algorithm @n + * @param[in] algorithm The hash algorithm name @n * For example, "SHA2/224", "SHA2/256", "SHA2/384", or "SHA2/512". * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. @@ -79,7 +79,7 @@ public: virtual result SetAlgorithm(const Tizen::Base::String& algorithm); /** - * Gets the hashes of the data (single-part). + * Gets the hashes of the specified data (single-part). * * @since 2.0 * @@ -89,28 +89,30 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetHashN(const Tizen::Base::ByteBuffer& input) const; /** - * Initializes a multiple-part hash operation. + * Initializes the multiple-part hash operation. * * @since 2.0 * * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. */ virtual result Initialize(void); /** - * Updates a multiple-part hash operation while processing another data part. + * Updates the multiple-part hash operation while processing another data part. * * @since 2.0 * @@ -119,14 +121,15 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. */ virtual result Update(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part hash operation. + * Finalizes the multiple-part hash operation. * * @since 2.0 * @@ -134,9 +137,10 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* FinalizeN(void); diff --git a/inc/FSecCryptoSha2Hmac.h b/inc/FSecCryptoSha2Hmac.h index e2ba99a..54eca9a 100755 --- a/inc/FSecCryptoSha2Hmac.h +++ b/inc/FSecCryptoSha2Hmac.h @@ -39,7 +39,7 @@ namespace Tizen { namespace Security { namespace Crypto * * The %Sha2Hmac class implements the SHA-2 HMAC algorithm. @n * - * For more information on the class features, see Hashing. + * For more information on the class features, see Hashing. * * @see Tizen::Security::Crypto::IHmac * @see Tizen::Security::Crypto::Md5Hmac @@ -71,7 +71,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] algorithm The name of the HMAC algorithm @n + * @param[in] algorithm The HMAC algorithm name @n * For example, "HMACSHA2/224", "HMACSHA2/256", "HMACSHA2/384", or "HMACSHA2/512". * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_ALGORITHM The algorithm is not supported. @@ -92,7 +92,7 @@ public: virtual result SetKey(const Tizen::Security::ISecretKey& key); /** - * Gets the HMAC with the given input. + * Gets the HMAC for the specified input. * * @since 2.0 * @@ -103,15 +103,16 @@ public: * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetHmacN(const Tizen::Base::ByteBuffer& input) const; /** - * Initializes a multiple-part HMAC operation. + * Initializes the multiple-part HMAC operation. * * @since 2.0 * @@ -125,7 +126,7 @@ public: virtual result Initialize(void); /** - * Updates a multiple-part HMAC operation while processing another part of the data. + * Updates the multiple-part HMAC operation while processing another part of the data. * * @since 2.0 * @@ -134,14 +135,15 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. */ virtual result Update(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part HMAC operation. + * Finalizes the multiple-part HMAC operation. * * @since 2.0 * @@ -149,9 +151,10 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* FinalizeN(void); diff --git a/inc/FSecCryptoSkipJackCipher.h b/inc/FSecCryptoSkipJackCipher.h index 8c1f67b..44dfbd5 100755 --- a/inc/FSecCryptoSkipJackCipher.h +++ b/inc/FSecCryptoSkipJackCipher.h @@ -38,8 +38,8 @@ class _SymmetricCipher; * * @since 2.0 * - * The %SkipJackCipher class provides a symmetric cipher using the Skipjack algorithm. Appropriate values have to be set for the requested mode or key bit or - * padding scheme and the cipher operation (::CIPHER_ENCRYPT or ::CIPHER_DECRYPT) parameters. @n + * The %SkipJackCipher class provides a symmetric cipher using the Skipjack algorithm. @n + * This class allows to set appropriate values for the requested mode or key bit or padding scheme and the cipher operation (::CIPHER_ENCRYPT or ::CIPHER_DECRYPT) parameters. * * For more information on the class features, see Ciphers. * @@ -74,7 +74,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] transformation The name of the requested mode or padding scheme @n + * @param[in] transformation The requested mode or padding scheme @n * As the default key size of the Skipjack cipher is 80 bits, there is no need to mention it explicitly. * For example, "CBC/PKCS7PADDING" or "ECB/NOPADDING". * @param[in] opMode The cipher operation mode @n @@ -82,14 +82,15 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c opMode contains invalid value for the cipher operation. - * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n - * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() method is used, then the result obtained is @c null and an exception is returned. + * @remarks If @c opMode is not matching the actual operation, the result of the operation is @c null and an exception is returned. @n + * For example, if @c opMode is set to @c CIPHER_ENCRYPT, @c CIPHER_WRAP, or @c CIPHER_UNWRAP and the DecryptN() method is used, + * then the result obtained is @c null and an exception is returned. */ virtual result Construct(const Tizen::Base::String& transformation, enum CipherOperation opMode); /** - * Sets a symmetric key for encryption or decryption. + * Sets the symmetric key for encryption or decryption. * * @since 2.0 * @@ -118,7 +119,7 @@ public: * Encrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer @@ -128,10 +129,11 @@ public: * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* EncryptN(const Tizen::Base::ByteBuffer& input); @@ -139,9 +141,9 @@ public: * Decrypts the data (single-part). * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n - * else @c null if an error occurs + * else @c null if an error occurs * @param[in] input An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The input Tizen::Base::ByteBuffer is empty or contains invalid data. @@ -149,30 +151,32 @@ public: * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& input); /** - * Initializes a multiple-part encryption or decryption operation. + * Initializes the instance of %SkipJackCipher for the multiple-part encryption or decryption. * * @since 2.0 - * @pre Before calling this method, a secret key and an initial vector should be set using SetKey() and SetInitialVector(). + * @pre Before calling this method, set a secret key and an initial vector using SetKey() and SetInitialVector(). * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_KEY_NOT_FOUND The specified key is not found. * @exception E_INVALID_OPERATION The specified cipher operation mode for this method is invalid. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. */ virtual result Initialize(void); /** - * Updates a multiple-part encryption or decryption operation. + * Updates the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -183,15 +187,16 @@ public: * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. * @exception E_INVALID_ARG The specified instance of Tizen::Base::ByteBuffer is invalid or empty. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* UpdateN(const Tizen::Base::ByteBuffer& input); /** - * Finalizes a multiple-part encryption or decryption operation. + * Finalizes the multiple-part encryption or decryption operation. * * @since 2.0 * @@ -200,17 +205,18 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_OVERFLOW This operation has caused the memory to overflow. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or - * the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* FinalizeN(void); /** - * Wraps the specified key. + * Wraps a key. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n * else @c null if an error occurs @@ -222,15 +228,15 @@ public: virtual Tizen::Base::ByteBuffer* WrapN(const Tizen::Base::ByteBuffer& secretKey); /** - * Unwraps the specified wrapped key. + * Unwraps a previously wrapped key. * * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n - * else @c null if an error occurs + * else @c null if an error occurs * @param[in] wrappedKey The wrapped key to unwrap * @remarks - * - This operation is not supported in %SkipJackCipher. Therefore, this method always returns @c null. @n + * - This operation is not supported in %SkipJackCipher. Therefore, this method always returns @c null. * - The @c E_UNSUPPORTED_ALGORITHM exception is returned using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* UnwrapN(const Tizen::Base::ByteBuffer& wrappedKey); diff --git a/inc/FSecCryptoTypes.h b/inc/FSecCryptoTypes.h index 208c9b7..f8e4837 100755 --- a/inc/FSecCryptoTypes.h +++ b/inc/FSecCryptoTypes.h @@ -28,19 +28,19 @@ namespace Tizen { namespace Security { namespace Crypto { /** - * @enum CipherOperation + * @enum CipherOperation * * Defines the cipher operation. * - * @since 2.0 + * @since 2.0 */ enum CipherOperation { - CIPHER_ENCRYPT = 0, /**Key Management and CSPRNG. + * For more information on the class features, see Key Management and CSPRNG. * * @see ISecureRandom * @see AesSecureRandom @@ -53,21 +53,21 @@ public: /** * This is the default constructor for this class. * - * @since 2.0 + * @since 2.0 */ DesSecureRandom(void); /** - * This destructor overrides Tizen::Base::Object::~Object(). + * This destructor overrides Tizen::Base::Object::~Object(). * - * @since 2.0 + * @since 2.0 */ virtual ~DesSecureRandom(void); /** - * Generates a user-specified number of random bytes. + * Generates a user-defined number of random bytes. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class, @n * else @c null if an error occurs @@ -75,8 +75,8 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c numBytes is @c 0 or negative. - * @exception E_SYSTEM A system error has occurred. @n - * The Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM A system error has occurred. @n + * The Tizen::Base::ByteBuffer operation has failed. */ virtual Tizen::Base::ByteBuffer* GenerateRandomBytesN(int numBytes); diff --git a/inc/FSecIKey.h b/inc/FSecIKey.h index b00d0ec..5df7c25 100644 --- a/inc/FSecIKey.h +++ b/inc/FSecIKey.h @@ -15,7 +15,7 @@ // /** - * @file FSecIKey.h + * @file FSecIKey.h * @brief This is the header file for the %IKey interface. * * This header file contains the declarations of the %IKey interface. @@ -29,12 +29,14 @@ namespace Tizen { namespace Security { /** - * @interface IKey - * @brief This interface provides methods that help in setting the buffer for the key. These methods also extract the encoding format of the key. + * @interface IKey + * @brief This interface provides methods that help in setting the buffer for the key. These methods also extract + * the encoding format of the key. * * @since 2.0 * - * The %IKey interface provides methods that help in setting the buffer for the key. These methods also extract the encoding format of the key. @n + * The %IKey interface provides methods that help in setting the buffer for the key. These methods also extract the encoding + * format of the key. @n * * For more information on the class features, see Key Management and CSPRNG. * @@ -50,8 +52,8 @@ class _OSP_EXPORT_ IKey public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ diff --git a/inc/FSecIKeyPairGenerator.h b/inc/FSecIKeyPairGenerator.h index 58b0b92..e852930 100644 --- a/inc/FSecIKeyPairGenerator.h +++ b/inc/FSecIKeyPairGenerator.h @@ -15,7 +15,7 @@ // /** - * @file FSecIKeyPairGenerator.h + * @file FSecIKeyPairGenerator.h * @brief This is the header file for the %IKeyPairGenerator interface. * * This header file contains the declarations of the %IKeyPairGenerator interface. @@ -47,8 +47,8 @@ class _OSP_EXPORT_ IKeyPairGenerator public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -62,9 +62,10 @@ public: * @return An error code * @param[in] modulusBitSize The modulus size in bits * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c modulusBitSize is invalid. @n - * The modulus size must be atleast greater than or equal to @c 1024 bits @n - * to generate cryptographically secure keys. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - The specified @c modulusBitSize is invalid. + * - The modulus size must be atleast greater than or equal to @c 1024 bits + * to generate cryptographically secure keys. */ virtual result Construct(int modulusBitSize) = 0; @@ -78,9 +79,10 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_ALGORITHM The requested algorithm is not supported. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::KeyPair* GenerateKeyPairN(void) const = 0; diff --git a/inc/FSecIKeyParameters.h b/inc/FSecIKeyParameters.h index a9f1cb5..3f8b098 100644 --- a/inc/FSecIKeyParameters.h +++ b/inc/FSecIKeyParameters.h @@ -15,7 +15,7 @@ // /** - * @file FSecIKeyParameters.h + * @file FSecIKeyParameters.h * @brief This is the header file for the %IKeyParameters interface. * * This header file contains the declarations of the %IKeyParameters interface. @@ -46,22 +46,22 @@ class _OSP_EXPORT_ IKeyParameters public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ virtual ~IKeyParameters(void) {} /** - * Gets the value of the parameter for a specified key parameter type. + * Gets the value of the parameter for the specified key parameter type. * * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the parameter values, @n * else @c null if an error occurs * @param[in] paramType The type of the parameter @n - * For example, @c KEY_PARAMETER_DH_G. + * For example, @c KEY_PARAMETER_DH_G. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_UNSUPPORTED_TYPE The specified @c paramType is not supported. diff --git a/inc/FSecIPrivateKey.h b/inc/FSecIPrivateKey.h index 897f910..bfc0704 100644 --- a/inc/FSecIPrivateKey.h +++ b/inc/FSecIPrivateKey.h @@ -15,7 +15,7 @@ // /** - * @file FSecIPrivateKey.h + * @file FSecIPrivateKey.h * @brief This is the header file for the %IPrivateKey interface. * * This header file contains the declarations of the %IPrivateKey interface. @@ -46,24 +46,24 @@ class _OSP_EXPORT_ IPrivateKey public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * - * @since 2.0 + * @since 2.0 */ virtual ~IPrivateKey(void){} /** - * Gets the name of the primary encoding format of a key. + * Gets the name of the primary encoding format of the key. * * @since 2.0 * - * @return The primary encoding format of a key + * @return The primary encoding format of the key */ virtual Tizen::Base::String GetFormat(void) const = 0; /** - * Gets a private key in its primary encoding format. + * Gets the private key in its primary encoding format. * * @since 2.0 * @@ -71,7 +71,7 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetEncodedN(void) const = 0; diff --git a/inc/FSecIPublicKey.h b/inc/FSecIPublicKey.h index 62f7b7a..e9f1593 100644 --- a/inc/FSecIPublicKey.h +++ b/inc/FSecIPublicKey.h @@ -15,7 +15,7 @@ // /** - * @file FSecIPublicKey.h + * @file FSecIPublicKey.h * @brief This is the header file for the %IPublicKey interface. * * This header file contains the declarations of the %IPublicKey interface. @@ -46,32 +46,32 @@ class _OSP_EXPORT_ IPublicKey public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * - * @since 2.0 + * @since 2.0 */ virtual ~IPublicKey(void){} /** - * Gets the name of the primary encoding format of a key. + * Gets the name of the primary encoding format of the key. * * @since 2.0 * - * @return The primary encoding format of a key + * @return The primary encoding format of the key */ virtual Tizen::Base::String GetFormat(void) const = 0; /** - * Gets a public key in its primary encoding format. + * Gets the public key in its primary encoding format. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n - * else @c null if an error occurs + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetEncodedN(void) const = 0; diff --git a/inc/FSecISecretKey.h b/inc/FSecISecretKey.h index 1bb8e73..936590a 100644 --- a/inc/FSecISecretKey.h +++ b/inc/FSecISecretKey.h @@ -15,7 +15,7 @@ // /** - * @file FSecISecretKey.h + * @file FSecISecretKey.h * @brief This is the header file for the %ISecretKey interface. * * This header file contains the declarations of the %ISecretKey interface. @@ -31,11 +31,13 @@ namespace Tizen { namespace Security /** * @interface ISecretKey - * @brief This interface provides methods that help in setting the buffer for the key. These methods also extract the encoding format of the key. + * @brief This interface provides methods that help in setting the buffer for the key. These methods also extract + * the encoding format of the key. * * @since 2.0 * - * The %ISecretKey interface provides methods that help in setting the buffer for the key. These methods also extract the encoding format of the key. @n + * The %ISecretKey interface provides methods that help in setting the buffer for the key. These methods also extract the + * encoding format of the key. @n * * For more information on the class features, see Key Management and CSPRNG. * @@ -46,8 +48,8 @@ class _OSP_EXPORT_ ISecretKey public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -71,7 +73,7 @@ public: * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetEncodedN(void) const = 0; diff --git a/inc/FSecISecretKeyGenerator.h b/inc/FSecISecretKeyGenerator.h index c6c827f..563c67e 100644 --- a/inc/FSecISecretKeyGenerator.h +++ b/inc/FSecISecretKeyGenerator.h @@ -34,7 +34,7 @@ namespace Tizen { namespace Security * @interface ISecretKeyGenerator * @brief This interface provides the abstract methods for generating a secret (symmetric) key. * - * @since 2.0 + * @since 2.0 * * The %ISecretKeyGenerator interface provides the abstract methods for generating a secret (symmetric) key. @n * @@ -47,10 +47,10 @@ class _OSP_EXPORT_ ISecretKeyGenerator public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * - * @since 2.0 + * @since 2.0 */ virtual ~ISecretKeyGenerator(void) {} @@ -63,9 +63,10 @@ public: * else @c null if the secret key generation fails * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::ISecretKey* GenerateKeyN(void) = 0; diff --git a/inc/FSecISecureRandom.h b/inc/FSecISecureRandom.h index d873417..bdefc20 100644 --- a/inc/FSecISecureRandom.h +++ b/inc/FSecISecureRandom.h @@ -33,11 +33,11 @@ namespace Tizen { namespace Security * @interface ISecureRandom * @brief This interface provides the abstract methods for generating a secure random object. * - * @since 2.0 + * @since 2.0 * - * The %ISecureRandom interface provides the abstract methods for generating a secure random object. @n + * The %ISecureRandom interface provides the abstract methods for generating a secure random object. @n * - * For more information on the class features, see Key Management and CSPRNG. + * For more information on the class features, see Key Management and CSPRNG. * * @see Tizen::Security::AesSecureRandom * @see Tizen::Security::DesSecureRandom @@ -48,8 +48,8 @@ class _OSP_EXPORT_ ISecureRandom public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes @n - * are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -66,10 +66,11 @@ public: * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c numBytes is @c 0 or negative. - * @exception E_SYSTEM A system error has occurred. @n - * The method has failed to operate with the OpenSSL library, or the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. - + * @exception E_SYSTEM Either of the following conditions has occurred: + * - A system error has occurred. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GenerateRandomBytesN(int numBytes) = 0; diff --git a/inc/FSecKeaKeyParameters.h b/inc/FSecKeaKeyParameters.h index c7fb1de..2c9e7d4 100644 --- a/inc/FSecKeaKeyParameters.h +++ b/inc/FSecKeaKeyParameters.h @@ -102,17 +102,17 @@ class _OSP_EXPORT_ KeaKeyParameters public: /** - * The object is not fully constructed after this constructor is called. For full construction, @n - * the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. For full construction, @n + * the Construct() method must be called right after calling this constructor. * - * @since 2.0 + * @since 2.0 */ KeaKeyParameters(void); /** - * This destructor overrides Tizen::Base::Object::~Object(). + * This destructor overrides Tizen::Base::Object::~Object(). * - * @since 2.0 + * @since 2.0 */ virtual ~KeaKeyParameters(void); @@ -122,12 +122,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] primeNumber The prime number to instantiate - * @param[in] generatorNumber The generator value to instantiate - * @param[in] privateKeySize The size of the private key to instantiate - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @param[in] primeNumber The prime number to instantiate + * @param[in] generatorNumber The generator value to instantiate + * @param[in] privateKeySize The size of the private key to instantiate + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_OUT_OF_MEMORY The memory is insufficient. * */ result Construct(const Tizen::Base::ByteBuffer& primeNumber, const Tizen::Base::ByteBuffer& generatorNumber, int privateKeySize); @@ -140,7 +140,7 @@ public: * @return A pointer to the Tizen::Base::ByteBuffer class that contains the parameter values, @n * else @c null if an error occurs * @param[in] paramType The parameter type @n - * For example, @c KEY_PARAMETER_KEA_P. + * For example, @c KEY_PARAMETER_KEA_P. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_UNSUPPORTED_TYPE The specified @c paramType is not supported. diff --git a/inc/FSecKeyPair.h b/inc/FSecKeyPair.h index 1496d48..42c8e30 100644 --- a/inc/FSecKeyPair.h +++ b/inc/FSecKeyPair.h @@ -33,18 +33,19 @@ namespace Tizen { namespace Security { /** - * @class KeyPair - * @brief This class is a simple holder for a key pair (a public and a private key). + * @class KeyPair + * @brief This class is a simple holder for a key pair (a public and a private key). * - * @since 2.0 + * @since 2.0 * - * The %KeyPair class manages a pair of keys comprising of a public and a private key, which are used in asymmetric ciphers. The key pairs are mainly used to encrypt messages and provide digital signatures. @n + * The %KeyPair class manages a pair of keys comprising of a public and a private key, which are used in asymmetric ciphers. + * The key pairs are mainly used to encrypt messages and provide digital signatures. @n * * For more information on the class features, see Key Management and CSPRNG. * - * @see IKeyPairGenerator - * @see Tizen::Security::IPublicKey - * @see Tizen::Security::IPrivateKey + * @see IKeyPairGenerator + * @see Tizen::Security::IPublicKey + * @see Tizen::Security::IPrivateKey */ class _OSP_EXPORT_ KeyPair : public Tizen::Base::Object diff --git a/inc/FSecKeyPairGenerator.h b/inc/FSecKeyPairGenerator.h index 56195de..fb272a2 100755 --- a/inc/FSecKeyPairGenerator.h +++ b/inc/FSecKeyPairGenerator.h @@ -31,17 +31,19 @@ namespace Tizen { namespace Security { /** - * @class KeyPairGenerator - * @brief This class provides a pair of public and private keys for the Public key algorithm. + * @class KeyPairGenerator + * @brief This class provides methods for generating a pair of public and private keys for the Public key algorithm. * - * @since 2.0 + * @since 2.0 * - * The %KeyPairGenerator class generates a key pair and its parameters that consists of a public and private key. These are used in asymmetric ciphers. The generated key pair and parameters are based on the underlying key pair encryption algorithm. @n + * The %KeyPairGenerator class generates a key pair and its parameters that consists of a public and private key. + * These are used in asymmetric ciphers. The generated key pair and parameters are based on the underlying key pair + * encryption algorithm. @n * - * For more information on the class features, see Key Management and CSPRNG. + * For more information on the class features, see Key Management and CSPRNG. * - * @see Tizen::Security::IKeyPairGenerator - * @see Tizen::Security::KeyPair + * @see Tizen::Security::IKeyPairGenerator + * @see Tizen::Security::KeyPair */ class _OSP_EXPORT_ KeyPairGenerator : public virtual IKeyPairGenerator @@ -50,17 +52,17 @@ class _OSP_EXPORT_ KeyPairGenerator public: /** - * The object is not fully constructed after this constructor is called. For full construction, @n - * the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. For full construction, @n + * the Construct() method must be called right after calling this constructor. * - * @since 2.0 + * @since 2.0 */ KeyPairGenerator(void); /** - * This destructor overrides Tizen::Base::Object::~Object(). + * This destructor overrides Tizen::Base::Object::~Object(). * - * @since 2.0 + * @since 2.0 */ virtual ~KeyPairGenerator(void); @@ -70,29 +72,30 @@ public: * @since 2.0 * * @return An error code - * @param[in] modulusBitSize The modulus size in bits + * @param[in] modulusBitSize The modulus size in bits * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified size is invalid. @n - * The modulus size must be at least greater than or equal to @c 1024 bits @n - * to generate cryptographically secure keys. + * The modulus size must be at least greater than or equal to @c 1024 bits + * to generate cryptographically secure keys. */ virtual result Construct(int modulusBitSize); /** * Constructs and initializes an instance of %KeyPairGenerator with the specified parameters. * - * @since 2.0 + * @since 2.0 * * @return An error code * @param[in] modulusBitSize The modulus size in bits @n * This is used for key generation. - * @param[in] algorithm The algorithm used to generate the key parameters @n + * @param[in] algorithm The algorithm used to generate the key parameters @n * The supported algorithms are RSA, DH, and KEA. The default value is RSA. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified size is invalid. @n - * @exception E_UNSUPPORTED_ALGORITHM The requested @c algorithm is not supported. @n - * The modulus size must be at least greater than or equal to @c 1024 bits @n - * to generate cryptographically secure keys. + * @exception E_UNSUPPORTED_ALGORITHM Either of the following conditions has occurred: + * - The requested @c algorithm is not supported. + * - The modulus size must be at least greater than or equal to @c 1024 bits + * to generate cryptographically secure keys. */ result Construct(int modulusBitSize, Tizen::Base::String algorithm); @@ -104,11 +107,11 @@ public: * The generated key parameters may be required to create a key pair. The RSA algorithm * does not call this method to generate a key pair. * - * @since 2.0 + * @since 2.0 * - * @return A pointer to the IKeyParameters class that contains a subset of the domain parameters ('p' prime - * number, 'g' generator) that are used to generate a key pair, @n - * else @c null if the method fails to create the key parameters + * @return A pointer to the IKeyParameters instance that contains a subset of the domain parameters ('p' prime + * number, 'g' generator) that are used to generate the key pair, @n + * else @c null if the method fails to create the key parameters * @param[in] lInBits The size of 'p', a prime number in bits @n * The size must be @c 1024 bits, @c 2048 bits, or @c 3072 bits. * @param[in] nInBits The size of 'g', a generator value in bits @n @@ -118,8 +121,10 @@ public: * - 256 bits, when @c lInBits is @c 3072 bits. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. @n - * The method has failed to operate with the OpenSSL library, or the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - The method cannot proceed due to a severe system error. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Security::IKeyParameters* GenerateKeyParametersN(int lInBits = 1024, int nInBits = 160) const; @@ -129,14 +134,16 @@ public: * * @since 2.0 * - * @return A pointer to the KeyPair class, @n + * @return A pointer to the KeyPair instance, @n * else @c null if the method fails to create the key pair - * @param[in] pKeyParams The domain parameters of the key exchange algorithm @n + * @param[in] pKeyParams The domain parameters of the key exchange algorithm @n * These parameters are instantiated. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. @n - * The method has failed to operate with the OpenSSL library, or the Tizen::Base::ByteBuffer operation has failed. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - The method cannot proceed due to a severe system error. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Security::KeyPair* GenerateKeyPairN(Tizen::Security::IKeyParameters* pKeyParams) const; @@ -146,14 +153,16 @@ public: * * @since 2.0 * - * @return A pointer to the KeyPair class, @n - else @c null if the method fails to create the key pair. - * Default key format will be pkcs1 for private key and x509 for public key. + * @return A pointer to the KeyPair instance, @n + * else @c null if the method fails to create the key pair. @n + * The default key format will be pkcs1 for private key and x509 for public key. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. @n - * The method has failed to operate with the OpenSSL library, or the Tizen::Base::ByteBuffer operation has failed. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM Either of the following conditions has occurred: + * - The method cannot proceed due to a severe system error. + * - The method has failed to operate with the OpenSSL library. + * - The Tizen::Base::ByteBuffer operation has failed. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::KeyPair* GenerateKeyPairN(void) const; @@ -179,7 +188,7 @@ private: class _KeyPairGeneratorImpl* __pKeyPairGeneratorImpl; friend class _KeyPairGeneratorImpl; -}; //KeyPairGenerator +}; //KeyPairGenerator } } //Tizen::Security diff --git a/inc/FSecPkcs.h b/inc/FSecPkcs.h index 3bff801..fa39748 100755 --- a/inc/FSecPkcs.h +++ b/inc/FSecPkcs.h @@ -39,12 +39,12 @@ #include /** - * @namespace Tizen::Security::Pkcs - * @brief This namespace contains classes and interfaces for managing the PKCS 5 and 8 implementation. - * @since 2.1 + * @namespace Tizen::Security::Pkcs + * @brief This namespace contains classes and interfaces for managing the PKCS 5 and 8 implementation. + * @since 2.1 * - * @remarks @b Header @b %file: @b \#include @b @n - * @b Library : @b osp-appfw + * @remarks @b Header @b %file: @b \#include @b @n + * @b Library: @b osp-appfw * * * The %Pkcs namespace provides classes and interfaces for managing PKCS 5 and 8 implementation. @@ -52,7 +52,7 @@ * mac genaration/verification. * It also provides a standard format to store private key and encrypted private key. * - * For more information on the %Pkcs namespace features, see Pkcs Guide. @n + * For more information on the %Pkcs namespace features, see Pkcs Guide. @n * * The following diagram illustrates the relationships between the classes belonging to the %Pkcs namespace. * @image html security_pkcs_classdiagram.png diff --git a/inc/FSecPkcsAlgorithmIdentifier.h b/inc/FSecPkcsAlgorithmIdentifier.h index e67efab..4c8f7ae 100755 --- a/inc/FSecPkcsAlgorithmIdentifier.h +++ b/inc/FSecPkcsAlgorithmIdentifier.h @@ -38,10 +38,10 @@ namespace Tizen { namespace Security { namespace Pkcs * @since 2.1 * * The %AlgorithmIdentifier class implements the ASN.1 specified %AlgorithmIdentifier, which is used for - * creating the standard %AlgorithmIdentifier object. - * %AlgorithmIdentifier structure consists the OID value of the algorithm along with the parameters of that algorithm. + * creating the standard %AlgorithmIdentifier object. The %AlgorithmIdentifier structure consists of the OID value of the + * algorithm along with the parameters of the algorithm. * - * This is defined in ASN.1 as demonstrated in the following code: + * This is defined in ASN.1 as demonstrated in the following code: * @code * AlgorithmIdentifier { ALGORITHM-IDENTIFIER:InfoObjectSet } * ::= @@ -74,45 +74,47 @@ public: virtual ~AlgorithmIdentifier(void); /** - * Initializes the %AlgorithmIdentifier with supplied input parameter values. + * Initializes the %AlgorithmIdentifier with the specified input parameter values. * * @since 2.1 * * @return An error code * @param[in] objectId The object identifier of a particular algorithm @n - * Object IDs are defined by standard bodies for algorithms and other crypto objects. - * Object ID of %AlgorithmIdentifier can be described in string format like 1.2.3.4 + * The object IDs are defined by standard bodies for algorithms and other crypto objects. @n + * The object ID of %AlgorithmIdentifier can be described in string format like 1.2.3.4 * @param[in] pParams A pointer to the AlgorithmParameters object @n - * This is an optional parameter and contains a list of user specified input parameters for the specified algorithm. For example, for Symmetric algorithms Initial vector, IV is required as an input. The default value of this parameter is @c null. - * @exception E_SUCCESS The method is successful. + * This is an optional parameter and contains a list of user specified input parameters for + * the specified algorithm. For example, for Symmetric algorithms Initial vector, IV is required + * as an input. The default value of this parameter is @c null. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. * @exception E_UNSUPPORTED_ALGORITHM The object ID of the input algorithm is not supported. */ result Construct(const Tizen::Base::String& objectId, const IAlgorithmParameters* pParams = null); /** - * Initializes this instance of %AlgorithmIdentifier with the DER encoded Tizen::Base::ByteBuffer that contains @n + * Initializes this instance of %AlgorithmIdentifier with the DER encoded Tizen::Base::ByteBuffer that contains * the ASN.1 specified %AlgorithmIdentifier structure. * * @since 2.1 * * @return An error code - * @param[in] encodedData An instance of DER encoded Tizen::Base::ByteBuffer - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. + * @param[in] encodedData An instance of DER encoded Tizen::Base::ByteBuffer + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& encodedData); /** * Checks whether the specified instance of %AlgorithmIdentifier equals the current instance. * - * @since 2.1 + * @since 2.1 * * @return @c true if the specified instance equals the current instance, @n - * else @c false - * @param[in] rhs An instance of %AlgorithmIdentifier - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. + * else @c false + * @param[in] rhs An instance of %AlgorithmIdentifier + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual bool Equals(const Tizen::Base::Object& rhs) const; @@ -127,12 +129,12 @@ public: virtual int GetHashCode(void) const; /** - * Gets the copy of %AlgorithmIdentifier instance. + * Gets the copy of the %AlgorithmIdentifier instance. * * @since 2.1 * - * @return Pointer to %AlgorithmIdentifier, containing the copy of the specified instance, @n - * else @c null if an error occurs + * @return A pointer to the %AlgorithmIdentifier instance that is the copy of the specified instance, @n + * else @c null if an error occurs * @remarks The specific error code can be accessed using the GetLastResult() method. */ AlgorithmIdentifier* CloneN(void) const; @@ -142,8 +144,8 @@ public: * * @since 2.1 * - * @return Pointer to IAlgorithmParameters, containing the parameter list of algorithm, @n - * else @c null if an no parameters exist + * @return A pointer to the IAlgorithmParameters instance containing the parameter list of algorithm, @n + * else @c null if no parameters exist * @remarks The specific error code can be accessed using the GetLastResult() method. */ IAlgorithmParameters* GetParametersN(void) const; @@ -151,9 +153,9 @@ public: /** * Gets the object ID value of an algorithm in string format. * - * @since 2.1 + * @since 2.1 * - * @return Object ID of %AlgorithmIdentifier in string format like 1.2.3.4 + * @return The object ID of %AlgorithmIdentifier in string format like 1.2.3.4 * */ Tizen::Base::String GetAlgorithmObjectId(void) const; @@ -164,8 +166,8 @@ public: * * @since 2.1 * - * @return Pointer to the DER encoded Tizen::Base::ByteBuffer, @n - * else @c null if an error occurs + * @return A pointer to the DER encoded Tizen::Base::ByteBuffer, @n + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. diff --git a/inc/FSecPkcsIAlgorithmParameters.h b/inc/FSecPkcsIAlgorithmParameters.h index a9c7f15..1ba2f3c 100755 --- a/inc/FSecPkcsIAlgorithmParameters.h +++ b/inc/FSecPkcsIAlgorithmParameters.h @@ -31,14 +31,14 @@ namespace Tizen { namespace Security { namespace Pkcs /** * @interface IAlgorithmParameters - * @brief This interface is an interface class for cryptographic algorithm parameters such as IV, etc. It provides the generic - * functionalities that must be supported by all derived algorithm parameters such PbKdf2Parameters, PbEs2Parameters. + * @brief This interface is an interface class for cryptographic algorithm parameters such as IV. It provides the generic + * functionalities that must be supported by all the derived algorithm parameters such PbKdf2Parameters, PbEs2Parameters. * * @since 2.1 * - * The %IAlgorithmParameters interface is an interface class for cryptographic algorithm parameters such as IV, etc. It provides the generic - * functionalities that must be supported by all derived algorithm parameters such PbKdf2Parameters, PbEs2Parameters. - * This is an abstract class and hence, object of this class cannot be instantiated. + * The %IAlgorithmParameters interface is an interface class for cryptographic algorithm parameters such as IV. It provides the generic + * functionalities that must be supported by all derived algorithm parameters such PbKdf2Parameters, PbEs2Parameters. + * This is an abstract class and hence, object of this class cannot be instantiated. * */ @@ -46,20 +46,20 @@ class _OSP_EXPORT_ IAlgorithmParameters { public: /** - * This polymorphic destructor should be overridden if required. This way, @n - * the destructors of the derived classes are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.1 */ virtual ~IAlgorithmParameters(void) {} /** - * Gets the copy of parameters of the specified algorithm type. + * Gets the copy of the parameters of the specified algorithm type. * - * @since 2.1 + * @since 2.1 * - * @return Pointer to AlgorithmParameters, containing the instance of algorithm parameter , @n - * else @c null if an error occurs + * @return A pointer to AlgorithmParameters, containing the instance of algorithm parameter , @n + * else @c null if an error occurs * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual IAlgorithmParameters* CloneN(void) const = 0; @@ -67,9 +67,9 @@ public: /** * Gets the PKCS algorithm parameter type enumerated value. * - * @since 2.1 + * @since 2.1 * - * @return PkcsAlgorithmParamterType, containing the enumerated value of PkcsAlgorithmParameterType + * @return The type containing the enumerated value of PkcsAlgorithmParameterType * */ virtual PkcsAlgorithmParameterType GetType(void) const = 0; @@ -82,7 +82,7 @@ protected: // // This method is reserved and may change its name at any time without prior notice. // - // @since 2.1 + // @since 2.1 // virtual void IAlgorithmParameters_Reserved1(void) {} @@ -92,7 +92,7 @@ protected: // // This method is reserved and may change its name at any time without prior notice. // - // @since 2.1 + // @since 2.1 // virtual void IAlgorithmParameters_Reserved2(void) {} @@ -102,7 +102,7 @@ protected: // // This method is reserved and may change its name at any time without prior notice. // - // @since 2.1 + // @since 2.1 // virtual void IAlgorithmParameters_Reserved3(void) {} diff --git a/inc/FSecPkcsInitialVector.h b/inc/FSecPkcsInitialVector.h index c9695af..dc09cde 100755 --- a/inc/FSecPkcsInitialVector.h +++ b/inc/FSecPkcsInitialVector.h @@ -38,8 +38,8 @@ namespace Tizen { namespace Security { namespace Pkcs * @since 2.1 * * The %InitialVector class implements the functionalities specified by the %InitialVector class. - * This class represents the Initial Vector parameter for symmetric ciphers such as DES, AES, DES_EDE. - * This %InitialVector parameters will be used by both PKCS05 and PKCS08 related classes at the time of encryption. + * This class represents the Initial Vector parameter for symmetric ciphers such as DES, AES, DES_EDE. + * This %InitialVector parameters will be used by both PKCS05 and PKCS08 related classes at the time of encryption. * * */ @@ -73,18 +73,18 @@ public: * * @return An error code * - * @param[in] initialVector An instance of Tizen::Base::ByteBuffer, holding the initial vector data - * @exception E_SUCCESS The method is successful. + * @param[in] initialVector An instance of Tizen::Base::ByteBuffer holding the initial vector data + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& initialVector); /** - * Gets copy of this instance. + * Gets a copy of this instance. * * @since 2.1 * - * @return A pointer to IAlgorithmParameters, containing the copy of this instance + * @return A pointer to IAlgorithmParameters containing the copy of this instance * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual IAlgorithmParameters* CloneN(void) const; @@ -94,7 +94,7 @@ public: * * @since 2.1 * - * @return PkcsAlgorithmParameterType Enum value containing the PKCS_ALGO_PARAM_TYPE_IV value for Initial Vector parameter + * @return PkcsAlgorithmParameterType The enum value containing the @c PKCS_ALGO_PARAM_TYPE_IV value for Initial Vector parameter * */ virtual PkcsAlgorithmParameterType GetType(void) const; @@ -105,10 +105,10 @@ public: * @since 2.1 * * @return @c true if the specified instance equals the current instance, @n - * else @c false + * else @c false * @param[in] rhs An instance of %InitialVector - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual bool Equals(const Tizen::Base::Object& rhs) const; @@ -123,7 +123,7 @@ public: virtual int GetHashCode(void) const; /** - * Gets the instance of Tizen::Base::ByteBuffer that contains the Initial Vector value. + * Gets an instance of Tizen::Base::ByteBuffer that contains the Initial Vector value. * * @since 2.1 * @@ -132,13 +132,13 @@ public: const Tizen::Base::ByteBuffer& GetInitialVector(void) const; /** - * Gets the encoded form of the InitialVector. @n - * It is assumed that each InitialVector type will have only a single form of encoding that is DER encoding. + * Gets the encoded form of the %InitialVector. @n + * It is assumed that each %InitialVector type will have only a single form of encoding that is DER encoding. * * @since 2.1 * - * @return Pointer to the DER encoded Tizen::Base::ByteBuffer, @n - * else @c null if an error occurs + * @return A pointer to the DER encoded Tizen::Base::ByteBuffer, @n + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. diff --git a/inc/FSecPkcsPkcs05PbEs2Parameters.h b/inc/FSecPkcsPkcs05PbEs2Parameters.h index 92381b8..c6a7af5 100755 --- a/inc/FSecPkcsPkcs05PbEs2Parameters.h +++ b/inc/FSecPkcsPkcs05PbEs2Parameters.h @@ -35,16 +35,15 @@ namespace Tizen { namespace Security { namespace Pkcs /** * @class Pkcs05PbEs2Parameters - * @brief This class implements the functionalities specified by the PKCS05 encryption scheme 2. + * @brief This class provides methods for the functionalities specified by the PKCS05 encryption scheme 2. * * @since 2.1 * * The %Pkcs05PbEs2Parameters class implements the functionalities specified by the PKCS05 encryption scheme 2. - * PBES2 combines a password-based key derivation function, which is PBKDF2 - * for PKCS #5 version 2.1, with an underlying encryption scheme. - * The key length and any other parameters for the underlying encryption scheme depends on the scheme. + * PBES2 combines a password-based key derivation function, which is PBKDF2 for PKCS #5 version 2.1, with an underlying + * encryption scheme. The key length and any other parameters for the underlying encryption scheme depends on the scheme. * - * This is defined in ASN.1 as demonstrated in the following code: + * This is defined in ASN.1 as demonstrated in the following code: * @code * PBES2-params ::= SEQUENCE { * keyDerivationFunc AlgorithmIdentifier {{PBES2-KDFs}}, @@ -76,26 +75,27 @@ public: virtual ~Pkcs05PbEs2Parameters(void); /** - * Initializes this instance of %Pkcs05PbEs2Parameters with the encoded Tizen::Base::ByteBuffer, which contain Password Based Encryption Parameters Structure(PBES2) in ASN.1 DER format. + * Initializes this instance of %Pkcs05PbEs2Parameters with the specified encoded Tizen::Base::ByteBuffer, which contains + * Password Based Encryption Parameters Structure(PBES2) in ASN.1 DER format. * * @since 2.1 * * @return An error code * @param[in] encodedData The DER encoded Tizen::Base::ByteBuffer containing %Pkcs05PbEs2Parameters - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& encodedData); /** - * Initializes this %Pkcs05PbEs2Parameters with specified input parameters values. + * Initializes this %Pkcs05PbEs2Parameters with the specified input parameters values. * * @since 2.1 * * @return An error code - * @param[in] keyDerivationFunction An instance of AlgorithmIdentifier, holding key derivation function - * @param[in] encryptionScheme An instance of AlgorithmIdentifier, holding encryption scheme - * @exception E_SUCCESS The method is successful. + * @param[in] keyDerivationFunction An instance of AlgorithmIdentifier holding key derivation function + * @param[in] encryptionScheme An instance of AlgorithmIdentifier holding encryption scheme + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const AlgorithmIdentifier& keyDerivationFunction, const AlgorithmIdentifier& encryptionScheme); @@ -106,8 +106,8 @@ public: * * @since 2.1 * - * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n - * else @c null if an error occurs + * @return A pointer to the Tizen::Base::ByteBuffer instance that contains the output, @n + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -115,30 +115,30 @@ public: Tizen::Base::ByteBuffer* GetEncodedDataN(void) const; /** - * Gets the reference to the AlgorithmIdentifier instance, which identifies the underlying key derivation function. @n - * It will be an algorithm ID with an OID in the set PBES2-KDFs, which for this version of PKCS #5 will consist of id-PBKDF2. + * Gets a reference to the AlgorithmIdentifier instance, which identifies the underlying key derivation function. @n + * It will be an algorithm ID with an OID in the set PBES2-KDFs, which will consist of id-PBKDF2 for this version of PKCS #5. * * @since 2.1 * - * @return A reference to AlgorithmIdentifier holding the underlying key derivation function + * @return A reference to the AlgorithmIdentifier instance holding the underlying key derivation function * @remarks The specific error code can be accessed using the GetLastResult() method. */ const AlgorithmIdentifier& GetKeyDerivationAlgorithm(void) const; /** - * Gets the reference to the AlgorithmIdentifier instance, which identifies the underlying encryption algorithm. @n + * Gets a reference to the AlgorithmIdentifier instance, which identifies the underlying encryption algorithm. @n * It shall be an OID in the set PBES2-Encs, whose definition is left to the application. * * @since 2.1 * - * @return A reference to AlgorithmIdentifier holding the underlying encryption algorithm + * @return A reference to the AlgorithmIdentifier instance holding the underlying encryption algorithm * @remarks The specific error code can be accessed using the GetLastResult() method. */ const AlgorithmIdentifier& GetEncryptionScheme(void) const; /** * Gets the AlgorithmParameters that identifies the underlying parameters such as PbKdf2, PbEs2, PbMac1. @n - * For this class %AlgorithmParameters will be of PBES2 type. + * For this class, %AlgorithmParameters will be of PBES2 type. * * @since 2.1 * @@ -154,7 +154,7 @@ public: * * @since 2.1 * - * @return PkcsAlgorithmParameterType holding enum value @c PKCS_ALGO_PARAM_TYPE_PKCS05_PBES02 for PBES2 Parameters + * @return The PkcsAlgorithmParameterType instance holding the enum value @c PKCS_ALGO_PARAM_TYPE_PKCS05_PBES02 for PBES2 Parameters * */ virtual PkcsAlgorithmParameterType GetType(void) const; @@ -166,9 +166,9 @@ public: * * @return @c true if the specified instance equals the current instance, @n * else @c false - * @param[in] rhs An instance of %Pkcs05PbEs2Parameters + * @param[in] rhs An instance of %Pkcs05PbEs2Parameters * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_INVALID_ARG The specified input parameter is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual bool Equals(const Tizen::Base::Object& rhs) const; diff --git a/inc/FSecPkcsPkcs05PbKdf2Parameters.h b/inc/FSecPkcsPkcs05PbKdf2Parameters.h index a04945b..e3d2d9d 100755 --- a/inc/FSecPkcsPkcs05PbKdf2Parameters.h +++ b/inc/FSecPkcsPkcs05PbKdf2Parameters.h @@ -34,15 +34,15 @@ namespace Tizen { namespace Security { namespace Pkcs /** * @class Pkcs05PbKdf2Parameters - * @brief This class implements the functionalities specified by the PKCS05 KDF2 scheme. + * @brief This class provides methods for the functionalities specified by the PKCS05 KDF2 scheme. * * @since 2.1 * - * The %Pkcs05PbKdf2Parameters class implements the functionalities specified by the PKCS05 KDF2 scheme. PBKDF2 applies a pseudo random function to derive - * keys. The length of the derived key is essentially unbounded. However, the maximum effective search space for the derived key can - * be limited by the structure of the underlying pseudo random function. + * The %Pkcs05PbKdf2Parameters class provides methods for the functionalities specified by the PKCS05 KDF2 scheme. PBKDF2 applies a pseudo + * random function to derive keys. The length of the derived key is essentially unbounded. However, the maximum effective search + * space for the derived key can be limited by the structure of the underlying pseudo random function. * - * This is defined in ASN.1 as demonstrated in the following code: + * This is defined in ASN.1 as demonstrated in the following code: * @code * PBKDF2-params ::= SEQUENCE { * salt CHOICE { @@ -79,56 +79,56 @@ public: virtual ~Pkcs05PbKdf2Parameters(void); /** - * Initializes this instance of %Pkcs05PbKdf2Parameters with the encoded Tizen::Base::ByteBuffer that contains Password Based Key Derivation Function parameters structure(PBKDF2) in ASN.1 DER format. - * + * Initializes this instance of %Pkcs05PbKdf2Parameters with the encoded Tizen::Base::ByteBuffer that contains Password + * Based Key Derivation Function parameters structure(PBKDF2) in ASN.1 DER format. + * * @since 2.1 * * @return An error code - * @param[in] encodedData DER encoded Tizen::Base::ByteBuffer of %Pkcs05PbKdf2Parameters - * @exception E_SUCCESS The method is successful. + * @param[in] encodedData The DER encoded Tizen::Base::ByteBuffer of %Pkcs05PbKdf2Parameters + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& encodedData); /** - * Initializes the %Pkcs05PbKdf2Parameters with specified input parameters values. + * Initializes the %Pkcs05PbKdf2Parameters with the specified input parameters values. * * @since 2.1 * * @return An error code - * @param[in] saltBuffer An instance of Tizen::Base::ByteBuffer, holding salt value - * @param[in] iterationCount Integer value holding the positive integer specifying iteration count - * for generation of password based key - * @param[in] derivedKeyLength Positive integer specifying length of password based key to generate - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. + * @param[in] saltBuffer An instance of Tizen::Base::ByteBuffer holding salt value + * @param[in] iterationCount The positive integer specifying iteration count for generation of password based key + * @param[in] derivedKeyLength The positive integer specifying the length of the password based key + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. * @remarks In this case, when pseudo random function algorithm is not passed, then default HMAC-SHA1 will be used. */ result Construct(const Tizen::Base::ByteBuffer& saltBuffer, int iterationCount, int derivedKeyLength = 0); /** - * Initializes this %Pkcs05PbKdf2Parameters with supplied input parameters values. + * Initializes this %Pkcs05PbKdf2Parameters instance with the specified input parameters values. * * @since 2.1 * * @return An error code - * @param[in] saltBuffer An instance of Tizen::Base::ByteBuffer, holding salt value - * @param[in] iterationCount Integer value holding the positive integer specifying iteration count - * for generation of password based key - * @param[in] prf An instance of AlgorithIdentifier, holding the underlying pseudo random function to use to generate a password based key - * @param[in] derivedKeyLength Positive integer specifying length of password based key to generate - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. + * @param[in] saltBuffer An instance of Tizen::Base::ByteBuffer holding salt value + * @param[in] iterationCount The positive integer specifying iteration count for generation of password based key + * @param[in] prf The AlgorithIdentifier instance holding the underlying pseudo random function to use + * to generate a password based key + * @param[in] derivedKeyLength The positive integer specifying the length of the password based key + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& saltBuffer, int iterationCount, const AlgorithmIdentifier& prf, int derivedKeyLength = 0); /** - * Gets the encoded form of the %Pkcs05PbKdf2Parameters. @n + * Gets the encoded form of the %Pkcs05PbKdf2Parameters instance. @n * It is assumed that each %Pkcs05PbKdf2Parameters will have only a single form of encoding, for example: ASN.1 DER. * * @since 2.1 * - * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n + * @return A pointer to the Tizen::Base::ByteBuffer instance that contains the output, @n * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -141,7 +141,7 @@ public: * * @since 2.1 * - * @return A reference to salt Tizen::Base::ByteBuffer containing the specified salt value + * @return A reference to the Tizen::Base::ByteBuffer instance containing the specified salt value * @remarks The specific error code can be accessed using the GetLastResult() method. */ const Tizen::Base::ByteBuffer& GetSaltValue(void) const; @@ -169,7 +169,7 @@ public: int GetDerivedKeyLength(void) const; /** - * Gets the reference to the AlgorithmIdentifier that identifies the underlying pseudo random function. + * Gets a reference to AlgorithmIdentifier that identifies the underlying pseudo random function. * * @since 2.1 * @@ -180,12 +180,12 @@ public: /** * - * Gets the pointer to the AlgorithmParameters that identifies the underlying parameters such as PbKdf2,PbEs2,PbMac1. @n - * For this class %AlgorithmParameters will be of PbKdf2 type. + * Gets a pointer to AlgorithmParameters that identifies the underlying parameters such as PbKdf2,PbEs2,PbMac1. @n + * For this class, %AlgorithmParameters will be of PbKdf2 type. * * @since 2.1 * - * @return Pointer to IAlgorithmParameters containing the algorithm identifier of underlying pseudo random function, @n + * @return A pointer to IAlgorithmParameters containing the algorithm identifier of underlying pseudo random function, @n * else @c null if an error occurs * @remarks The specific error code can be accessed using the GetLastResult() method. */ @@ -196,7 +196,7 @@ public: * * @since 2.1 * - * @return PkcsAlgorithmParameterType holding enum value @c PKCS_ALGO_PARAM_TYPE_PKCS05_KDF02 for KDF2 Parameters + * @return The PkcsAlgorithmParameterType instance holding the enum value @c PKCS_ALGO_PARAM_TYPE_PKCS05_KDF02 for KDF2 Parameters */ virtual PkcsAlgorithmParameterType GetType(void) const; @@ -207,9 +207,9 @@ public: * * @return @c true if the specified instance equals the current instance, @n * else @c false - * @param[in] rhs An instance of %Pkcs05PbKdf2Parameters + * @param[in] rhs An instance of %Pkcs05PbKdf2Parameters * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_INVALID_ARG The specified input parameter is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual bool Equals(const Tizen::Base::Object& rhs) const; diff --git a/inc/FSecPkcsPkcs05PbMacParameters.h b/inc/FSecPkcsPkcs05PbMacParameters.h index 3e78e00..d164a96 100755 --- a/inc/FSecPkcsPkcs05PbMacParameters.h +++ b/inc/FSecPkcsPkcs05PbMacParameters.h @@ -34,17 +34,16 @@ namespace Tizen { namespace Security { namespace Pkcs /** * @class Pkcs05PbMacParameters - * @brief This class implements the functionalities specified by the PKCS05 MAC scheme. + * @brief This class provides methods for the functionalities specified by the PKCS05 MAC scheme. * * @since 2.1 * * The %Pkcs05PbMacParameters class implements the functionalities specified by the PKCS05 MAC scheme. - * PBMAC1 combines a password-based key derivation function, which will be PBKDF2 - * for this version of PKCS #5, with an underlying message authentication - * scheme. The key length and any other parameters for - * the underlying message authentication scheme depend on the scheme. + * PBMAC1 combines a password-based key derivation function, which will be PBKDF2 for this version of PKCS #5, with an underlying + * message authentication scheme. The key length and any other parameters for the underlying message authentication scheme depend + * on the scheme. * - * This is defined in ASN.1 as demonstrated in the following code: + * This is defined in ASN.1 as demonstrated in the following code: * @code * PBMAC1-params ::= SEQUENCE { * keyDerivationFunc AlgorithmIdentifier {{PBMAC1-KDFs}}, @@ -75,14 +74,14 @@ public: virtual ~Pkcs05PbMacParameters(void); /** - * Initializes this instance of %Pkcs05PbMacParameters with the Tizen::Base::ByteBuffer instance that contains Password Based Message @n + * Initializes this instance of %Pkcs05PbMacParameters with the Tizen::Base::ByteBuffer instance that contains Password Based Message * Authentication Cryptography parameters structure(PBMAC1) in ASN.1 DER format. * * @since 2.1 * * @return An error code - * @param[in] encodedData DER encoded Tizen::Base::ByteBuffer contains %Pkcs05PbMacParameters. - * @exception E_SUCCESS The method is successful. + * @param[in] encodedData The DER encoded Tizen::Base::ByteBuffer containing %Pkcs05PbMacParameters. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& encodedData); @@ -93,21 +92,21 @@ public: * @since 2.1 * * @return An error code - * @param[in] keyDerivationFunc An instance of AlgorithmIdentifier, holding key derivation function - * @param[in] messageAuthScheme An instance of AlgorithmIdentifier, holding message authentication scheme - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. + * @param[in] keyDerivationFunc An instance of AlgorithmIdentifier holding key derivation function + * @param[in] messageAuthScheme An instance of AlgorithmIdentifier holding message authentication scheme + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const AlgorithmIdentifier& keyDerivationFunc, const AlgorithmIdentifier& messageAuthScheme); /** - * Gets the encoded form of the %Pkcs05PbMacParameters. @n + * Gets the encoded form of the %Pkcs05PbMacParameters instance. @n * It is assumed that each %Pkcs05PbMacParameters will have only a single form of encoding, for example ASN.1 DER. * * @since 2.1 * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n - * else @c null if an error occurs. + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -115,44 +114,44 @@ public: Tizen::Base::ByteBuffer* GetEncodedDataN(void) const; /** - * Gets the reference to the AlgorithmIdentifier instance that identifies the underlying key derivation function. @n + * Gets a reference to the AlgorithmIdentifier instance that identifies the underlying key derivation function. @n * It will be an algorithm ID with an OID in the set PBES2-KDFs, which for this version of PKCS #5 will consist of ID-PBKDF2. * * @since 2.1 * - * @return A reference to AlgorithmIdentifier holding the underlying key derivation function. + * @return A reference to the AlgorithmIdentifier instance holding the underlying key derivation function. * @remarks The specific error code can be accessed using the GetLastResult() method. */ const AlgorithmIdentifier& GetKeyDerivationAlgorithm(void) const; /** - * Gets the algorithm identifier that identifies the underlying - * MAC algorithm. @n It shall be an OID like OID_HMAC_SHA1 or OID_HMAC_SHA2_224, and so on. + * Gets the algorithm identifier that identifies the underlying MAC algorithm. @n + * It shall be an OID like ::OID_HMAC_SHA1 or ::OID_HMAC_SHA2_224, and so on. * * @since 2.1 * - * @return A reference to AlgorithmIdentifier holding the underlying MAC algorithm + * @return A reference to the AlgorithmIdentifier instance holding the underlying MAC algorithm * @remarks The specific error code can be accessed using the GetLastResult() method. */ const AlgorithmIdentifier& GetMacAlgorithm(void) const; /** * Gets the AlgorithmParameters that identifies the underlying Parameters such as PbKdf2, PbEs2, PbMac1. @n - * For this class %AlgorithmParameters will be of PbMac1 type. + * For this class, %AlgorithmParameters will be of PbMac1 type. * * @since 2.1 * - * @return A pointer to IAlgorithmParameters containing the algorithm identifier of underlying pseudo random function + * @return A pointer to the IAlgorithmParameters instance containing the algorithm identifier of underlying pseudo random function * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual IAlgorithmParameters* CloneN(void) const; /** - * Get the PkcsAlgorithmParameterType value. + * Gets the PkcsAlgorithmParameterType value. * * @since 2.1 * - * @return PkcsAlgorithmParameterType holding enum value @c PKCS_ALGO_PARAM_TYPE_PKCS05_MAC for PBMAC parameters + * @return An instance of PkcsAlgorithmParameterType holding the enum value @c PKCS_ALGO_PARAM_TYPE_PKCS05_MAC for PBMAC parameters */ virtual PkcsAlgorithmParameterType GetType(void) const; @@ -165,7 +164,7 @@ public: * else @c false * @param[in] rhs An instance of %Pkcs05PbMacParameters * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_INVALID_ARG The specified input parameter is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual bool Equals(const Tizen::Base::Object& rhs) const; diff --git a/inc/FSecPkcsPkcs05Schemes.h b/inc/FSecPkcsPkcs05Schemes.h index e6d3da8..72d4226 100755 --- a/inc/FSecPkcsPkcs05Schemes.h +++ b/inc/FSecPkcsPkcs05Schemes.h @@ -34,13 +34,13 @@ namespace Tizen { namespace Security { namespace Pkcs /** * @class Pkcs05Schemes - * @brief This class implements the functionalities specified by the pkcs05 schemes like key derivation function, - * encryption and signature schemes. + * @brief This class provides methods for the functionalities specified by the pkcs05 schemes like key derivation function, + * encryption and signature schemes. * * @since 2.1 * - * The %Pkcs05Schemes class implements the functionalities specified by the pkcs05 schemes like key derivation function, - * encryption and signature schemes. + * The %Pkcs05Schemes class provides methods for the functionalities specified by the pkcs05 schemes like key derivation function, + * encryption and signature schemes. */ class _OSP_EXPORT_ Pkcs05Schemes @@ -68,11 +68,11 @@ public: * @since 2.1 * * @return An error code - * @param[in] password An instance of Tizen::Base::ByteBuffer holding the password - * @param[in] derivedKeyLength A positive integer that contains the length of derived key @n - * It is a variable length in PbEs2 based on the underlying encryption operation. - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. + * @param[in] password An instance of Tizen::Base::ByteBuffer holding the password + * @param[in] derivedKeyLength The length of the derived key @n + * The length is variable in PbEs2 based on the underlying encryption operation. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& password, int derivedKeyLength); @@ -85,89 +85,88 @@ public: * * @return A pointer to Tizen::Base::ByteBuffer that contains the derived key, @n * else @c null if an error occurs - * @param[in] params An instance of PbKdf2Parameters containing the Kdf2 parameter, - * salt value, iteration count, and key length - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] params An instance of PbKdf2Parameters containing the Kdf2 parameter, + * salt value, iteration count, and key length + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::ByteBuffer* GenerateKeyKdf2N(const Pkcs05PbKdf2Parameters& params); /** - * Encrypts the message M under a password P to produce a ciphertext C, by applying selected key derivation function KDF - * (which is GenerateKeyKdf2N) and selected underlying encryption scheme (which can be any block chiper). + * Encrypts the message M under a password P to produce a ciphertext C, by applying the selected key derivation function KDF + * (which is GenerateKeyKdf2N) and the selected underlying encryption scheme (which can be any block chiper). * * @since 2.1 * * @return A pointer to Tizen::Base::ByteBuffer that contains the encrypted message, @n * else @c null if an error occurs - * @param[in] params An instance of the PbEs2Parameters parameter structure holding AlgorithmIdentifier for key derivation - * function and AlgorithmIdentifier for underlying encryption scheme - * @param[in] message An instance of Tizen::Base::ByteBuffer holding the plain text to encrypt - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] params An instance of PbEs2Parameters holding AlgorithmIdentifier for the key derivation + * function and AlgorithmIdentifier for the underlying encryption scheme + * @param[in] message An instance of Tizen::Base::ByteBuffer holding the plain text to encrypt + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::ByteBuffer* EncryptionScheme2N(const Pkcs05PbEs2Parameters& params, const Tizen::Base::ByteBuffer& message); /** - * Decrypts the ciphertext C, under a password P to recover message M , by applying selected key derivation function KDF(which is GenerateKeyKdf2N) - * and selected underlying decryption algorithm (which can be any block cipher). + * Decrypts the ciphertext C, under a password P to recover message M , by applying the selected key derivation function KDF + * (which is GenerateKeyKdf2N) and the selected underlying decryption algorithm (which can be any block cipher). * * @since 2.1 * * @return A pointer to Tizen::Base::ByteBuffer that contains the plain text message - * @param[in] params An instance of the PbEs2Parameters parameter structure holding AlgorithmIdentifier for key derivation - * function and AlgorithmIdentifier for underlying encryption scheme - * @param[in] message An instance of Tizen::Base::ByteBuffer holding the cipher text to decrypt - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] params An instance of PbEs2Parameters holding AlgorithmIdentifier for the key derivation + * function and AlgorithmIdentifier for the underlying encryption scheme + * @param[in] message An instance of Tizen::Base::ByteBuffer holding the cipher text to decrypt + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::ByteBuffer* DecryptionScheme2N(const Pkcs05PbEs2Parameters& params, const Tizen::Base::ByteBuffer& message); /** - * Gets a message M under a password P to generate a message authentication code T, - * by applying selected key derivation function KDF(which is GenerateKeyKdf2N) and selected underlying message authentication scheme - * (which can be any HMAC algorithm). @n GenerateMacN combines a password-based key derivation function, which shall be - * GenerateKeyKdf2N for this version of PKCS #5, with an underlying message authentication scheme - * The key length and any other parameters for the underlying message authentication scheme - * depend on the scheme. + * Gets the message M under a password P to generate a message authentication code T, by applying the selected key derivation + * function KDF(which is GenerateKeyKdf2N) and the selected underlying message authentication scheme (which can be any HMAC algorithm). @n + * GenerateMacN combines a password-based key derivation function, which shall be GenerateKeyKdf2N for this version of PKCS #5, + * with an underlying message authentication scheme. The key length and any other parameters for the underlying message + * authentication scheme depend on the scheme. * * @since 2.1 * * @return A pointer to Tizen::Base::ByteBuffer containing the HMAC generated from message, @n * else @c null if an error occurs - * @param[in] params An instance of the PbMacParameters parameter structure holding AlgorithmIdentifier for key derivation - * function and AlgorithmIdentifier for underlying encryption scheme - * @param[in] message An instance of Tizen::Base::ByteBuffer holding the message for which MAC needs to generate - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] params An instance of PbMacParameters holding AlgorithmIdentifier for the key derivation + * function and AlgorithmIdentifier for the underlying encryption scheme + * @param[in] message An instance of Tizen::Base::ByteBuffer holding the message to generate MAC + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::ByteBuffer* GetPbHMacN(const Pkcs05PbMacParameters& params, const Tizen::Base::ByteBuffer& message); /** - * Verifies a message M under a password P to verify a message authentication code T, - * by applying a selected key derivation function KDF2 and a selected underlying message authentication scheme combines a - * password-based key derivation function, which shall be GenerateKeyKdf2N for this version of PKCS #5, with an underlying - * message authentication scheme (which can be any SHA-1 or any SHA-2 algorithm). @n The key length and any other parameters - * for the underlying message authentication scheme depend on the scheme. + * Verifies the message M under a password P to verify a message authentication code T, by applying a selected key derivation + * function KDF2 and a selected underlying message authentication scheme. This method combines a password-based key derivation function, + * which shall be GenerateKeyKdf2N for this version of PKCS #5, with an underlying message authentication scheme (which can + * be any SHA-1 or any SHA-2 algorithm). @n + * The key length and any other parameters for the underlying message authentication scheme depend on the scheme. * * @since 2.1 * * @return An error code - * @param[in] params An instance of the PbMacParameters parameter structure holding AlgorithmIdentifier for key derivation - * function and AlgorithmIdentifier for underlying encryption scheme - * @param[in] message An instance of Tizen::Base::ByteBuffer holding the message M - * @param[in] mac An instance of Tizen::Base::ByteBuffer holding the HMAC mac that needs to verify against the message - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] params An instance of PbMacParameters holding AlgorithmIdentifier for the key derivation + * function and AlgorithmIdentifier for the underlying encryption scheme + * @param[in] message An instance of Tizen::Base::ByteBuffer holding the message M + * @param[in] mac An instance of Tizen::Base::ByteBuffer holding the HMAC mac to verify against the message + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ result VerifyPbMac(const Pkcs05PbMacParameters& params, const Tizen::Base::ByteBuffer& message, const Tizen::Base::ByteBuffer& mac); diff --git a/inc/FSecPkcsPkcs08Attribute.h b/inc/FSecPkcsPkcs08Attribute.h index 578c720..e78e6af 100755 --- a/inc/FSecPkcsPkcs08Attribute.h +++ b/inc/FSecPkcsPkcs08Attribute.h @@ -38,8 +38,8 @@ namespace Tizen { namespace Security { namespace Pkcs * @since 2.1 * * The %Pkcs08Attribute class implements the functionalities specified by the %Pkcs08Attribute class. An Attribute object consists - * of an attribute type (specified by an object identifier) and one or more attribute values. It acts as a - * container for adding, inserting, removing, and encoding X.509 AttributeValue. + * of an attribute type (specified by an object identifier) and one or more attribute values. It acts as a + * container for adding, inserting, removing, and encoding X.509 AttributeValue. * */ @@ -63,14 +63,14 @@ public: virtual ~Pkcs08Attribute(void); /** - * Initializes this instance of %Pkcs08Attribute with the Tizen::Base::ByteBuffer that contains the X.509 attribute @n + * Initializes this instance of %Pkcs08Attribute with the specified Tizen::Base::ByteBuffer instance that contains the X.509 attribute * structure in ASN.1 DER format. * * @since 2.1 * * @return An error code * @param[in] encodedData The DER encoded Tizen::Base::ByteBuffer containing the X.509 attribute structure - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& encodedData); @@ -81,8 +81,9 @@ public: * @since 2.1 * * @return An error code - * @param[in] attributeType The object identifier of a particular X.509 attribute type @n Object IDs (for example, oid for name is 2.5.4.41) are defined by standard attribute bodies. - * @exception E_SUCCESS The method is successful. + * @param[in] attributeType The object identifier of a particular X.509 attribute type @n + * Object IDs (for example, oid for name is 2.5.4.41) are defined by standard attribute bodies. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const Tizen::Base::String& attributeType); @@ -93,33 +94,33 @@ public: * * @since 2.1 * - * @return Containing the object ID of attribute type in string format like 2.5.4.41 + * @return The string with the object ID of attribute type like 2.5.4.41 * */ Tizen::Base::String GetAttributeType(void) const; /** - * Adds an attribute value in the attribute value list. + * Adds the attribute value in the attribute value list. * * @since 2.1 * * @return An error code - * @param[in] attributeValue An instance of Pkcs08AttributeValue to add an attribute in the list + * @param[in] attributeValue An instance of Pkcs08AttributeValue */ result AddAttributeValue(const Pkcs08AttributeValue& attributeValue); /** - * Removes an attribute value from the attribute value list. + * Removes the attribute value from the attribute value list. * * @since 2.1 * * @return An error code - * @param[in] attributeValue An instance of Pkcs08AttributeValue to remove an attribute from the list + * @param[in] attributeValue An instance of Pkcs08AttributeValue */ result RemoveAttributeValue(const Pkcs08AttributeValue& attributeValue); /** - * Returns an array list containing the attribute values of type Pkcs08AttributeValue. + * Gets an array list containing the attribute values of type Pkcs08AttributeValue. * * @since 2.1 * @@ -134,7 +135,7 @@ public: * @since 2.1 * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n - * else @c null if an error occurs + * else @c null if an error occurs * * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. diff --git a/inc/FSecPkcsPkcs08AttributeValue.h b/inc/FSecPkcsPkcs08AttributeValue.h index 2333152..186bad4 100755 --- a/inc/FSecPkcsPkcs08AttributeValue.h +++ b/inc/FSecPkcsPkcs08AttributeValue.h @@ -61,14 +61,14 @@ public: virtual ~Pkcs08AttributeValue(void); /** - * Initializes this instance of %Pkcs08AttributeValue with the Tizen::Base::ByteBuffer that contains the AttributeValue @n - * (contain tag, that is, Ans1_Type and the value). + * Initializes this instance of %Pkcs08AttributeValue with the specified Tizen::Base::ByteBuffer that contains the AttributeValue @n + * (contains tag, that is, Ans1_Type and the value). * * @since 2.1 * * @return An error code * @param[in] encodedData The DER encoded Tizen::Base::ByteBuffer of AttributeValue - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& encodedData); @@ -81,19 +81,19 @@ public: * * @return An error code * @param[in] value An instance of Tizen::Base::ByteBuffer holding raw value - * @param[in] tag A tag holding the tag type @n This tag number is assigned by ASN1 standards for @n - * basic data types. + * @param[in] tag A tag holding the tag type @n This tag number is assigned by ASN1 standards for + * basic data types. * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_INVALID_ARG A specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& value, Pkcs08TagValue tag); /** - * Gets a reference to Tizen::Base::ByteBuffer that contains the attribute value. + * Gets a reference to the Tizen::Base::ByteBuffer instance that contains the attribute value. * * @since 2.1 * - * @return A reference to Tizen::Base::ByteBuffer containing raw value + * @return An instance of Tizen::Base::ByteBuffer containing raw value * @remarks The specific error code can be accessed using the GetLastResult() method. */ const Tizen::Base::ByteBuffer& GetValue(void) const; @@ -114,8 +114,8 @@ public: * * @since 2.1 * - * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n - * else @c null if an error occurs + * @return A pointer to the Tizen::Base::ByteBuffer instance that contains the output, @n + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. diff --git a/inc/FSecPkcsPkcs08EncryptedPrivateKeyInfo.h b/inc/FSecPkcsPkcs08EncryptedPrivateKeyInfo.h index a3c0863..3b6cc05 100755 --- a/inc/FSecPkcsPkcs08EncryptedPrivateKeyInfo.h +++ b/inc/FSecPkcsPkcs08EncryptedPrivateKeyInfo.h @@ -37,9 +37,9 @@ namespace Tizen { namespace Security { namespace Pkcs * @since 2.1 * * The %Pkcs08EncryptedPrivateKeyInfo class provides methods to encrypt a private key. An encrypted private key structure consist - * of an encryption algorithm and the encrypted Pkcs08PrivateKeyInfo. + * of an encryption algorithm and the encrypted Pkcs08PrivateKeyInfo. * - * This is defined in ASN.1 as demonstrated in the following code: + * This is defined in ASN.1 as demonstrated in the following code: * @code * EncryptedPrivateKeyInfo ::= SEQUENCE { * encryptionAlgorithm AlgorithmIdentifier {{KeyEncryptionAlgorithms}}, @@ -68,15 +68,15 @@ public: virtual ~Pkcs08EncryptedPrivateKeyInfo(void); /** - * Initializes this instance of %Pkcs08EncryptedPrivateKeyInfo with the encoded Tizen::Base::ByteBuffer that contains @n + * Initializes this instance of %Pkcs08EncryptedPrivateKeyInfo with the encoded Tizen::Base::ByteBuffer that contains * the EncryptedPrivateKeyInfo structure(EncryptedPrivateKeyInfo) in ASN.1 DER format. * * @since 2.1 * * @return An error code - * @param[in] encodedData The DER encoded Tizen::Base::ByteBuffer that contains the Pkcs08 EncryptedPrivateKeyInfo structure - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. + * @param[in] encodedData The DER encoded Tizen::Base::ByteBuffer that contains the Pkcs08 EncryptedPrivateKeyInfo structure + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& encodedData); @@ -88,7 +88,7 @@ public: * @return An error code * @param[in] algorithmId An instance of AlgorithmIdentifier * @param[in] encryptedData An encrypted private key - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. */ result Construct(const AlgorithmIdentifier& algorithmId, const Tizen::Base::ByteBuffer& encryptedData); @@ -99,11 +99,11 @@ public: * @since 2.1 * * @return An error code - * @param[in] algorithmId An instance of AlgorithmIdentifier that identifies the secret key algorithm - * @param[in] key The key for encrypting privateKeyInfo - * @param[in] encodedPrivateKeyInfo An instance of Tizen::Base::ByteBuffer containing encoded privateKeyInfo - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. + * @param[in] algorithmId An instance of AlgorithmIdentifier that identifies the secret key algorithm + * @param[in] key The key for encrypting PrivateKeyInfo + * @param[in] encodedPrivateKeyInfo An instance of Tizen::Base::ByteBuffer containing encoded PrivateKeyInfo + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A specified input parameter is invalid. * */ result Construct(const AlgorithmIdentifier& algorithmId, const Tizen::Base::ByteBuffer& key, const Tizen::Base::ByteBuffer& encodedPrivateKeyInfo); @@ -136,11 +136,11 @@ public: * * @return A pointer to Tizen::Base::ByteBuffer that contains the decrypted private key of the %Pkcs08EncryptedPrivateKeyInfo object, @n * else @c null if an error occurs - * @param[in] key An instance of Tizen::Base::ByteBuffer holding a key to decrypt the private key using a particular @n - * secret key algorithm - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] key An instance of Tizen::Base::ByteBuffer holding a key to decrypt the private key using a particular + * secret key algorithm + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::ByteBuffer* DecryptN(const Tizen::Base::ByteBuffer& key); @@ -151,9 +151,9 @@ public: * @since 2.1 * * @return A pointer to the Tizen::Base::ByteBuffer class that contains the output, @n - * else @c null if an error occurs - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * else @c null if an error occurs + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::ByteBuffer* GetEncodedDataN(void) const; diff --git a/inc/FSecPkcsPkcs08PrivateKeyInfo.h b/inc/FSecPkcsPkcs08PrivateKeyInfo.h index 662f2e8..e507597 100755 --- a/inc/FSecPkcsPkcs08PrivateKeyInfo.h +++ b/inc/FSecPkcsPkcs08PrivateKeyInfo.h @@ -73,16 +73,16 @@ public: virtual ~Pkcs08PrivateKeyInfo(void); /** - * Initializes this instance of %Pkcs08PrivateKeyInfo with the encoded byte buffer that contains @n - * pkcs08 private key info structure(PrivateKeyInfo) in ASN.1 DER format. @n + * Initializes this instance of %Pkcs08PrivateKeyInfo with the encoded byte buffer that contains pkcs08 private key info + * structure(PrivateKeyInfo) in ASN.1 DER format. @n * It parses this encoded buffer and extracts the appropriate values of private key, its algorithm ID, and attributes. * * @since 2.1 * * @return An error code - * @param[in] encodedData An instance of Tizen::Base::ByteBuffer containing DER encoded PrivateKeyInfo structure - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. + * @param[in] encodedData An instance of Tizen::Base::ByteBuffer containing DER encoded PrivateKeyInfo structure + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& encodedData); @@ -92,16 +92,16 @@ public: * @since 2.1 * * @return An error code. - * @param[in] keyAlgorithmId An instance of AlgorithmIdentifier holding algorithm identifier of the private key algorithm - * @param[in] privateKey An instance of Tizen::Base::ByteBuffer holding private key - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. + * @param[in] keyAlgorithmId An instance of AlgorithmIdentifier holding the algorithm identifier of the private key algorithm + * @param[in] privateKey An instance of Tizen::Base::ByteBuffer holding the private key + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A specified input parameter is invalid. */ result Construct(const AlgorithmIdentifier& keyAlgorithmId, const Tizen::Base::ByteBuffer& privateKey); /** - * Gets the private key syntax version number of PrivateKeyInfo object @n - * that is used for storing private key and its related information and default value of this version is @c 0. + * Gets the private key syntax version number of PrivateKeyInfo object that is used for storing private key and its related + * information and default value of this version is @c 0. * * @since 2.1 * @@ -111,7 +111,7 @@ public: int GetVersion(void) const; /** - * Gets the reference to AlgorithmIdentifier that identifies the secret key algorithm. + * Gets a reference to AlgorithmIdentifier that identifies the secret key algorithm. * * @since 2.1 * @@ -121,7 +121,7 @@ public: const AlgorithmIdentifier& GetPrivateKeyAlgorithm(void) const; /** - * Gets the reference to Tizen::Base::ByteBuffer that contains the private key in binary format. + * Gets a reference to Tizen::Base::ByteBuffer that contains the private key in binary format. * * @since 2.1 * @@ -131,7 +131,7 @@ public: const Tizen::Base::ByteBuffer& GetPrivateKey(void) const; /** - * Gets the attributes of the type Pkcs08Attribute that are extended information of the private key in context. + * Gets the attributes of the type Pkcs08Attribute that are the extended information of the private key in context. * * @since 2.1 * @@ -140,7 +140,7 @@ public: const Tizen::Base::Collection::ArrayList& GetAttributes(void) const; /** - * Adds the attributes in private key information that is extended information of the private key in context. + * Adds the attributes in private key information that is the extended information of the private key in context. * * @since 2.1 * @@ -150,7 +150,7 @@ public: result AddAttribute(const Pkcs08Attribute& attributes); /** - * Removes the attribute in private key information that is extended information of the private key in context. + * Removes the attributes from the private key information that is the extended information of the private key in context. * * @since 2.1 * @@ -158,7 +158,7 @@ public: * @param[in] attributes An instance of Pkcs08Attribute */ result RemoveAttribute(const Pkcs08Attribute& attributes); - + /** * Gets the DER encoded %Pkcs08PrivateKeyInfo structure. * diff --git a/inc/FSecPkcsRc2CbcParameters.h b/inc/FSecPkcsRc2CbcParameters.h index d5d3a8d..4147faa 100755 --- a/inc/FSecPkcsRc2CbcParameters.h +++ b/inc/FSecPkcsRc2CbcParameters.h @@ -38,8 +38,8 @@ namespace Tizen { namespace Security { namespace Pkcs * @since 2.1 * * The %Rc2CbcParameters class implements the functionalities specified by the Rc2 Cbc mode parameter. - * This class represents the Rc2 cbc mode parameter for symmetric ciphers RC2. - * ASN.1 format for RC2-CBC-Parameter ::= SEQUENCE { + * This class represents the Rc2 cbc mode parameter for symmetric ciphers RC2. + * ASN.1 format for RC2-CBC-Parameter ::= SEQUENCE { * rc2ParameterVersion INTEGER OPTIONAL, * iv OCTET STRING (SIZE(8)) } * @@ -72,12 +72,12 @@ public: * @since 2.1 * * @return An error code - * @param[in] initialVector An instance of Tizen::Base::ByteBuffer containing the initial vector - * @param[in] version An integer value that defines the rc2 cbc parameter version @n - * As per Pkcs 5 standard, possible values can be 160,120,58, or any value - * greater than or equal to 256. - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. + * @param[in] initialVector An instance of Tizen::Base::ByteBuffer containing the initial vector + * @param[in] version An integer value that defines the rc2 cbc parameter version @n + * As per Pkcs 5 standard, possible values can be 160,120,58, or any value + * greater than or equal to 256. + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A specified input parameter is invalid. */ result Construct(const Tizen::Base::ByteBuffer& initialVector, int version = 0); @@ -107,10 +107,10 @@ public: * @since 2.1 * * @return @c true if the specified instance equals the current instance, @n - * else @c false + * else @c false * @param[in] rhs An instance of %Rc2CbcParameters * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified input parameter is invalid. + * @exception E_INVALID_ARG The specified input parameter is invalid. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual bool Equals(const Tizen::Base::Object& rhs) const; @@ -151,7 +151,7 @@ public: * @since 2.1 * * @return A pointer to the DER encoded Tizen::Base::ByteBuffer, @n - * else @c null if an error occurs + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @remarks The specific error code can be accessed using the GetLastResult() method. diff --git a/inc/FSecPkcsTypes.h b/inc/FSecPkcsTypes.h index c9cd4fd..5deb37c 100755 --- a/inc/FSecPkcsTypes.h +++ b/inc/FSecPkcsTypes.h @@ -18,7 +18,7 @@ * @file FSecPkcsTypes.h * @brief This is the header file for the declarations of the %PkcsAlgorithmParameterType and %Pkcs08TagValue enumerators and the AttributeType OID List. * - * This header file contains the declarations of the %PkcsAlgorithmParameterType and %Pkcs08TagValue enumerators and the AttributeType OID List. + * This header file contains the declarations of the PkcsAlgorithmParameterType and Pkcs08TagValue enumerators and the AttributeType OID List. */ #ifndef _FSEC_PKCS_TYPES_H_ @@ -30,7 +30,7 @@ namespace Tizen { namespace Security { namespace Pkcs { /** - * @enum PkcsAlgorithmParameterType + * @enum PkcsAlgorithmParameterType * * Defines the types of parameters. * @@ -38,97 +38,97 @@ namespace Tizen { namespace Security { namespace Pkcs */ enum PkcsAlgorithmParameterType { - PKCS_ALGO_PARAM_TYPE_IV, /**< The parameter type is initial vector */ - PKCS_ALGO_PARAM_TYPE_PKCS05_PBES02, /**< The parameter type is pkcs5 password based encryption scheme2 */ - PKCS_ALGO_PARAM_TYPE_PKCS05_KDF02, /**< The parameter type is pkcs5 password based key derivation scheme2 */ - PKCS_ALGO_PARAM_TYPE_PKCS05_MAC, /**< The parameter type is pkcs5 message authentication scheme */ - PKCS_ALGO_PARAM_TYPE_RC2, /**< The parameter type is rc2 cbc */ - PKCS_ALGO_PARAM_TYPE_UNKOWN = 0xFFFFFFFF /**< An unknown parameter type */ + PKCS_ALGO_PARAM_TYPE_IV, /**< The parameter type is initial vector */ + PKCS_ALGO_PARAM_TYPE_PKCS05_PBES02, /**< The parameter type is pkcs5 password based encryption scheme2 */ + PKCS_ALGO_PARAM_TYPE_PKCS05_KDF02, /**< The parameter type is pkcs5 password based key derivation scheme2 */ + PKCS_ALGO_PARAM_TYPE_PKCS05_MAC, /**< The parameter type is pkcs5 message authentication scheme */ + PKCS_ALGO_PARAM_TYPE_RC2, /**< The parameter type is rc2 cbc */ + PKCS_ALGO_PARAM_TYPE_UNKOWN = 0xFFFFFFFF /**< An unknown parameter type */ }; //PkcsAlgorithmParameterType; /** - * @enum Pkcs08TagValue + * @enum Pkcs08TagValue * * Defines the Asn1 tag type. * - * @since 2.1 + * @since 2.1 */ enum Pkcs08TagValue { - PKCS08_TAG_RESERVED = 0, /**< Reserved for use by the encoding rules */ - PKCS08_TAG_BOOLEAN = 1, /**< An arbitrary bool value */ - PKCS08_TAG_INTEGER = 2, /**< An arbitrary integer value */ - PKCS08_TAG_BITSTRING = 3, /**< An arbitrary string of bits */ - PKCS08_TAG_OCTETSTRING = 4, /**< An arbitrary string of octets */ - PKCS08_TAG_NULL = 5, /**< A null value */ - PKCS08_TAG_OBJECT_ID = 6, /**< An object identifier */ - PKCS08_TAG_OBJECT_DES = 7, /**< An object descriptor providing a brief description of an object */ - PKCS08_TAG_EXTERNAL = 8, /**< An arbitrary external value */ - PKCS08_TAG_REAL = 9, /**< An arbitrary real value */ - PKCS08_TAG_ENUM = 10, /**< An enumerated value */ - PKCS08_TAG_EMBEDDED = 11, /**< An embedded value */ - PKCS08_TAG_UTF8STRING = 12, /**< An arbitrary utf8 string */ - PKCS08_TAG_REL_OBJ_ID = 13, /**< A relative object ID */ - PKCS08_TAG_SEQUENCE = 16, /**< An ordered collection of one or more types */ - PKCS08_TAG_SET = 17, /**< An unordered collection of one or more types */ - PKCS08_TAG_CHAR_STRING = 18, /**< A numeric string */ - PKCS08_TAG_PRINTABLE_STRING = 19, /**< An arbitrary string of printable characters */ - PKCS08_TAG_TELETEXT_STRING = 20, /**< A teletext string, T61 string */ - PKCS08_TAG_VIDEOTEXT_STRING = 21, /**< A videotext string */ - PKCS08_TAG_IA5STRING = 22, /**< An arbitrary string of IA5 (ASCII) characters */ - PKCS08_TAG_UTC_TIME = 23, /**< A coordinated universal time or Greenwich Mean Time (GMT) value */ - PKCS08_TAG_GEN_TIME = 24, /**< A generalized time */ - PKCS08_TAG_GRAPHICS_STRING = 25, /**< A graphic string */ - PKCS08_TAG_VISIBLE_STRING = 26, /**< A visible string, ISO64 string */ - PKCS08_TAG_GENERAL_STRING = 27, /**< A general string */ - PKCS08_TAG_UNIVERSAL_STRING = 28, /**< A universal string */ - PKCS08_TAG_CHARACTER_STRING = 29, /**< An arbitrary character string */ - PKCS08_TAG_BMP_STRING = 30, /**< A bmp string */ - PKCS08_TAG_UNKNOWN = -1 /**< An unknown tag type */ + PKCS08_TAG_RESERVED = 0, /**< Reserved for use by the encoding rules */ + PKCS08_TAG_BOOLEAN = 1, /**< An arbitrary bool value */ + PKCS08_TAG_INTEGER = 2, /**< An arbitrary integer value */ + PKCS08_TAG_BITSTRING = 3, /**< An arbitrary string of bits */ + PKCS08_TAG_OCTETSTRING = 4, /**< An arbitrary string of octets */ + PKCS08_TAG_NULL = 5, /**< A null value */ + PKCS08_TAG_OBJECT_ID = 6, /**< An object identifier */ + PKCS08_TAG_OBJECT_DES = 7, /**< An object descriptor providing a brief description of an object */ + PKCS08_TAG_EXTERNAL = 8, /**< An arbitrary external value */ + PKCS08_TAG_REAL = 9, /**< An arbitrary real value */ + PKCS08_TAG_ENUM = 10, /**< An enumerated value */ + PKCS08_TAG_EMBEDDED = 11, /**< An embedded value */ + PKCS08_TAG_UTF8STRING = 12, /**< An arbitrary utf8 string */ + PKCS08_TAG_REL_OBJ_ID = 13, /**< A relative object ID */ + PKCS08_TAG_SEQUENCE = 16, /**< An ordered collection of one or more types */ + PKCS08_TAG_SET = 17, /**< An unordered collection of one or more types */ + PKCS08_TAG_CHAR_STRING = 18, /**< A numeric string */ + PKCS08_TAG_PRINTABLE_STRING = 19, /**< An arbitrary string of printable characters */ + PKCS08_TAG_TELETEXT_STRING = 20, /**< A teletext string, T61 string */ + PKCS08_TAG_VIDEOTEXT_STRING = 21, /**< A videotext string */ + PKCS08_TAG_IA5STRING = 22, /**< An arbitrary string of IA5 (ASCII) characters */ + PKCS08_TAG_UTC_TIME = 23, /**< A coordinated universal time or Greenwich Mean Time (GMT) value */ + PKCS08_TAG_GEN_TIME = 24, /**< A generalized time */ + PKCS08_TAG_GRAPHICS_STRING = 25, /**< A graphic string */ + PKCS08_TAG_VISIBLE_STRING = 26, /**< A visible string, ISO64 string */ + PKCS08_TAG_GENERAL_STRING = 27, /**< A general string */ + PKCS08_TAG_UNIVERSAL_STRING = 28, /**< A universal string */ + PKCS08_TAG_CHARACTER_STRING = 29, /**< An arbitrary character string */ + PKCS08_TAG_BMP_STRING = 30, /**< A bmp string */ + PKCS08_TAG_UNKNOWN = -1 /**< An unknown tag type */ }; // Pkcs08TagValue; /* -- Basic object identifiers in Pkcs05 and Pkcs08 */ -_OSP_EXPORT_ extern const wchar_t OID_PBKDF2[]; /**< An object identifier for password based key derivation function scheme2 */ -_OSP_EXPORT_ extern const wchar_t OID_PBES2[]; /**< An object identifier for password based encryption scheme2 */ -_OSP_EXPORT_ extern const wchar_t OID_PBMAC1[]; /**< An object identifier for password based message authentication scheme1 */ -_OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA1[]; /**< An object identifier for hmac-sha1 */ -_OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA2_224[]; /**< An object identifier for hmac-sha224 */ -_OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA2_256[]; /**< An object identifier for hmac-sha256 */ -_OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA2_384[]; /**< An object identifier for hmac-sha384 */ -_OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA2_512[]; /**< An object identifier for hmac-sha512 */ -_OSP_EXPORT_ extern const wchar_t OID_DES_CBC[]; /**< An object identifier for des-cbc mode */ -_OSP_EXPORT_ extern const wchar_t OID_DES_CBC_EDE3[]; /**< An object identifier for des-cbc-ede3 mode */ -_OSP_EXPORT_ extern const wchar_t OID_AES_128_CBC[]; /**< An object identifier for aes-128-cbc mode */ -_OSP_EXPORT_ extern const wchar_t OID_AES_192_CBC[]; /**< An object identifier for aes-192-cbc mode */ -_OSP_EXPORT_ extern const wchar_t OID_AES_256_CBC[]; /**< An object identifier for aes-256-cbc mode */ -_OSP_EXPORT_ extern const wchar_t OID_RC2_CBC[]; /**< An object identifier for rc2-cbc mode */ -_OSP_EXPORT_ extern const wchar_t OID_RSA_ENCRYPTION[]; /**< An object identifier for RSA encryption scheme */ +_OSP_EXPORT_ extern const wchar_t OID_PBKDF2[]; /**< An object identifier for password based key derivation function scheme2 */ +_OSP_EXPORT_ extern const wchar_t OID_PBES2[]; /**< An object identifier for password based encryption scheme2 */ +_OSP_EXPORT_ extern const wchar_t OID_PBMAC1[]; /**< An object identifier for password based message authentication scheme1 */ +_OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA1[]; /**< An object identifier for hmac-sha1 */ +_OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA2_224[]; /**< An object identifier for hmac-sha224 */ +_OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA2_256[]; /**< An object identifier for hmac-sha256 */ +_OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA2_384[]; /**< An object identifier for hmac-sha384 */ +_OSP_EXPORT_ extern const wchar_t OID_HMAC_SHA2_512[]; /**< An object identifier for hmac-sha512 */ +_OSP_EXPORT_ extern const wchar_t OID_DES_CBC[]; /**< An object identifier for des-cbc mode */ +_OSP_EXPORT_ extern const wchar_t OID_DES_CBC_EDE3[]; /**< An object identifier for des-cbc-ede3 mode */ +_OSP_EXPORT_ extern const wchar_t OID_AES_128_CBC[]; /**< An object identifier for aes-128-cbc mode */ +_OSP_EXPORT_ extern const wchar_t OID_AES_192_CBC[]; /**< An object identifier for aes-192-cbc mode */ +_OSP_EXPORT_ extern const wchar_t OID_AES_256_CBC[]; /**< An object identifier for aes-256-cbc mode */ +_OSP_EXPORT_ extern const wchar_t OID_RC2_CBC[]; /**< An object identifier for rc2-cbc mode */ +_OSP_EXPORT_ extern const wchar_t OID_RSA_ENCRYPTION[]; /**< An object identifier for RSA encryption scheme */ /* -- Basic object identifiers in Pkcs08 for AttributeType */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_NAME[]; /**< An object identifier for attribute type name */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_SURNAME[]; /**< An object identifier for attribute type surname */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_GIVEN_NAME[]; /**< An object identifier for attribute type of any given name */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_INITIAL[]; /**< An object identifier for attribute type initial */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_GEN_QUALIFIER[]; /**< An object identifier for attribute type generation qualifier */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_COMMON_NAME[]; /**< An object identifier for attribute type common name */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_LOCALITY_NAME[]; /**< An object identifier for attribute type locality name */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_STATE_OR_PROV_NAME[]; /**< An object identifier for attribute type state/province name */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_ORG_NAME[]; /**< An object identifier for attribute type of any organization name */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_ORG_UNIT_NAME[]; /**< An object identifier for any organization unit name */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_TITLE[]; /**< An object identifier for attribute type title */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_DN_QUALIFIER[]; /**< An object identifier for distinguished name qualifier */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_COUNTRY_NAME[]; /**< An object identifier for attribute type country name */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_SERIAL_NUMBER[]; /**< An object identifier for attribute type serial number */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_PSEUDONYM[]; /**< An object identifier for attribute type pseudonym */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_DOMAIN_COMPONENT[]; /**< An object identifier for any domain component */ -_OSP_EXPORT_ extern const wchar_t OID_ATTR_EMAIL_ADDRESS[]; /**< An object identifier for any email address */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_NAME[]; /**< An object identifier for attribute type name */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_SURNAME[]; /**< An object identifier for attribute type surname */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_GIVEN_NAME[]; /**< An object identifier for attribute type of any given name */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_INITIAL[]; /**< An object identifier for attribute type initial */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_GEN_QUALIFIER[]; /**< An object identifier for attribute type generation qualifier */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_COMMON_NAME[]; /**< An object identifier for attribute type common name */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_LOCALITY_NAME[]; /**< An object identifier for attribute type locality name */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_STATE_OR_PROV_NAME[]; /**< An object identifier for attribute type state/province name */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_ORG_NAME[]; /**< An object identifier for attribute type of any organization name */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_ORG_UNIT_NAME[]; /**< An object identifier for any organization unit name */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_TITLE[]; /**< An object identifier for attribute type title */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_DN_QUALIFIER[]; /**< An object identifier for distinguished name qualifier */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_COUNTRY_NAME[]; /**< An object identifier for attribute type country name */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_SERIAL_NUMBER[]; /**< An object identifier for attribute type serial number */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_PSEUDONYM[]; /**< An object identifier for attribute type pseudonym */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_DOMAIN_COMPONENT[]; /**< An object identifier for any domain component */ +_OSP_EXPORT_ extern const wchar_t OID_ATTR_EMAIL_ADDRESS[]; /**< An object identifier for any email address */ } } } // Tizen::Security::Pkcs diff --git a/inc/FSecPrivacyInfo.h b/inc/FSecPrivacyInfo.h index 2bd6004..05b5ac3 100755 --- a/inc/FSecPrivacyInfo.h +++ b/inc/FSecPrivacyInfo.h @@ -13,25 +13,25 @@ // See the License for the specific language governing permissions and // limitations under the License. // - + /** -* @file FSecPrivacyInfo.h -* @brief This is the header file for the %PrivacyInfo class. +* @file FSecPrivacyInfo.h +* @brief This is the header file for the %PrivacyInfo class. * * This header file contains the declarations of the %PrivacyInfo class. */ - + #ifndef _FSEC_PRIVACY_INFO_H_ #define _FSEC_PRIVACY_INFO_H_ - + #include - + namespace Tizen { namespace Security { - + /** * @class PrivacyInfo -* @brief This class represents the privacy information. +* @brief This class provides methods for the privacy information. * * @since 2.1 * @@ -40,13 +40,13 @@ namespace Tizen { namespace Security * The %PrivacyInfo class represents the privacy information. * This class provides methods to retrieve the name and description of privilege. */ - + class _OSP_EXPORT_ PrivacyInfo : public Tizen::Base::Object { public: - + /** * 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. @@ -54,7 +54,7 @@ public: * @since 2.1 */ PrivacyInfo(void); - + /** * This destructor overrides Tizen::Base::Object::~Object(). * @@ -62,7 +62,7 @@ public: * */ virtual ~PrivacyInfo(void); - + /** * Initializes this instance of %PrivacyInfo with the specified parameters. * @@ -71,15 +71,15 @@ public: * @return An error code * @param[in] privacyId The privacy ID * @param[in] enable Set to @c true to enable the privacy setting, @n - * else @c false + * else @c false * @exception E_SUCCESS The method is successful. * @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); - + /** - * Gets a privacy ID. + * Gets the privacy ID. * * @since 2.1 * @@ -87,7 +87,7 @@ public: * */ Tizen::Base::String GetId(void) const; - + /** * Checks whether the privacy setting is enabled. * @@ -98,20 +98,21 @@ public: * @see SetEnabled() */ bool IsEnabled(void) const; - + /** * Enables or disables the privacy setting. * * @since 2.1 * - * @param[in] enable A Boolean value indicating whether the privacy setting is enabled + * @param[in] enable @c true if the privacy setting is enabled, @n + * else @c false * @see IsEnabled() * */ void SetEnabled(bool enable); - + /** - * Gets a localized display name of privacy. + * Gets the localized display name of privacy. * * @since 2.1 * @@ -120,9 +121,9 @@ public: * */ Tizen::Base::String GetDisplayName(void) const; - + /** - * Gets a localized description of privacy. + * Gets the localized description of privacy. * * @since 2.1 * @@ -131,31 +132,31 @@ public: * */ Tizen::Base::String GetDescription(void) const; - + private: - + // // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects. // - // @param[in] rhs An instance of %PrivacyInfo + // @param[in] rhs An instance of %PrivacyInfo // PrivacyInfo(const PrivacyInfo& rhs); - + // // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects. // - // @param[in] rhs An instance of %PrivacyInfo + // @param[in] rhs An instance of %PrivacyInfo // PrivacyInfo& operator =(const PrivacyInfo& rhs); - + private: - + class _PrivacyInfoImpl* __pImpl; friend class _PrivacyInfoImpl; - + }; // PrivacyInfo - + } } // Tizen::Security - + #endif // _FSEC_PRIVACY_INFO_H_ - + diff --git a/inc/FSecPrivacyManager.h b/inc/FSecPrivacyManager.h index ad91939..52b1beb 100755 --- a/inc/FSecPrivacyManager.h +++ b/inc/FSecPrivacyManager.h @@ -13,17 +13,17 @@ // See the License for the specific language governing permissions and // limitations under the License. // - + /** * @file FSecPrivacyManager.h * @brief This is the header file for the %PrivacyManager class. * * This header file contains the declarations of the %PrivacyManager class. */ - + #ifndef _FSEC_PRIVACY_MANAGER_H_ #define _FSEC_PRIVACY_MANAGER_H_ - + #include #include @@ -34,42 +34,42 @@ class IList; namespace Tizen { namespace Security { - + class PrivacyInfo; - + /** - * @class PrivacyManager - * @brief This class gets the privacy information and manages an application's privacy settings. + * @class PrivacyManager + * @brief This class provides methods for managing the privacy information and the application's privacy settings. * - * @since 2.1 + * @since 2.1 * - * @final This class is not intended for extension. + * @final This class is not intended for extension. * * The %PrivacyManager class lets an application to get or save application's privacy settings. */ - + class _OSP_EXPORT_ PrivacyManager : public Tizen::Base::Object { public: - + /** - * Gets the privacy manager instance. + * Gets a pointer to the %PrivacyManager instance. * * @since 2.1 * * @return A pointer to the %PrivacyManager instance, @n * else @c null if it fails * - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. * * @remarks The specific error code can be accessed using the GetLastResult() method. */ static PrivacyManager* GetInstance(void); - + /** - * Gets a list of packages which access user's privacy information. + * Gets the list of packages which access user's privacy information. * * @since 2.1 * @privlevel platform @@ -85,9 +85,9 @@ public: * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::Collection::IList* GetPrivacyAppPackageListN(void) const; - + /** - * Gets a list of privacy information of a package. + * Gets the list of privacy information of a package. * * @since 2.1 * @privlevel platform @@ -106,7 +106,7 @@ public: Tizen::Base::Collection::IList* GetPrivacyInfoListN(const Tizen::App::PackageId& packageId) const; /** - * Sets a specific privacy setting of a package. + * Sets the privacy setting of the specified package. * * @since 2.1 * @privlevel platform @@ -116,52 +116,53 @@ public: * @param[in] packageId The package ID * @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 is not defined to access the privacy information. + * @exception E_OBJ_NOT_FOUND Either of the following conditions has occurred: + * - The specified @c packageId is not found in privacy database. + * - 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. * */ result SetAppPackagePrivacy(const Tizen::App::PackageId& packageId, const PrivacyInfo& privacyInfo); - + private: - + // // This default constructor is intentionally declared as private to implement the %Singleton semantic. // - // @since 2.1 + // @since 2.1 // PrivacyManager(void); - + // // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects. // - // @since 2.1 + // @since 2.1 // PrivacyManager(const PrivacyManager& rhs); - + // // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects. // - // @since 2.1 + // @since 2.1 // PrivacyManager& operator =(const PrivacyManager& rhs); - + // // This destructor is intentionally declared as private to implement the %Singleton semantic. // - // @since 2.1 + // @since 2.1 // virtual ~PrivacyManager(void); - + private: - + class _PrivacyManagerImpl* __pPrivacyManagerImpl; friend class _PrivacyManagerImpl; - + }; // PrivacyManager - + }} // Tizen::Security - + #endif // _FSEC_PRIVACY_MANAGER_H_ diff --git a/inc/FSecPrivateKey.h b/inc/FSecPrivateKey.h index 0cc1ef0..425f17b 100644 --- a/inc/FSecPrivateKey.h +++ b/inc/FSecPrivateKey.h @@ -15,7 +15,7 @@ // /** - * @file FSecPrivateKey.h + * @file FSecPrivateKey.h * @brief This is the header file for the %PrivateKey class. * * This header file contains the declarations of the %PrivateKey class. @@ -32,13 +32,13 @@ namespace Tizen { namespace Security /** * @class PrivateKey - * @brief This class specifies the RSA private key. + * @brief This class provides methods to manage the RSA private key. * - * @since 2.0 + * @since 2.0 * - * The %PrivateKey class manages a private key, which is used in asymmetric ciphers. The RSA algorithm decrypts the data using the private key. @n + * The %PrivateKey class manages a private key, which is used in asymmetric ciphers. The RSA algorithm decrypts the data using the private key. @n * - * For more information on the class features, see Key Management and CSPRNG. + * For more information on the class features, see Key Management and CSPRNG. * * @see IKey * @see IPrivateKey @@ -54,43 +54,43 @@ public: /** * This is the default constructor for this class. * - * @since 2.0 + * @since 2.0 */ PrivateKey(void); /** - * This destructor overrides Tizen::Base::Object::~Object(). + * This destructor overrides Tizen::Base::Object::~Object(). * - * @since 2.0 + * @since 2.0 */ virtual ~PrivateKey(void); /** * Gets the name of the primary encoding format of the current instance of %PrivateKey. * - * @since 2.0 + * @since 2.0 * - * @return The primary encoding format of a key + * @return The primary encoding format of the key */ virtual Tizen::Base::String GetFormat(void) const; /** * Gets the private key in its primary encoding format. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class, @n - * else @c null if an error occurs + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetEncodedN(void) const; /** * Sets the private key buffer. * - * @since 2.0 + * @since 2.0 * * @return An error code * @param[in] keyBuffer An instance of Tizen::Base::ByteBuffer diff --git a/inc/FSecPrivilegeInfo.h b/inc/FSecPrivilegeInfo.h index c4362a5..af5a82b 100755 --- a/inc/FSecPrivilegeInfo.h +++ b/inc/FSecPrivilegeInfo.h @@ -23,9 +23,9 @@ #ifndef _FSEC_PRIVILEGE_INFO_H_ #define _FSEC_PRIVILEGE_INFO_H_ - + #include - + namespace Tizen { namespace Security { @@ -33,7 +33,7 @@ class _PrivilegeInfoImpl; /** * @class PrivilegeInfo -* @brief This class represents the privilege information. +* @brief This class provides methods for managing the privilege information. * * @since 2.1 * @@ -53,7 +53,7 @@ public: * 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.1 + * @since 2.1 */ PrivilegeInfo(void); @@ -68,22 +68,22 @@ public: /** * Initializes this instance of %PrivilegeInfo with the specified parameters. * - * @since 2.1 + * @since 2.1 * - * @return An error code - * @param[in] privilegeId The privilege ID - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c privilegeId is invalid. + * @return An error code + * @param[in] privilegeId The privilege ID + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified @c privilegeId is invalid. * */ result Construct(const Tizen::Base::String& privilegeId); /** - * Gets a privilege ID. + * Gets the privilege ID. * - * @since 2.1 + * @since 2.1 * - * @return The privilege ID + * @return The privilege ID * */ Tizen::Base::String GetId(void) const; @@ -91,10 +91,10 @@ public: /** * Gets the localized display name of privilege. * - * @since 2.1 + * @since 2.1 * - * @return The display name of privilege, @n - * 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; @@ -102,10 +102,10 @@ public: /** * Gets the localized description of privilege. * - * @since 2.1 + * @since 2.1 * - * @return The description of privilege, @n - * 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; @@ -115,14 +115,14 @@ private: // // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects. // - // @param[in] rhs An instance of %PrivilegeInfo + // @param[in] rhs An instance of %PrivilegeInfo // PrivilegeInfo(const PrivilegeInfo& rhs); // // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects. // - // @param[in] rhs An instance of %PrivilegeInfo + // @param[in] rhs An instance of %PrivilegeInfo // PrivilegeInfo& operator =(const PrivilegeInfo& rhs); diff --git a/inc/FSecPublicKey.h b/inc/FSecPublicKey.h index 53f37bb..63ab2b9 100644 --- a/inc/FSecPublicKey.h +++ b/inc/FSecPublicKey.h @@ -15,7 +15,7 @@ // /** - * @file FSecPublicKey.h + * @file FSecPublicKey.h * @brief This is the header file for the %PublicKey class. * * This header file contains the declarations of the %PublicKey class. @@ -32,9 +32,9 @@ namespace Tizen { namespace Security /** * @class PublicKey - * @brief This class specifies the RSA public key. + * @brief This class provides methods for managing the RSA public key. * - * @since 2.0 + * @since 2.0 * * The %PublicKey class manages a public key, which is used in asymmetric ciphers. * The RSA algorithm encrypts the data using the public key. @n @@ -54,21 +54,21 @@ public: /** * This is the default constructor for this class. * - * @since 2.0 + * @since 2.0 */ PublicKey(void); /** * This destructor overrides Tizen::Base::Object::~Object(). * - * @since 2.0 + * @since 2.0 */ virtual ~PublicKey(void); /** * Gets the name of the primary encoding format of the current instance of %PublicKey. * - * @since 2.0 + * @since 2.0 * * @return The primary encoding format of the key */ @@ -77,20 +77,20 @@ public: /** * Gets the public key in its primary encoding format. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class, @n - * else @c null if an error occurs + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::ByteBuffer* GetEncodedN(void) const; /** * Sets the public key buffer. * - * @since 2.0 + * @since 2.0 * * @return An error code * @param[in] keyBuffer An instance of Tizen::Base::ByteBuffer @@ -105,14 +105,14 @@ private: // // The implementation of this copy constructor is intentionally blank and declared as private to prohibit copying of objects. // - // @since 2.0 + // @since 2.0 // PublicKey(const PublicKey& rhs); // // The implementation of this copy assignment operator is intentionally blank and declared as private to prohibit copying of objects. // - // @since 2.0 + // @since 2.0 // PublicKey& operator =(const PublicKey& rhs); diff --git a/inc/FSecRsaKeyConverter.h b/inc/FSecRsaKeyConverter.h index 1cf437a..90cf88b 100755 --- a/inc/FSecRsaKeyConverter.h +++ b/inc/FSecRsaKeyConverter.h @@ -15,7 +15,7 @@ // /** - * @file FSecRsaKeyConverter.h + * @file FSecRsaKeyConverter.h * @brief This is the header file for the %RsaKeyConverter class. * * This header file contains the declarations of the %RsaKeyConverter class. @@ -31,30 +31,30 @@ namespace Tizen { namespace Security { /** - * @enum RsaKeyFormat + * @enum RsaKeyFormat * - * Defines the types of rsa key format. + * Defines the types of rsa key format. * - * @since 2.1 + * @since 2.1 */ enum RsaKeyFormat { - RSA_KEY_FORMAT_PKCS01_PRIVATE_KEY = 0, /**< The rsa key format is PKCS1 private key */ - RSA_KEY_FORMAT_PKCS01_PUBLIC_KEY = 1, /**< The rsa key format is PKCS1 public key */ - RSA_KEY_FORMAT_PKCS08_PRIVATE_KEY = 2, /**< The rsa key format is PKCS8 private key */ - RSA_KEY_FORMAT_X509_PUBLIC_KEY = 3, /**< The rsa key format is X509 public key */ - RSA_KEY_FORMAT_UNKNOWN = 0xffffffff /**< The rsa key format is unknown */ + RSA_KEY_FORMAT_PKCS01_PRIVATE_KEY = 0, /**< The rsa key format is PKCS1 private key */ + RSA_KEY_FORMAT_PKCS01_PUBLIC_KEY = 1, /**< The rsa key format is PKCS1 public key */ + RSA_KEY_FORMAT_PKCS08_PRIVATE_KEY = 2, /**< The rsa key format is PKCS8 private key */ + RSA_KEY_FORMAT_X509_PUBLIC_KEY = 3, /**< The rsa key format is X509 public key */ + RSA_KEY_FORMAT_UNKNOWN = 0xffffffff /**< The rsa key format is unknown */ }; //RsaKeyFormat; /** - * @class RsaKeyConverter - * @brief This class provides support for converting the RSA public/private key in multiple key formats and multiple encoding formats. + * @class RsaKeyConverter + * @brief This class provides methods for converting the RSA public/private key in multiple key formats and multiple encoding formats. * - * @since 2.1 + * @since 2.1 * - * The %RsaKeyConverter class provides support for converting the RSA public/private key in multiple key formats and multiple encoding formats. @n - * Supported RSA key formats are PKCS1/PKCS8/X509. @n - * Supported encoding formats are DER/PEM. + * The %RsaKeyConverter class provides support for converting the RSA public/private key in multiple key formats and multiple encoding formats. @n + * The supported RSA key formats are PKCS1/PKCS8/X509. @n + * The supported encoding formats are DER/PEM. */ class _OSP_EXPORT_ RsaKeyConverter @@ -62,38 +62,40 @@ class _OSP_EXPORT_ RsaKeyConverter public: /** - * Generates a RSA encoded private key in the passed input RSA key format. @n + * Generates an RSA encoded private key in the passed input RSA key format. @n * If the input private key is in PEM encoded format, then the output RSA private key will be PEM encoded; if it is in DER encoded format, * then the output RSA private key will be DER encoded. * * @since 2.1 * * @return A pointer to the encoded Tizen::Base::ByteBuffer instance, @n - * else @c null if the method fails to convert the private key in the passed input format - * @param[in] format An enum value that contains the RSA private key format @n - * Valid values for the supported output RSA private key formats are only @c RSA_KEY_FORMAT_PKCS01_PRIVATE_KEY and @c RSA_KEY_FORMAT_PKCS08_PRIVATE_KEY. - * @param[in] key An instance of IPrivateKey - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * else @c null if the method fails to convert the private key in the passed input format + * @param[in] format An enum value that contains the RSA private key format @n + * The valid values for the supported output RSA private key formats are only + * @c RSA_KEY_FORMAT_PKCS01_PRIVATE_KEY and @c RSA_KEY_FORMAT_PKCS08_PRIVATE_KEY. + * @param[in] key An instance of IPrivateKey + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Base::ByteBuffer* ConvertPrivateKeyFormatN(RsaKeyFormat format, const IPrivateKey& key); /** - * Generates a RSA encoded public key in the passed input RSA key format. @n + * Generates an RSA encoded public key in the passed input RSA key format. @n * If the input public key is in PEM encoded format, then the output RSA public key will be PEM encoded; if it is in DER encoded format, * then the output RSA public key will be DER encoded. * * @since 2.1 * * @return A pointer to the encoded Tizen::Base::ByteBuffer instance, @n - * else @c null if the method fails to convert the public key in the passed input format - * @param[in] format An enum value that contains the RSA public key format @n - * Valid values for the supported output RSA public key formats are only @c RSA_KEY_FORMAT_PKCS01_PUBLIC_KEY and @c RSA_KEY_FORMAT_X509_PUBLIC_KEY. - * @param[in] key An instance of IPublicKey - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * else @c null if the method fails to convert the public key in the passed input format + * @param[in] format An enum value that contains the RSA public key format @n + * The valid values for the supported output RSA public key formats are only + * @c RSA_KEY_FORMAT_PKCS01_PUBLIC_KEY and @c RSA_KEY_FORMAT_X509_PUBLIC_KEY. + * @param[in] key An instance of IPublicKey + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Base::ByteBuffer* ConvertPublicKeyFormatN(RsaKeyFormat format, const IPublicKey& key); @@ -103,12 +105,12 @@ public: * @since 2.1 * * @return A pointer to the PEM encoded Tizen::Base::ByteBuffer instance, @n - * else @c null if the method fails to convert the key in the PEM encoded format - * @param[in] format An enum value that contains the RSA key format of the input key - * @param[in] key An instance of IKey - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * else @c null if the method fails to convert the key in the PEM encoded format + * @param[in] format An enum value that contains the RSA key format of the input key + * @param[in] key An instance of IKey + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Base::ByteBuffer* ConvertDerToPemN(RsaKeyFormat format, const IKey& key); @@ -118,12 +120,12 @@ public: * @since 2.1 * * @return A pointer to the DER encoded Tizen::Base::ByteBuffer instance, @n - * else @c null if the method fails to convert the key in the DER encoded format + * else @c null if the method fails to convert the key in the DER encoded format * @param[in] format An enum value that contains the RSA key format of the input key * @param[in] key An instance of IKey - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG A specified input parameter is invalid. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Base::ByteBuffer* ConvertPemToDerN(RsaKeyFormat format, const IKey& key); @@ -160,7 +162,7 @@ private: class _RsaKeyConverterImpl* __pRsaKeyConverterImpl; friend class _RsaKeyConverterImpl; -}; //RsaKeyConverter +}; //RsaKeyConverter } } //Tizen::Security diff --git a/inc/FSecSecretKey.h b/inc/FSecSecretKey.h index 643c582..b3fedcb 100644 --- a/inc/FSecSecretKey.h +++ b/inc/FSecSecretKey.h @@ -15,7 +15,7 @@ // /** - * @file FSecSecretKey.h + * @file FSecSecretKey.h * @brief This is the header file for the %SecretKey class. * * This header file contains the declarations of the %SecretKey class. @@ -32,18 +32,19 @@ namespace Tizen { namespace Security /** * @class SecretKey - * @brief This class specifies a secret key. + * @brief This class provides methods for managing a secret key. * - * @since 2.0 + * @since 2.0 * - * The %SecretKey class manages a secret key, which is used in symmetric ciphers, such as Advanced Encryption Standard (AES), Data Encryption Standard (DES), and Triple Data Encryption Standard (3DES). @n + * The %SecretKey class manages a secret key, which is used in symmetric ciphers, such as Advanced Encryption Standard (AES), + * Data Encryption Standard (DES), and Triple Data Encryption Standard (3DES). @n * * For more information on the class features, see Key Management and CSPRNG. * - * @see IKey - * @see ISecretKey - * @see SecretKeyGenerator - * @see ISecretKeyGenerator + * @see IKey + * @see ISecretKey + * @see SecretKeyGenerator + * @see ISecretKeyGenerator */ class _OSP_EXPORT_ SecretKey : public virtual IKey @@ -55,21 +56,21 @@ public: /** * This is the default constructor for this class. * - * @since 2.0 + * @since 2.0 */ SecretKey(void); /** - * This destructor overrides Tizen::Base::Object::~Object(). + * This destructor overrides Tizen::Base::Object::~Object(). * - * @since 2.0 + * @since 2.0 */ virtual ~SecretKey(void); /** * Gets the name of the primary encoding format of the current instance of %SecretKey. * - * @since 2.0 + * @since 2.0 * * @return The primary encoding format of a key */ @@ -78,10 +79,10 @@ public: /** * Gets the secret key in its primary encoding format. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer class, @n - * else @c null if an error occurs + * else @c null if an error occurs * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -91,12 +92,12 @@ public: /** * Sets the secret key buffer. * - * @since 2.0 + * @since 2.0 * * @return An error code * @param[in] keyBuffer An instance of Tizen::Base::ByteBuffer * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c keyBuffer is invalid. + * @exception E_INVALID_ARG The specified @c keyBuffer is invalid. */ virtual result SetKey(const Tizen::Base::ByteBuffer& keyBuffer); @@ -122,7 +123,7 @@ private: class _SecretKeyImpl* __pSecretKeyImpl; friend class _SecretKeyImpl; -}; //SecretKey +}; //SecretKey } } // Tizen::Security diff --git a/inc/FSecSecretKeyGenerator.h b/inc/FSecSecretKeyGenerator.h index 9671a65..ac91aac 100755 --- a/inc/FSecSecretKeyGenerator.h +++ b/inc/FSecSecretKeyGenerator.h @@ -33,11 +33,12 @@ namespace Tizen { namespace Security /** * @class SecretKeyGenerator - * @brief This class is used for generating a secret (symmetric) key. + * @brief This class provides methods for generating a secret (symmetric) key. * - * @since 2.0 + * @since 2.0 * - * The %SecretKeyGenerator class generates a secret key, which is used in symmetric ciphers. The generated secret key is based on an encryption algorithm. @n + * The %SecretKeyGenerator class generates a secret key, which is used in symmetric ciphers. The generated secret key + * is based on an encryption algorithm. @n * * For more information on the class features, see Key Management and CSPRNG. * @@ -50,24 +51,24 @@ class _OSP_EXPORT_ SecretKeyGenerator public: /** - * The object is not fully constructed after this constructor is called. For full construction, @n - * the Construct() method must be called right after calling this constructor. + * The object is not fully constructed after this constructor is called. For full construction, @n + * the Construct() method must be called right after calling this constructor. * - * @since 2.0 + * @since 2.0 */ SecretKeyGenerator(void); /** - * This destructor overrides Tizen::Base::Object::~Object(). + * This destructor overrides Tizen::Base::Object::~Object(). * - * @since 2.0 + * @since 2.0 */ virtual ~SecretKeyGenerator(void); /** * Constructs and initializes this instance of %SecretKeyGenerator with the specified key. * - * @since 2.0 + * @since 2.0 * * @return An error code * @param[in] keyBytes The key of type Tizen::Base::ByteBuffer @@ -80,11 +81,11 @@ public: /** * Constructs and initializes this instance of %SecretKeyGenerator for the specified @c algorithm. * - * @since 2.0 + * @since 2.0 * * @return An error code * @param[in] algorithm The name of the secure random generator algorithm @n - * For example, "AES","DES", or "3DES". + * For example, "AES","DES", or "3DES". * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG The specified @c algorithm is invalid or an empty string. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -95,7 +96,7 @@ public: * Constructs and initializes this instance of %SecretKeyGenerator with the specified key size. @n * The default algorithm is Advanced Encryption Standard (AES). * - * @since 2.0 + * @since 2.0 * * @return An error code * @param[in] keySize The key size @@ -108,13 +109,13 @@ public: /** * Generates a new secret key. * - * @since 2.0 + * @since 2.0 * * @return A pointer to the ISecretKey interface, @n - * else @c null if it fails to generate a secret key + * else @c null if it fails to generate a secret key * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_SYSTEM A system error has occurred. + * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Security::ISecretKey* GenerateKeyN(void); diff --git a/inc/FSecurity.h b/inc/FSecurity.h index f29edfc..6ff18c0 100755 --- a/inc/FSecurity.h +++ b/inc/FSecurity.h @@ -60,14 +60,14 @@ * @namespace Tizen::Security * @brief This namespace contains classes and interfaces for security services. * - * @since 2.0 + * @since 2.0 * * @remarks @b Header @b %file: @b \#include @b @n - * @b Library : @b osp-appfw + * @b Library: @b osp-appfw * * - * The %Security namespace contains classes for - * managing certificates, cryptographic keys, signatures, and for generating pseudo-random numbers. @n + * The %Security namespace contains classes for managing certificates, cryptographic keys, signatures, + * and for generating pseudo-random numbers. @n * * For more information on the %Security namespace features, see Security Guide. @n * diff --git a/inc/FSysAlarm.h b/inc/FSysAlarm.h index 4436b99..b1da170 100644 --- a/inc/FSysAlarm.h +++ b/inc/FSysAlarm.h @@ -48,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); @@ -85,67 +86,73 @@ public: * @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; @@ -155,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; diff --git a/inc/FSysBattery.h b/inc/FSysBattery.h index 7cc8b14..9a995ec 100644 --- a/inc/FSysBattery.h +++ b/inc/FSysBattery.h @@ -42,9 +42,8 @@ namespace Tizen { namespace System * @deprecated This class is deprecated. Instead of using this class, use the PowerManager class. * @final This class is not intended for extension. * - * The %Battery class provides methods to get the status related to battery levels and - * determine whether the battery is currently being charged. - * You cannot create an instance of this class directly. + * The %Battery class provides methods to get the status related to battery levels and determine whether the battery is + * currently being charged. You cannot create an instance of this class directly. * * For more information on the class features, see Battery Status. * @endif @@ -66,12 +65,12 @@ public: * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompGetCurrentLevelInPercentage "here". * @endif - * @return An error code - * @param[out] level The percentage of the charge remaining in the battery - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[out] level The percentage of the charge remaining in the battery + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The battery service is not available. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The resolution of the level is @c 1% since 2.0. The range of the level is @c 0 (Minimum) to @c 100 (Maximum). + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @remarks The resolution of the level is @c 1% since 2.0. The range of the level is @c 0 (Minimum) to @c 100 (Maximum). * @endcond */ static result GetCurrentLevelInPercentage(int& level); @@ -102,11 +101,11 @@ public: * @compatibility This method has compatibility issues with OSP compatible applications. @n * For more information, see @ref CompGetCurrentLevel "here". * @endif - * @return An error code + * @return An error code * @param[out] level A value from the enumerator BatteryLevel indicating the current charging level - * @exception E_SUCCESS The method is successful. + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The battery service is not available. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @endcond */ static result GetCurrentLevel(BatteryLevel& level); @@ -139,10 +138,10 @@ public: * @endif * @return An error code * @param[out] charging Set to @c true if the charging cable is connected to the phone, @n - * else @c false - * @exception E_SUCCESS The method is successful. + * else @c false + * @exception E_SUCCESS The method is successful. * @exception E_INVALID_STATE The battery service is not available. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @endcond */ static result IsCharging(bool& charging); diff --git a/inc/FSysDeviceManager.h b/inc/FSysDeviceManager.h index 85ce055..9e0441b 100644 --- a/inc/FSysDeviceManager.h +++ b/inc/FSysDeviceManager.h @@ -69,9 +69,8 @@ enum DeviceType * * @final This class is not intended for extension. * - * The %DeviceManager class provides listener to handle events for various external device, - * such as a Bluetooth headset, HDMI, and headphone. - * This class also gets the current state of the device. You cannot create an instance of this class directly. + * The %DeviceManager class provides listeners to handle events for various external device, such as a Bluetooth headset, HDMI, + * and headphone. This class also gets the current state of the device. You cannot create an instance of this class directly. * * For more information on the class features, see External Device Management. * @@ -89,19 +88,19 @@ public: * @if OSPCOMPAT * @brief [Compatibility] * @endif - * @since 2.0 + * @since 2.0 * @if OSPCOMPAT * @compatibility This method has compatibility issues with %Tizen API versions @b prior @b to @b 2.0. @n - * For more information, see @ref DeviceManagerGetStatePage "here". + * For more information, see @ref DeviceManagerGetStatePage "here". * @endif * * @param[in] deviceType The value from the enumerator DeviceType indicating the device * @param[out] state The device state of type Tizen::Base::String * - * @return An error code - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. - * @exception E_INVALID_ARG The specified @c deviceType is not valid. + * @return An error code + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM A system error has occurred. + * @exception E_INVALID_ARG The specified @c deviceType is not valid. * @exception E_UNSUPPORTED_OPERATION The specified @c deviceType is not supported on this model. */ static result GetState(DeviceType deviceType, Tizen::Base::String& state); @@ -111,31 +110,31 @@ public: * @page DeviceManagerGetStatePage Compatibility for GetState() * @section DeviceManagerGetStatePageIssueSection Issues * Implementation of this method in OSP compatible applications has the following issue: @n - * The GetState() method does not return E_DEVICE_UNAVAILABLE anymore. The E_DEVICE_UNAVAILABLE exception is removed. + * The GetState() method does not return @c E_DEVICE_UNAVAILABLE anymore. The @c E_DEVICE_UNAVAILABLE exception is removed. * @section DeviceManagerGetStatePageIssueSection Resolutions - * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE. + * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use @c E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE. * @endif */ /** - * Adds a device event listener. + * Adds the device event listener. * * @if OSPCOMPAT * @brief [Compatibility] * @endif - * @since 2.0 + * @since 2.0 * @if OSPCOMPAT * @compatibility This method has compatibility issues with %Tizen API versions @b prior @b to @b 2.0. @n * For more information, see @ref DeviceManagerAddDeviceEventListenerPage "here". * @endif * - * @return An error code - * @param[in] deviceType The types of a device - * @param[in] listener The device event listener - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. - * @exception E_INVALID_ARG The specified @c deviceType is not valid. - * @exception E_OBJ_ALREADY_EXIST The specified @c deviceType and @c listener are already registered. + * @return An error code + * @param[in] deviceType The device type + * @param[in] listener The device event listener + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM A system error has occurred. + * @exception E_INVALID_ARG The specified @c deviceType is not valid. + * @exception E_OBJ_ALREADY_EXIST The specified @c deviceType and @c listener are already registered. * @exception E_UNSUPPORTED_OPERATION The specified @c deviceType is not supported on this model. */ static result AddDeviceEventListener(DeviceType deviceType, IDeviceEventListener& listener); @@ -145,24 +144,24 @@ public: * @page DeviceManagerAddDeviceEventListenerPage Compatibility for AddDeviceEventListener() * @section DeviceManagerAddDeviceEventListenerPageIssueSection Issues * Implementation of this method in OSP compatible applications has the following issue: @n - * This AddDeviceEventListener() method does not return E_DEVICE_UNAVAILABLE anymore. The E_DEVICE_UNAVAILABLE exception is removed. + * This AddDeviceEventListener() method does not return @c E_DEVICE_UNAVAILABLE anymore. The @c E_DEVICE_UNAVAILABLE exception is removed. * @section DeviceManagerAddDeviceEventListenerPageIssueSection Resolutions - * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE. + * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use @c E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE. * @endif */ /** - * Removes a device event listener from all types of devices. + * Removes the device event listener from all types of devices. * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] deviceType The types of a device - * @param[in] listener The device event listener - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. - * @exception E_INVALID_ARG The specified @c deviceType is not valid. - * @exception E_OBJ_NOT_FOUND The specified @c deviceType and @c listener are not registered. + * @return An error code + * @param[in] deviceType The types of a device + * @param[in] listener The device event listener + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM A system error has occurred. + * @exception E_INVALID_ARG The specified @c deviceType is not valid. + * @exception E_OBJ_NOT_FOUND The specified @c deviceType and @c listener are not registered. * @exception E_UNSUPPORTED_OPERATION The specified @c deviceType is not supported on this model. */ static result RemoveDeviceEventListener(DeviceType deviceType, IDeviceEventListener& listener); @@ -172,18 +171,18 @@ public: * @page DeviceManagerRemoveDeviceEventListenerPage Compatibility for RemoveDeviceEventListener() * @section DeviceManagerRemoveDeviceEventListenerPageIssueSection Issues * Implementation of this method in OSP compatible applications has the following issue: @n - * This RemoveDeviceEventListener() method does not return E_DEVICE_UNAVAILABLE anymore. The E_DEVICE_UNAVAILABLE exception is removed. + * This RemoveDeviceEventListener() method does not return @c E_DEVICE_UNAVAILABLE anymore. The @c E_DEVICE_UNAVAILABLE exception is removed. * @section DeviceManagerRemoveDeviceEventListenerPageIssueSection Resolutions - * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE. + * The E_UNSUPPORTED_OPERATION exception is added since Tizen. So, use @c E_UNSUPPORTED_OPERATION instead of E_DEVICE_UNAVAILABLE. * @endif */ /** - * Removes all device event listeners. + * Removes all the device event listeners. * - * @since 2.0 + * @since 2.0 * - * @return An error code + * @return An error code * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. */ diff --git a/inc/FSysEnvironment.h b/inc/FSysEnvironment.h index f039d85..5874d4f 100644 --- a/inc/FSysEnvironment.h +++ b/inc/FSysEnvironment.h @@ -72,7 +72,7 @@ class _OSP_EXPORT_ Environment public: /** - * Gets the path for the media directory that is usually used to store media contents. + * Gets the path for the media directory that stores the media contents. * * @since 2.0 * @@ -81,7 +81,7 @@ public: static Tizen::Base::String GetMediaPath(void); /** - * Gets the path for the default download directory that is usually used to store downloaded contents by the Tizen::Content::DownloadManager class. + * Gets the path for the default download directory that stores the downloaded contents by the Tizen::Content::DownloadManager class. * * @since 2.0 * @@ -101,14 +101,14 @@ public: /** * Gets the directory path according to the pre-defined directory type. * - * @since 2.0 + * @since 2.0 * - * @return The pre-defined directory path according to the specified @c dirType, @n - * else an empty string if the specified @c dirType is invalid - * @param[in] dirType The pre-defined directory type - * @remarks The directory path for some directory types such as IMAGES, SOUNDS, VIDEOS, CAMERA, DOWNLOADS, and OTHERS may not yet exist, - * so you must make sure that it exists before using it. - * @see Tizen::Io::Directory::Create() + * @return The pre-defined directory path according to the specified @c dirType, @n + * else an empty string if the specified @c dirType is invalid + * @param[in] dirType The pre-defined directory type + * @remarks The directory path for some directory types such as IMAGES, SOUNDS, VIDEOS, CAMERA, DOWNLOADS, and OTHERS may not yet exist, + * so you must make sure that it exists before using it. + * @see Tizen::Io::Directory::Create() */ static Tizen::Base::String GetPredefinedPath(PredefinedDirectoryType dirType); diff --git a/inc/FSysIAlarmEventListener.h b/inc/FSysIAlarmEventListener.h index b3e9ff6..23c33eb 100644 --- a/inc/FSysIAlarmEventListener.h +++ b/inc/FSysIAlarmEventListener.h @@ -35,7 +35,7 @@ class Alarm; /** * @interface IAlarmEventListener - * @brief This interface is the listener of the alarm event. + * @brief This interface is the listener of the alarm event. * * @since 2.0 * @@ -47,7 +47,9 @@ class _OSP_EXPORT_ IAlarmEventListener { public: /** - * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This is the destructor for this class. @n + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ diff --git a/inc/FSysIBatteryEventListener.h b/inc/FSysIBatteryEventListener.h index 3c0a1c8..736d24f 100644 --- a/inc/FSysIBatteryEventListener.h +++ b/inc/FSysIBatteryEventListener.h @@ -32,7 +32,7 @@ namespace Tizen { namespace System /** * @interface IBatteryEventListener - * @brief This interface is the listener of the battery event. + * @brief This interface is the listener of the battery event. * * @since 2.0 * @@ -44,9 +44,11 @@ class _OSP_EXPORT_ IBatteryEventListener { public: /** - * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This is the destructor for this class. @n + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * - * @since 2.0 + * @since 2.0 */ virtual ~IBatteryEventListener(void) {} @@ -55,7 +57,7 @@ public: * * @since 2.0 * - * @param[in] percentage The changed battery level + * @param[in] percentage The changed battery level * @remarks The resolution of the level is @c 5%. The range of the level is @c 0 (Minimum) to @c 100 (Maximum). */ virtual void OnBatteryLevelChangedInPercentage(int percentage) = 0; diff --git a/inc/FSysIBootEventListener.h b/inc/FSysIBootEventListener.h index fe6022a..c9e56e1 100644 --- a/inc/FSysIBootEventListener.h +++ b/inc/FSysIBootEventListener.h @@ -32,7 +32,7 @@ namespace Tizen { namespace System /** * @interface IBootEventListener - * @brief This interface is the listener of the boot event. + * @brief This interface is the listener of the boot event. * * @since 2.1 * @@ -44,7 +44,9 @@ class _OSP_EXPORT_ IBootEventListener { public: /** - * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This is the destructor for this class. @n + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.1 */ diff --git a/inc/FSysIChargingEventListener.h b/inc/FSysIChargingEventListener.h index 9bfbc81..57890d4 100644 --- a/inc/FSysIChargingEventListener.h +++ b/inc/FSysIChargingEventListener.h @@ -32,7 +32,7 @@ namespace Tizen { namespace System /** * @interface IChargingEventListener - * @brief This interface is the listener of the charging event. + * @brief This interface is the listener for charging events. * @since 2.0 * * The %IChargingEventListener interface must be registered and implemented by an application to @@ -44,9 +44,11 @@ class _OSP_EXPORT_ IChargingEventListener { public: /** - * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This is the destructor for this class. @n + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * - * @since 2.0 + * @since 2.0 */ virtual ~IChargingEventListener(void) {} diff --git a/inc/FSysIDeviceEventListener.h b/inc/FSysIDeviceEventListener.h index 834d155..6b2d0a0 100644 --- a/inc/FSysIDeviceEventListener.h +++ b/inc/FSysIDeviceEventListener.h @@ -33,7 +33,7 @@ namespace Tizen { namespace System /** * @interface IDeviceEventListener - * @brief This interface is the listener of the device state changes. + * @brief This interface is the listener of the device state changes. * * @since 2.0 * @@ -46,7 +46,9 @@ class _OSP_EXPORT_ IDeviceEventListener { public: /** - * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This is the destructor for this class. @n + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -57,7 +59,7 @@ public: * * @since 2.0 * - * @param[in] deviceType The types of a device + * @param[in] deviceType The device type * @param[in] state The device state of type Tizen::Base::String */ virtual void OnDeviceStateChanged(DeviceType deviceType, const Tizen::Base::String& state) = 0; diff --git a/inc/FSysIRuntimeInfoGetIntAsyncResultListener.h b/inc/FSysIRuntimeInfoGetIntAsyncResultListener.h index 3a17c89..89fd757 100644 --- a/inc/FSysIRuntimeInfoGetIntAsyncResultListener.h +++ b/inc/FSysIRuntimeInfoGetIntAsyncResultListener.h @@ -31,12 +31,13 @@ namespace Tizen { namespace System { /** -* @interface IRuntimeInfoGetIntAsyncResultListener -* @brief This interface defines the result listener for an asynchronous method call to the %RuntimeInfo class. +* @interface IRuntimeInfoGetIntAsyncResultListener +* @brief This interface defines the result listener for an asynchronous method call to the %RuntimeInfo class. * * @since 2.0 * -* The %IRuntimeInfoGetIntAsyncResultListener interface defines the result listener for an asynchronous method call to the RuntimeInfo class. An instance of this interface is removed automatically by platform, after result is notified. +* The %IRuntimeInfoGetIntAsyncResultListener interface defines the result listener for an asynchronous method call to the +* RuntimeInfo class. An instance of this interface is removed automatically by the platform, after result is notified. * */ class _OSP_EXPORT_ IRuntimeInfoGetIntAsyncResultListener @@ -44,7 +45,8 @@ class _OSP_EXPORT_ IRuntimeInfoGetIntAsyncResultListener { public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are when the destructor of this interface is called. * * @since 2.0 */ @@ -54,10 +56,10 @@ public: * * @since 2.0 * - * @param[in] value The @c int type runtime information - * @param[in] r An error code - * @exception E_SUCCESS The result is successful. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] value The @c int type runtime information + * @param[in] r An error code + * @exception E_SUCCESS The result is successful. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ virtual void OnResultReceivedForGetValueAsync(int value, result r) = 0; diff --git a/inc/FSysIRuntimeInfoGetLonglongAsyncResultListener.h b/inc/FSysIRuntimeInfoGetLonglongAsyncResultListener.h index 2e8c177..ceb7fb5 100644 --- a/inc/FSysIRuntimeInfoGetLonglongAsyncResultListener.h +++ b/inc/FSysIRuntimeInfoGetLonglongAsyncResultListener.h @@ -31,12 +31,13 @@ namespace Tizen { namespace System { /** -* @interface IRuntimeInfoGetLonglongAsyncResultListener -* @brief This interface defines the result listener for an asynchronous method call to the %RuntimeInfo class. +* @interface IRuntimeInfoGetLonglongAsyncResultListener +* @brief This interface defines the result listener for an asynchronous method call to the %RuntimeInfo class. * -* @since 2.0 +* @since 2.0 * -* The %IRuntimeInfoGetLonglongAsyncResultListener interface defines the result listener for an asynchronous method call to the RuntimeInfo class. An instance of this interface is removed automatically by platform, after result is notified. +* The %IRuntimeInfoGetLonglongAsyncResultListener interface defines the result listener for an asynchronous method call +* to the RuntimeInfo class. An instance of this interface is removed automatically by the platform, after result is notified. * */ class _OSP_EXPORT_ IRuntimeInfoGetLonglongAsyncResultListener @@ -44,7 +45,8 @@ class _OSP_EXPORT_ IRuntimeInfoGetLonglongAsyncResultListener { public: /** - * This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -54,10 +56,10 @@ public: * * @since 2.0 * - * @param[in] value The @c long @c long type runtime information - * @param[in] r An error code - * @exception E_SUCCESS The result is successful. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] value The @c long @c long type runtime information + * @param[in] r An error code + * @exception E_SUCCESS The result is successful. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ virtual void OnResultReceivedForGetValueAsync(long long value, result r) = 0; diff --git a/inc/FSysIScreenEventListener.h b/inc/FSysIScreenEventListener.h index 8357610..671b805 100644 --- a/inc/FSysIScreenEventListener.h +++ b/inc/FSysIScreenEventListener.h @@ -32,7 +32,7 @@ namespace Tizen { namespace System /** * @interface IScreenEventListener - * @brief This interface is the listener of the screen event. + * @brief This interface is the listener of the screen event. * * @since 2.0 * @@ -53,9 +53,11 @@ public: /** * Called when the screen turns off. @n - * Unless there is a strong reason to do otherwise, release resources (such as 3D, media, and sensors) to allow the device to enter the sleep mode to save the battery. - * Invoking a lengthy asynchronous method within this listener method can be risky, because it is not guaranteed to invoke a callback before the device enters the sleep mode. - * Similarly, do not perform lengthy operations in this listener method. All operations must be quick ones. + * Unless there is a strong reason to do otherwise, release the resources (such as 3D, media, and sensors) to allow the device + * to enter the sleep mode to save the battery. @n + * Invoking a lengthy asynchronous method within this listener method can be risky, because it is not guaranteed to invoke a + * callback before the device enters the sleep mode. Similarly, do not perform lengthy operations in this listener method. @n + * All operations must be quick ones. * *@since 2.0 */ diff --git a/inc/FSysISettingEventListener.h b/inc/FSysISettingEventListener.h index 573fd19..280494c 100644 --- a/inc/FSysISettingEventListener.h +++ b/inc/FSysISettingEventListener.h @@ -32,7 +32,7 @@ namespace Tizen { namespace System /** * @interface ISettingEventListener - * @brief This interface is the listener of the setting event. + * @brief This interface is the listener of the setting event. * * @since 2.0 * @@ -44,18 +44,21 @@ class _OSP_EXPORT_ ISettingEventListener { public: /** - * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This is the destructor for this class. @n + * This polymorphic destructor should be overridden if required. @n This way, + * the destructors of the derived classes are called when the destructor of this interface is called. * - * @since 2.0 + * @since 2.0 */ virtual ~ISettingEventListener(void) {} /** - * Called when a certain setting value has been changed. + * Called when a setting value has been changed. * * @since 2.0 * - * @param[in] key The key name of the changed setting information - * @remarks Invokes one of the overloaded getter methods of Tizen::System::SettingInfo to get the changed value corresponding to the given key. + * @param[in] key The key name of the changed setting information + * @remarks Invokes one of the overloaded getter methods of Tizen::System::SettingInfo to get the changed value + * corresponding to the given key. */ virtual void OnSettingChanged(Tizen::Base::String& key) = 0; diff --git a/inc/FSysISettingInfoSetValueAsyncResultListener.h b/inc/FSysISettingInfoSetValueAsyncResultListener.h index c1c5b7d..e105fed 100644 --- a/inc/FSysISettingInfoSetValueAsyncResultListener.h +++ b/inc/FSysISettingInfoSetValueAsyncResultListener.h @@ -36,7 +36,8 @@ namespace Tizen { namespace System * * @since 2.0 * - * The %ISettingInfoSetValueAsyncResultListener interface must be registered and implemented by an application to receive result for an asynchronous setting change method call. + * The %ISettingInfoSetValueAsyncResultListener interface must be registered and implemented by an application + * to receive result for an asynchronous setting change method call. * */ class _OSP_EXPORT_ ISettingInfoSetValueAsyncResultListener @@ -44,7 +45,9 @@ class _OSP_EXPORT_ ISettingInfoSetValueAsyncResultListener { public: /** - * This is the destructor for this class. This polymorphic destructor should be overridden if required. This way, the destructors of the derived classes are called when the destructor of this interface is called. + * This is the destructor for this class. @n + * This polymorphic destructor should be overridden if required. @n + * This way, the destructors of the derived classes are called when the destructor of this interface is called. * * @since 2.0 */ @@ -55,10 +58,10 @@ public: * * @since 2.0 * - * @param[in] key The key name of the changed setting information - * @param[in] r An error code - * @exception E_SUCCESS The result is successful. - * @exception E_SYSTEM The method cannot proceed due to severe system error. + * @param[in] key The key name of the changed setting information + * @param[in] r An error code + * @exception E_SUCCESS The result is successful. + * @exception E_SYSTEM The method cannot proceed due to severe system error. */ virtual void OnResultReceivedForSetValueAsync(const Tizen::Base::String& key, result r) = 0; diff --git a/inc/FSysPowerManager.h b/inc/FSysPowerManager.h index 124fd8e..0986dbd 100644 --- a/inc/FSysPowerManager.h +++ b/inc/FSysPowerManager.h @@ -49,17 +49,19 @@ enum BatteryLevel BATTERY_LOW, // This enum value is deprecated. Instead of using this enum value, use BATTERY_LEVEL_LOW. BATTERY_CRITICAL, // This enum value is deprecated. Instead of using this enum value, use BATTERY_LEVEL_CRITICAL. BATTERY_EMPTY, // This enum value is deprecated. Instead of using this enum value, use BATTERY_LEVEL_EMPTY. - BATTERY_LEVEL_FULL = BATTERY_FULL,/**< The battery is fully charged */ - BATTERY_LEVEL_HIGH = BATTERY_HIGH,/**< The battery has plenty of charge */ - BATTERY_LEVEL_LOW = BATTERY_LOW,/**< The battery has little charge */ - BATTERY_LEVEL_CRITICAL = BATTERY_CRITICAL,/**< The battery charge is at a critical state @n It is strongly recommended to stop using all multimedia features because they are not guaranteed to work correctly at this level. */ - BATTERY_LEVEL_EMPTY = BATTERY_EMPTY, /**< The battery is empty @n It is strongly recommended to prepare for the safe termination of the application because the device will start a shutdown process soon after entering this level. */ + BATTERY_LEVEL_FULL = BATTERY_FULL, /**< The battery is fully charged */ + BATTERY_LEVEL_HIGH = BATTERY_HIGH, /**< The battery has plenty of charge */ + BATTERY_LEVEL_LOW = BATTERY_LOW, /**< The battery has little charge */ + BATTERY_LEVEL_CRITICAL = BATTERY_CRITICAL, /**< The battery charge is at a critical state @n + It is strongly recommended to stop using all multimedia features because they are not guaranteed to work correctly at this level. */ + BATTERY_LEVEL_EMPTY = BATTERY_EMPTY, /**< The battery is empty @n + It is strongly recommended to prepare for the safe termination of the application because the device will start a shutdown process soon after entering this level. */ }; /** * @enum PowerMode * - * Defines the representation of the charge remaining in the battery. + * Defines the representation of the power mode. * * @since 2.0 */ @@ -67,8 +69,8 @@ enum PowerMode { POWER_STANDBY, // This enum value is deprecated. Instead of using this enum value, use POWER_MODE_STANDBY. POWER_SLEEP, // This enum value is deprecated. Instead of using this enum value, use POWER_MODE_SLEEP. - POWER_MODE_STANDBY = POWER_STANDBY, /**< The battery is fully charged */ - POWER_MODE_SLEEP = POWER_SLEEP, /**< The battery has plenty of charge */ + POWER_MODE_STANDBY = POWER_STANDBY, /**< The standby power mode */ + POWER_MODE_SLEEP = POWER_SLEEP, /**< The sleep power mode */ }; /** @@ -93,144 +95,151 @@ public: /** * Changes the policy of the screen power management. * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/power * - * @return An error code - * @param[in] keepOn Set to @c true if the screen remains in the 'ON' state until the application goes to the background(inactivated), @n - * else @c false if the state of the screen is controlled by the default power control policy of the system - * @param[in] dimming Set to @c true if the screen is dimmed when there is no user input for a certain amount of time, @n - * else @c false if the screen is not dimmed - * @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. - * @remarks This screen power control is available only when an application is active. To check the events that are active, use the Tizen::Ui::Controls::IFrameEventListener::OnFrameActivated() method. + * @return An error code + * @param[in] keepOn Set to @c true for the screen to remain in the 'ON' state until the application goes to the background(inactivated), @n + * else @c false for the state of the screen to be controlled by the default power control policy of the system + * @param[in] dimming Set to @c true to dim the screen when there is no user input for a certain amount of time, @n + * else @c false to not dim the screen + * @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. + * @remarks The screen power control is available only when an application is active. @n + * To check the events that are active, use the Tizen::Ui::Controls::IFrameEventListener::OnFrameActivated() method. */ static result KeepScreenOnState(bool keepOn, bool dimming = true); /** * Restores the screen brightness control. * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_STATE The brightness is never changed. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see SetScreenBrightness() + * @return An error code + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_STATE The brightness is never changed. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @see SetScreenBrightness() */ static result RestoreScreenBrightness(void); /** * Sets the screen brightness level for an application. * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/power * - * @return An error code - * @param[in] brightness The brightness level to set between @c 1 (minimum) and @c 10 (maximum). - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] brightness The brightness level to set between @c 1 (minimum) and @c 10 (maximum). + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_OUT_OF_RANGE The specified @c brightness is out of range. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks This brightness level change is available only when an application is active. To check the events that are active, use the Tizen::Ui::Controls::IFrameEventListener::OnFrameActivated() method. Even if the brightness is set to level 1, a black screen is not displayed. Level 1 is the minimum brightness level that can be set for an application. To know more about screen off, see the TurnScreenOff() method. - * @see RestoreScreenBrightness() - * @see TurnScreenOff() + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @remarks The brightness level change is available only when an application is active. @n + * To check the events that are active, use the Tizen::Ui::Controls::IFrameEventListener::OnFrameActivated() method. @n + * Even if the brightness is set to level 1, a black screen is not displayed. + * Level 1 is the minimum brightness level that can be set for an application. @n + * To know more about turning the screen off, see the TurnScreenOff() method. + * @see RestoreScreenBrightness() */ static result SetScreenBrightness(int brightness); /** * Gets the screen brightness level of an application. * - * @since 2.0 + * @since 2.0 * - * @return The brightness level of the current application - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks This method returns the screen brightness level set for an application. If the brightness level is not set, it will return the default system brightness level. @n - * In case of error, this method returns @c -1. + * @return The brightness level of the current application, @n + * else @c -1 in case of error + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM A system error has occurred. + * @remarks + * - This method returns the screen brightness level set for an application. If the brightness level is not set, + * it will return the default system brightness level. + * - The specific error code can be accessed using the GetLastResult() method. */ static int GetScreenBrightness(void); /** * Checks whether the screen is on. * - * @since 2.0 + * @since 2.0 * - * @return @c true if the screen is on, @n - * else @c false - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM A system error has occurred. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks This method returns @c true when the screen is in the dimming state, and @c false in case of an error. + * @return @c true if the screen is on, @n + * else @c false + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM A system error has occurred. + * @remarks + * - This method returns @c true when the screen is in the dimming state, and @c false in case of an error. + * - The specific error code can be accessed using the GetLastResult() method. */ static bool IsScreenOn(void); /** - * Turns on the screen. + * Turns the screen on. * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/power * - * @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. */ static result TurnScreenOn(void); /** - * Turns off the screen. + * Turns the screen off. * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/power * - * @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. */ static result TurnScreenOff(void); /** - * Changes the policy of the CPU (Central Processing Unit) power management. + * Sets the policy of the CPU (Central Processing Unit) power management. * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/power * - * @return An error code + * @return An error code * @param[in] enable Set to @c true to prevent the CPU from going into sleep mode, @n - * else @c false to let the state of the CPU follow the system default power management policy - * @exception E_SUCCESS The method is successful. + * else @c false to let the state of the CPU follow the system default power management policy + * @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. - * @remarks This method keeps CPU power state only. Screen state or lock screen is not managed by this method. + * @exception E_SYSTEM A system error has occurred. + * @remarks This method only manages the CPU power state. The screen state or lock screen is not managed by this method. */ static result KeepCpuAwake(bool enable); /** * Sets the screen event listener. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated. @n - * Instead of using this method, use AddScreenEventListener() and RemoveScreenEventListener(). - * @since 2.0 + * 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 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. + * @remarks This method always overwrites the first element of internal IScreenEventListener list. @n + * 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); @@ -240,25 +249,23 @@ public: * * @since 2.1 * - * @param[in] listener The screen event listener - * @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 + * @param[in] listener The screen event listener + * @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 RemoveScreenEventListener() */ static result AddScreenEventListener(IScreenEventListener& listener); /** - * Removes the screen event listener. + * Removes the specified screen event listener. * * @since 2.1 * - * @param[in] listener The screen event listener - * @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 + * @param[in] listener The screen event listener + * @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 AddScreenEventListener() */ static result RemoveScreenEventListener(IScreenEventListener& listener); @@ -267,43 +274,42 @@ public: /** * Sets the charging event listener. * - * @brief [Deprecated] + * @brief [Deprecated] * @deprecated This method is deprecated. @n - * Instead of using this method, use AddChargingEventListener() and RemoveChargingEventListener(). - * @since 2.0 + * 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, - * which may not be an expected behavior by API users. So, it is not recommended to use this method. + * @remarks + * - This method always overwrites the first element of internal IChargingEventListener list. + * - The first element added by AddChargingEventListener() may be overwritten by this method, + * which may not be the expected behavior. So, it is not recommended to use this method. */ static void SetChargingEventListener(IChargingEventListener& listener); /** * Adds the charging event listener. * - * @since 2.1 + * @since 2.1 * - * @param[in] listener The charging event listener - * @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 - * @see RemoveChargingEventListener() + * @param[in] listener The charging event listener + * @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 RemoveChargingEventListener() */ static result AddChargingEventListener(IChargingEventListener& listener); /** * Removes the charging event listener. * - * @since 2.1 + * @since 2.1 * - * @param[in] listener The charging event listener - * @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 - * @see AddChargingEventListener() + * @param[in] listener The charging event listener + * @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 AddChargingEventListener() */ static result RemoveChargingEventListener(IChargingEventListener& listener); @@ -316,7 +322,7 @@ public: * @param[in] pListener The battery event listener * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. - * @remarks If @c pListener is set to @c null, the pre-registered listener is unregistered. + * @remarks If @c pListener is set to @c null, the current listener is unregistered. */ static result SetBatteryEventListener(IBatteryEventListener* pListener); @@ -325,12 +331,13 @@ public: * * @since 2.0 * - * @return The percentage of the charge remaining in the battery. - * @exception E_SUCCESS The method is successful. - * @exception E_UNSUPPORTED_OPERATION The method is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks The resolution of the level is @c 1 percentage. The range of the level is minimum @c 0 to maximum @c 100. + * @return The percentage of the charge remaining in the battery. + * @exception E_SUCCESS The method is successful. + * @exception E_UNSUPPORTED_OPERATION The method is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @remarks + * - The resolution of the level is @c 1 percentage. The range of the level is minimum @c 0 to maximum @c 100. + * - The specific error code can be accessed using the GetLastResult() method. */ static int GetCurrentBatteryLevelInPercentage(void); @@ -339,25 +346,25 @@ public: * * @since 2.0 * - * @return A value from the enumerator BatteryLevel indicating the current charging level - * @exception E_SUCCESS The method is successful. - * @exception E_UNSUPPORTED_OPERATION The method is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @return A value from the enumerator BatteryLevel indicating the current charging level + * @exception E_SUCCESS The method is successful. + * @exception E_UNSUPPORTED_OPERATION The method is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ static BatteryLevel GetCurrentBatteryLevel(void); /** * Checks whether the battery is currently charging. * - * @since 2.0 + * @since 2.0 * - * @return @c true if the charging cable is connected to the phone, @n - * else @c false - * @exception E_SUCCESS The method is successful. - * @exception E_UNSUPPORTED_OPERATION The method is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @return @c true if the charging cable is connected to the phone, @n + * else @c false + * @exception E_SUCCESS The method is successful. + * @exception E_UNSUPPORTED_OPERATION The method is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ static bool IsCharging(void); @@ -367,23 +374,23 @@ public: * @since 2.1 * * @return An error code - * @param[in] listener The boot event listener - * @exception E_SUCCESS The method is successful. + * @param[in] listener The boot event listener + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_ALREADY_EXIST The listener is already added. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result AddBootEventListener(IBootEventListener& listener); /** * Removes the boot event listener. * - * @since 2.1 + * @since 2.1 * * @return An error code - * @param[in] listener The boot event listener - * @exception E_SUCCESS The method is successful. + * @param[in] listener The boot event listener + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_ALREADY_EXIST The listener is not added. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result RemoveBootEventListener(IBootEventListener& listener); diff --git a/inc/FSysRuntimeInfo.h b/inc/FSysRuntimeInfo.h index 822140d..8aeeb85 100644 --- a/inc/FSysRuntimeInfo.h +++ b/inc/FSysRuntimeInfo.h @@ -42,7 +42,8 @@ class IRuntimeInfoGetLonglongAsyncResultListener; * * @final This class is not intended for extension. * - * The %RuntimeInfo class provides runtime information, such as the allocated memory used by the application storage, memory, and CPU utilization. To get the information, you must provide the RuntimeInfo key. + * The %RuntimeInfo class provides runtime information, such as the allocated memory used by the application storage, memory, and CPU utilization. + * To get the information, you must provide the RuntimeInfo key. * * For more information on the class features, see Runtime Information. * @@ -80,49 +81,46 @@ class _OSP_EXPORT_ RuntimeInfo public: /** - * Gets the specific Tizen::Base::String type runtime information based on the specified - * designators (key). + * Gets the Tizen::Base::String type runtime information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the runtime information - * @param[out] value The runtime information of type Tizen::Base::String - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] key The key name of the runtime information + * @param[out] value The runtime information of type Tizen::Base::String + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, Tizen::Base::String& value); /** - * Gets the specific integer type runtime information based on the specified - * designators (key). + * Gets the integer type runtime information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the runtime information @n + * @return An error code + * @param[in] key The key name of the runtime information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. * - @b Deprecated All the key values provided prior to %Tizen are deprecated. For more detailed information, refer * here. * @endif - * @param[out] value The integer type runtime information - * @exception E_SUCCESS The method is successful. + * @param[out] value The integer type runtime information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, int& value); /** - * Gets the specific @c long @c long type runtime information based on the specified - * designators (key). + * Gets the @c long @c long type runtime information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the runtime information @n + * @return An error code + * @param[in] key The key name of the runtime information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. @@ -130,83 +128,80 @@ public: * here. * @xmlonly @endxmlonly MaxAllocatableMemory, AvailableVideoMemory @xmlonly @endxmlonly * @endif - * @param[out] value The @c long @c long type runtime information - * @exception E_SUCCESS The method is successful. + * @param[out] value The @c long @c long type runtime information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, long long& value); /** - * Gets the specific double type runtime information based on the specified - * designators (key). + * Gets the double type runtime information based on the specified designators (key). * * @since 2.0 * - * @return An error code - * @param[in] key The key name of the runtime information - * @param[out] value The @c double type runtime information - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] key The key name of the runtime information + * @param[out] value The @c double type runtime information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, double& value); /** - * Gets the specific @c bool type runtime information based on the specified - * designators (key). + * Gets the @c bool type runtime information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the runtime information - * @param[out] value The @c bool type runtime information - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] key The key name of the runtime information + * @param[out] value The @c bool type runtime information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, bool& value); /** - * Gets the specific UuId type runtime information based on the specified - * designators (key). + * Gets the UuId type runtime information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the runtime information - * @param[out] value The UuId type runtime information - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] key The key name of the runtime information + * @param[out] value The UuId type runtime information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, Tizen::Base::UuId& value); /** - * Gets the specific @c long @c long type runtime information based on specified designators (key) asynchronously. + * Gets the @c long @c long type runtime information based on specified designators (key) asynchronously. * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the runtime information - * @param[in] listener The result listener - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] key The key name of the runtime information + * @param[in] listener The result listener + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValueAsync(const Tizen::Base::String& key, IRuntimeInfoGetLonglongAsyncResultListener* listener); /** - * Gets the specific @c int type runtime information based on specified designators (key) asynchronously. + * Gets the @c int type runtime information based on specified designators (key) asynchronously. * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the runtime information - * @param[in] listener The result listener - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] key The key name of the runtime information + * @param[in] listener The result listener + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValueAsync(const Tizen::Base::String& key, IRuntimeInfoGetIntAsyncResultListener* listener); diff --git a/inc/FSysSettingInfo.h b/inc/FSysSettingInfo.h index 54b7973..901debd 100644 --- a/inc/FSysSettingInfo.h +++ b/inc/FSysSettingInfo.h @@ -35,13 +35,14 @@ namespace Tizen { namespace System /** * @class SettingInfo - * @brief This class provides methods for managing setting information. + * @brief This class provides methods to manage the setting information. * * @since 2.0 * * @final This class is not intended for extension. * - * The %SettingInfo class provides methods to managing the variety user setting elements. Please refer SettingInfo key. + * The %SettingInfo class provides methods to manage the user setting elements. @n + * To get the system information, you must provide the SettingInfo key. * * For more information on the class features, see Settings Information. * @@ -80,188 +81,182 @@ class _OSP_EXPORT_ SettingInfo public: /** - * Gets the specific Tizen::Base::String type setting information based on the specified - * designators (key). + * Gets the Tizen::Base::String type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the setting information @n + * @return An error code + * @param[in] key The key name of the setting information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[out] value The setting information of type Tizen::Base::String - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[out] value The setting information of type Tizen::Base::String + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, Tizen::Base::String& value); /** - * Gets the specific integer type setting information based on the specified - * designators (keys). + * Gets the specific integer type setting information for the specified designators (keys). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the setting information @n + * @return An error code + * @param[in] key The key name of the setting information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[out] value The setting information of type integer - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[out] value The setting information of type @c int + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, int& value); /** - * Gets the specific @c long @c long type setting information based on the specified - * designators (key). + * Gets the @c long @c long type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the setting information + * @return An error code + * @param[in] key The key name of the setting information * @param[out] value The setting information of type @c long @c long - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, long long& value); /** - * Gets the specific double type setting information based on the specified - * designators (key). + * Gets the double type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the setting information - * @param[out] value The setting information of type double - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @return An error code + * @param[in] key The key name of the setting information + * @param[out] value The setting information of type @c double + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, double& value); /** - * Gets the specific @c bool type setting information based on the specified - * designators (key). + * Gets the @c bool type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the setting information @n + * @return An error code + * @param[in] key The key name of the setting information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[out] value The setting information of type bool - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[out] value The setting information of type @c bool + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, bool& value); /** - * Gets the specific UuId type setting information based on the specified - * designators (key). + * Gets the UuId type setting information for the specified designators (key). * * @since 2.0 * - * @return An error code - * @param[in] key The key name of the setting information - * @param[out] value The setting information of type UuId - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @return An error code + * @param[in] key The key name of the setting information + * @param[out] value The setting information of type UuId + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, Tizen::Base::UuId& value); /** - * Checks whether specific designator(key) is supported or not. + * Checks whether specific designator(key) is supported. * - * @since 2.0 + * @since 2.0 * - * @return @c true if the key is supported, @n - * else @c false - * @param[in] key The key name of the setting information + * @return @c true if the key is supported, @n + * else @c false + * @param[in] key The key name of the setting information * */ static bool HasKey(const Tizen::Base::String& key); /** - * Sets the specific @c bool type setting information based on the specified designators (key). + * Sets the specified @c bool type setting information for the specified designators (key). * * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/setting * - * @return An error code + * @return An error code * @param[in] key The key name of the setting information - * @param[in] value The setting information of type bool - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] value The setting information of type @c bool + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetValue(const Tizen::Base::String& key, bool value); /** - * Sets the specific @c int type setting information based on the specified designators (key). + * Sets the specified @c int type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/setting * - * @return An error code + * @return An error code * @param[in] key The key name of the setting information - * @param[in] value The setting information of type int - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] value The setting information of type @c int + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetValue(const Tizen::Base::String& key, int value); /** * Sets the specific Tizen::Base::String type setting information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/setting * - * @return An error code + * @return An error code * @param[in] key The key name of the setting information - * @param[in] value The setting information of type Tizen::Base::String - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] value The setting information of type Tizen::Base::String + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetValue(const Tizen::Base::String& key, Tizen::Base::String value); @@ -273,12 +268,12 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/setting * - * @return An error code - * @param[in] filePath The file path of the wallpaper - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] filePath The file path of the wallpaper + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_FILE_NOT_FOUND The entry for the specified wallpaper file or the file path cannot be found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetWallpaper(const Tizen::Base::String& filePath); @@ -291,12 +286,12 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/setting * - * @return An error code - * @param[in] filePath The file path of the ringtone - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] filePath The file path of the ringtone + * @exception E_SUCCESS The method is successful. * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. * @exception E_FILE_NOT_FOUND The entry for the specified wallpaper file or the file path cannot be found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetRingtone(const Tizen::Base::String& filePath); @@ -308,14 +303,14 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/setting * - * @return An error code + * @return An error code * @param[in] soundCategory The sound volume category - * @param[in] level The sound volume level of the designated category - * @exception E_SUCCESS The method is successful. + * @param[in] level The sound volume level of the designated category + * @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 soundCategory is invalid. * @exception E_OUT_OF_RANGE The specified @c level is outside the bounds of @c soundCategory. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetVolume(const Tizen::Base::String& soundCategory, int level); @@ -323,116 +318,115 @@ public: * Adds the setting event listener. @n * This listener is called when a setting value is changed. * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] listener The setting event listener - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_ALREADY_EXIST The listener is already added. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see RemoveSettingEventListener() + * @return An error code + * @param[in] listener The setting event listener + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_ALREADY_EXIST The listener is already added. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @see RemoveSettingEventListener() */ static result AddSettingEventListener(ISettingEventListener& listener); /** * Removes the setting event listener. * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] listener The setting event listener - * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The listener is not added. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @see AddSettingEventListener() + * @return An error code + * @param[in] listener The setting event listener + * @exception E_SUCCESS The method is successful. + * @exception E_OBJ_NOT_FOUND The listener is not added. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @see AddSettingEventListener() */ static result RemoveSettingEventListener(ISettingEventListener& listener); /** - * Gets the specific @c bool type setting information based on the specified designators (key). + * Gets the @c bool type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * * @privlevel platform * @privilege %http://tizen.org/privilege/settingmanager.read @n - * (%http://tizen.org/privilege/systemsetting.read is deprecated.) - * - * @return An error code - * @param[in] key The key name of the setting information - * @param[out] value The setting information of type bool - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * (%http://tizen.org/privilege/systemsetting.read is deprecated.) + * + * @return An error code + * @param[in] key The key name of the setting information + * @param[out] value The setting information of type @c bool + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValueForPrivilegedKey(const Tizen::Base::String& key, bool& value); /** - * Sets the specific @c bool type setting information based on the specified designators (key). + * Sets the @c bool type setting information for the specified designators (key). * - * @since 2.0 + * @since 2.0 * * @privlevel platform * @privilege %http://tizen.org/privilege/settingmanager.write @n - * (%http://tizen.org/privilege/systemsetting.write is deprecated.) - * - * @return An error code - * @param[in] key The key name of the setting information - * @param[in] value The setting information of type bool - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * (%http://tizen.org/privilege/systemsetting.write is deprecated.) + * + * @return An error code + * @param[in] key The key name of the setting information + * @param[in] value The setting information of type @c bool + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid value. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetValueForPrivilegedKey(const Tizen::Base::String& key, bool value); /** - * Sets the specific @c bool type setting information based on the specified designators (key) asynchronously. + * Sets the @c bool type setting information for the specified designators (key) asynchronously. * - * @since 2.0 + * @since 2.0 * @privlevel platform * @privilege %http://tizen.org/privilege/settingmanager.write @n - * (%http://tizen.org/privilege/systemsetting.write is deprecated.) + * (%http://tizen.org/privilege/systemsetting.write is deprecated.) * - * @return An error code + * @return An error code * @param[in] key The key name of the setting information - * @param[in] value The setting information of type bool - * @param[in] listener The result listener. - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key is existed, However it is not supported by this device. - * @exception E_IN_PROGRESS The specified key is under processing or invalid state. - * @exception E_SYSTEM Either of the following conditions has occured: - * - The method cannot proceed due to a severe system error. - * - This error can occur and Wi-Fi Direct™ is not activated if the @c key is %http://tizen.org/setting/network.wifi.direct and Wi-Fi is activated.- -Direct™ is not activated if the @c key is %http://tizen.org/setting/network.wifi.direct and Wi-Fi is activated. - + * @param[in] value The setting information of type @c bool + * @param[in] listener The result listener + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However it is not supported by this device. + * @exception E_IN_PROGRESS The specified key is under processing or is in an invalid state. + * @exception E_SYSTEM Either of the following conditions has occured: + * - The method cannot proceed due to a severe system error. + * - Wi-Fi Direct™ is not activated if the @c key is %http://tizen.org/setting/network.wifi.direct and Wi-Fi is + * activated. */ static result SetValueAsyncForPrivilegedKey(const Tizen::Base::String& key, bool value, ISettingInfoSetValueAsyncResultListener* listener); /** - * Sets the specific @c bool type setting information based on the specified designators (key) asynchronously. + * Sets the @c bool type setting information for the specified designators (key) asynchronously. * - * @since 2.0 + * @since 2.0 * @privlevel platform * @privilege %http://tizen.org/privilege/setting * - * @return An error code + * @return An error code * @param[in] key The key name of the setting information - * @param[in] value The setting information of type bool - * @param[in] listener The result listener. - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_UNSUPPORTED_OPERATION The specified @c key is existed, However it is not supported by this device. - * @exception E_IN_PROGRESS The specified key is under processing or invalid state. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @param[in] value The setting information of type @c bool + * @param[in] listener The result listener + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid value. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However it is not supported by this device. + * @exception E_IN_PROGRESS The specified key is under processing or is in an invalid state. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetValueAsync(const Tizen::Base::String& key, bool value, ISettingInfoSetValueAsyncResultListener* listener); @@ -444,50 +438,51 @@ Direct™ is not activated if the @c key is %http://tizen.org/setting/network.wi * * @privlevel platform * @privilege %http://tizen.org/privilege/settingmanager.write @n - * (%http://tizen.org/privilege/systemsetting.write is deprecated.) + * (%http://tizen.org/privilege/systemsetting.write is deprecated.) * - * @return An error code + * @return An error code * @param[in] key The key name of the setting information - * @param[in] value The setting information of type Tizen::Base::String - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. - * @exception E_INVALID_ARG The specified @c value is invalid value. - * @exception E_OBJ_NOT_FOUND The specified @c key is not found. + * @param[in] value The setting information of type Tizen::Base::String + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_DENIED The application does not have the privilege to call this method. + * @exception E_INVALID_ARG The specified @c value is invalid. + * @exception E_OBJ_NOT_FOUND The specified @c key is not found. * @exception E_UNSUPPORTED_OPERATION The specified @c key exists. However, it is not supported by this device. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetValueForPrivilegedKey(const Tizen::Base::String& key, Tizen::Base::String value); /** - * Resets current device. @n + * Resets the current device to the default factory settings. @n * All data is removed and device is initialized. * - * @since 2.0 + * @since 2.0 * * @privlevel platform * @privilege %http://tizen.org/privilege/settingmanager.write @n - * (%http://tizen.org/privilege/systemsetting.write is deprecated.) + * (%http://tizen.org/privilege/systemsetting.write is deprecated.) * - * @return An error code - * @exception E_SUCCESS The method is successful. - * @exception E_PRIVILEGED_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. + * @return An error code + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGED_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. */ static result ResetToFactoryDefault(void); /** * @if OSPCOMPAT * @if OSPDEPREC - * Sets the setting event listener. + * Sets the specified setting event listener. * - * @deprecated This method is provided only for backward compatibility and will be deleted in the near future. Instead of using this method, it is recommended to use AddSettingEventListener() and RemoveSettingEventListener(). - * @since 2.0 + * @deprecated This method is provided only for backward compatibility and will be deleted in the near future. Instead of using this method, it is + * recommended to use AddSettingEventListener() and RemoveSettingEventListener(). + * @since 2.0 * - * @return An error code + * @return An error code * @param[in] pListener The setting event listener * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks If the value of the listener object (pListener) is @c null, the setting event listener is not called. + * @remarks If the value of the listener object (pListener) is @c null, the setting event listener is not called. * @endif * @endif */ diff --git a/inc/FSysSystemInfo.h b/inc/FSysSystemInfo.h index f917b42..5458ed9 100644 --- a/inc/FSysSystemInfo.h +++ b/inc/FSysSystemInfo.h @@ -60,7 +60,7 @@ enum SystemInfoValueType * * The %SystemInfo class provides system information, such as the API and platform versions, supported device features, * and screen dimensions. - * To get the information, you must provide the SystemInfo key. + * To get the system information, you must provide the SystemInfo key. * * For more information on the class features, see System Information. * @@ -98,195 +98,195 @@ class _OSP_EXPORT_ SystemInfo public: /** - * Gets the specific Tizen::Base::String type system information based on the specified designators (key). + * Gets the Tizen::Base::String type system information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the system information @n + * @return An error code + * @param[in] key The key name of the system information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[out] value The system information of type Tizen::Base::String - * @exception E_SUCCESS The method is successful. + * @param[out] value The system information of type Tizen::Base::String + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, Tizen::Base::String& value); /** - * Gets the specific integer type system information based on the specified designators (key). + * Gets the integer type system information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the system information @n + * @return An error code + * @param[in] key The key name of the system information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[out] value The integer type system information - * @exception E_SUCCESS The method is successful. + * @param[out] value The integer type system information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, int& value); /** - * Gets the specific double type system information based on the specified designators (key). + * Gets the @c double type system information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the system information - * @param[out] value The @c double type system information - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] key The key name of the system information + * @param[out] value The @c double type system information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, double& value); /** - * Gets the specific UuId type system information based on the specified designators (key). + * Gets the UuId type system information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the system information - * @param[out] value The UuId type system information - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[in] key The key name of the system information + * @param[out] value The UuId type system information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, Tizen::Base::UuId& value); /** - * Gets the specific system information based on the specified key and data type of the information. + * Gets the system information based on the specified key and data type of the information. * - * @since 2.0 + * @since 2.0 * - * @return A system information list - * @param[in] key The key name of the system information @n + * @return The system information list + * @param[in] key The key name of the system information @n * @if OSPCOMPAT * The following key values are updated @n * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[in] type The data type of the information - * @exception E_SUCCESS The method is successful. + * @param[in] type The data type of the information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ static Tizen::Base::Collection::IList* GetValuesN(const Tizen::Base::String& key, SystemInfoValueType type); /** - * Gets the specific boolean type system information based on the specified designators (key). + * Gets the @c bool type system information based on the specified designators (key). * - * @since 2.0 + * @since 2.0 * - * @return An error code - * @param[in] key The key name of the system information @n + * @return An error code + * @param[in] key The key name of the system information @n * @if OSPCOMPAT * The following key values are updated: @n * - Since Tizen, refer here. * - @b Deprecated All the key values provided prior to %Tizen 2.0 are deprecated. For more detailed information, refer * here. * @endif - * @param[out] value The @c bool type system information - * @exception E_SUCCESS The method is successful. + * @param[out] value The @c bool type system information + * @exception E_SUCCESS The method is successful. * @exception E_OBJ_NOT_FOUND The specified @c key is not found. - * @exception E_SYSTEM The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetValue(const Tizen::Base::String& key, bool& value); /** * Gets the platform version in the "[Major].[Minor].[Patch Version]" format. * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/system @n - * (%http://tizen.org/privilege/platforminfo is deprecated.) + * (%http://tizen.org/privilege/platforminfo is deprecated.) * - * @return An error code + * @return An error code * @param[out] platformVersion The platform version - * @exception E_SUCCESS The method is successful. + * @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 The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetPlatformVersion(Tizen::Base::String& platformVersion); /** - * Gets the Native API version in the "[Major].[Minor]" format. + * Gets the native API version in the "[Major].[Minor]" format. * * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/system @n - * (%http://tizen.org/privilege/platforminfo is deprecated.) + * (%http://tizen.org/privilege/platforminfo is deprecated.) * - * @return An error code - * @param[out] nativeApiVersion The Native API version - * @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 The method cannot proceed due to a severe system error. + * @return An error code + * @param[out] nativeApiVersion The native API version + * @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 The method cannot proceed due to a severe system error. */ static result GetNativeApiVersion(Tizen::Base::String& nativeApiVersion); /** * Gets the WEB API version in the "[Major].[Minor]" format. * - * @since 2.0 + * @since 2.0 * * @privlevel public * @privilege %http://tizen.org/privilege/system @n - * (%http://tizen.org/privilege/platforminfo is deprecated.) + * (%http://tizen.org/privilege/platforminfo is deprecated.) * - * @return An error code + * @return An error code * @param[out] webApiVersion The %Tizen API version - * @exception E_SUCCESS The method is successful. + * @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 The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetWebApiVersion(Tizen::Base::String& webApiVersion); /** * Gets the platform build information. * - * @since 2.1 + * @since 2.1 * * @privlevel public * @privilege %http://tizen.org/privilege/system @n - * (%http://tizen.org/privilege/platforminfo is deprecated.) + * (%http://tizen.org/privilege/platforminfo is deprecated.) * - * @return An error code - * @param[out] buildInfo The %Tizen build information - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[out] buildInfo The %Tizen build information + * @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 The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetBuildInfo(Tizen::Base::String& buildInfo); /** * Gets the International Mobile Equipment Identity (IMEI) of the device. * - * @since 2.0 + * @since 2.0 * * @privlevel partner * @privilege %http://tizen.org/privilege/systemmanager @n - * (%http://tizen.org/privilege/useridentity is deprecated.) + * (%http://tizen.org/privilege/useridentity is deprecated.) * - * @return An error code - * @param[out] imei The IMEI of the device - * @exception E_SUCCESS The method is successful. + * @return An error code + * @param[out] imei The IMEI of the device + * @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 The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result GetImei(Tizen::Base::String& imei); diff --git a/inc/FSysSystemTime.h b/inc/FSysSystemTime.h index 20c8dba..f2dbda9 100644 --- a/inc/FSysSystemTime.h +++ b/inc/FSysSystemTime.h @@ -57,9 +57,9 @@ enum TimeMode UTC_TIME, // This enum value is deprecated. Instead of using this enum value, use UTC_TIME. STANDARD_TIME, // This enum value is deprecated. Instead of using this enum value, use STANDARD_TIME. WALL_TIME, // This enum value is deprecated. Instead of using this enum value, use TIME_MODE_WALL. - TIME_MODE_UTC = UTC_TIME, /**< The UTC Time */ - TIME_MODE_STANDARD = STANDARD_TIME, /**< The Standard Time */ - TIME_MODE_WALL = WALL_TIME, /**< The Wall Time */ + TIME_MODE_UTC = UTC_TIME, /**< The UTC Time */ + TIME_MODE_STANDARD = STANDARD_TIME, /**< The Standard Time */ + TIME_MODE_WALL = WALL_TIME, /**< The Wall Time */ }; class _OSP_EXPORT_ SystemTime @@ -94,7 +94,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] timeMode The time mode @c TIME_MODE_UTC, @c TIME_MODE_STANDARD, or @c TIME_MODE_WALL + * @param[in] timeMode The time mode which can be @c TIME_MODE_UTC, @c TIME_MODE_STANDARD, or @c TIME_MODE_WALL * @param[out] currentTime The current system time * @exception E_SUCCESS The method is successful. */ @@ -118,13 +118,13 @@ public: * * @privlevel platform * @privilege %http://tizen.org/privilege/settingmanager.write @n - * (%http://tizen.org/privilege/systemsetting.write is deprecated.) + * (%http://tizen.org/privilege/systemsetting.write is deprecated.) * * @return An error code - * @param[in] currentTime The current system time in UTC - * @exception E_SUCCESS The method is successful. + * @param[in] currentTime The current system time in UTC + * @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 The method cannot proceed due to a severe system error. + * @exception E_SYSTEM The method cannot proceed due to a severe system error. */ static result SetCurrentTime(const Tizen::Base::DateTime& currentTime); private: diff --git a/inc/FSysVibrator.h b/inc/FSysVibrator.h index 33463c3..c29f120 100644 --- a/inc/FSysVibrator.h +++ b/inc/FSysVibrator.h @@ -35,7 +35,7 @@ namespace Tizen { namespace System * * @since 2.0 * - * The %Vibrator class handles the vibration functionality of a device. It allows you to manage the device's vibrator parameters, such as vibration count and level. + * The %Vibrator class handles the vibration functionality of a device. It allows the management of the device's vibrator parameters, such as the vibration count and level. * * For more information on the class features, see Vibrator Management. * @@ -84,23 +84,23 @@ namespace Tizen { namespace System /** * @struct IntensityDurationVibrationPattern - * @brief This struct has the specified duration and a vibration intensity level. + * @brief This struct represents the specified duration and vibration intensity level. * - * 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. + * The %IntensityDurationVibrationPattern struct represents the specified duration and vibration intensity level. This struct 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 - * The @c duration is not allowed a negative value. - */ + int duration; /**< The duration in milliseconds when the vibrator is on @n + * The @c duration does not allow a negative value. + */ int intensity; /**< The vibration intensity [@c -1~ @c 100]: @n - * @li The system default vibration intensity (-1) - * @li The silent vibration intensity (0) - * @li The minimum vibration intensity (1) - * @li The maximum vibration intensity (100) - */ + * @li The system default vibration intensity (-1) + * @li The silent vibration intensity (0) + * @li The minimum vibration intensity (1) + * @li The maximum vibration intensity (100) + */ }; @@ -110,11 +110,11 @@ class _OSP_EXPORT_ Vibrator 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. + * 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. */ Vibrator(void); @@ -142,27 +142,28 @@ public: /** - * Vibrates the device with a specified array pattern that has vibration intensity and duration. @n + * Vibrates the device with a specified array pattern that has a 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 this method is called again before the previous vibration stops, the previous vibration is cancelled 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. + * If a system alert occurs such as a ring vibration or a system event notification, the vibration can be interrupted. @n + * If the application is terminated, the vibration is cancelled. * * @since 2.1 - * @privlevel public + * @privlevel public * @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 times the pattern repeats @n This value must be between @c 1 to @c 100. - * @exception E_SUCCESS The method is successful. + * @param[in] patterns The 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. - * @exception E_OPERATION_FAILED The device operation has failed. - * @remarks The vibration intensity does not apply the change, even if the system default vibration intensity is changed after starting vibration. + * @exception E_INVALID_ARG A specified input parameter is invalid. + * @exception E_OPERATION_FAILED The device operation has failed. + * @remarks The vibration intensity does not apply the change, even if the system default vibration intensity is changed after starting the vibration. * @see IntensityDurationVibrationPattern */ result Start(IntensityDurationVibrationPattern* patterns, int length, int repeatCount = 1); @@ -170,61 +171,66 @@ public: /** * Vibrates the device with the specified pattern and level. @n * 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. + * If this method is called again before the previous vibration stops, the previous vibration is cancelled and the new vibration starts immediately. * - * @brief [Deprecated] - * @deprecated This method is deprecated. Instead of using this method, use Start(IntensityDurationVibrationPattern*, int, int). + * @brief [Deprecated] + * @deprecated This method is deprecated. Instead of using this method, use Start(IntensityDurationVibrationPattern*, int, int). * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/vibrator * * @return An error code - * @param[in] onPeriod The period in milliseconds when the vibrator is on @n - * It should be greater than @c 0. - * @param[in] offPeriod The period in milliseconds when the vibrator is off @n - * It should be equal to or greater than @c 0. - * @param[in] count The number of times to execute the given pattern @n - * It should be greater than @c 0. - * @param[in] level The vibration level @n - * Ranges from [@c 0~ @c 100], where '@c 0' is a special case indicating the system default level. + * @param[in] onPeriod The period in milliseconds when the vibrator is on @n + * It should be greater than @c 0. + * @param[in] offPeriod The period in milliseconds when the vibrator is off @n + * It should be equal to or greater than @c 0. + * @param[in] count The number of times to execute the given pattern @n + * It should be greater than @c 0. + * @param[in] level The vibration level @n + * It ranges from [@c 0~ @c 100], where '@c 0' is a special case indicating the system default level. * @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_DEVICE_BUSY The device cannot be approached because of other operations. * @exception E_DEVICE_FAILED The device operation has failed. - * @remarks Various devices may have different vibration capabilities. - * If the device supports only one level of vibration, then a level value between [@c 0~ @c 100] results in the default vibration. - * If the device supports many levels of vibration, then a level value @c 0 results in the system default vibration, value @c 1 results in the lowest frequency vibration, value @c 100 results in the highest frequency vibration, and intermediate values result in intermediate vibration levels. @n - * Devices have implementation-specific limits for the total duration of the vibration, and vibration cuts off at that limit even if the duration parameter is greater than the limit. + * @remarks Various devices may have different vibration capabilities. @n + * If the device supports only one level of vibration, then a level value between [@c 0~ @c 100] results in the default vibration. @n + * If the device supports many levels of vibration, then a level value @c 0 results in the system default vibration, + * value @c 1 results in the lowest frequency vibration, value @c 100 results in the highest frequency vibration, and intermediate values result in + * intermediate vibration levels. @n + * Devices have implementation-specific limits for the total duration of the vibration, and vibration cuts off at that limit even if the duration parameter is + * greater than the limit. * */ result Start(long onPeriod, long offPeriod, int count, int level = 0); /** - * Vibrates the device for the specified duration at the specified @c level. @n + * Vibrates the device for the specified duration at the specified level. @n * 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. + * If this method is called again before the previous vibration stops, the previous vibration is cancelled and the new vibration starts immediately. * - * @brief [Deprecated] - * @deprecated This method is deprecated. Instead of using this method, use Start(IntensityDurationVibrationPattern*, int, int). + * @brief [Deprecated] + * @deprecated This method is deprecated. Instead of using this method, use Start(IntensityDurationVibrationPattern*, int, int). * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/vibrator * * @return An error code - * @param[in] milliseconds The duration for the vibration in milliseconds @n - * It should be greater than @c 0. - * @param[in] level The vibration level @n - * Ranges from [@c 0~ @c 100], where ' @c 0' is a special case indicating the system default level. - * @exception E_SUCCESS The method is successful. + * @param[in] milliseconds The duration for the vibration in milliseconds @n + * It should be greater than @c 0. + * @param[in] level The vibration level @n + * It ranges from [@c 0~ @c 100], where ' @c 0' is a special case indicating the system default level. + * @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_DEVICE_BUSY The device cannot be approached because of other operations. * @exception E_DEVICE_FAILED The device operation has failed. * @remarks Various devices have different vibration capabilities. @n - * If the device supports only one level of vibration, then a level value between [@c 0~ @c 100] results in the default vibration. - * If the device supports many levels of vibration, then a level value @c 0 results in the system default vibration, value @c 1 results in the lowest frequency vibration, value @c 100 results in the highest frequency vibration, and intermediate values result in intermediate vibration levels. @n - * Devices have implementation-specific limits for the total duration of the vibration, and vibration cuts off at that limit even if the duration parameter is greater than the limit. + * If the device supports only one level of vibration, then a level value between [@c 0~ @c 100] results in the default vibration. @n + * If the device supports many levels of vibration, then a level value @c 0 results in the system default vibration, value @c 1 results in the lowest + * frequency vibration, value @c 100 results in the highest frequency vibration, and intermediate values result in intermediate vibration levels. @n + * Devices have implementation-specific limits for the total duration of the vibration, and vibration cuts off at that limit even if the duration parameter is + * greater than the limit. * */ result Start(long milliseconds, int level = 0); @@ -232,7 +238,7 @@ public: /** * Turns the vibrator off. * - * @since 2.0 + * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/vibrator * diff --git a/inc/FSystem.h b/inc/FSystem.h index aada397..e61d108 100644 --- a/inc/FSystem.h +++ b/inc/FSystem.h @@ -66,11 +66,11 @@ namespace Tizen { /** * @namespace Tizen::System - * @brief This namespace contains classes and interfaces for %System. - * @since 2.0 + * @brief This namespace contains classes and interfaces for %System. + * @since 2.0 * * @remarks @b Header @b %file: @b \#include @b @n - * @b Library : @b osp-appfw + * @b Library: @b osp-appfw * * The %System namespace provides system management features, such as system time, alarm, vibrator, power, and device management. * It also provides the system, setting, and runtime information. diff --git a/inc/FText.h b/inc/FText.h index 6e1236e..33695bc 100644 --- a/inc/FText.h +++ b/inc/FText.h @@ -38,18 +38,19 @@ /** * @namespace Tizen::Text - * @brief This namespace contains classes that encode and decode characters. + * @brief This namespace contains classes that encode and decode characters. * * @since 2.0 * * @remarks @b Header @b %file: @b \#include @b @n - * @b Library: @b osp-appfw + * @b Library: @b osp-appfw * - * The %Text namespace contains the Encoding class, which is the base class for encoding and decoding many character encodings, such as UTF-8, UCS-2, Latin-1, GSM, and ASCII. It also contains the Decoder and Encoder classes for converting text blocks. The main purpose of this namespace is to support inter- + * + * The %Text namespace contains the Encoding class, which is the base class for encoding and decoding different character encodings, such as UTF-8, UCS-2, Latin-1, GSM, and ASCII. + * It also contains the Decoder and Encoder classes for converting text blocks. The main purpose of this namespace is to support inter- * operability between the various existing languages and scripts. * %Text is a data consisting of a sequence of characters. - * It is also defined as a series of characters that can be displayed on a - * display terminal or printed on paper for human reading. + * It is also defined as a series of characters that can be displayed on a display terminal or printed on a paper for human reading. * * For more information on the %Text namespace features, see Text Guide. * diff --git a/inc/FTextAsciiEncoding.h b/inc/FTextAsciiEncoding.h index 64d2ab0..82f7492 100644 --- a/inc/FTextAsciiEncoding.h +++ b/inc/FTextAsciiEncoding.h @@ -109,9 +109,9 @@ public: * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. - * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode + * else @c null if an exception occurs @n + * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. + * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c chars is empty or invalid. @@ -128,9 +128,9 @@ public: * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. - * @param[in] str A string to encode + * else @c null if an exception occurs @n + * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. + * @param[in] str The string to encode * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c str is empty or invalid. @@ -147,21 +147,25 @@ public: * @since 2.0 * * @return An error code - * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode - * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored - * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance + * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charCount The total number of characters to encode + * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored + * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c chars or @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or - * the specified @c bytes does not contain sufficient space to store the encoded characters. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars or @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c bytes does not contain sufficient space to store the encoded characters. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetChars() */ @@ -174,22 +178,26 @@ public: * @since 2.0 * * @return An error code - * @param[in] str A string to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode - * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored - * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c str or @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or - * the specified @c bytes does not contain sufficient space to store the encoded characters. - * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. + * @param[in] str The string to encode + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charCount The total number of characters to encode + * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored + * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c str or @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c bytes does not contain sufficient space to store the encoded characters. + * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetString() */ virtual result GetBytes(const Tizen::Base::String& str, int charIndex, int charCount, @@ -203,9 +211,9 @@ public: * @since 2.0 * * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last decoded byte plus one and the starting position is zero. - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * else @c null if an exception occurs @n + * The buffer limit is the position of the last decoded byte plus one and the starting position is zero. + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c bytes is empty or invalid. @@ -224,84 +232,93 @@ public: * @since 2.0 * * @return An error code - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] byteIndex The index from where decoding begins - * @param[in] byteCount The total number of bytes to decode - * @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded string is stored - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes or @c chars is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or - * the specified @c chars does not contain sufficient space to store the decoded bytes. + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @param[in] byteIndex The index from where the decoding begins + * @param[in] byteCount The total number of bytes to decode + * @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded string is stored + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes or @c chars is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c chars does not contain sufficient space to store the decoded bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetBytes() */ virtual result GetChars(const Tizen::Base::ByteBuffer& bytes, int byteIndex, int byteCount, Tizen::Base::WcharBuffer& chars, int charIndex = 0) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * * @return An error code - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[out] str A Tizen::Base::String instance @n - * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @param[out] str A Tizen::Base::String instance @n + * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. - * @remarks This method assumes that the Tizen::Base::ByteBuffer instance contains all the bytes necessary to generate the entire string. - * If the bytes are in multiple byte arrays, use the Decoder class, which maintains state consistency - * between multiple calls. + * @remarks + * - This method assumes that the Tizen::Base::ByteBuffer instance contains all the bytes necessary to generate the entire string. + * - If the bytes are in the multiple byte arrays, use the Decoder class, which maintains state consistency + * between multiple calls. * @see GetBytesN() */ virtual result GetString(const Tizen::Base::ByteBuffer& bytes, Tizen::Base::String& str) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * * @return An error code - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] index The index from where decoding begins - * @param[in] count The total number of bytes to decode - * @param[out] str A Tizen::Base::String instance @n - * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @param[in] index The index from where the decoding begins + * @param[in] count The total number of bytes to decode + * @param[out] str A Tizen::Base::String instance @n + * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. - * @remarks This method assumes that the Tizen::Base::ByteBuffer instance contains all the bytes necessary to generate the entire string. - * If the bytes are in multiple byte arrays, use the Decoder class, which maintains state consistency - * between multiple calls. + * @remarks + * - This method assumes that the Tizen::Base::ByteBuffer instance contains all the bytes necessary to generate the entire string. + * - If the bytes are in multiple byte arrays, use the Decoder class, which maintains state consistency + * between multiple calls. * @see GetBytes() */ virtual result GetString(const Tizen::Base::ByteBuffer& bytes, int index, int count, Tizen::Base::String& str) const; /** - * Gets the maximum number of bytes required for encoding a given number of characters. + * Gets the maximum number of bytes required for encoding the given number of characters. * * @since 2.0 * - * @return The maximum number of bytes required for encoding a given number of characters - * @param[in] charCount The total number of characters to encode - * @remarks This method determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding. - * @see Encoding::GetByteCount() - * @see GetBytes() + * @return The maximum number of bytes required for encoding the given number of characters + * @param[in] charCount The total number of characters to encode + * @remarks This method determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding. + * @see Encoding::GetByteCount() */ virtual int GetMaxByteCount(int charCount) const; @@ -311,11 +328,10 @@ public: * @since 2.0 * * @return The maximum number of characters that are generated by decoding the specified number of bytes - * @param[in] byteCount The total number of bytes to encode - * @remarks This method determines an appropriate buffer size for character arrays passed to - * GetChars() or a decoder for encoding. - * @see Encoding::GetCharCount() - * @see GetChars() + * @param[in] byteCount The total number of bytes to encode + * @remarks This method determines an appropriate buffer size for character arrays passed to + * GetChars() or a decoder for encoding. + * @see Encoding::GetCharCount() */ virtual int GetMaxCharCount(int byteCount) const; @@ -325,11 +341,11 @@ public: * * @since 2.0 * - * @return A pointer to the Encoder instance for the current encoding - * @remarks Contrary to GetBytes(), an encoder can convert partial sequences of characters into - * partial sequences of bytes by maintaining the appropriate state between the conversions. @n - * At present, only the Utf8Encoding class supports this method. Other classes return @c null. - * @see GetBytes() + * @return A pointer to the Encoder instance for the current encoding + * @remarks + * - Contrary to GetBytes(), an encoder can convert partial sequences of characters into + * partial sequences of bytes by maintaining the appropriate state between the conversions. + * - At present, only the Utf8Encoding class supports this method. Other classes return @c null. */ virtual Encoder* GetEncoderN(void) const; @@ -338,12 +354,11 @@ public: * * @since 2.0 * - * @return A pointer to the Decoder instance for the current encoding - * @remarks Contrary to GetChars(), a decoder can convert partial sequences of bytes - * into partial sequences of characters by maintaining the appropriate state between the conversions. @n - * At present, only the Utf8Encoding class supports this method. Other classes return @c null. - * - * @see GetChars() + * @return A pointer to the Decoder instance for the current encoding + * @remarks + * - Contrary to GetChars(), a decoder can convert partial sequences of bytes + * into partial sequences of characters by maintaining the appropriate state between the conversions. + * - At present, only the Utf8Encoding class supports this method. Other classes return @c null. */ virtual Decoder* GetDecoderN(void) const; @@ -352,7 +367,7 @@ public: * * @since 2.0 * - * @return An encoding type + * @return The encoding type */ virtual Tizen::Base::String GetEncodingType(void) const; diff --git a/inc/FTextDecoder.h b/inc/FTextDecoder.h index 4761a0c..fa1ee1b 100644 --- a/inc/FTextDecoder.h +++ b/inc/FTextDecoder.h @@ -38,7 +38,7 @@ namespace Tizen { namespace Text * * The %Decoder class converts blocks of encoded bytes into blocks of Unicode characters * through successive calls to the GetCharsN() method. This class maintains state consistency information between - * successive calls to %GetCharsN(), enabling it to decode a sequence of bytes that span adjacent blocks. + * successive calls to %GetCharsN() and enables it to decode a sequence of bytes that span adjacent blocks. * * For more information on the class features, see Converting Text Data in Separate Blocks. * @@ -62,20 +62,23 @@ public: * @since 2.0 * * @return An error code - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] byteIndex The index from where decoding begins - * @param[in] byteCount The total number of bytes to decode - * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n - * else @c false - * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @param[in] byteIndex The index from where the decoding begins + * @param[in] byteCount The total number of bytes to decode + * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n + * else @c false + * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. - * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. + * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see Encoder::GetByteCount() */ virtual result GetCharCount(const Tizen::Base::ByteBuffer& bytes, @@ -89,13 +92,14 @@ public: * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n * else @c null if an exception occurs @n * The buffer limit is the position of the last decoded byte plus one in the buffer and the starting position is zero. - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n - * else @c false + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n + * else @c false * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Encoder::GetBytesN() @@ -110,23 +114,27 @@ public: * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n * else @c null if an exception occurs @n * The buffer limit is the position of the last decoded byte in the buffer and the starting position is zero. - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] byteIndex The index from where decoding begins - * @param[in] byteCount The total number of bytes to decode - * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n - * else @c false - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @param[in] byteIndex The index from where the decoding begins + * @param[in] byteCount The total number of bytes to decode + * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n + * else @c false + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. - * @remarks This method maintains state consistency between conversions. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks The pointer to the Tizen::Base::WcharBuffer instance is not terminated by a @c null character. + * @remarks + * - This method maintains state consistency between conversions. + * - The specific error code can be accessed using the GetLastResult() method. + * - The pointer to the Tizen::Base::WcharBuffer instance is not terminated by a @c null character. * @see Encoder::GetBytesN() */ virtual Tizen::Base::WcharBuffer* GetCharsN(const Tizen::Base::ByteBuffer& bytes, int byteIndex, int byteCount, diff --git a/inc/FTextEncoder.h b/inc/FTextEncoder.h index 26e4d0c..9282be0 100644 --- a/inc/FTextEncoder.h +++ b/inc/FTextEncoder.h @@ -38,7 +38,7 @@ namespace Tizen { namespace Text * * The %Encoder class converts blocks of characters to blocks of encoded bytes * through successive calls to the GetBytesN() method. This class maintains the state consistency information between - * successive calls to %GetBytesN(), enabling it to encode a character into a sequence of bytes, + * successive calls to %GetBytesN() and enables it to encode a character into a sequence of bytes, * such as surrogate pairs, that span adjacent blocks. * * For more information on the class features, see Converting Text Data in Separate Blocks. @@ -62,19 +62,22 @@ public: * @since 2.0 * * @return An error code - * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode - * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n - * else @c false - * @param[out] byteCount The total number of bytes required to encode the specified range of characters - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c chars is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. + * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charCount The total number of characters to encode + * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n + * else @c false + * @param[out] byteCount The total number of bytes required to encode the specified range of characters + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see Decoder::GetCharCount() */ @@ -87,15 +90,16 @@ public: * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last encoded byte plus one in the buffer and the starting position is zero. - * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode - * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n - * else @c false - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c chars is empty. + * else @c null if an exception occurs @n + * The buffer limit is the position of the last encoded byte plus one in the buffer and the starting position is zero. + * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode + * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n + * else @c false + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Decoder::GetCharsN() @@ -108,24 +112,28 @@ public: * @since 2.0 * * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last encoded byte in the buffer and the starting position is zero. - * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode - * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n - * else @c false - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c chars is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. + * else @c null if an exception occurs @n + * The buffer limit is the position of the last encoded byte in the buffer and the starting position is zero. + * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charCount The total number of characters to encode + * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n + * else @c false + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character. * @see Decoder::GetCharsN() */ virtual Tizen::Base::ByteBuffer* GetBytesN(const Tizen::Base::WcharBuffer& chars, int charIndex, int charCount, diff --git a/inc/FTextEncoding.h b/inc/FTextEncoding.h index f08c8d2..e12bec2 100644 --- a/inc/FTextEncoding.h +++ b/inc/FTextEncoding.h @@ -117,7 +117,9 @@ public: * @param[in] str The string to encode * @param[out] byteCount The total number of bytes that are required to encode the specified string * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c str is an empty string. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c str is an empty string. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method determines the total number of bytes * that are generated when the specified string is encoded. @@ -131,10 +133,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode - * @param[out] byteCount The total number of bytes required to encode the specified range of characters - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c chars is empty. + * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode + * @param[out] byteCount The total number of bytes required to encode the specified range of characters + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method determines the total number of bytes * that are generated when the specified array of characters are encoded. @@ -150,13 +154,19 @@ public: * * @return An error code * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charCount The total number of characters to encode * @param[out] byteCount The total number of bytes that are required to encode the specified range of characters * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c chars is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method determines the total number of bytes * that are generated when the specified array of characters are encoded. @@ -174,7 +184,7 @@ public: * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n * else @c null if an exception occurs @n * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. - * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode + * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c chars is invalid or empty. @@ -193,7 +203,7 @@ public: * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n * else @c null if an exception occurs @n * The buffer limit is the position of the last encoded byte plus one and the position is zero. - * @param[in] str The string to encode + * @param[in] str The string to encode * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c str is invalid or is an empty string. @@ -210,17 +220,25 @@ public: * @since 2.0 * * @return An error code - * @param[in] chars The buffer containing the character array to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] chars The buffer that contains the character array to encode + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance * @param[in] charCount The total number of characters to encode * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c chars or @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or the specified @c bytes does not contain sufficient space to store the encoded characters. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars or @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input paramter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c bytes does not contain sufficient space to store the encoded characters. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method encodes a range of characters in Tizen::Base::WcharBuffer into a range of bytes in Tizen::Base::ByteBuffer. * @see GetChars() @@ -235,17 +253,25 @@ public: * @since 2.0 * * @return An error code - * @param[in] str The string to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode - * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored - * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance + * @param[in] str The string to encode + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charCount The total number of characters to encode + * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored + * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c str or @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or the specified @c bytes does not contain sufficient space to store the encoded characters. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c str or @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c bytes does not contain sufficient space to store the encoded characters. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetString() */ @@ -262,7 +288,9 @@ public: * @param[out] charCount The total number of characters that are generated by decoding a range of bytes in the specified Tizen::Base::ByteBuffer instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method determines the total number of characters * that are generated when the specified range of bytes are encoded. @@ -278,14 +306,20 @@ public: * * @return An error code * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] byteIndex The index from where decoding begins + * @param[in] byteIndex The index from where the decoding begins * @param[in] byteCount The total number of bytes to decode * @param[out] charCount The total number of characters that are generated by decoding a range of bytes in the specified Tizen::Base::ByteBuffer instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method determines the total number of characters * that are generated when the specified range of bytes are encoded. @@ -302,7 +336,7 @@ public: * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n * else @c null if an exception occurs @n * The buffer limit is the position of the last decoded byte plus one and the starting position is zero. - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c bytes is invalid or empty. @@ -319,17 +353,25 @@ public: * @since 2.0 * * @return An error code - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] byteIndex The index from where decoding begins - * @param[in] byteCount The total number of bytes to decode - * @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded data is stored - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @param[in] byteIndex The index from where the decoding begins + * @param[in] byteCount The total number of bytes to decode + * @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded data is stored + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or the specified @c chars does not contain sufficient space to store the decoded bytes. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c chars does not contain sufficient space to store the decoded bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetBytes() */ @@ -347,7 +389,9 @@ public: * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * * @see GetBytesN() @@ -362,15 +406,21 @@ public: * * @return An error code * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] index The index from where decoding begins + * @param[in] index The index from where the decoding begins * @param[in] count The total number of bytes to decode - * @param[out] str A Tizen::Base::String instance @n - * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * @param[out] str A Tizen::Base::String instance @n + * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetBytes() * @see GetString() @@ -386,7 +436,6 @@ public: * @param[in] charCount The total number of characters to encode * @remarks This method determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding. * @see GetByteCount() - * @see GetBytes() */ virtual int GetMaxByteCount(int charCount) const = 0; @@ -400,7 +449,6 @@ public: * @remarks This method determines an appropriate buffer size for character arrays passed to * GetChars() or a decoder for encoding. * @see GetCharCount() - * @see GetChars() */ virtual int GetMaxCharCount(int byteCount) const = 0; @@ -410,10 +458,10 @@ public: * @since 2.0 * * @return A pointer to the Encoder instance for the current encoding - * @remarks Contrary to GetBytes(), an encoder can convert partial sequences of characters into - * partial sequences of bytes by maintaining an appropriate state between the conversions. - * Currently, only UTF-8 encoding supports this method. The other classes return a value of @c null. - * @see GetBytes() + * @remarks + * - Contrary to GetBytes(), an encoder can convert partial sequences of characters into + * partial sequences of bytes by maintaining an appropriate state between the conversions. + * - Currently, only UTF-8 encoding supports this method. The other classes return a @c null value. */ virtual Encoder* GetEncoderN(void) const = 0; @@ -423,10 +471,10 @@ public: * @since 2.0 * * @return A pointer to the Decoder instance for the current encoding - * @remarks Contrary to GetChars(), a decoder can convert partial sequences of bytes - * into partial sequences of characters by maintaining an appropriate state between the conversions. - * Currently, only UTF-8 encoding supports this method. The other classes return a value of @c null. - * @see GetChars() + * @remarks + * - Contrary to GetChars(), a decoder can convert partial sequences of bytes + * into partial sequences of characters by maintaining an appropriate state between the conversions. + * - Currently, only UTF-8 encoding supports this method. The other classes return a @c null value. */ virtual Decoder* GetDecoderN(void) const = 0; @@ -435,62 +483,57 @@ public: * * @since 2.0 * - * @return An encoding type + * @return The encoding type */ virtual Tizen::Base::String GetEncodingType(void) const = 0; /** - * Gets an encoding for the UTF-8 format. + * Gets the encoding for the UTF-8 format. * * @since 2.0 * - * @return An encoding for the UTF-8 format + * @return The encoding for the UTF-8 format * - * @see Tizen::Text::Utf8Encoding */ static Utf8Encoding& GetUtf8Encoding(void); /** - * Gets an encoding for the UCS-2 format. + * Gets the encoding for the UCS-2 format. * * @since 2.0 * - * @return An encoding for the UCS-2 format + * @return The encoding for the UCS-2 format -* - * @see Tizen::Text::Ucs2Encoding */ static Ucs2Encoding& GetUcs2Encoding(void); /** - * Gets an encoding for the GSM format. + * Gets the encoding for the GSM format. * * @since 2.0 * - * @return An encoding for the GSM format + * @return The encoding for the GSM format * - * @see Tizen::Text::GsmEncoding */ static GsmEncoding& GetGsmEncoding(void); /** - * Gets an encoding for the Latin1 format. + * Gets the encoding for the Latin1 format. * * @since 2.0 * - * @return An encoding for the Latin1 format + * @return The encoding for the Latin1 format * - * @see Tizen::Text::Latin1Encoding */ static Latin1Encoding& GetLatin1Encoding(void); /** - * Gets an encoding for the ASCII format. + * Gets the encoding for the ASCII format. * * @since 2.0 * - * @return An encoding for the ASCII format + * @return The encoding for the ASCII format * - * @see Tizen::Text::AsciiEncoding */ static AsciiEncoding& GetAsciiEncoding(void); @@ -499,16 +542,18 @@ public: * * @since 2.0 * - * @return An instance of %Encoding, @n - * else @c null if the method fails - * @param[in] encodingType An encoding type + * @return An instance of %Encoding, @n + * else @c null if it fails + * @param[in] encodingType The encoding type * @exception E_SUCCESS The method is successful. * @exception E_UNSUPPORTED_TYPE The specified encoding type is not supported. - * @remarks The specific error code can be accessed using the GetLastResult() method. @n - * The supported encoding types are ASCII, GSM, UCS-2, UCS-2LE, UCS-2BE, UCS-4, UCS-4LE, UCS-4BE, UTF-8, UTF-16, UTF-16LE, UTF-16BE, @n + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - The supported encoding types are ASCII, GSM, UCS-2, UCS-2LE, UCS-2BE, UCS-4, UCS-4LE, UCS-4BE, UTF-8, UTF-16, UTF-16LE, UTF-16BE, @n * UTF-32, UTF-32LE, UTF-32BE, ISO-8859-1~16 (except ISO-8859-12), Windows-874, Windows-1250 ~ Windows-1258, @n * KSC5601, BIG5, GB2312, Shift-JIS and ISO-2022-JP. @n - * For more information on the supported encoding types, see Encoding standards in %Tizen. + * For more information on the supported encoding types, see + * Encoding standards in %Tizen. * @see Tizen::Text::Encoding::GetAvailableEncodingsN() */ static Encoding* GetEncodingN(const Tizen::Base::String& encodingType); @@ -518,7 +563,7 @@ public: * * @since 2.0 * - * @return An encoding type + * @return The encoding type * @param[in] encoding An instance of %Encoding */ static Tizen::Base::String GetEncodingType(const Encoding& encoding); @@ -528,8 +573,8 @@ public: * * @since 2.0 * - * @return A list of Tizen::Base::String instances (ASCII, UTF-8, ISO-8859-1, ISO-8859-2, Windows-1254, and so on), @n - * else @c null if the method fails + * @return The list of Tizen::Base::String instances (ASCII, UTF-8, ISO-8859-1, ISO-8859-2, Windows-1254, and so on), @n + * else @c null if it fails * @exception E_SUCCESS The method is successful. * @exception E_SYSTEM A system error has occurred. * @remarks The specific error code can be accessed using the GetLastResult() method. @@ -541,15 +586,17 @@ public: * * @since 2.0 * - * @return A new buffer for storing the result of the conversion, @n + * @return The new buffer for storing the result of the conversion, @n * else @c null if an exception occurs @n - * The buffer limit is the position of the last converted byte plus one and the starting position is zero. + * The buffer limit is the position of the last converted byte plus one and the starting position is zero. * @param[in] src The source of the encoding * @param[in] dst The destination of the encoding * @param[in] srcBytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c srcBytes is empty. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c srcBytes is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see GetBytes() @@ -565,7 +612,7 @@ public: * * @return A new buffer for storing result of the conversion, @n * else @c null if an exception occurs @n - * The buffer limit is the position of the last converted byte plus one and the starting position is zero. + * The buffer limit is the position of the last converted byte plus one and the starting position is zero. * @param[in] src The source of the encoding * @param[in] dst The destination of the encoding * @param[in] srcBytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored @@ -573,9 +620,15 @@ public: * @param[in] count The total number of bytes to convert * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c srcBytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the specified @c index or @c count is greater than the length of the specified @c srcBytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c index and @c count is greater than the length of the specified @c srcBytes. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c srcBytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The specified @c index or @c count is greater than the length of the specified @c srcBytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c srcBytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see GetBytes() diff --git a/inc/FTextGsmEncoding.h b/inc/FTextGsmEncoding.h index 3e3a881..9a04639 100644 --- a/inc/FTextGsmEncoding.h +++ b/inc/FTextGsmEncoding.h @@ -108,10 +108,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] str A string to encode - * @param[out] byteCount The total number of bytes required to encode the specified string - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c str is empty. + * @param[in] str The string to encode + * @param[out] byteCount The total number of bytes required to encode the specified string + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c str is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method determines the total number of bytes * that are generated when the specified string is encoded. @@ -125,10 +127,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode - * @param[out] byteCount The total number of bytes required to encode the specified range of characters + * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode + * @param[out] byteCount The total number of bytes required to encode the specified range of characters * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c chars is empty. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method determines the total number of bytes * that are generated when the specified array of characters is encoded. @@ -142,14 +146,20 @@ public: * @since 2.0 * * @return An error code - * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode - * @param[out] byteCount The total number of bytes required to encode the specified range of characters + * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charCount The total number of characters to encode + * @param[out] byteCount The total number of bytes required to encode the specified range of characters * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c chars is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method determines the total number of bytes * that are generated when the specified array of characters is encoded. @@ -164,14 +174,15 @@ public: * * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n * else @c null if an exception occurs @n - * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. - * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode + * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. + * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c chars is invalid or empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character. * @see GetCharsN() */ virtual Tizen::Base::ByteBuffer* GetBytesN(const Tizen::Base::WcharBuffer& chars) const; @@ -184,13 +195,14 @@ public: * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n * else @c null if an exception occurs @n * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. - * @param[in] str A string to encode + * @param[in] str The string to encode * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c str is invalid or empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character. * @see GetString() */ virtual Tizen::Base::ByteBuffer* GetBytesN(const Tizen::Base::String& str) const; @@ -202,18 +214,26 @@ public: * @since 2.0 * * @return An error code - * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance * @param[in] charCount The total number of characters to encode * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c chars or @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or the specified @c bytes does not contain sufficient space to store the encoded characters. - * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars or @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c bytes does not contain sufficient space to store the encoded characters. + * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method encodes a range of characters in Tizen::Base::WcharBuffer into a range of bytes in Tizen::Base::ByteBuffer. * @see GetChars() */ @@ -227,17 +247,25 @@ public: * @since 2.0 * * @return An error code - * @param[in] str A string to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode - * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored - * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance + * @param[in] str The string to encode + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charCount The total number of characters to encode + * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored + * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c str or @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or the specified @c bytes does not contain sufficient space to store the encoded characters. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c str or @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c bytes does not contain sufficient space to store the encoded characters. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetString() */ @@ -250,13 +278,14 @@ public: * @since 2.0 * * @return An error code - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. - * @remarks This method determines the total number of characters - * that are generated when the specified range of bytes are decoded. + * @remarks This method determines the total number of characters that are generated when the specified range of bytes are decoded. * @see GetMaxCharCount() */ virtual result GetCharCount(const Tizen::Base::ByteBuffer& bytes, int& charCount) const; @@ -267,14 +296,20 @@ public: * @since 2.0 * * @return An error code - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] byteIndex The index from where decoding begins - * @param[in] byteCount The total number of bytes to decode - * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @param[in] byteIndex The index from where the decoding begins + * @param[in] byteCount The total number of bytes to decode + * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method determines the total number of characters * that are generated when the specified range of bytes are decoded. @@ -289,8 +324,8 @@ public: * * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n * else @c null if an exception occurs @n - * The buffer limit is the position of the last decoded byte plus one and the starting position is zero. - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * The buffer limit is the position of the last decoded byte plus one and the starting position is zero. + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c bytes is invalid or empty. @@ -307,17 +342,25 @@ public: * @since 2.0 * * @return An error code - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] byteIndex The index from where decoding begins - * @param[in] byteCount The total number of bytes to decode - * @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded data is stored - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @param[in] byteIndex The index from where the decoding begins + * @param[in] byteCount The total number of bytes to decode + * @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded data is stored + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes or @c chars is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or the specified @c chars does not contain sufficient space to store the decoded bytes. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes or @c chars is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c chars does not contain sufficient space to store the decoded bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetBytes() */ @@ -325,38 +368,46 @@ public: Tizen::Base::WcharBuffer& chars, int charIndex = 0) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * * @return An error code - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[out] str A Tizen::Base::String instance @n - * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty. + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @param[out] str A Tizen::Base::String instance @n + * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetBytesN() */ virtual result GetString(const Tizen::Base::ByteBuffer& bytes, Tizen::Base::String& str) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * * @return An error code - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] index The index from where decoding begins - * @param[in] count The total number of bytes to decode - * @param[out] str A Tizen::Base::String instance @n - * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @param[in] index The index from where the decoding begins + * @param[in] count The total number of bytes to decode + * @param[out] str A Tizen::Base::String instance @n + * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or the specified @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parmater is outside the valid range defined by the method. + * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetBytes() */ @@ -395,11 +446,11 @@ public: * * @since 2.0 * - * @return A pointer to the Encoder instance for the current encoding - * @remarks Contrary to GetBytes(), an encoder can convert partial sequences of characters into - * partial sequences of bytes by maintaining the appropriate state between the conversions. - * Currently only UTF-8 encoding supports this method. The other classes return a value of @c null. - * @see GetBytes() + * @return A pointer to the Encoder instance for the current encoding + * @remarks + * - Contrary to GetBytes(), an encoder can convert partial sequences of characters into + * partial sequences of bytes by maintaining the appropriate state between the conversions. + * - Currently only UTF-8 encoding supports this method. The other classes return a @c null value. */ virtual Encoder* GetEncoderN(void) const; @@ -408,11 +459,11 @@ public: * * @since 2.0 * - * @return A pointer to the Decoder instance for the current encoding - * @remarks Contrary to GetChars(), a decoder can convert partial sequences of bytes - * into partial sequences of characters by maintaining the appropriate state between the conversions. - * Currently only UTF-8 encoding supports this method. The other classes return a value of @c null. - * @see GetChars() + * @return A pointer to the Decoder instance for the current encoding + * @remarks + * - Contrary to GetChars(), a decoder can convert partial sequences of bytes + * into partial sequences of characters by maintaining the appropriate state between the conversions. + * - Currently only UTF-8 encoding supports this method. The other classes return a @c null value. */ virtual Decoder* GetDecoderN(void) const; @@ -421,7 +472,7 @@ public: * * @since 2.0 * - * @return An encoding type + * @return The encoding type */ virtual Tizen::Base::String GetEncodingType(void) const; diff --git a/inc/FTextLatin1Encoding.h b/inc/FTextLatin1Encoding.h index d24dbae..f999190 100644 --- a/inc/FTextLatin1Encoding.h +++ b/inc/FTextLatin1Encoding.h @@ -42,8 +42,8 @@ namespace Tizen { namespace Text * though the two are not identical. * Latin1 also serves as the basis for the ANSI character set of MS Windows. * Only the characters in ISO Latin-1 are guaranteed to be supported on an Internet website. - * When a %Web browser, such as Internet Explorer or Firefox formats a %Web page on a client system, such as - * Windows, it maps the ISO Latin-1 characters as best it can into the default character set. + * When a %Web browser, such as Internet Explorer or Firefox formats a Web page on a client system, such as + * Windows, it maps the ISO Latin-1 characters to the default character set in the best possible way. * * For more information on the class features, see Converting All Text Data at Once. * @@ -110,9 +110,9 @@ public: * * @since 2.0 * - * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. + * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n + * else @c null if an exception occurs @n + * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -128,10 +128,10 @@ public: * * @since 2.0 * - * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. - * @param[in] str A string to encode + * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n + * else @c null if an exception occurs @n + * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. + * @param[in] str The string to encode * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c str is empty or invalid. @@ -149,20 +149,24 @@ public: * * @return An error code * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charCount The total number of characters to encode * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c chars or @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or - * the specified @c bytes does not contain sufficient space to store the encoded characters. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars or @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c bytes does not contain sufficient space to store the encoded characters. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method encodes a range of characters in Tizen::Base::WcharBuffer into a range of bytes in Tizen::Base::ByteBuffer. * @see GetChars() @@ -177,21 +181,25 @@ public: * @since 2.0 * * @return An error code - * @param[in] str A string to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode + * @param[in] str The string to encode + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charCount The total number of characters to encode * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored - * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance + * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c str or @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or - * the specified @c bytes does not contain sufficient space to store the encoded characters. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c str or @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parmater is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c bytes does not contain sufficient space to store the encoded characters. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetString() */ @@ -203,9 +211,9 @@ public: * * @since 2.0 * - * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last decoded byte plus one and the starting position is zero. + * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n + * else @c null if an exception occurs @n + * The buffer limit is the position of the last decoded byte plus one and the starting position is zero. * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -224,20 +232,24 @@ public: * * @return An error code * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] byteIndex The index from where decoding begins + * @param[in] byteIndex The index from where the decoding begins * @param[in] byteCount The total number of bytes to decode * @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded data is stored - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes or @c chars is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or - * the specified @c chars does not contain sufficient space to store the decoded bytes. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes or @c chars is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c chars does not contain sufficient space to store the decoded bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetBytes() */ @@ -245,7 +257,7 @@ public: Tizen::Base::WcharBuffer& chars, int charIndex = 0) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * @@ -255,32 +267,36 @@ public: * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetBytesN() */ virtual result GetString(const Tizen::Base::ByteBuffer& bytes, Tizen::Base::String& str) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * * @return An error code - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] index The index from where decoding begins - * @param[in] count The total number of bytes to decode - * @param[out] str A Tizen::Base::String instance @n - * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @param[in] index The index from where the decoding begins + * @param[in] count The total number of bytes to decode + * @param[out] str A Tizen::Base::String instance @n + * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetBytes() */ @@ -292,9 +308,9 @@ public: * * @since 2.0 * - * @return The maximum number of bytes required for encoding a given number of characters + * @return The maximum number of bytes required for encoding the given number of characters * @param[in] charCount The total number of characters to encode - * @remarks This method determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding. + * @remarks This method determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding. * @see Encoding::GetByteCount() */ virtual int GetMaxByteCount(int charCount) const; @@ -305,9 +321,9 @@ public: * * @since 2.0 * - * @return The maximum number of characters generated by decoding the specified number of bytes + * @return The maximum number of characters generated by decoding the specified number of bytes * @param[in] byteCount The total number of bytes to encode - * @remarks This method determines an appropriate buffer size for character arrays passed to + * @remarks This method determines an appropriate buffer size for character arrays passed to * GetChars() or a decoder for encoding. * @see Encoding::GetByteCount() */ @@ -319,11 +335,11 @@ public: * * @since 2.0 * - * @return A pointer to the Encoder instance for the current encoding - * @remarks Contrary to GetBytes(), an encoder can convert partial sequences of characters into - * partial sequences of bytes by maintaining the appropriate state between the conversions. - * Currently only Utf8Encoding supports this method. Other classes return @c null. - * @see GetBytes() + * @return A pointer to the Encoder instance for the current encoding + * @remarks + * - Contrary to GetBytes(), an encoder can convert partial sequences of characters into + * partial sequences of bytes by maintaining the appropriate state between the conversions. + * - Currently only Utf8Encoding supports this method. Other classes return @c null. */ virtual Encoder* GetEncoderN(void) const; @@ -333,10 +349,10 @@ public: * @since 2.0 * * @return A pointer to the Decoder instance for the current encoding - * @remarks Contrary to GetChars(), a decoder can convert partial sequences of bytes - * into partial sequences of characters by maintaining the appropriate state between the conversions. - * Currently only Utf8Encoding supports this method. Other classes return @c null. - * @see GetChars() + * @remarks + * - Contrary to GetChars(), a decoder can convert partial sequences of bytes + * into partial sequences of characters by maintaining the appropriate state between the conversions. + * - Currently only Utf8Encoding supports this method. Other classes return @c null. */ virtual Decoder* GetDecoderN(void) const; @@ -345,7 +361,7 @@ public: * * @since 2.0 * - * @return An encoding type + * @return The encoding type */ virtual Tizen::Base::String GetEncodingType(void) const; diff --git a/inc/FTextUcs2Encoding.h b/inc/FTextUcs2Encoding.h index 1af58d9..ed744bb 100644 --- a/inc/FTextUcs2Encoding.h +++ b/inc/FTextUcs2Encoding.h @@ -110,11 +110,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] str A string to encode + * @param[in] str The string to encode * @param[out] byteCount The total number of bytes required to encode the string * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c str is an empty string. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c str is an empty string. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method determines the exact number of bytes * that are produced if the given string is encoded. @@ -131,8 +132,9 @@ public: * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode * @param[out] byteCount The total number of bytes required to encode the specified range of characters * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c chars is empty. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method determines the exact number of bytes * that are produced if the given array of characters is encoded. @@ -146,17 +148,20 @@ public: * @since 2.0 * * @return An error code - * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode - * @param[out] byteCount The total number of bytes required to encode the specified range of characters + * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charCount The total number of characters to encode + * @param[out] byteCount The total number of bytes required to encode the specified range of characters * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c chars is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified inout parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method determines the exact number of bytes * that are produced if the given array of characters is encoded. @@ -170,9 +175,9 @@ public: * * @since 2.0 * - * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. + * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n + * else @c null if an exception occurs @n + * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. @@ -188,11 +193,11 @@ public: * * @since 2.0 * - * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. - * @param[in] str A string to encode - * @exception E_SUCCESS The method is successful. + * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n + * else @c null if an exception occurs @n + * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. + * @param[in] str The string to encode + * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c str is empty or invalid. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. @@ -210,19 +215,23 @@ public: * @return An error code * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode + * @param[in] charCount The total number of characters to encode * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored - * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance + * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c chars or @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or - * the specified @c bytes does not contain sufficient space to store the encoded characters. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars or @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c bytes does not contain sufficient space to store the encoded characters. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method encodes a range of characters in a Tizen::Base::WcharBuffer into a range of bytes in a Tizen::Base::ByteBuffer. * @see GetChars() @@ -237,21 +246,25 @@ public: * @since 2.0 * * @return An error code - * @param[in] str A string to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode + * @param[in] str The string to encode + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charCount The total number of characters to encode * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored - * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c str or @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or - * the specified @c bytes does not contain sufficient space to store the encoded characters. + * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c str or @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c bytes does not contain sufficient space to store the encoded characters. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetString() */ @@ -265,10 +278,11 @@ public: * * @return An error code * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance + * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method determines the exact number of characters * that are produced if the given range of bytes is converted. @@ -283,16 +297,19 @@ public: * * @return An error code * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] byteIndex The index from where decoding begins + * @param[in] byteIndex The index from where the decoding begins * @param[in] byteCount The total number of bytes to decode * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks This method determines the exact number of characters * that are produced if the given range of bytes is converted. @@ -301,14 +318,14 @@ public: virtual result GetCharCount(const Tizen::Base::ByteBuffer& bytes, int byteIndex, int byteCount, int& charCount) const; /** - *Decodes an instance of Tizen::Base::ByteBuffer into an instance of Tizen::Base::WcharBuffer. + * Decodes an instance of Tizen::Base::ByteBuffer into an instance of Tizen::Base::WcharBuffer. * * @since 2.0 * - * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last decoded byte plus one and the starting position is zero. - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n + * else @c null if an exception occurs @n + * The buffer limit is the position of the last decoded byte plus one and the starting position is zero. + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c bytes is empty or invalid. @@ -326,20 +343,24 @@ public: * * @return An error code * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] byteIndex The index from where decoding begins + * @param[in] byteIndex The index from where the decoding begins * @param[in] byteCount The total number of bytes to decode * @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded data is stored - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes or @ chars is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or - * the specified @c chars does not contain sufficient space to store the decoded bytes. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes or @ chars is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c chars does not contain sufficient space to store the decoded bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetBytes() */ @@ -347,42 +368,46 @@ public: Tizen::Base::WcharBuffer& chars, int charIndex = 0) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * * @return An error code - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[out] str A Tizen::Base::String instance @n - * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @param[out] str A Tizen::Base::String instance @n + * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetBytesN() */ virtual result GetString(const Tizen::Base::ByteBuffer& bytes, Tizen::Base::String& str) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * * @return An error code * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] index The index from where decoding begins + * @param[in] index The index from where the decoding begins * @param[in] count The total number of bytes to decode * @param[out] str A Tizen::Base::String instance @n - * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. + * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetBytesN() */ @@ -390,15 +415,14 @@ public: /** - * Gets the maximum number of bytes required for encoding a given number of characters. + * Gets the maximum number of bytes required for encoding the given number of characters. * * @since 2.0 * * @return The maximum number of bytes required for encoding the given number of characters * @param[in] charCount The total number of characters to encode - * @remarks This method determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding. + * @remarks This method determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding. * @see GetByteCount() - * @see GetBytes() */ virtual int GetMaxByteCount(int charCount) const; @@ -410,10 +434,9 @@ public: * * @return The maximum number of characters generated by decoding the specified number of bytes * @param[in] byteCount The total number of bytes to encode - * @remarks This method determines an appropriate buffer size for the character arrays passed to - * GetChars() or a decoder for encoding. + * @remarks This method determines an appropriate buffer size for the character arrays passed to + * GetChars() or a decoder for encoding. * @see GetByteCount() - * @see GetChars() */ virtual int GetMaxCharCount(int byteCount) const; @@ -423,11 +446,11 @@ public: * * @since 2.0 * - * @return A pointer to the Encoder instance for the current encoding - * @remarks Contrary to GetBytes(), an encoder can convert partial sequences of characters into - * partial sequences of bytes by maintaining the appropriate state between the conversions. - * Currently only Utf8Encoding supports this method. Other classes return @c null. - * @see GetBytes() + * @return A pointer to the Encoder instance for the current encoding + * @remarks + * - Contrary to GetBytes(), an encoder can convert partial sequences of characters into + * partial sequences of bytes by maintaining the appropriate state between the conversions. + * - Currently only Utf8Encoding supports this method. Other classes return @c null. */ virtual Encoder* GetEncoderN(void) const; @@ -437,12 +460,11 @@ public: * * @since 2.0 * - * @return A pointer to the Decoder instance for the current encoding - * @remarks Contrary to GetChars(), a decoder can convert partial sequences of bytes - * into partial sequences of characters by maintaining the appropriate state between the conversions. - * Currently only Utf8Encoding supports this method. Other classes return @c null. - * - * @see GetChars() + * @return A pointer to the Decoder instance for the current encoding + * @remarks + * - Contrary to GetChars(), a decoder can convert partial sequences of bytes + * into partial sequences of characters by maintaining the appropriate state between the conversions. + * - Currently only Utf8Encoding supports this method. Other classes return @c null. */ virtual Decoder* GetDecoderN(void) const; @@ -451,7 +473,7 @@ public: * * @since 2.0 * - * @return An encoding type + * @return The encoding type */ virtual Tizen::Base::String GetEncodingType(void) const; diff --git a/inc/FTextUtf8Decoder.h b/inc/FTextUtf8Decoder.h index cf0e220..cb0ee6f 100644 --- a/inc/FTextUtf8Decoder.h +++ b/inc/FTextUtf8Decoder.h @@ -39,8 +39,8 @@ namespace Tizen { namespace Text * * The %Utf8Decoder class converts blocks of bytes into decoded blocks of characters. * Universal Transformation Format-8 (UTF-8) is a translated language that is used on the internet. - * It converts the unicode into 8-bit bytes. - * UTF-8 encoding supports all unicode character values and surrogates. + * It converts the Unicode into 8-bit bytes. + * UTF-8 encoding supports all Unicode character values and surrogates. * * For more information on the class features, see Converting Text Data in Separate Blocks. * @@ -124,19 +124,22 @@ public: * * @return An error code * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] byteIndex The index from where decoding begins + * @param[in] byteIndex The index from where the decoding begins * @param[in] byteCount The total number of bytes to decode * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. - * @exception E_INVALID_ENCODING_RANGE The conversion has failed due to invalid encoding range. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. + * @exception E_INVALID_ENCODING_RANGE The conversion has failed due to an invalid encoding range. */ virtual result GetCharCount(const Tizen::Base::ByteBuffer& bytes, int byteIndex, int byteCount, int& charCount, bool flush = false) const; @@ -145,17 +148,18 @@ public: * * @since 2.0 * - * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last decoded byte plus one and the starting position is zero. - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n - * else @c false - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. - * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. + * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n + * else @c null if an exception occurs @n + * The buffer limit is the position of the last decoded byte plus one and the starting position is zero. + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n + * else @c false + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. + * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks The specific error code can be accessed using the GetLastResult() method. */ virtual Tizen::Base::WcharBuffer* GetCharsN(const Tizen::Base::ByteBuffer& bytes, bool flush = false) const; @@ -164,27 +168,30 @@ public: * Decodes an instance of Tizen::Base::ByteBuffer into an instance of Tizen::Base::WcharBuffer as per the specified range. * * @since 2.0 - * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last decoded byte and the starting position is zero. + * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n + * else @c null if an exception occurs @n + * The buffer limit is the position of the last decoded byte and the starting position is zero. * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] byteIndex The index from where decoding begins + * @param[in] byteIndex The index from where the decoding begins * @param[in] byteCount The total number of bytes to decode * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n * else @c false * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. - * @remarks This method maintains state consistency between conversions. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character. - * + * @remarks + * - This method maintains state consistency between conversions. + * - The specific error code can be accessed using the GetLastResult() method. + * - The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character. */ virtual Tizen::Base::WcharBuffer* GetCharsN(const Tizen::Base::ByteBuffer& bytes, int byteIndex, int byteCount, bool flush = false) const; diff --git a/inc/FTextUtf8Encoder.h b/inc/FTextUtf8Encoder.h index fecb8e7..b1969b6 100644 --- a/inc/FTextUtf8Encoder.h +++ b/inc/FTextUtf8Encoder.h @@ -41,8 +41,8 @@ namespace Tizen { namespace Text * * The %Utf8Encoder class converts the blocks of characters into encoded blocks of bytes. * Universal Transformation Format-8 (UTF-8) is a translated language that is used on the internet. It converts the - * unicode into 8-bit bytes. @n UTF-8 encoding supports all unicode character values and surrogates. - * Note that %Utf8Encoder is not used in reality, because keeping the internal state of encoding from unicode + * Unicode into 8-bit bytes. @n UTF-8 encoding supports all Unicode character values and surrogates. + * Note that %Utf8Encoder is not used in reality, because keeping the internal state of encoding from Unicode * to UTF-8 can be avoided if the translation unit is even. * This means that the real implementation of %Utf8Encoder is the same as that of Utf8Encoding in this state. * @@ -129,19 +129,22 @@ public: * @since 2.0 * * @return An error code - * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode - * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n - * else @c false - * @param[out] byteCount The total number of bytes required to encode the specified range of characters + * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charCount The total number of characters to encode + * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n + * else @c false + * @param[out] byteCount The total number of bytes required to encode the specified range of characters * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c chars is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid, or + * - The specified @c chars is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see Utf8Decoder::GetCharCount() */ @@ -153,16 +156,17 @@ public: * * @since 2.0 * - * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. - * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode - * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n - * else @c false + * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n + * else @c null if an exception occurs @n + * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. + * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode + * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n + * else @c false * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c chars is empty. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see Utf8Decoder::GetCharsN() @@ -174,25 +178,29 @@ public: * * @since 2.0 * - * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last encoded byte and the starting position is zero. - * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode + * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n + * else @c null if an exception occurs @n + * The buffer limit is the position of the last encoded byte and the starting position is zero. + * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charCount The total number of characters to encode * @param[in] flush Set to @c true to allow this instance to flush its state at the end of the conversion, @n * else @c false * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c chars is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. - * @remarks The specific error code can be accessed using the GetLastResult() method. - * @remarks The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character. + * @remarks + * - The specific error code can be accessed using the GetLastResult() method. + * - The pointer to the Tizen::Base::ByteBuffer instance is not terminated by a @c null character. * @see Utf8Decoder::GetCharsN() */ virtual Tizen::Base::ByteBuffer* GetBytesN(const Tizen::Base::WcharBuffer& chars, int charIndex, int charCount, diff --git a/inc/FTextUtf8Encoding.h b/inc/FTextUtf8Encoding.h index f797162..eba0eb3 100644 --- a/inc/FTextUtf8Encoding.h +++ b/inc/FTextUtf8Encoding.h @@ -106,7 +106,7 @@ public: virtual ~Utf8Encoding(void); /** - * Gets the total number of bytes that are generated by encoding an instance of specified string. @n + * Gets the total number of bytes that are generated by encoding an instance of the specified string. @n * The %GetByteCount() method determines the total number of bytes that are generated when the specified string is encoded. * * @since 2.0 @@ -115,8 +115,9 @@ public: * @param[in] str The string to encode * @param[out] byteCount The total number of bytes required to encode the string * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c str is an empty string. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c str is an empty string. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetMaxByteCount() */ @@ -130,12 +131,13 @@ public: * @since 2.0 * * @return An error code - * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode - * @param[out] byteCount The total number of bytes required to encode the specified range of characters - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c chars is empty. - * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. + * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode + * @param[out] byteCount The total number of bytes required to encode the specified range of characters + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars is empty. + * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetMaxByteCount() */ virtual result GetByteCount(const Tizen::Base::WcharBuffer& chars, int& byteCount) const; @@ -148,16 +150,19 @@ public: * * @return An error code * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode - * @param[out] byteCount The total number of bytes required to encode the specified range of characters + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charCount The total number of characters to encode + * @param[out] byteCount The total number of bytes required to encode the specified range of characters * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c chars is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetMaxByteCount() */ @@ -168,13 +173,13 @@ public: * * @since 2.0 * - * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. - * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG The specified @c chars is empty or invalid. + * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n + * else @c null if an exception occurs @n + * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. + * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG The specified @c chars is empty or invalid. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see GetCharsN() @@ -186,14 +191,15 @@ public: * * @since 2.0 * - * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. - * @param[in] str A string to encode - * @exception E_SUCCESS The method is successful. + * @return A pointer to the Tizen::Base::ByteBuffer instance where the resultant encoded string is stored, @n + * else @c null if an exception occurs @n + * The buffer limit is the position of the last encoded byte plus one and the starting position is zero. + * @param[in] str The string to encode + * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c str is an empty string. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c str is an empty string. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see GetString() @@ -208,20 +214,24 @@ public: * * @return An error code * @param[in] chars An instance of Tizen::Base::WcharBuffer to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charCount The total number of characters to encode * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c chars or @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or - * the specified @c bytes does not contain sufficient space to store the encoded characters. + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c chars or @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c chars. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c chars. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c bytes does not contain sufficient space to store the encoded characters. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetChars() */ @@ -235,22 +245,26 @@ public: * @since 2.0 * * @return An error code - * @param[in] str A string to encode - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance - * @param[in] charCount The total number of characters to encode + * @param[in] str The string to encode + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charCount The total number of characters to encode * @param[out] bytes The Tizen::Base::ByteBuffer instance where the resultant encoded string is stored - * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance - * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c str or @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or - * the specified @c bytes does not contain sufficient space to store the encoded characters. - * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. + * @param[in] byteIndex The starting index of the resultant encoding in the Tizen::Base::ByteBuffer instance + * @exception E_SUCCESS The method is successful. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c str or @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c charIndex or @c charCount is greater than the length of the specified @c str. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c charIndex and @c charCount is greater than the length of the specified @c str. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c bytes does not contain sufficient space to store the encoded characters. + * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetString() */ virtual result GetBytes(const Tizen::Base::String& str, int charIndex, int charCount, @@ -267,8 +281,9 @@ public: * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetMaxCharCount() */ @@ -283,16 +298,19 @@ public: * * @return An error code * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] byteIndex The index from where decoding begins + * @param[in] byteIndex The index from where the decoding begins * @param[in] byteCount The total number of bytes to decode - * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. + * @param[out] charCount The total number of characters that are generated by decoding the specified Tizen::Base::ByteBuffer instance + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetMaxCharCount() */ @@ -303,14 +321,14 @@ public: * * @since 2.0 * - * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n - * else @c null if an exception occurs @n - * The buffer limit is the position of the last decoded byte plus one and the position is zero. - * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode + * @return A pointer to the Tizen::Base::WcharBuffer instance where the resultant decoded data is stored, @n + * else @c null if an exception occurs @n + * The buffer limit is the position of the last decoded byte plus one and the position is zero. + * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. * @exception E_INVALID_ARG The specified @c bytes is empty or invalid. - * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. + * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @remarks The specific error code can be accessed using the GetLastResult() method. * @see GetBytesN() */ @@ -324,20 +342,24 @@ public: * * @return An error code * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] byteIndex The index from where decoding begins + * @param[in] byteIndex The index from where the decoding begins * @param[in] byteCount The total number of bytes to decode * @param[out] chars The Tizen::Base::WcharBuffer instance where the resultant decoded data is stored - * @param[in] charIndex The index from where encoding begins in the Tizen::Base::WcharBuffer instance + * @param[in] charIndex The index from where the encoding begins in the Tizen::Base::WcharBuffer instance * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes or @c chars is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. - * @exception E_OVERFLOW This operation has caused the memory to overflow, or - * the specified @c chars does not contain sufficient space to store the decoded bytes. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes or @c chars is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The length of the specified @c byteIndex or @c byteCount is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c byteIndex and @c byteCount is greater than the length of the specified @c bytes. + * @exception E_OVERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to overflow. + * - The specified @c chars does not contain sufficient space to store the decoded bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetBytes() */ @@ -345,42 +367,46 @@ public: Tizen::Base::WcharBuffer& chars, int charIndex = 0) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * * @return An error code * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[out] str A Tizen::Base::String instance @n - * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * @param[out] str A Tizen::Base::String instance @n + * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetBytesN() */ virtual result GetString(const Tizen::Base::ByteBuffer& bytes, Tizen::Base::String& str) const; /** - * Gets a string containing the decoded representation of the specified Tizen::Base::ByteBuffer instance. + * Gets a string that contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * * @since 2.0 * * @return An error code * @param[in] bytes An instance of Tizen::Base::ByteBuffer to decode - * @param[in] index The index from where decoding begins + * @param[in] index The index from where the decoding begins * @param[in] count The total number of bytes to decode * @param[out] str A Tizen::Base::String instance @n * It contains the decoded representation of the specified Tizen::Base::ByteBuffer instance. * @exception E_SUCCESS The method is successful. * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_INVALID_ARG A specified input parameter is invalid, or - * the specified @c bytes is empty. - * @exception E_OUT_OF_RANGE The value of an argument is outside the valid range defined by the method, or - * the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. - * @exception E_UNDERFLOW This operation has caused the memory to underflow, or - * the sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. + * @exception E_INVALID_ARG Either of the following conditions has occurred: + * - A specified input parameter is invalid. + * - The specified @c bytes is empty. + * @exception E_OUT_OF_RANGE Either of the following conditions has occurred: + * - A specified input parameter is outside the valid range defined by the method. + * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. + * @exception E_UNDERFLOW Either of the following conditions has occurred: + * - This operation has caused the memory to underflow. + * - The sum of the length of the specified @c index and @c count is greater than the length of the specified @c bytes. * @exception E_INVALID_ENCODING_RANGE The specified string contains code points that are outside the bounds of the character encoding scheme. * @see GetBytes() */ @@ -388,15 +414,14 @@ public: /** - * Gets the maximum number of bytes required for encoding a given number of characters. + * Gets the maximum number of bytes required for encoding the given number of characters. * * @since 2.0 * - * @return The maximum number of bytes required for encoding a given number of characters + * @return The maximum number of bytes required for encoding the given number of characters * @param[in] charCount The total number of characters to encode * @remarks This method determines an appropriate buffer size for the byte arrays passed to GetBytes() for encoding. * @see GetByteCount() - * @see GetBytes() */ virtual int GetMaxByteCount(int charCount) const; @@ -406,12 +431,11 @@ public: * * @since 2.0 * - * @return The maximum number of characters generated by decoding the specified number of bytes - * @param[in] byteCount The total number of bytes to encode + * @return The maximum number of characters generated by decoding the specified number of bytes + * @param[in] byteCount The total number of bytes to encode * @remarks This method determines an appropriate buffer size for the character arrays passed to * GetChars() or a decoder for encoding. * @see GetCharCount() - * @see GetChars() */ virtual int GetMaxCharCount(int byteCount) const; @@ -420,10 +444,9 @@ public: * * @since 2.0 * - * @return A pointer to the Encoder instance for the current encoding + * @return A pointer to the Encoder instance for the current encoding * @remarks Contrary to GetBytes(), an encoder can convert partial sequences of characters into * partial sequences of bytes by maintaining the appropriate states between the conversions. - * @see GetBytes() */ virtual Encoder* GetEncoderN(void) const; @@ -432,10 +455,9 @@ public: * * @since 2.0 * - * @return A pointer to the Decoder instance for the current encoding + * @return A pointer to the Decoder instance for the current encoding * @remarks Contrary to GetChars(), a decoder can convert partial sequences of bytes * into partial sequences of characters by maintaining the appropriate states between the conversions. - * @see GetChars() */ virtual Decoder* GetDecoderN(void) const; @@ -444,7 +466,7 @@ public: * * @since 2.0 * - * @return An encoding type + * @return The encoding type */ virtual Tizen::Base::String GetEncodingType(void) const; diff --git a/osp-appfw-server.pc.in b/osp-appfw-server.pc.in index 23414e0..74c5d15 100755 --- a/osp-appfw-server.pc.in +++ b/osp-appfw-server.pc.in @@ -3,7 +3,7 @@ prefix=@PREFIX@ exec_prefix=/usr libdir=/usr/lib/osp-server -includedir=/usr/include/osp/server +includedir=/usr/include/osp/server/appfw Name: @PC_NAME@ Description: @PACKAGE_DESCRIPTION@ diff --git a/osp-appfw.manifest b/osp-appfw.manifest index ec50cdf..6659498 100644 --- a/osp-appfw.manifest +++ b/osp-appfw.manifest @@ -14,5 +14,6 @@ + diff --git a/osp-system-server.pc.in b/osp-system-server.pc.in index 55148fe..62f5b14 100755 --- a/osp-system-server.pc.in +++ b/osp-system-server.pc.in @@ -3,7 +3,7 @@ prefix=@PREFIX@ exec_prefix=/usr libdir=/usr/lib/osp-server -includedir=/usr/include/osp/server +includedir=/usr/include/osp/server/system Name: @PC_NAME@ Description: @PACKAGE_DESCRIPTION@ diff --git a/packaging/osp-appfw.spec b/packaging/osp-appfw.spec index 9518ba0..255266f 100644 --- a/packaging/osp-appfw.spec +++ b/packaging/osp-appfw.spec @@ -72,8 +72,7 @@ BuildRequires: capi-security-privilege-manager-devel BuildRequires: boost-devel BuildRequires: gettext-tools BuildRequires: pkgconfig(security-server) -BuildRequires: pkgconfig(badge) -BuildRequires: pkgconfig(appinfo) >= 0.1.0 +BuildRequires: pkgconfig(appinfo) >= 0.1.2 # runtime requires Requires: capi-appfw-application @@ -84,7 +83,7 @@ Requires: capi-system-runtime-info Requires: capi-security-privilege-manager Requires: chromium Requires: message-port -Requires: osp-env-config >= 1.2.2.1 +Requires: osp-env-config Requires: sqlite Requires: iniparser @@ -99,7 +98,6 @@ The App Framework library of OSP %package devel Summary: The App Framework library of OSP (Development) -Group: TO_BE/FILLED_IN Requires: %{name} = %{version}-%{release} Requires: boost-devel Requires: pkgconfig(pkgmgr-info) @@ -108,8 +106,7 @@ Requires: pkgconfig(pkgmgr-info) The App Framework library of OSP (DEV) %package internal-devel -Summary: osp app framework internel (Internal) -Group: TO_BE/FILLED_IN +Summary: OSP app framework internal (Internal) Requires: %{name} = %{version}-%{release} Requires: %{name}-devel @@ -118,7 +115,6 @@ The App Framework library of OSP (Internal-DEV) %package debug Summary: The App Framework library of OSP (Development) -Group: TO_BE/FILLED_IN Requires: %{name} = %{version}-%{release} %description debug @@ -194,6 +190,7 @@ chmod 444 /opt/usr/etc/clocale.list %config /opt/usr/etc/* /usr/share/locale/* %config /usr/etc/* +%attr(755,root,app_logging) /usr/bin/nativeinfologctrl %{_libdir}/osp/libosp-appfw.so* %{_libdir}/osp-server/libosp-appfw-server.so* %{_libdir}/osp-server/libosp-system-server.so* @@ -211,7 +208,6 @@ chmod 444 /opt/usr/etc/clocale.list %{_includedir}/osp/system/* %{_includedir}/osp/text/* %{_includedir}/osp/server/* -%{_includedir}/osp/system-server/* %{_libdir}/pkgconfig/osp-appfw.pc %{_libdir}/pkgconfig/osp-appfw-server.pc %{_libdir}/pkgconfig/osp-system-server.pc diff --git a/res/common/usr/bin/nativeinfologctrl b/res/common/usr/bin/nativeinfologctrl new file mode 100755 index 0000000..13c5b15 --- /dev/null +++ b/res/common/usr/bin/nativeinfologctrl @@ -0,0 +1,57 @@ +#!/bin/sh +MODE=none +OBJ=none +VAL=none +#echo "tizen_platform_dlog_logging_ctrl" +case "$1" in +get) + MODE=get +;; +set) + MODE=set +;; + +*) +echo "Usage: dlogctrl {get|set} {platformlog} {1|0}" +exit 1 +esac + +case "$2" in +platformlog) + OBJ=platformlog +;; +*) + echo "Usage: dlogctrl {get|set} {platformlog} {1|0}" +exit 1 +esac + +if [ "$MODE" = "set" ]; then + case "$3" in + 1) + VAL=1 + ;; + 0) + VAL=0 + ;; + *) + echo "Usage: dlogctrl {get|set} {platformlog} {1|0}" + exit 1 + esac +fi + +if [ "$MODE" = "set" ]; then + if [ "$OBJ" = "platformlog" ] && [ "$VAL" = "1" ] ; then + echo 1 > /opt/etc/platformlog.conf 2>/dev/null + touch /home/developer/.platforminfologgingmode 2>/dev/null + elif [ "$OBJ" = "platformlog" ] && [ "$VAL" = "0" ] ; then + echo 0 > /opt/etc/platformlog.conf 2>/dev/null + rm /home/developer/.platforminfologgingmode 2>/dev/null + fi + echo "You must reboot this target to apply the change!" +else + if [ "$OBJ" = "platformlog" ]; then + cat /opt/etc/platformlog.conf 2>/dev/null + fi +fi + +exit 0 diff --git a/src/CMakeLists.txt b/src/CMakeLists.txt index 756f465..2013365 100644 --- a/src/CMakeLists.txt +++ b/src/CMakeLists.txt @@ -15,7 +15,6 @@ pkg_check_modules(pkgs REQUIRED ecore glib-2.0 haptic - badge icu-i18n iniparser libpcre @@ -60,5 +59,5 @@ ADD_SUBDIRECTORY(system) ADD_SUBDIRECTORY(text) ADD_SUBDIRECTORY(appfw) ADD_SUBDIRECTORY(osp-string) -ADD_SUBDIRECTORY(server osp-appfw-server) -ADD_SUBDIRECTORY(system-server osp-system-server) +ADD_SUBDIRECTORY(server) +ADD_SUBDIRECTORY(server/system osp-system-server) diff --git a/src/app/FAppAppControl.cpp b/src/app/FAppAppControl.cpp index c5d3893..447d748 100644 --- a/src/app/FAppAppControl.cpp +++ b/src/app/FAppAppControl.cpp @@ -90,6 +90,9 @@ AppControl::FindAndStart(const String& operationId, const String* pUriPattern, c result AppControl::Stop(void) { + result r = _AccessController::CheckUserPrivilege(_PRV_APPLICATION_LAUNCH); + SysTryReturnResult(NID_APP, !IsFailed(r), E_PRIVILEGE_DENIED, "The application does not have the privilege to call this method."); + SysAssertf(__pAppControlImpl != null, "Instance is not constructed properly."); return __pAppControlImpl->Stop(); } diff --git a/src/app/FAppAppManager.cpp b/src/app/FAppAppManager.cpp old mode 100755 new mode 100644 index 719256c..a3fcc04 --- a/src/app/FAppAppManager.cpp +++ b/src/app/FAppAppManager.cpp @@ -76,7 +76,11 @@ AppManager::Construct(void) SysTryReturnResult(NID_APP, __pAppManagerImpl != null, E_OUT_OF_MEMORY, ""); r = __pAppManagerImpl->Construct(); - SysTryCatch(NID_APP, !IsFailed(r), , r, "[%s] Propagating.", GetErrorMessage(r)); + if (IsFailed(r)) + { + SysPropagate(NID_APP, r); + goto CATCH; + } return r; @@ -150,8 +154,7 @@ AppManager::GetAppSharedPath(const AppId& appId) String sharedPath; result r = _AppManagerImpl::GetAppRootPath(appId, sharedPath); - SysTryReturn(NID_APP, !IsFailed(r), sharedPath, r, "[%s] Propagating to caller...", - GetErrorMessage(r)); + SysTryReturn(NID_APP, !IsFailed(r), sharedPath, r, "[%s] Propagating to caller...", GetErrorMessage(r)); sharedPath.Append(L"shared/"); diff --git a/src/app/FAppAppSetting.cpp b/src/app/FAppAppSetting.cpp index 712dab2..922828b 100644 --- a/src/app/FAppAppSetting.cpp +++ b/src/app/FAppAppSetting.cpp @@ -24,9 +24,11 @@ #include #include #include +#include #include "FApp_AppSettingImpl.h" using namespace Tizen::Base::Collection; +using namespace Tizen::Security; namespace Tizen { namespace App { @@ -79,13 +81,20 @@ AppSetting::GetInstance(const Tizen::Base::String& version) AppSetting* AppSetting::GetInstanceByAppId(const AppId& appId) { - //TODO: Add privilege checking code + result r = _AccessController::CheckUserPrivilege(_PRV_APPSETTING); + SysTryReturn(NID_APP, !IsFailed(r), null, E_PRIVILEGE_DENIED, + "[%s] The application does not have the privilege to call this method.", GetErrorMessage(E_PRIVILEGE_DENIED)); + return _AppSettingImpl::GetInstanceByAppId(appId); } result AppSetting::ReleaseInstanceByAppId(const AppId& appId) { + result r = _AccessController::CheckUserPrivilege(_PRV_APPSETTING); + SysTryReturnResult(NID_APP, !IsFailed(r), E_PRIVILEGE_DENIED, + "[%s] The application does not have the privilege to call this method.", GetErrorMessage(E_PRIVILEGE_DENIED)); + return _AppSettingImpl::ReleaseInstanceByAppId(appId); } diff --git a/src/app/FAppMapDataControl.cpp b/src/app/FAppMapDataControl.cpp index 0a6e942..82035d5 100644 --- a/src/app/FAppMapDataControl.cpp +++ b/src/app/FAppMapDataControl.cpp @@ -25,10 +25,12 @@ #include #include "FApp_MapDataControlImpl.h" +#include using namespace Tizen::Base; using namespace Tizen::Base::Collection; using namespace Tizen::App; +using namespace Tizen::Security; namespace Tizen { namespace App { @@ -47,6 +49,9 @@ result MapDataControl::GetValue(const String& dataId, const String& key, RequestId& reqId, int pageNo, int countPerPage) { + result r = _AccessController::CheckUserPrivilege(_PRV_DATACONTROL_CONSUMER); + SysTryReturnResult(NID_APP, !IsFailed(r), E_PRIVILEGE_DENIED, "The application does not have the privilege to call this method."); + SysTryReturnResult(NID_APP, __pMapDataControlImpl, E_INVALID_STATE, "This instance has not been properly constructed yet."); @@ -57,6 +62,9 @@ result MapDataControl::AddValue(const String& dataId, const String& key, const String& value, RequestId& reqId) { + result r = _AccessController::CheckUserPrivilege(_PRV_DATACONTROL_CONSUMER); + SysTryReturnResult(NID_APP, !IsFailed(r), E_PRIVILEGE_DENIED, "The application does not have the privilege to call this method."); + SysTryReturnResult(NID_APP, __pMapDataControlImpl, E_INVALID_STATE, "This instance has not been properly constructed yet."); @@ -67,6 +75,9 @@ result MapDataControl::SetValue(const String& dataId, const String& key, const String& oldValue, const String& newValue, RequestId& reqId) { + result r = _AccessController::CheckUserPrivilege(_PRV_DATACONTROL_CONSUMER); + SysTryReturnResult(NID_APP, !IsFailed(r), E_PRIVILEGE_DENIED, "The application does not have the privilege to call this method."); + SysTryReturnResult(NID_APP, __pMapDataControlImpl, E_INVALID_STATE, "This instance has not been properly constructed yet."); @@ -77,6 +88,9 @@ result MapDataControl::RemoveValue(const String& dataId, const String& key, const String& value, RequestId& reqId) { + result r = _AccessController::CheckUserPrivilege(_PRV_DATACONTROL_CONSUMER); + SysTryReturnResult(NID_APP, !IsFailed(r), E_PRIVILEGE_DENIED, "The application does not have the privilege to call this method."); + SysTryReturnResult(NID_APP, __pMapDataControlImpl, E_INVALID_STATE, "This instance has not been properly constructed yet."); diff --git a/src/app/FAppSqlDataControl.cpp b/src/app/FAppSqlDataControl.cpp index a512047..66cb727 100644 --- a/src/app/FAppSqlDataControl.cpp +++ b/src/app/FAppSqlDataControl.cpp @@ -25,9 +25,11 @@ #include #include "FApp_SqlDataControlImpl.h" +#include using namespace Tizen::Base; using namespace Tizen::Base::Collection; +using namespace Tizen::Security; namespace Tizen { namespace App { @@ -47,6 +49,9 @@ result SqlDataControl::Select(const String& dataId, const IList* pColumnList, const String* pWhere, const String *pOrder, RequestId& reqId, int pageNo, int countPerPage) { + result r = _AccessController::CheckUserPrivilege(_PRV_DATACONTROL_CONSUMER); + SysTryReturnResult(NID_APP, !IsFailed(r), E_PRIVILEGE_DENIED, "The application does not have the privilege to call this method."); + SysTryReturnResult(NID_APP, __pSqlDataControlImpl, E_INVALID_STATE, "This instance has not been properly constructed."); @@ -57,6 +62,9 @@ result SqlDataControl::Insert(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& insertMap, RequestId& reqId) { + result r = _AccessController::CheckUserPrivilege(_PRV_DATACONTROL_CONSUMER); + SysTryReturnResult(NID_APP, !IsFailed(r), E_PRIVILEGE_DENIED, "The application does not have the privilege to call this method."); + SysTryReturnResult(NID_APP, __pSqlDataControlImpl, E_INVALID_STATE, "This instance has not been properly constructed."); @@ -67,6 +75,9 @@ result SqlDataControl::Update(const Tizen::Base::String& dataId, const Tizen::Base::Collection::IMap& updateMap, const Tizen::Base::String* pWhere, RequestId& reqId) { + result r = _AccessController::CheckUserPrivilege(_PRV_DATACONTROL_CONSUMER); + SysTryReturnResult(NID_APP, !IsFailed(r), E_PRIVILEGE_DENIED, "The application does not have the privilege to call this method."); + SysTryReturnResult(NID_APP, __pSqlDataControlImpl, E_INVALID_STATE, "This instance has not been properly constructed."); return __pSqlDataControlImpl->Update(dataId, updateMap, pWhere, reqId); @@ -75,6 +86,9 @@ SqlDataControl::Update(const Tizen::Base::String& dataId, const Tizen::Base::Col result SqlDataControl::Delete(const Tizen::Base::String& dataId, const Tizen::Base::String* pWhere, RequestId& reqId) { + result r = _AccessController::CheckUserPrivilege(_PRV_DATACONTROL_CONSUMER); + SysTryReturnResult(NID_APP, !IsFailed(r), E_PRIVILEGE_DENIED, "The application does not have the privilege to call this method."); + SysTryReturnResult(NID_APP, __pSqlDataControlImpl, E_INVALID_STATE, "This instance has not been properly constructed."); diff --git a/src/app/FApp_ActiveWindowManager.cpp b/src/app/FApp_ActiveWindowManager.cpp index 1088790..b0cf879 100644 --- a/src/app/FApp_ActiveWindowManager.cpp +++ b/src/app/FApp_ActiveWindowManager.cpp @@ -36,7 +36,6 @@ using namespace Tizen::Base; using namespace Tizen::Base::Collection; -//using namespace Tizen::Base::Utility; using namespace Tizen::Base::Runtime; namespace @@ -239,7 +238,11 @@ _ActiveWindowManager::AddActiveAppEventListener(IActiveAppEventListener& listene bool alreadyExist = __activeAppEventListenerList.Contains(&listener); SysTryReturnResult(NID_APP, !alreadyExist, E_OBJ_ALREADY_EXIST, "The event listener already exist."); result r = __activeAppEventListenerList.Add(&listener); - SysTryReturn(NID_APP, !IsFailed(r), r, r, "[%s] Propagating.", GetErrorMessage(r)); + if (IsFailed(r)) + { + SysPropagate(NID_APP, r); + return r; + } if (!pWindowPropertyChanged) { @@ -275,7 +278,11 @@ _ActiveWindowManager::RemoveActiveAppEventListener(IActiveAppEventListener& list } result r = __activeAppEventListenerList.Remove(&listener); - SysTryReturn(NID_APP, !IsFailed(r), r, r, "[%s] Propagating.", GetErrorMessage(r)); + if (IsFailed(r)) + { + SysPropagate(NID_APP, r); + return r; + } if (__activeAppEventListenerList.GetCount() == 0) { diff --git a/src/app/FApp_AppArg.cpp b/src/app/FApp_AppArg.cpp index 67ffb46..3f79949 100644 --- a/src/app/FApp_AppArg.cpp +++ b/src/app/FApp_AppArg.cpp @@ -80,9 +80,6 @@ static const char BUNDLE_KEY_PREFIX_UG[] = "__UG_"; static const char OSP_K_SUBMODE_CALLEE[] = "__OSP_SUB_CALLEE__"; static const char OSP_K_SERVICE_CALLEE[] = "__OSP_SERVICE_CALLEE__"; -const char TIZEN_NOTIFICATION_DATA[] = "http://tizen.org/appcontrol/data/notification"; -const wchar_t LEGACY_OPERATION_MAIN[] = L"osp.operation.MAIN"; - _AppArg::_AppArg(void) : __pBundle(null) @@ -120,36 +117,6 @@ _AppArg::Construct(const IList* pList) result -_AppArg::Construct(const _AppControlImpl& ac, const IList* pList) -{ - __pBundle = bundle_create(); - SysTryReturnResult(NID_APP, __pBundle != null, E_OUT_OF_MEMORY, "Bundle creation failure."); - - return CreateAppControlArg(__pBundle, ac, pList); -} - - -result -_AppArg::Construct(const _AppControlImpl& ac, const String* pUri, const String* pMime, const IMap* pList) -{ - __pBundle = bundle_create(); - SysTryReturnResult(NID_APP, __pBundle != null, E_OUT_OF_MEMORY, "Bundle creation failure."); - - return CreateAppControlArg(__pBundle, ac, pUri, pMime, pList); -} - - -result -_AppArg::Construct(const _AppMessageImpl& msg, const String& oId, const String* pUri, const String* pMime) -{ - __pBundle = bundle_dup(const_cast(msg.GetBundle())); - SysTryReturnResult(NID_APP, __pBundle != null, E_OUT_OF_MEMORY, "Bundle creation failure."); - - return CreateAppControlArg(__pBundle, oId, pUri, pMime, null); -} - - -result _AppArg::Construct(const _SqlDataControlImpl& dc, _DataControlRequestType requestType, const IList* pList) { __pBundle = bundle_create(); @@ -190,9 +157,9 @@ _AppArg::ConstructResult(const _AppArg& arg, const IMap* pMap) result -_AppArg::Construct(bundle* b) +_AppArg::Construct(const bundle* b) { - __pBundle = bundle_dup(b); + __pBundle = bundle_dup(const_cast(b)); SysTryReturnResult(NID_APP, __pBundle != null, E_INVALID_STATE, "Bundle creatioin from service handle failure."); return E_SUCCESS; @@ -573,9 +540,9 @@ _AppArg::GetCallerAppId(void) const AppId -_AppArg::GetCalleeAppId(void) const +_AppArg::GetCalleeAppId(bundle* pBundle) { - const char* pBundleValue = bundle_get_val(__pBundle, AUL_K_CALLEE_APPID); + const char* pBundleValue = bundle_get_val(pBundle, AUL_K_CALLEE_APPID); const AppId retVal = pBundleValue; @@ -889,73 +856,6 @@ _AppArg::CreateAppLaunchConditionArg(bundle* b, const String& condition, const I } -result -_AppArg::CreateAppControlArg(bundle* b, const _AppControlImpl& ac, const IList* pList) -{ - SysAssertf(b != null, "Valid bundle should be supplied"); - - bundle* pb = b; - - AddStrArray(pb, OSP_K_ARG, pList); - - std::unique_ptr pOperation(_StringConverter::CopyToCharArrayN(ac._opId)); - if (pOperation) - { - appsvc_set_operation(pb, pOperation.get()); - } - - bundle_add(pb, OSP_K_LAUNCH_TYPE, OSP_V_LAUNCH_TYPE_APPCONTROL); - - return E_SUCCESS; -} - - -result -_AppArg::CreateAppControlArg(bundle* b, const _AppControlImpl& ac, const String* pUriData, const String* pMimeType, const IMap* pMap) -{ - return CreateAppControlArg(b, ac._opId, pUriData, pMimeType, pMap); -} - - -result -_AppArg::CreateAppControlArg(bundle* b, const String& oId, const String* pUriData, const String* pMimeType, const IMap* pMap) -{ - SysAssertf(b != null, "Valid bundle should be supplied"); - - bundle* pb = b; - - std::unique_ptr pOperation(_StringConverter::CopyToCharArrayN(oId)); - if (pOperation.get()) - { - appsvc_set_operation(pb, pOperation.get()); - } - - if (pUriData) - { - std::unique_ptr pUri(_StringConverter::CopyToCharArrayN(*pUriData)); - if (pUri.get()) - { - appsvc_set_uri(pb, pUri.get()); - } - } - - if (pMimeType) - { - std::unique_ptr pMime(_StringConverter::CopyToCharArrayN(*pMimeType)); - if (pMime.get()) - { - appsvc_set_mime(pb, pMime.get()); - } - } - - AddStrMap(pb, pMap); - - bundle_add(pb, OSP_K_LAUNCH_TYPE, OSP_V_LAUNCH_TYPE_APPCONTROL); - - return E_SUCCESS; -} - - namespace { const int MAX_LEN_DATA_CONTROL_REQ_TYPE = 8; diff --git a/src/app/FApp_AppControlEvent.cpp b/src/app/FApp_AppControlEvent.cpp index 5843165..ae009bd 100644 --- a/src/app/FApp_AppControlEvent.cpp +++ b/src/app/FApp_AppControlEvent.cpp @@ -52,7 +52,7 @@ _AppControlEvent::FireImpl(IEventListener& listener, const IEventArg& arg) if (pNativeArg != null) { - pListener->OnAppControlEventReceivedN(pNativeArg->GetRequestId(), pNativeArg->GetResult(), pNativeArg->GetArgs(), pNativeArg->GetProperty()); + pListener->OnAppControlPluginEventReceivedN(pNativeArg->GetRequestId(), pNativeArg->GetResult(), pNativeArg->GetOptionalAppId(), pNativeArg->GetOptionalOperationId(), pNativeArg->GetArgs(), pNativeArg->GetProperty()); return; } diff --git a/src/app/FApp_AppControlEventArg.cpp b/src/app/FApp_AppControlEventArg.cpp index 12404f0..dfc257d 100644 --- a/src/app/FApp_AppControlEventArg.cpp +++ b/src/app/FApp_AppControlEventArg.cpp @@ -44,53 +44,19 @@ _AppControlEventArg::~_AppControlEventArg(void) _NativeAppControlEventArg::_NativeAppControlEventArg(int reqId, int res, IMap* pArg, int prop) : __reqId(reqId) , __result(res) - , __pArgs(null) + , __pArgs(pArg) , __property(prop) { - if (pArg == null) - { - return; - } - -#if 0 - HashMap* pMap = new (std::nothrow) HashMap(SingleObjectDeleter); - SysTryReturnVoidResult(NID_APP, pMap, E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY] Insufficient memory."); - - pMap->Construct(); - - std::unique_ptr pMapEnum(pArg->GetMapEnumeratorN()); - - while(pMapEnum->MoveNext() == E_SUCCESS) - { - String* pKey = dynamic_cast(pMapEnum->GetKey()); - String* pVal = dynamic_cast(pMapEnum->GetValue()); - - if (pKey == null || pVal == null) - { - continue; - } - - pMap->Add(new (std::nothrow) String(*pKey), new (std::nothrow) String(*pVal)); - } - - __pArgs = pMap; -#else - // ownership is transferred to event - __pArgs = pArg; -#endif - - return; } -_NativeAppControlEventArg::~_NativeAppControlEventArg(void) +_NativeAppControlEventArg::_NativeAppControlEventArg(int reqId, int res, const AppId& appId, const String& oId, IMap* pArg, int prop) + : __reqId(reqId) + , __result(res) + , __pArgs(pArg) + , __property(prop) + , __optAppId(appId) + , __optOperationId(oId) { -/* - if (__pArgs) - { - SysLog(NID_APP, "Deleting native AppControl argument."); - delete __pArgs; - } -*/ } } } // Tizen::App diff --git a/src/app/FApp_AppControlEventArg.h b/src/app/FApp_AppControlEventArg.h index 621fcf3..5585266 100644 --- a/src/app/FApp_AppControlEventArg.h +++ b/src/app/FApp_AppControlEventArg.h @@ -102,7 +102,9 @@ class _NativeAppControlEventArg public: _NativeAppControlEventArg(int reqId, int res, Tizen::Base::Collection::IMap* pArgs, int prop); - virtual ~_NativeAppControlEventArg(void); + _NativeAppControlEventArg(int reqId, int res, const AppId& appId, const Tizen::Base::String& oId, Tizen::Base::Collection::IMap* pArgs, int prop); + + virtual ~_NativeAppControlEventArg(void) {} int GetRequestId(void) const { @@ -124,11 +126,23 @@ public: return __property; } + AppId GetOptionalAppId(void) const + { + return __optAppId; + } + + Tizen::Base::String GetOptionalOperationId(void) const + { + return __optOperationId; + } + private: const int __reqId; const int __result; Tizen::Base::Collection::IMap* __pArgs; const int __property; + AppId __optAppId; + Tizen::Base::String __optOperationId; }; // _NativeAppControlEventArg /** diff --git a/src/app/FApp_AppControlImpl.cpp b/src/app/FApp_AppControlImpl.cpp index 376b58e..899c9ea 100644 --- a/src/app/FApp_AppControlImpl.cpp +++ b/src/app/FApp_AppControlImpl.cpp @@ -33,10 +33,9 @@ #include #include -#include - #include "FApp_AppControlImpl.h" #include "FApp_AppControlManager.h" +#include "FApp_IAppControlPluginProvider.h" #include "FApp_AppArg.h" #include "FApp_AppControlRegistry.h" #include "FApp_AppMessageImpl.h" @@ -57,20 +56,19 @@ using namespace Tizen::Io; namespace { -static const int _REQ_ID_INVALID = -1; +const wchar_t ACTL_IMPLICIT_PLUGIN[] = L"libosp-ac-implicit.so"; +const wchar_t TIZEN_ALIAS_APPID_PREFIX[] = L"tizen."; } namespace Tizen { namespace App { -const wchar_t TIZEN_OPERATION_MAIN[] = L"http://tizen.org/appcontrol/operation/main"; - _AppControlImpl::_AppControlImpl(const AppControl& value) : _appControl(value) - , _reqId(_REQ_ID_INVALID) + , _reqId(APPCONTROL_REQUEST_ID_INVALID) , _property(_APPCONTROL_PROPERTY_NONE) - , _processId(_REQ_ID_INVALID) + , _processId(APPCONTROL_REQUEST_ID_INVALID) { __appControlResponseEventList.Construct(); } @@ -102,32 +100,21 @@ _AppControlImpl::~_AppControlImpl(void) } AppControl* -_AppControlImpl::CreateN(const String& path, const String& aId, const String& oId, const String& name, int prop) +_AppControlImpl::CreateN(const String& path, const String& aId, const String& oId, int prop) { SysTryReturn(NID_APP, !path.IsEmpty(), null, E_INVALID_ARG, "[E_INVALID_ARG] Path is empty."); SysTryReturn(NID_APP, !aId.IsEmpty(), null, E_INVALID_ARG, "[E_INVALID_ARG] Provider Id is empty."); - SysTryReturn(NID_APP, !oId.IsEmpty(), null, E_INVALID_ARG, "[E_INVALID_ARG] Operation Id is empty."); - - AppControl* pAc = new (std::nothrow) AppControl; - SysTryReturn(NID_APP, pAc != null, null, E_OUT_OF_MEMORY, "AppControl allocation failure."); - _AppControlImpl* pImpl = pAc->__pAppControlImpl; - SysTryReturn(NID_APP, pImpl != null, null, E_OUT_OF_MEMORY, "AppControlImpl instance must not be null."); - - pImpl->_path = path; - pImpl->_provider = aId; - pImpl->_opId = oId; - // [FIXME] Proper App name setting - pImpl->_appName = name; - pImpl->_property = prop; + String actualAppId = aId; + if (aId.StartsWith(TIZEN_ALIAS_APPID_PREFIX, 0)) + { + // little bit of performance tweak + actualAppId = _AppControlRegistry::GetInstance()->GetAliasAppId(aId); + } - return pAc; -} + const bool isInstalled = _Aul::IsInstalled(actualAppId); + SysTryReturn(NID_APP, isInstalled, null, E_OBJ_NOT_FOUND, "[E_OBJ_NOT_FOUND] %ls not installed.", actualAppId.GetPointer()); -AppControl* -_AppControlImpl::CreateN(const AppId& appId, const String& operationId, bool changeAppId) -{ - SysTryReturn(NID_APP, !appId.IsEmpty(), null, E_INVALID_ARG, "[E_INVALID_ARG] appId is empty."); AppControl* pAc = new (std::nothrow) AppControl; SysTryReturn(NID_APP, pAc != null, null, E_OUT_OF_MEMORY, "AppControl allocation failure."); @@ -135,86 +122,32 @@ _AppControlImpl::CreateN(const AppId& appId, const String& operationId, bool cha _AppControlImpl* pImpl = pAc->__pAppControlImpl; SysTryReturn(NID_APP, pImpl != null, null, E_OUT_OF_MEMORY, "AppControlImpl instance must not be null."); - pImpl->_path = appId; - pImpl->_provider = appId; - pImpl->_opId = operationId; - //pImpl->_appName = appId; - pImpl->_property |= (_APPCONTROL_PROPERTY_OSP | _APPCONTROL_PROPERTY_PUBLIC); - - if (changeAppId) - { - pImpl->_property |= _APPCONTROL_PROPERTY_APPID_CHANGE; - } + pImpl->_path = path; + pImpl->_appId = aId; + pImpl->_opId = (oId.IsEmpty()) ? TIZEN_OPERATION_MAIN : oId; + pImpl->_property = prop; return pAc; } -AppControl* -_AppControlImpl::CreateN(const AppControl& ac) -{ - const _AppControlImpl* pImpl = GetInstance(ac); - SysTryReturn(NID_APP, pImpl != null, null, E_INVALID_STATE, "AppControlImpl instance must not be null."); - - return CreateN(pImpl->_path, pImpl->_provider, pImpl->_opId, pImpl->_appName, pImpl->_property); -} -const _AppControlImpl* -_AppControlImpl::GetInstance(const AppControl& ac) +_IAppControlPluginProvider* +_AppControlImpl::GetAppControlPluginProvider(const String& path) { - return ac.__pAppControlImpl; -} + _LibraryImpl lib; + lib.Construct(path, _LIBRARY_OPTION); -_AppControlImpl* -_AppControlImpl::GetInstance(AppControl& ac) -{ - return ac.__pAppControlImpl; -} + APP_CONTROL_PROVIDER_GET_FN pProvider = reinterpret_cast(lib.GetProcAddress(L"GetAppControlProviderPlugin")); -result -_AppControlImpl::Start(const IList* pDataList, IAppControlEventListener* pListener) -{ - SysLog(NID_APP, "Enter"); - result r = E_SYSTEM; - - if (_property & _APPCONTROL_PROPERTY_SLP) - { - r = StartNative(pDataList, pListener); - } - else if (_property & _APPCONTROL_PROPERTY_OSP) - { - r = StartOsp(pDataList, pListener); - } - else + if (!pProvider) { - SysLogException(NID_APP, E_SYSTEM, "[E_SYSTEM] Invalid AppControl type(property %d)", _property); + SysLogException(NID_APP, E_SYSTEM, "Cannot load plugin properly for %ls.", path.GetPointer()); + return null; } - SysLog(NID_APP, "Exit"); - return r; + return (*pProvider)(); } -result -_AppControlImpl::Start(const String* pUriData, const String* pDataType, const IMap* pExtraData, IAppControlResponseListener* pListener) -{ - SysLog(NID_APP, "Enter"); - result r = E_SYSTEM; - - if (_property & _APPCONTROL_PROPERTY_SLP) - { - r = StartNative(pUriData, pDataType, pExtraData, pListener); - } - else if (_property & _APPCONTROL_PROPERTY_OSP) - { - r = StartOsp(pUriData, pDataType, pExtraData, pListener); - } - else - { - SysLogException(NID_APP, E_SYSTEM, "[E_SYSTEM] Invalid AppControl type(property %d)", _property); - } - SysLog(NID_APP, "Exit"); - - return r; -} result _AppControlImpl::FindAndStart(const String& operationId, const String* pUriPattern, const String* pDataType, const String* pCategory, const IMap* pExtraData, IAppControlResponseListener* pListener) @@ -234,25 +167,7 @@ _AppControlImpl::FindAndStart(const String& operationId, const String* pUriPatte if (pDataType) { - String mimeType = *pDataType; - - if ((*pDataType)[0] == L'.') - { - SysLog(NID_APP, "Extension to MIME conversion for %ls", pDataType->GetPointer()); - -#if 0 - String ext; - pDataType->SubString(1, ext); - - result r = _AppControlManager::GetMimeFromExt(ext, mimeType); - - SysTryReturn(NID_APP, !IsFailed(r), null, r, "[%s] MIME type conversion failure for %ls.", GetErrorMessage(r), ext.GetPointer()); - - pMimeType = &mimeType; - - SysLog(NID_APP, "Conversion : %ls -> %ls.", pDataType->GetPointer(), pMimeType->GetPointer()); -#endif - } + const String& mimeType = _AppControlManager::GetMimeTypeFromDataType(*pDataType); _AppMessageImpl::SetMime(pBundle.get(), mimeType); } @@ -265,381 +180,102 @@ _AppControlImpl::FindAndStart(const String& operationId, const String* pUriPatte return StartImplicit(pBundle.get(), pExtraData, pListener); } -result -_AppControlImpl::StartOsp(const IList* pDataList, IAppControlEventListener* pListener) -{ - SysLog(NID_APP, "Enter"); - result r = E_SUCCESS; - - _AppArg* pArg = new (std::nothrow) _AppArg; - SysTryReturnResult(NID_APP, pArg != null, E_OUT_OF_MEMORY, "Argument allocation failure."); - - pArg->Construct(*this, pDataList); - - _AppControlManager* pImpl = _AppControlManager::GetInstance(); - int req = _REQ_ID_INVALID; - - if (pListener) - { - _AppControlManager::_RequestGuard reqObj = _AppControlManager::_RequestGuard(*pImpl, pArg, AppControlCbLegacy, pListener, _property); - req = reqObj.GetRequestNumber(); - - _processId = pImpl->Launch(_path, pArg, req); - - if (_processId < 0) - { - reqObj.Invalidate(); - r = GetLastResult(); - SysLog(NID_APP, "[%s]Launching(%ls) is failed" , GetErrorMessage(r), _path.GetPointer()); - return r; - } - } - else - { - _processId = pImpl->Launch(_path, pArg); - delete pArg; - SysTryReturnResult(NID_APP, _processId >= 0, GetLastResult(), "Launching(%ls) is failed", _path.GetPointer()); - } - SysLog(NID_APP, "Exit"); - - return r; -} - -result -_AppControlImpl::StartOsp(const String* pUriData, const String* pMimeType, const IMap* pDataList, IAppControlResponseListener* pListener) -{ - SysLog(NID_APP, "Enter"); - result r = E_SUCCESS; - - _AppArg* pArg = new (std::nothrow) _AppArg; - SysTryReturnResult(NID_APP, pArg != null, E_OUT_OF_MEMORY, "Argument allocation failure."); - - pArg->Construct(*this, pUriData, pMimeType, pDataList); - - _AppControlManager* pImpl = _AppControlManager::GetInstance(); - int req = _REQ_ID_INVALID; - - if (pListener) - { - _AppControlManager::_RequestGuard reqObj = _AppControlManager::_RequestGuard(*pImpl, pArg, AppControlCb, pListener, _property); - req = reqObj.GetRequestNumber(); - - if (_ThreadImpl::GetCurrentThreadImpl()->GetThreadType() == THREAD_TYPE_EVENT_DRIVEN) - { - _AppControlResponseEvent* pAppControlResponseEvent = new (std::nothrow) _AppControlResponseEvent(); - if (pAppControlResponseEvent != null) - { - r = pAppControlResponseEvent->Construct(); - SysTryLog(NID_APP, r == E_SUCCESS, "[%s]_AppControlResponseEvent::Construct() is failed", GetErrorMessage(r)); - - r = pAppControlResponseEvent->AddListener(*this, true); - SysTryLog(NID_APP, r == E_SUCCESS, "[%s]_AppControlResponseEvent::AddListener() is failed", GetErrorMessage(r)); - - IMapT* pResponseEventContainer = pImpl->GetAppControlResponseEventContainer(); - if (pResponseEventContainer != null) - { - pResponseEventContainer->Add(req, pAppControlResponseEvent); - __appControlResponseEventList.Add(req); - SysLog(NID_APP, "pResponseEvent gets added. reqId(%d)", req); - } - } - } - - _processId = pImpl->Launch(_path, pArg, req); - if (_processId < 0) - { - reqObj.Invalidate(); - r = GetLastResult(); - SysLog(NID_APP, "[%s]Launching(%ls) is failed" , GetErrorMessage(r), _path.GetPointer()); - return r; - } - } - else - { - _processId = pImpl->Launch(_path, pArg); - delete pArg; - SysTryReturnResult(NID_APP, _processId >= 0, GetLastResult(), "Launching(%ls) is failed", _path.GetPointer()); - } - SysLog(NID_APP, "Exit"); - - return r; -} result -_AppControlImpl::StartImplicit(bundle* pBundle, const IList* pDataList, IAppControlEventListener* pListener) +_AppControlImpl::StartImplicit(const _AppMessageImpl& msg, IEventListener* pListener, bool isLegacy) { SysLog(NID_APP, "Enter"); - result r = E_SUCCESS; - - _AppArg* pArg = new (std::nothrow) _AppArg; - SysTryReturnResult(NID_APP, pArg != null, E_OUT_OF_MEMORY, "Argument allocation failure."); - - pArg->Construct(pBundle); - - _AppMessageImpl::AddData(pArg->GetBundle(), pDataList); + int req = APPCONTROL_REQUEST_ID_INVALID; - _AppControlManager* pImpl = _AppControlManager::GetInstance(); - int req = _REQ_ID_INVALID; - - if (pListener) + _IAppControlPluginProvider* pProvider = GetAppControlPluginProvider(ACTL_IMPLICIT_PLUGIN); + if (pProvider == null) { - _AppControlManager::_RequestGuard reqObj = _AppControlManager::_RequestGuard(*pImpl, pArg, AppControlCbLegacy, pListener, _APPCONTROL_PROPERTY_NONE); - req = reqObj.GetRequestNumber(); - - r = pImpl->LaunchAppImplicit(pArg, req); - SysTryCatch(NID_APP, r == E_SUCCESS, reqObj.Invalidate(), r, "[%s] Propagating." , GetErrorMessage(r)); + SysPropagate(NID_APP, E_OBJ_NOT_FOUND); + return E_OBJ_NOT_FOUND; } - else - { - r = pImpl->LaunchAppImplicit(pArg, -1); - delete pArg; - } - - // [FIXME] launch registration is not working correctly - SysLog(NID_APP, "Exit"); - -CATCH: - return r; -} - -result -_AppControlImpl::StartImplicit(bundle* pBundle, const IMap* pData, IAppControlResponseListener* pListener) -{ - SysLog(NID_APP, "Enter"); - result r = E_SUCCESS; - - _AppArg* pArg = new (std::nothrow) _AppArg; - SysTryReturnResult(NID_APP, pArg != null, E_OUT_OF_MEMORY, "Argument allocation failure."); - - pArg->Construct(pBundle); - - _AppArg::AddStrMap(pArg->GetBundle(), pData); - - _AppControlManager* pImpl = _AppControlManager::GetInstance(); - int req = _REQ_ID_INVALID; if (pListener) { - _AppControlManager::_RequestGuard reqObj = _AppControlManager::_RequestGuard(*pImpl, pArg, AppControlCb, pListener, _APPCONTROL_PROPERTY_NONE); - req = reqObj.GetRequestNumber(); - - if (_ThreadImpl::GetCurrentThreadImpl()->GetThreadType() == THREAD_TYPE_EVENT_DRIVEN) + _InProcessInfo* pItem = new (std::nothrow) _InProcessInfo(isLegacy, pProvider, pListener); + if (pItem) { - _AppControlResponseEvent* pAppControlResponseEvent = new (std::nothrow) _AppControlResponseEvent(); - - if (pAppControlResponseEvent != null) - { - r = pAppControlResponseEvent->Construct(); - SysTryLog(NID_APP, r == E_SUCCESS, "[%s]_AppControlResponseEvent::Construct() is failed", GetErrorMessage(r)); - - r = pAppControlResponseEvent->AddListener(*pImpl, true); - SysTryLog(NID_APP, r == E_SUCCESS, "[%s]_AppControlResponseEvent::AddListener() is failed", GetErrorMessage(r)); - - IMapT* pResponseEventContainer = pImpl->GetAppControlResponseEventContainer(); - if (pResponseEventContainer != null) - { - pResponseEventContainer->Add(req, pAppControlResponseEvent); - SysLog(NID_APP, "pResponseEvent gets added. reqId(%d)", req); - } - } + req = _AppControlManager::GetInstance()->__inAppManager.InsertItem(pItem); } - r = pImpl->LaunchAppImplicit(pArg, req); - SysTryCatch(NID_APP, r == E_SUCCESS, reqObj.Invalidate(), r, "[%s] Propagating." , GetErrorMessage(r)); - } - else - { - r = pImpl->LaunchAppImplicit(pArg, -1); - delete pArg; - } - SysLog(NID_APP, "Exit"); - - // [FIXME] launch registration is not working correctly - -CATCH: - - return r; -} - -result -_AppControlImpl::AppControlCbLegacy(void* data, _AppArg* pArg, _AppArg* pResArg, service_result_e res, int prop, int reqId) -{ - SysLog(NID_APP, "Result value %d", res); - - SysTryReturnResult(NID_APP, data && pResArg && pArg, E_SYSTEM, "Invalid result (callback, result, arg) = (0x%x, 0x%x, 0x%x).", - data, pResArg, - pArg); - - bundle* b = pResArg->GetBundle(); - SysTryReturnResult(NID_APP, b != NULL, E_SYSTEM, "Invalid result bundle."); - - IAppControlEventListener* pListener = static_cast(data); - SysTryReturnResult(NID_APP, pListener == null || typeid(pListener) == typeid(IAppControlEventListener*), E_SYSTEM, "Invalid result callback"); - - bundle* inb = pArg->GetBundle(); - SysTryReturnResult(NID_APP, inb != NULL, E_SYSTEM, "Empty caller bundle."); - - String oId; - - AppId provider = pResArg->GetCalleeAppId(); - - const char* p = appsvc_get_operation(inb); - if (p) - { - oId = p; } - SysLog(NID_APP, "Invoking callback with (%ls, %ls)", provider.GetPointer(), oId.GetPointer()); + result r = InvokeStartAppControl(pProvider, req, L"", msg); - if (prop & _APPCONTROL_PROPERTY_ALIAS) + if (pListener == null) { - const _AppControlRegistry::_AppControlAliasEntry* pEntry = null; - pEntry = _AppControlRegistry::GetInstance()->GetReverseAppControlAliasEntry(provider, oId); - if (pEntry) - { - provider = pEntry->provider; - oId = pEntry->operation; - - SysLog(NID_APP, "Legacy AppControl(%ls, %ls).", provider.GetPointer(), oId.GetPointer()); - } + pProvider->Release(); } - if (prop & _APPCONTROL_PROPERTY_APPID_CHANGE) + // after acquring request number, pLib should be managed from the list, not CATCH + if (IsFailed(r)) { - String tmp = _AppControlRegistry::GetInstance()->GetReverseAliasAppId(provider); - if (!tmp.IsEmpty()) - { - SysLog(NID_APP, "App change (%ls -> %ls).", provider.GetPointer(), tmp.GetPointer()); + _AppControlManager::GetInstance()->__inAppManager.RemoveItem(req); + SysLog(NID_APP, "[%s] A system error has occurred.", GetErrorMessage(r)); - provider = tmp; - } + return r; } - const bool isSubMode = _AppArg::IsSubMode(b); - const bool isServiceCallee = _AppArg::IsServiceApp(b); - - std::unique_ptr pMap(pResArg->GetArgMapN()); - - ArrayList list(SingleObjectDeleter); - _AppArg::FillLegacyAppControlResult(list, res, pMap.get(), provider); - - _AppControlManager::InvokeLegacyAppControlCompleteListener(*pListener, provider, oId, &list, isSubMode | isServiceCallee); - + SysLog(NID_APP, "Exit %d", req); return E_SUCCESS; } + result -_AppControlImpl::AppControlCb(void* data, _AppArg* pArg, _AppArg* pResArg, service_result_e res, int prop, int reqId) +_AppControlImpl::StartImplicit(bundle* pBundle, const IList* pDataList, IAppControlEventListener* pListener) { - SysLog(NID_APP, "Result value : %d, property : 0x%x", res, prop); - - SysTryReturnResult(NID_APP, data && pResArg && pArg, E_SYSTEM, "Invalid result (callback, result, arg) = (0x%x, 0x%x, 0x%x).", - data, pResArg, - pArg); - - bundle* b = pResArg->GetBundle(); - SysTryReturnResult(NID_APP, b != NULL, E_SYSTEM, "Invalid result bundle."); - - IAppControlResponseListener* pListener = static_cast(data); - SysTryReturnResult(NID_APP, pListener == null || typeid(pListener) == typeid(IAppControlResponseListener*), E_SYSTEM, "Invalid result callback"); - - bundle* inb = pArg->GetBundle(); - SysTryReturnResult(NID_APP, inb != NULL, E_SYSTEM, "Empty caller bundle."); - - String oId; - - AppId provider = pResArg->GetCalleeAppId(); - - const char* p = appsvc_get_operation(inb); - if (p) - { - oId = p; - } - - SysLog(NID_APP, "Invoking callback with (%ls, %ls)", provider.GetPointer(), oId.GetPointer()); - - if (prop & _APPCONTROL_PROPERTY_ALIAS) - { - const _AppControlRegistry::_AppControlAliasEntry* pEntry = null; - pEntry = _AppControlRegistry::GetInstance()->GetReverseRuntimeAliasEntry(provider, oId); - if (pEntry) - { - provider = pEntry->provider; - oId = pEntry->operation; - - SysLog(NID_APP, "Original AppControl(%ls, %ls).", provider.GetPointer(), oId.GetPointer()); - } - } + _AppMessageImpl msg(pBundle); + msg.AddData(pDataList); - if (prop & _APPCONTROL_PROPERTY_APPID_CHANGE) - { - String tmp = _AppControlRegistry::GetInstance()->GetReverseAliasAppId(provider); - if (!tmp.IsEmpty()) - { - SysLog(NID_APP, "App change (%ls -> %ls).", provider.GetPointer(), tmp.GetPointer()); - - provider = tmp; - } - } - - const bool isSubMode = _AppArg::IsSubMode(b); - const bool isServiceCallee = _AppArg::IsServiceApp(b); - - std::unique_ptr pMap(pResArg->GetArgMapN()); - - AppCtrlResult ret = _AppControlManager::ConvertAppControlResultCode(res); - - SysLog(NID_APP, "Result code : 0x%x.", ret); + return StartImplicit(msg, pListener, true); +} - // proper callback invokation - _AppControlResponseEvent* pResponseEvent = null; - _AppControlManager::GetInstance()->GetAppControlResponseEventContainer()->GetValue(reqId, pResponseEvent); - if (pResponseEvent != null) - { - _AppControlResponseEventArg* pResponseEventArg = new (std::nothrow) _AppControlResponseEventArg(pListener, _APPCONTROL_RESPONSETYPE_COMPLETE, provider, oId, E_SUCCESS, ret, pMap.release(), reqId, isSubMode | isServiceCallee); - pResponseEvent->Fire(*pResponseEventArg); - SysLog(NID_APP, "OnAppControlCompleteResponseReceived, pResponseEvent is Fired"); - } - else - { - _AppControlManager::InvokeAppControlCompleteListener(*pListener, provider, oId, ret, pMap.get(), isSubMode | isServiceCallee); - } +result +_AppControlImpl::StartImplicit(bundle* pBundle, const IMap* pData, IAppControlResponseListener* pListener) +{ + _AppMessageImpl msg(pBundle); + _AppArg::AddStrMap(msg.GetBundle(), pData); - return E_SUCCESS; + return StartImplicit(msg, pListener, false); } + result -_AppControlImpl::StartNative(const IList* pDataList, IAppControlEventListener* pListener) +_AppControlImpl::Start(const IList* pDataList, IAppControlEventListener* pListener) { SysLog(NID_APP, "Enter"); _InProcessInfo* pInfo = _AppControlManager::GetInstance()->__inAppManager.FindItem(_reqId); SysTryReturnResult(NID_APP, pInfo == null, E_IN_PROGRESS, "Request ID %d is already in progress.", _reqId); - int req = _REQ_ID_INVALID; - _LibraryImpl* pLib = null; - - pLib = new (std::nothrow) _LibraryImpl; - SysTryReturnResult(NID_APP, pLib != null, E_OUT_OF_MEMORY, "Failed to allocate libraryimpl."); + int req = APPCONTROL_REQUEST_ID_INVALID; - result r = pLib->Construct(_path, _LIBRARY_OPTION); - SysTryCatch(NID_APP, !IsFailed(r), , r, "[%s] Propagating.", GetErrorMessage(r)); + _IAppControlPluginProvider* pProvider = GetAppControlPluginProvider(_path); + if (pProvider == null) + { + SysPropagate(NID_APP, E_OBJ_NOT_FOUND); + return E_OBJ_NOT_FOUND; + } if (pListener) { - _InProcessInfo* pItem = new (std::nothrow) _InProcessInfo(_provider, _opId, _property, true, *pLib, pListener); + _InProcessInfo* pItem = new (std::nothrow) _InProcessInfo(_appId, _opId, _property, true, pProvider, pListener); if (pItem) { req = _AppControlManager::GetInstance()->__inAppManager.InsertItem(pItem); } } - r = InvokeStartAppControl(*pLib, req, _provider, _opId, pDataList); + + result r = InvokeStartAppControl(pProvider, req, _appId, _opId, pDataList); if (pListener == null) { - delete pLib; + pProvider->Release(); } - // after acquring request number, pLib should be managed from the list, not CATCH if (IsFailed(r)) { _AppControlManager::GetInstance()->__inAppManager.RemoveItem(req); @@ -652,49 +288,35 @@ _AppControlImpl::StartNative(const IList* pDataList, IAppControlEventListener* p SysLog(NID_APP, "Exit %d", req); return E_SUCCESS; - -CATCH: - delete pLib; - - switch (r) - { - case E_LIBRARY_NOT_FOUND: - r = E_OBJ_NOT_FOUND; - break; - default: - r = E_SYSTEM; - break; - } - - return r; } result -_AppControlImpl::StartNative(const String* pUriData, const String* pMimeType, const IMap* pDataList, IAppControlResponseListener* pListener) +_AppControlImpl::Start(const String* pUriData, const String* pMimeType, const IMap* pDataList, IAppControlResponseListener* pListener) { SysLog(NID_APP, "Enter"); _InProcessInfo* pInfo = _AppControlManager::GetInstance()->__inAppManager.FindItem(_reqId); SysTryReturnResult(NID_APP, pInfo == null, E_IN_PROGRESS, "Request ID %d is already in progress.", _reqId); - int req = _REQ_ID_INVALID; - _LibraryImpl* pLib = null; - - pLib = new (std::nothrow) _LibraryImpl; - SysTryReturnResult(NID_APP, pLib != null, E_OUT_OF_MEMORY, "Failed to allocate libraryimpl."); - - result r = pLib->Construct(_path, _LIBRARY_OPTION); + int req = APPCONTROL_REQUEST_ID_INVALID; + result r = E_SUCCESS; - SysTryCatch(NID_APP, !IsFailed(r), , r, "[%s] Propagating.", GetErrorMessage(r)); + _IAppControlPluginProvider* pProvider = GetAppControlPluginProvider(_path); + if (pProvider == null) + { + SysPropagate(NID_APP, E_OBJ_NOT_FOUND); + return E_OBJ_NOT_FOUND; + } if (pListener) { - _InProcessInfo* pItem = new (std::nothrow) _InProcessInfo(_provider, _opId, _property, false, *pLib, pListener); + _InProcessInfo* pItem = new (std::nothrow) _InProcessInfo(_appId, _opId, _property, false, pProvider, pListener); if (pItem) { req = _AppControlManager::GetInstance()->__inAppManager.InsertItem(pItem); } - if (_ThreadImpl::GetCurrentThreadImpl()->GetThreadType() == THREAD_TYPE_EVENT_DRIVEN) + const _ThreadImpl* pThreadImpl = _ThreadImpl::GetCurrentThreadImpl(); + if (pThreadImpl && pThreadImpl->GetThreadType() == THREAD_TYPE_EVENT_DRIVEN) { _AppControlResponseEvent* pAppControlResponseEvent = new (std::nothrow) _AppControlResponseEvent(); @@ -717,14 +339,13 @@ _AppControlImpl::StartNative(const String* pUriData, const String* pMimeType, co } } } - r = InvokeStartAppControl(*pLib, req, _provider, _opId, pUriData, pMimeType, pDataList); + r = InvokeStartAppControl(pProvider, req, _appId, _opId, pUriData, pMimeType, pDataList); if (pListener == null) { - delete pLib; + pProvider->Release(); } - // after acquring request number, pLib should be managed from the list, not CATCH if (IsFailed(r)) { _AppControlManager::GetInstance()->__inAppManager.RemoveItem(req); @@ -737,25 +358,10 @@ _AppControlImpl::StartNative(const String* pUriData, const String* pMimeType, co SysLog(NID_APP, "Exit %d", req); return E_SUCCESS; - -CATCH: - delete pLib; - - switch (r) - { - case E_LIBRARY_NOT_FOUND: - r = E_OBJ_NOT_FOUND; - break; - default: - r = E_SYSTEM; - break; - } - - return r; } result -_AppControlImpl::InvokeStartAppControl(_LibraryImpl& lib, int req, const String& appId, const String& oId, const IList* pList) +_AppControlImpl::InvokeStartAppControl(_IAppControlPluginProvider* pProvider, int req, const String& appId, const String& oId, const IList* pList) { SysLog(NID_APP, "Legacy stuff for converting argument"); @@ -770,182 +376,100 @@ _AppControlImpl::InvokeStartAppControl(_LibraryImpl& lib, int req, const String& pMap = ↦ } - return InvokeStartAppControl(lib, req, appId, oId, null, null, pMap); + return InvokeStartAppControl(pProvider, req, appId, oId, null, null, pMap); } result -_AppControlImpl::InvokeStartAppControl(_LibraryImpl& lib, int req, const String& appId, const String& oId, const String* pUri, const String* pMime, const IMap* pMap) +_AppControlImpl::InvokeStartAppControl(_IAppControlPluginProvider* pProvider, int req, const String& appId, const String& oId, const String* pUri, const String* pMime, const IMap* pMap) { - result (*pFunc)(int req, const String&, const String&, const String*, const String*, const IMap*) = null; + String data; - pFunc = - reinterpret_cast(lib.GetProcAddress(L"StartAppControl")); - SysTryReturnResult(NID_APP, pFunc != null, E_OBJ_NOT_FOUND, "Entry \"StartAppControl\" not found for %ls", appId.GetPointer()); + if (pMime) + { + data = _AppControlManager::GetMimeTypeFromDataType(*pMime); + } - const String* pActualUri = (pUri && !(pUri->IsEmpty())) ? pUri : null; - const String* pActualMime = (pMime && !(pMime->IsEmpty())) ? pMime : null; - return (*pFunc)(req, appId, oId, pActualUri, pActualMime, pMap); + _AppMessageImpl msg(appId, oId, pUri, &data, pMap); + + return InvokeStartAppControl(pProvider, req, appId, msg); } -static bool -IsValidAppControl(const String& appcontrolID) + +result +_AppControlImpl::InvokeStartAppControl(_IAppControlPluginProvider* pProvider, int req, const String& appId, const _AppMessageImpl& message) { - return ((appcontrolID == L"osp.appcontrol.provider.audio") - || (appcontrolID == L"osp.appcontrol.provider.bluetooth") - || (appcontrolID == L"osp.appcontrol.provider.calendar") - || (appcontrolID == L"osp.appcontrol.provider.camera") - || (appcontrolID == L"osp.appcontrol.provider.contact") - || (appcontrolID == L"osp.appcontrol.provider.certificatemanager") - || (appcontrolID == L"osp.appcontrol.provider.email") - || (appcontrolID == L"osp.appcontrol.provider.image") - || (appcontrolID == L"osp.appcontrol.provider.media") - || (appcontrolID == L"osp.appcontrol.provider.message") - || (appcontrolID == L"osp.appcontrol.provider.video") - || (appcontrolID == L"osp.appcontrol.provider.imageeditor") - || (appcontrolID == L"osp.appcontrol.provider.allshare") - || (appcontrolID == L"tizen.filemanager") - || (appcontrolID == L"tizen.camera") - || (appcontrolID == L"tizen.gallery") - || (appcontrolID == L"tizen.imageviewer") - || (appcontrolID == L"tizen.videoplayer") - || (appcontrolID == L"tizen.memo") - || (appcontrolID == L"tizen.contacts") - || (appcontrolID == L"tizen.calendar") - || (appcontrolID == L"tizen.todo") - || (appcontrolID == L"tizen.email") - || (appcontrolID == L"tizen.settings") - || (appcontrolID == L"tizen.messages") - || (appcontrolID == L"tizen.musicplayer") - || (appcontrolID == L"tizen.bluetooth") - || (appcontrolID == L"samsung.snote") - || (appcontrolID == L"0pnxz8hbsr.MyFiles") - || (appcontrolID == L"hdufar9ycj.Camera") - || (appcontrolID == L"ijudt7w61q.Gallery") - || (appcontrolID == L"jysyv9o1dc.ImageViewer") - || (appcontrolID == L"npwf0scb88.VideoPlayer") - || (appcontrolID == L"zunqjlsnce.Memo") - || (appcontrolID == L"f9uev8hsyo.Contacts") - || (appcontrolID == L"ph1vq2phrp.Calendar") - || (appcontrolID == L"vxqbrefica.Email") - || (appcontrolID == L"kto5jikgul.Settings") - || (appcontrolID == L"8r4r5ddzzn.Messages") - || (appcontrolID == L"dhrul6qzj3.MusicPlayer") - || (appcontrolID == L"smemo-efl")); + SysTryReturnResult(NID_APP, pProvider != null, E_SYSTEM, "Wrong AppControl provider plugin for %ls(%d).", appId.GetPointer(), req); + + return pProvider->StartAppControlPlugin(req, appId, message, null); } + result _AppControlImpl::Stop(void) { - const String appcontrolID(GetAppControlProviderId()); - SysTryReturnResult(NID_APP, IsValidAppControl(appcontrolID), E_INVALID_OPERATION, "Invalid appcontrolID(%ls)", appcontrolID.GetPointer()); + result r = E_SUCCESS; + result (*pStop)(int req) = null; - if (_property & _APPCONTROL_PROPERTY_SLP) + if (_reqId != APPCONTROL_REQUEST_ID_INVALID) { - result (*pStop)(int req) = null; + _InProcessInfo* pInfo = _AppControlManager::GetInstance()->__inAppManager.FindItem(_reqId); + SysTryReturnResult(NID_APP, pInfo != null, E_INVALID_OPERATION, "Request ID %d is not found.", _reqId); - if (_reqId != _REQ_ID_INVALID) + if (pInfo->pProvider) { - _InProcessInfo* pInfo = _AppControlManager::GetInstance()->__inAppManager.FindItem(_reqId); - SysTryReturnResult(NID_APP, pInfo != null, E_INVALID_OPERATION, "Request ID %d is not found.", _reqId); - - pStop = reinterpret_cast(pInfo->pLib->GetProcAddress(L"TerminateAppControl")); - SysTryReturnResult(NID_APP, pStop != null, E_SYSTEM, "No TerminateAppControl() function."); - - (*pStop)(_reqId); + r = pInfo->pProvider->StopAppControlPlugin(_reqId); + } - _AppControlManager::GetInstance()->__inAppManager.RemoveItem(_reqId); + _AppControlManager::GetInstance()->__inAppManager.RemoveItem(_reqId); - _reqId = _REQ_ID_INVALID; - } - else + _reqId = APPCONTROL_REQUEST_ID_INVALID; + } + else + { + _IAppControlPluginProvider* pProvider = GetAppControlPluginProvider(_path); + if (pProvider) { - _LibraryImpl lib; - result r = lib.Construct(_path, _LIBRARY_OPTION); - if (r == E_SUCCESS) - { - pStop = reinterpret_cast(lib.GetProcAddress(L"TerminateAppControl")); - SysTryReturnResult(NID_APP, pStop != null, E_SYSTEM, "No TerminateAppControl() function."); + r = pProvider->StopAppControlPlugin(-1); - (*pStop)(_reqId); - } + pProvider->Release(); } } - else if (_property & _APPCONTROL_PROPERTY_OSP) - { - _Aul::TerminateApplicationByPid(_processId); - } - return E_SUCCESS; + SysLog(NID_APP, "[%s] Request is stopped.", GetErrorMessage(r)); + + return r; } String -_AppControlImpl::GetAppName(void) +_AppControlImpl::GetAppName(void) const { if (_appName.IsEmpty()) { AppId appId = GetAppId(); - AppId aliasAppId = _AppControlRegistry::GetInstance()->GetAliasAppId(appId); + const AppId& aliasAppId = _AppControlRegistry::GetInstance()->GetAliasAppId(appId); if (!aliasAppId.IsEmpty()) { appId = aliasAppId; } + appId = _Aul::GetRealAppId(appId); + std::unique_ptr pInfo(_PackageManagerImpl::GetInstance()->GetPackageAppInfoN(appId)); if (pInfo.get()) { - SysLog(NID_APP, "PackageInfo of appId(%ls) exists", appId.GetPointer()); - const String& name = pInfo->GetAppName(); - if (name == L"_AppControl") - { - // workaround for special case: requery with actual appId - const PackageId& packageId = _PackageManagerImpl::GetPackageIdByAppId(appId); - const String& defaultName = _PackageManagerImpl::GetInstance()->GetDefaultAppExecutableName(packageId); - - const String& convertedAppId = packageId + L'.' + defaultName; - - std::unique_ptr pNewInfo(_PackageManagerImpl::GetInstance()->GetPackageAppInfoN(convertedAppId)); - - if (pNewInfo.get()) - { - _appName = pNewInfo->GetAppDisplayName(); - } - else - { - SysLog(NID_APP, "No default applicaiton information, possible database error."); - } - } - else - { - _appName = pInfo->GetAppDisplayName(); - } + SysLog(NID_APP, "PackageInfo of [%ls] exists.", appId.GetPointer()); + _appName = pInfo->GetAppDisplayName(); } else { - SysLog(NID_APP, "PackageInfo of appId(%ls) does not exist", appId.GetPointer()); + SysLog(NID_APP, "PackageInfo of [%ls] does not exist.", appId.GetPointer()); } } return _appName; } -String -_AppControlImpl::GetAppId(void) const -{ - return (_property & _APPCONTROL_PROPERTY_OSP) ? _path : _provider; -} - -const String& -_AppControlImpl::GetAppControlProviderId(void) const -{ - return _provider; -} - -const String& -_AppControlImpl::GetOperationId(void) const -{ - return _opId; -} IList* _AppControlImpl::GetCategoryListN(void) const @@ -953,7 +477,7 @@ _AppControlImpl::GetCategoryListN(void) const AppId appId = GetAppId(); SysTryReturn(NID_APP, !appId.IsEmpty(), null, E_SYSTEM, "[E_SYSTEM] Empty appId."); - AppId aliasAppId = _AppControlRegistry::GetInstance()->GetAliasAppId(appId); + const AppId& aliasAppId = _AppControlRegistry::GetInstance()->GetAliasAppId(appId); if (!aliasAppId.IsEmpty()) { appId = aliasAppId; @@ -970,7 +494,7 @@ _AppControlImpl::GetCategoryListN(void) const void _AppControlImpl::StopAppControlResponseListener(IAppControlResponseListener* pListener) { - _AppControlManager::GetInstance()->__listenerList.Add(pListener); + _AppControlManager::GetInstance()->StopAppControlResponseListener(pListener); } void diff --git a/src/app/FApp_AppControlManager.cpp b/src/app/FApp_AppControlManager.cpp index a0cbc28..c2b933d 100644 --- a/src/app/FApp_AppControlManager.cpp +++ b/src/app/FApp_AppControlManager.cpp @@ -43,10 +43,10 @@ #include #include #include - +#include #include + #include -#include #include #include "FApp_AppArg.h" @@ -66,6 +66,8 @@ #include "FApp_AppMessageImpl.h" #include "FApp_AppManagerImpl.h" #include "FApp_AppControlResponseEvent.h" +#include "FApp_IAppControlPluginProvider.h" + using namespace Tizen::App::Package; using namespace Tizen::Base; @@ -74,15 +76,14 @@ using namespace Tizen::Base::Runtime; using namespace Tizen::Base::Utility; using namespace Tizen::Io; -namespace -{ -const char SELECTOR_NOTI_KEY[] = "__APP_SVC_CALLER_NOTI__"; -} namespace Tizen { namespace App { -const wchar_t TIZEN_OPERATION_PICK[] = L"http://tizen.org/appcontrol/operation/pick"; +const wchar_t TIZEN_OPERATION_PICK[] = L"http://tizen.org/appcontrol/operation/pick"; +const wchar_t TIZEN_OPERATION_MAIN[] = L"http://tizen.org/appcontrol/operation/main"; +const wchar_t LEGACY_OPERATION_MAIN[] = L"osp.operation.MAIN"; +const char TIZEN_NOTIFICATION_DATA[] = "http://tizen.org/appcontrol/data/notification"; _AppControlManager::_AppControlManager(void) { @@ -91,7 +92,6 @@ _AppControlManager::_AppControlManager(void) // AppControl event handling is expected to be performed in the main thread. __appControlEvent.Construct(); __appControlEvent.AddListener(*dynamic_cast<_IAppControlSysEventListener*>(this)); - __listenerList.Construct(); __appControlResponseEventContainer.Construct(); __appControlResponseEventList.Construct(); } @@ -144,6 +144,30 @@ _AppControlManager::GetMimeFromExt(const String& ext, String& out) return E_SUCCESS; } + +String +_AppControlManager::GetMimeTypeFromDataType(const String& data) +{ + // Data type is either MIME type or .[extension] + + if (data.IsEmpty() || data[0] != L'.') + { + return data; + } + + // .[extension] + String ext; + data.SubString(1, ext); + + String res; + result r = _AppControlManager::GetMimeFromExt(ext, res); + SysTryReturn(NID_APP, !IsFailed(r), L"", r, "[%s] MIME type conversion failed for %ls.", GetErrorMessage(r), ext.GetPointer()); + + SysLog(NID_APP, "Conversion from %ls into %ls.", data.GetPointer(), res.GetPointer()); + return res; +} + + void _AppControlManager::OnAppControlEventReceivedN(int reqId, _AppArg* pAppArg, int res) { @@ -151,7 +175,7 @@ _AppControlManager::OnAppControlEventReceivedN(int reqId, _AppArg* pAppArg, int //_AppArg::Print(b); // get launch info from request Id - _LaunchInfo* pInfo = __launchManager.FindItem(reqId); + _DataControlInfo* pInfo = __launchManager.FindItem(reqId); SysTryReturnVoidResult(NID_APP, pInfo != null, E_OBJ_NOT_FOUND, "[E_OBJ_NOT_FOUND] request Id %d not found with response %d", reqId, res); @@ -163,7 +187,7 @@ _AppControlManager::OnAppControlEventReceivedN(int reqId, _AppArg* pAppArg, int SysLog(NID_APP, "Invoking callback 0x%x", pInfo->launchCb); //pAppArg->Print(); - if (pInfo->pUserData && (!__listenerList.Contains(pInfo->pUserData))) + if (pInfo->pUserData) { (*pInfo->launchCb)(pInfo->pUserData, pInfo->pArg, pAppArg, static_cast(res), pInfo->property, reqId); } @@ -179,54 +203,57 @@ _AppControlManager::OnAppControlEventReceivedN(int reqId, _AppArg* pAppArg, int } -// callback for out-of-process AppControl start event +// callback for AppControl start event void _AppControlManager::OnAppControlEventReceivedN(int reqId, const AppId& appId, const String& operationId) { SysLog(NID_APP, "Received request Id %d, app %ls, operationId %ls", reqId, appId.GetPointer(), operationId.GetPointer()); // get launch info from request Id - _LaunchInfo* pInfo = __launchManager.FindItem(reqId); + _InProcessInfo* pInfo = __inAppManager.FindItem(reqId); SysTryReturnVoidResult(NID_APP, pInfo != null, E_OBJ_NOT_FOUND, "[E_OBJ_NOT_FOUND] request Id %d not found.", reqId); - // at least listener - IAppControlResponseListener* pListener = static_cast(pInfo->pUserData); - SysTryReturnVoidResult(NID_APP, typeid(pListener) == typeid(IAppControlResponseListener*), E_SYSTEM, "[E_SYSTEM] Invalid result callback."); + IAppControlResponseListener* pListener = dynamic_cast(pInfo->pListener); + if (pListener == null) + { + SysLog(NID_APP, "Empty AppControl listener callback for req %d, app %ls.", reqId, appId.GetPointer()); + return; + } + + result r = E_SUCCESS; - if (pListener) + AppId actualAppId = appId; + if (appId == L'c') { - result r = E_SUCCESS; - AppId actualAppId = appId; - if (appId == L'c') - { - actualAppId.Clear(); - r = E_OPERATION_CANCELED; - } - SysLog(NID_APP, "Invoking callback 0x%x.", pListener); + actualAppId.Clear(); + r = E_OPERATION_CANCELED; + } + SysLog(NID_APP, "Invoking callback 0x%x.", pListener); - _AppControlResponseEvent* pResponseEvent = null; - __appControlResponseEventContainer.GetValue(reqId, pResponseEvent); - SysLog(NID_APP, "StartResponseReceived Request Id(%d), ResponseEvent 0x%x.", reqId, pResponseEvent); - if (pResponseEvent != null) - { - String oId(operationId); - _AppControlResponseEventArg* pResponseEventArg = new (std::nothrow) _AppControlResponseEventArg(pListener, _APPCONTROL_RESPONSETYPE_START, actualAppId, oId, r, APP_CTRL_RESULT_SUCCEEDED, null, reqId, false); + _AppControlResponseEvent* pResponseEvent = null; + __appControlResponseEventContainer.GetValue(reqId, pResponseEvent); + SysLog(NID_APP, "StartResponseReceived Request Id(%d), ResponseEvent 0x%x.", reqId, pResponseEvent); + if (pResponseEvent != null) + { + String oId(operationId); + _AppControlResponseEventArg* pResponseEventArg = new (std::nothrow) _AppControlResponseEventArg(pListener, _APPCONTROL_RESPONSETYPE_START, actualAppId, oId, r, APP_CTRL_RESULT_SUCCEEDED, null, reqId, false); - if (pResponseEventArg != null) - { - pResponseEvent->Fire(*pResponseEventArg); - SysLog(NID_APP, "pResponseEvent is Fired"); - } - } - else + if (pResponseEventArg != null) { - pListener->OnAppControlStartResponseReceived(actualAppId, operationId, r); - SysLog(NID_APP, "OnAppControlStartResponseReceived called directly"); + pResponseEvent->Fire(*pResponseEventArg); + SysLog(NID_APP, "pResponseEvent is Fired"); } } else { - SysLog(NID_APP, "No listener registered."); + pListener->OnAppControlStartResponseReceived(actualAppId, operationId, r); + SysLog(NID_APP, "OnAppControlStartResponseReceived called directly"); + } + + if (r == E_OPERATION_CANCELED) + { + SysLog(NID_APP, "Removed start listener as operation is canceled."); + __inAppManager.RemoveItem(reqId); } } @@ -261,7 +288,7 @@ _AppControlManager::InvokeLegacyAppControlCompleteListener(IAppControlEventListe // callback for in-process event handling void -_AppControlManager::OnAppControlEventReceivedN(int reqId, int res, const IMap* pArgs, int property) +_AppControlManager::OnAppControlPluginEventReceivedN(int reqId, int res, const AppId& optAppId, const String& optOperation, const IMap* pArgs, int property) { SysLog(NID_APP, "Received request Id %d, res %d, args 0x%x", reqId, res, pArgs); @@ -270,26 +297,27 @@ _AppControlManager::OnAppControlEventReceivedN(int reqId, int res, const IMap* p SysTryReturnVoidResult(NID_APP, pInfo != null, E_OBJ_NOT_FOUND, "[E_OBJ_NOT_FOUND] request Id %d not found with args 0x%x", reqId, pArgs); - if (pInfo->pListener && (!__listenerList.Contains(pInfo->pListener))) + if (pInfo->pListener) { - String aId = pInfo->providerId; - String oId = pInfo->operationId; + String aId; + String oId; - SysLog(NID_APP, "Invoking callback 0x%x for (%ls, %ls).", pInfo->pListener, aId.GetPointer(), oId.GetPointer()); - - if (pInfo->property & _APPCONTROL_PROPERTY_ALIAS) + if (optAppId.IsEmpty()) { - const _AppControlRegistry::_AppControlAliasEntry* pEntry = null; - pEntry = _AppControlRegistry::GetInstance()->GetReverseAppControlAliasEntry(aId, oId); - if (pEntry) - { - aId = pEntry->provider; - oId = pEntry->operation; + aId = pInfo->providerId; + oId = pInfo->operationId; + } + else + { + // implicit launch only + aId = optAppId; + oId = optOperation; - SysLog(NID_APP, "Legacy AppControl (%ls, %ls).", aId.GetPointer(), oId.GetPointer()); - } + SysLog(NID_APP, "Changing appId/operation for implicit launch."); } + SysLog(NID_APP, "Invoking callback 0x%x for (%ls, %ls).", pInfo->pListener, aId.GetPointer(), oId.GetPointer()); + const bool isSubMode = (property & _APPCONTROL_PROPERTY_SUBMODE); const bool isServiceCallee = (property & _APPCONTROL_PROPERTY_SERVICE_CALLEE); @@ -341,20 +369,9 @@ _AppControlManager::OnAppControlEventReceivedN(int reqId, int res, const IMap* p } else { - SysLogException(NID_APP, E_SYSTEM, "Invalid AppControl listener."); + SysLog(NID_APP, "Empty AppControl listener."); } - // call TerminateAppControl - result (* pFunc)(int req) = null; - pFunc = reinterpret_cast(pInfo->pLib->GetProcAddress(L"TerminateAppControl")); - if (pFunc) - { - (*pFunc)(pInfo->reqId); - } - else - { - SysLogException(NID_APP, E_SYSTEM, "No TerminateAppControl() function."); - } // remove from list and unload dll __inAppManager.RemoveItem(reqId); @@ -374,6 +391,26 @@ _AppControlManager::GetAppControlResponseEventContainer(void) } +static bool +IsMatchingProcListener(const _InProcessInfo& info, IEventListener* pListener) +{ + return (info.pListener == pListener); +} + + +void +_AppControlManager::StopAppControlResponseListener(IAppControlResponseListener* pListener) +{ + // __inAppManager, __launchManager + _InProcessInfo* pProcInfo = __inAppManager.FindItemWithListener(IsMatchingProcListener, pListener); + if (pProcInfo) + { + pProcInfo->pListener = null; + SysLog(NID_APP, "Listener 0x%x is removed from in-process stub list.", pListener); + } +} + + // generic launch callback static void LaunchResultCb(bundle* b, int request_code, appsvc_result_val res, void* data) @@ -422,7 +459,6 @@ result _AppControlManager::LaunchPkg(_AppMessageImpl& msg, const char* pkg_name, const char* op, const char* mime, const char* uri, AppSvcResFn pCb, void* data) { bundle* kb = msg.GetBundle(); - SysTryReturnResult(NID_APP, kb != NULL, E_OUT_OF_MEMORY, "Bundle allocation failure."); if (pkg_name) { @@ -441,31 +477,12 @@ _AppControlManager::LaunchPkg(_AppMessageImpl& msg, const char* pkg_name, const appsvc_set_uri(kb, uri); } - if (_AppImpl::GetInstance() != null) - { - const long handle = _AppImpl::GetInstance()->GetWindowHandle(); - _AppArg::UpdateWindowHandle(kb, handle); - } - - SysLog(NID_APP, "MIME(%s), URI(%s).", appsvc_get_mime(kb), appsvc_get_uri(kb)); - int pid = appsvc_run_service(kb, 0, reinterpret_cast(pCb), this); + int pid = LaunchPkg(msg, pCb, data); result r = E_SUCCESS; if (pid < 0) { - switch (pid) - { - case APPSVC_RET_EILLACC: - r = E_ILLEGAL_ACCESS; - break; - case APPSVC_RET_EINVAL: - r = E_MAX_EXCEEDED; - break; - default: - r = E_SYSTEM; - break; - } - SysLog(NID_APP, "[%s] Launching service %s failure", GetErrorMessage(r), pkg_name); + r = GetLastResult(); } return r; @@ -528,63 +545,51 @@ _AppControlManager::Launch(_AppMessageImpl& msg, const char* pkg_name, const cha int -_AppControlManager::LaunchPkg(_AppMessageImpl& msg, const AppId& appId, const String& opId, const String* pUri, const String* pMime, AppSvcResFn pCb, void* data) +_AppControlManager::LaunchPkg(_AppMessageImpl& msg, AppSvcResFn pCb, void* data) { - std::unique_ptr pPackage(_StringConverter::CopyToCharArrayN(appId)); - std::unique_ptr pOperation(_StringConverter::CopyToCharArrayN(opId)); + bundle* kb = msg.GetBundle(); + SysTryReturn(NID_APP, kb != NULL, -1, E_OUT_OF_MEMORY, "Bundle allocation failure."); - const char* pUriData = null; - if (pUri) + if (_AppImpl::GetInstance() != null) { - pUriData = _StringConverter::CopyToCharArrayN(*pUri); + const long handle = _AppImpl::GetInstance()->GetWindowHandle(); + _AppArg::UpdateWindowHandle(kb, handle); } - const char* pMimeData = null; - if (pMime) + int pid = appsvc_run_service(kb, 0, reinterpret_cast(pCb), this); + + result r = E_SUCCESS; + if (pid < 0) { - pMimeData = _StringConverter::CopyToCharArrayN(*pMime); + switch (pid) + { + case APPSVC_RET_EILLACC: + r = E_ILLEGAL_ACCESS; + break; + case APPSVC_RET_EINVAL: + r = E_MAX_EXCEEDED; + break; + default: + r = E_SYSTEM; + break; + } + SysLog(NID_APP, "[%s] Launching service %s failure", GetErrorMessage(r), appsvc_get_appid(kb)); } - - int pid = Launch(msg, pPackage.get(), pOperation.get(), pMimeData, pUriData, pCb, data); - - delete [] pUriData; - delete [] pMimeData; + SetLastResult(r); return pid; } result -_AppControlManager::LaunchPkg(const char* pkg_name, const char* op, const char* mime, const char* uri, AppSvcResFn pCb, void* data) -{ - _AppMessageImpl msg; - - return LaunchPkg(msg, pkg_name, op, mime, uri, pCb, data); -} - -result -_AppControlManager::LaunchAppWithCondition(const AppId& appId, const String& condition, IList* pArrayArgs) -{ - result r = E_SUCCESS; - _AppArg * pArg = new (std::nothrow) _AppArg(); - SysTryCatch(NID_APP, pArg != null, r = E_OUT_OF_MEMORY, E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY]"); - - r = pArg->ConstructForAppLaunchCondition(condition, pArrayArgs); - SysTryCatch(NID_APP, !IsFailed(r), , r, "[%s] ConstructForAppLaunchCondition(%ls, .. ) fails", GetErrorMessage(r), condition.GetPointer()); - - r = _AppControlManager::LaunchApp(appId, pArg); -CATCH: - delete pArg; - return r; -} - -result _AppControlManager::LaunchApp(const AppId& appId, _AppArg* pArg, int req) { SysTryReturnResult(NID_APP, pArg != null, E_INVALID_ARG, "Invalid launch argument"); SysLog(NID_APP, "App: %ls.", appId.GetPointer()); String actualAppId = appId; +#if 0 + // This logic is only for very old legacy code to support "pkgid" launch and should be removed if (appId.GetLength() == 10) { const String& name = _PackageManagerImpl::GetInstance()->GetDefaultAppExecutableName(appId); @@ -595,6 +600,7 @@ _AppControlManager::LaunchApp(const AppId& appId, _AppArg* pArg, int req) actualAppId.Append(name); } } +#endif pArg->UpdateRequestId(req); @@ -606,25 +612,34 @@ _AppControlManager::LaunchApp(const AppId& appId, _AppArg* pArg, int req) int pid = -1; bundle* kb = NULL; - String tempId; - actualAppId.SubString(0, 10, tempId); - tempId += L'.'; - tempId += L"_AppControl"; - - // [INFO] Ugly solution for submode support - pArg->UpdateAppId(tempId); - kb = pArg->GetBundle(); - - pid = appsvc_run_service(kb, req, LaunchResultCb, this); - if (pid >= 0) - { - SysLog(NID_APP, "Submode launch successful"); - return E_SUCCESS; - } - else if (pid == APPSVC_RET_EINVAL) + + std::unique_ptr< PackageAppInfo > pAppInfo(_PackageManagerImpl::GetInstance()->GetPackageAppInfoN(appId)); + SysTryReturn(NID_APP, pAppInfo != null, E_SYSTEM, GetLastResult(), "[%s] Getting AppInfo failed.", GetErrorMessage(GetLastResult())); + _PackageAppInfoImpl* pAppInfoImpl = _PackageAppInfoImpl::GetInstance(pAppInfo.get()); + SysTryReturnResult(NID_APP, pAppInfoImpl != null , E_SYSTEM, "Severe system error"); + + if (pAppInfoImpl->IsServiceApp() == false) { - SysLog(NID_APP, "Argument overflow"); - return E_MAX_EXCEEDED; + String tempId; + actualAppId.SubString(0, 10, tempId); + tempId += L'.'; + tempId += String(SUBMODE_NAME); + + // [INFO] Ugly solution for submode support + pArg->UpdateAppId(tempId); + kb = pArg->GetBundle(); + + pid = appsvc_run_service(kb, req, LaunchResultCb, this); + if (pid >= 0) + { + SysLog(NID_APP, "Submode launch successful"); + return E_SUCCESS; + } + else if (pid == APPSVC_RET_EINVAL) + { + SysLog(NID_APP, "Argument overflow"); + return E_MAX_EXCEEDED; + } } pArg->UpdateAppId(actualAppId); @@ -695,26 +710,21 @@ _IsDefaultApplication(const AppId& packageId, const String& appId) int -_AppControlManager::Launch(const _AppMessageImpl& msg, const AppId& aId, const String& oId, const String* pUriData, const String* pMimeType, AppSvcResFn pCb, void* pData) +_AppControlManager::Launch(const AppId& appId, _AppArg* pArg, int req) { - SysLog(NID_APP, "Enter"); - - _AppArg arg; - arg.Construct(msg, oId, pUriData, pMimeType); - - int pid = Launch(aId, &arg, pCb, pData, -1); - SysTryReturn(NID_APP, pid >= 0, -1, GetLastResult(), "Launching(%ls) is failed", aId.GetPointer()); - - SysLog(NID_APP, "Exit"); - - return pid; + return Launch(appId, pArg, reinterpret_cast(LaunchResultCb), this, req); } int -_AppControlManager::Launch(const AppId& appId, _AppArg* pArg, int req) +_AppControlManager::Launch(const _AppMessageImpl& msg, AppSvcResFn pCb, void* pData, int req) { - return Launch(appId, pArg, reinterpret_cast(LaunchResultCb), this, req); + const bundle* pBundle = msg.GetBundle(); + + _AppArg arg; + arg.Construct(pBundle); + + return Launch(_AppMessageImpl::GetApplicationId(pBundle), &arg, pCb, pData, req); } @@ -725,18 +735,6 @@ _AppControlManager::Launch(const AppId& appId, _AppArg* pArg, AppSvcResFn pCb, v SysLog(NID_APP, "App: %ls.", appId.GetPointer()); String actualAppId = appId; -#if 0 - if (appId.GetLength() == 10) - { - const String& execName = _PackageManagerImpl::GetInstance()->GetDefaultAppExecutableName(appId); - - if (!execName.IsEmpty()) - { - actualAppId.Append(L'.'); - actualAppId.Append(execName); - } - } -#endif pArg->UpdateRequestId(req); @@ -756,7 +754,7 @@ _AppControlManager::Launch(const AppId& appId, _AppArg* pArg, AppSvcResFn pCb, v if ((!(type & _APP_TYPE_SERVICE_APP)) && _IsDefaultApplication(tempId, appId)) { tempId += L'.'; - tempId += L"_AppControl"; + tempId += String(SUBMODE_NAME); // [INFO] Ugly solution for submode support pArg->UpdateAppId(tempId); @@ -822,78 +820,6 @@ _AppControlManager::Launch(const AppId& appId, _AppArg* pArg, AppSvcResFn pCb, v return pid; } -result -_AppControlManager::LaunchAppImplicit(_AppArg* pArg, int req) -{ - SysTryReturnResult(NID_APP, pArg != null, E_INVALID_ARG, "Invalid launch argument"); - - result r = E_SUCCESS; - bundle* kb = pArg->GetBundle(); - - if (req >= 0) - { - pArg->UpdateRequestId(req); - appsvc_add_data(kb, SELECTOR_NOTI_KEY, appinfo_get_appid()); - } - - if (_AppImpl::GetInstance() != null) - { - const long handle = _AppImpl::GetInstance()->GetWindowHandle(); - _AppArg::UpdateWindowHandle(kb, handle); - } - - int pid = appsvc_run_service(kb, req, LaunchResultCb, this); - if (pid >= 0) - { - if (pid == 0) - { - SysLog(NID_APP, "Sending local process again."); - pid = getpid(); - } - - char pkgname[255] = {0, }; - if (aul_app_get_pkgname_bypid(pid, pkgname, 255) != AUL_R_OK) - { - SysLog(NID_APP, "Fail to get package name by pid : (%d).", pid); - return E_SYSTEM; - } - - if (strncmp(pkgname, APP_SELECTOR, strlen(APP_SELECTOR)) != 0) - { - const char* pOperation = appsvc_get_operation(kb); - - SysLog(NID_APP, "Starting application without selector : (%s, %s).", pkgname, pOperation); - - SendAppControlStartResponse(req, pkgname, pOperation); - } - } - else - { - switch (pid) - { - case APPSVC_RET_EINVAL: - r = E_OBJ_NOT_FOUND; - break; - case APPSVC_RET_ENOMATCH: - r = E_OBJ_NOT_FOUND; - break; - case APPSVC_RET_EILLACC: - r = E_ILLEGAL_ACCESS; - break; - case APPSVC_RET_ERROR: - // fall through - case APPSVC_RET_ELAUNCH: - // fall through - default: - r = E_SYSTEM; - break; - } - } - - SysLog(NID_APP, "[%s] Application(%d) launched with reqId(%d) and arg(0x%x).", GetErrorMessage(r), pid, req, pArg); - - return r; -} void _AppControlManager::FinishAppControl(int reqId, int res, IMap* pMap) @@ -903,9 +829,20 @@ _AppControlManager::FinishAppControl(int reqId, int res, IMap* pMap) SysTryReturnVoidResult(NID_APP, pArg != null, E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY] Return argument allocation failure."); SendAppControlEvent(*pArg); - SysLog(NID_APP, "Exit."); } + + void +_AppControlManager::FinishAppControl(int reqId, int res, const AppId& appId, const String& oId, IMap* pMap, int prop) +{ + SysLog(NID_APP, "req %d, res %d, appId(%ls), oId(%ls).", reqId, res, appId.GetPointer(), oId.GetPointer()); + _NativeAppControlEventArg* pArg = new (std::nothrow) _NativeAppControlEventArg(reqId, res, appId, oId, pMap, prop); + SysTryReturnVoidResult(NID_APP, pArg != null, E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY] Return argument allocation failure."); + + SendAppControlEvent(*pArg); +} + + void _AppControlManager::RemoveResultRequest(int reqId) { @@ -924,7 +861,7 @@ _AppControlManager::AddLaunchRequest(_AppArg* pArg, LaunchCbType pCb, void* pDat { SysTryReturn(NID_APP, pArg != null, -1, E_INVALID_ARG, "[E_INVALID_ARG] Empty argument."); - _LaunchInfo* pItem = new (std::nothrow) _LaunchInfo(pArg, pCb, pData, prop); + _DataControlInfo* pItem = new (std::nothrow) _DataControlInfo(pArg, pCb, pData, prop); SysTryReturn(NID_APP, pItem != null, -1, E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY] Empty argument."); SysLog(NID_APP, "Registering callback 0x%x, 0x%x", pCb, pData); @@ -967,22 +904,6 @@ CATCH: } -bool -_AppControlManager::IsAllowedAppControl(const char aTable[][2][96], int count, const String& aId, const String& oId) -{ - for (int i = 0; i < count; i++) - { - if (aId == aTable[i][0] && oId == aTable[i][1]) - { - SysLog(NID_APP, "Found entry (%s, %s)", aTable[i][0], aTable[i][1]); - return true; - } - } - - return false; -} - - AppCtrlResult _AppControlManager::ConvertAppControlResultCode(int resCode) { @@ -1054,10 +975,4 @@ _AppControlManager::OnAppControlResponseEventReceivedN(const Tizen::Base::Runtim } } -AppId -_AppControlManager::GetAliasAppId(const AppId& appId) -{ - return _AppControlRegistry::GetInstance()->GetAliasAppId(appId); -} - }} // Tizen::App diff --git a/src/app/FApp_AppControlProviderManagerImpl.cpp b/src/app/FApp_AppControlProviderManagerImpl.cpp index 2250b0d..1bc79a9 100644 --- a/src/app/FApp_AppControlProviderManagerImpl.cpp +++ b/src/app/FApp_AppControlProviderManagerImpl.cpp @@ -76,13 +76,16 @@ _AppControlProviderManagerImpl::SendAppControlResult(RequestId reqId, const ILis _AppArg resArg; result r = resArg.ConstructResult(arg, pResultList); - SysTryReturn(NID_APP, !IsFailed(r), r, r, "[%s] Propagating.", GetErrorMessage(r)); + if (IsFailed(r)) + { + // erase _AppArg after sending the result back to the caller + pAppMgr->__resultManager.RemoveItem(reqId); - const bool isService = _AppInfo::GetAppType() & _APP_TYPE_SERVICE_APP; + SysPropagate(NID_APP, r); + return r; + } - //resArg.Print(); - r = _Aul::SendResult(resArg.GetBundle(), static_cast(0), _AppInfo::IsSubMode(), isService); - SysLog(NID_APP, "Sent AppControl event for %d.", reqId); + r = SendAppControlResultPrimitive(reqId, resArg, 0); // erase _AppArg after sending the result back to the caller pAppMgr->__resultManager.RemoveItem(reqId); @@ -104,7 +107,14 @@ _AppControlProviderManagerImpl::SendAppControlResult(RequestId reqId, AppCtrlRes _AppArg resArg; result r = resArg.ConstructResult(arg, pResultMap); - SysTryReturn(NID_APP, !IsFailed(r), r, r, "[%s] Propagating.", GetErrorMessage(r)); + if (IsFailed(r)) + { + // erase _AppArg after sending the result back to the caller + pAppMgr->__resultManager.RemoveItem(reqId); + + SysPropagate(NID_APP, r); + return r; + } const int code = appControlResult; int res = APPSVC_RES_NOT_OK; @@ -130,11 +140,7 @@ _AppControlProviderManagerImpl::SendAppControlResult(RequestId reqId, AppCtrlRes break; } - const bool isService = _AppInfo::GetAppType() & _APP_TYPE_SERVICE_APP; - - //resArg.Print(); - r = _Aul::SendResult(resArg.GetBundle(), static_cast(res), _AppInfo::IsSubMode(), isService); - SysLog(NID_APP, "Sent AppControl event for %d.", reqId); + r = SendAppControlResultPrimitive(reqId, resArg, res); // erase _AppArg after sending the result back to the caller pAppMgr->__resultManager.RemoveItem(reqId); @@ -142,6 +148,36 @@ _AppControlProviderManagerImpl::SendAppControlResult(RequestId reqId, AppCtrlRes return r; } + +result +_AppControlProviderManagerImpl::SendAppControlResultPrimitive(RequestId reqId, _AppArg& arg, int ret) +{ + static bool firstRequestSent = false; + + if (reqId == 0 && firstRequestSent) + { + SysLog(NID_APP, "Sent main AppControl request already."); + + return E_SUCCESS; + } + else + { + if (reqId == 0) + { + firstRequestSent = true; + } + + const bool isService = _AppInfo::GetAppType() & _APP_TYPE_SERVICE_APP; + + //resArg.Print(); + result r = _Aul::SendResult(arg.GetBundle(), static_cast(ret), _AppInfo::IsSubMode(), isService); + SysLog(NID_APP, "Sent AppControl event for %d.", reqId); + + return r; + } +} + + AppId _AppControlProviderManagerImpl::GetClientAppId(RequestId reqId) const { diff --git a/src/app/FApp_AppControlProviderManagerImpl.h b/src/app/FApp_AppControlProviderManagerImpl.h index 58448ae..13db532 100644 --- a/src/app/FApp_AppControlProviderManagerImpl.h +++ b/src/app/FApp_AppControlProviderManagerImpl.h @@ -27,7 +27,6 @@ #include #include #include -#include namespace Tizen { namespace Base { @@ -36,12 +35,14 @@ class ByteBuffer; }} namespace Tizen { namespace Base { namespace Collection { class IList; } } } +namespace Tizen { namespace Base { namespace Collection { class IMap; } } } namespace Tizen { namespace App { class AppControlProviderManager; class IAppControlProviderEventListener; +class _AppArg; /** * @class _AppControlProviderManagerImpl @@ -50,7 +51,6 @@ class IAppControlProviderEventListener; * The %_AppControlProviderManagerImpl class manages all the application controls. */ class _AppControlProviderManagerImpl - : public Tizen::Base::Object { public: @@ -81,7 +81,7 @@ private: /** * This is the destructor for this class. */ - virtual ~_AppControlProviderManagerImpl(void); + ~_AppControlProviderManagerImpl(void); /** * This is the default copy constructor for this class. @@ -93,6 +93,8 @@ private: */ _AppControlProviderManagerImpl& operator =(const _AppControlProviderManagerImpl& rhs); + result SendAppControlResultPrimitive(RequestId reqId, _AppArg& arg, int ret); + friend class AppControlProviderManager; }; diff --git a/src/app/FApp_AppControlRegistry.cpp b/src/app/FApp_AppControlRegistry.cpp index 866f405..2775ba4 100644 --- a/src/app/FApp_AppControlRegistry.cpp +++ b/src/app/FApp_AppControlRegistry.cpp @@ -21,8 +21,9 @@ #include #include -#include #include +#include +#include #include #include @@ -35,14 +36,11 @@ #include #include -#include "FAppPkg_PackageManagerImpl.h" #include "FApp_AppControlImpl.h" -#include "FApp_Aul.h" #include "FApp_AppControlRegistry.h" #include "FApp_AppMessageImpl.h" #include "FApp_TemplateUtil.h" -using namespace Tizen::App::Package; using namespace Tizen::Base; using namespace Tizen::Base::Collection; using namespace Tizen::Io; @@ -52,14 +50,11 @@ namespace const wchar_t ACTL_DEFAULT_FILE[] = L"/usr/etc/app-control-info.ini"; const wchar_t ACTL_LEGACY_FILE[] = L"/usr/etc/app-control-alias.ini"; -const wchar_t ACTL_ALIAS_FILE[] = L"/usr/etc/app-control-appid.ini"; - -const wchar_t TIZEN_ALIAS_APPID_PREFIX[] = L"tizen."; +const wchar_t ACTL_DEFAULT_PLUGIN[] = L"libosp-ac-platform.so"; const String ACTL_REGISTRY_PATH = L"Path"; const String ACTL_REGISTRY_ALIAS_PROVIDER = L"PROVIDER_ALIAS"; -const int PKG_APPID_LEN = 256; const int REG_VALUE_BUFFER_LEN = 256; } @@ -75,17 +70,11 @@ _AppControlRegistry::_AppControlRegistry(void) __tizenList.Construct(); __aliasList.Construct(); - - __aliasAppId.Construct(); - - __runtimeAlias.Construct(); } _AppControlRegistry::~_AppControlRegistry(void) { _DeleteCollectionMapValue(__aliasList); - - _DeleteCollection<_AppControlAliasEntry>(__runtimeAlias); } _AppControlRegistry* @@ -101,8 +90,6 @@ _AppControlRegistry::GetInstance(void) __pSelf->LoadTizenAppControlRegistry(); __pSelf->LoadLegacyList(); - - __pSelf->LoadAliasList(); } return __pSelf; @@ -117,7 +104,11 @@ _AppControlRegistry::LoadTizenAppControlRegistry(void) const String regPath = ACTL_DEFAULT_FILE; result r = reg.Construct(regPath, REG_OPEN_READ_ONLY, null); - SysTryReturn(NID_APP, !IsFailed(r), r, r, "[%s] Propagating.", GetErrorMessage(r)); + if (IsFailed(r)) + { + SysPropagate(NID_APP, r); + return r; + } const int secCount = reg.GetAllSectionCount(); SysTryReturnResult(NID_APP, !(secCount <= 0), E_OBJ_NOT_FOUND, "Registry contains no data."); @@ -166,7 +157,11 @@ _AppControlRegistry::LoadLegacyList(void) const String& regPath(ACTL_LEGACY_FILE); result r = reg.Construct(regPath, REG_OPEN_READ_ONLY, null); - SysTryReturn(NID_APP, !IsFailed(r), r, r, "[%s] Propagating.", GetErrorMessage(r)); + if (IsFailed(r)) + { + SysPropagate(NID_APP, r); + return r; + } const int sec_count = reg.GetAllSectionCount(); SysTryReturnResult(NID_APP, !(sec_count <= 0), E_OBJ_NOT_FOUND, "Registry contains no data."); @@ -215,7 +210,7 @@ _AppControlRegistry::LoadLegacyList(void) r = reg.GetValue(secName, *pStr, value); if (IsFailed(r)) { - SysLog(NID_APP, "[%s] Propagating.", GetErrorMessage(r)); + SysPropagate(NID_APP, r); continue; } @@ -239,49 +234,6 @@ _AppControlRegistry::LoadLegacyList(void) return E_SUCCESS; } -result -_AppControlRegistry::LoadAliasList(void) -{ - _RegistryImpl reg; - - const String regPath = ACTL_ALIAS_FILE; - - result r = reg.Construct(regPath, REG_OPEN_READ_ONLY, null); - SysTryReturn(NID_APP, !IsFailed(r), r, r, "[%s] Propagating.", GetErrorMessage(r)); - - HashMap* pMap = null; - r = reg.GetEntryListN(L"Alias", &pMap); - if (r != E_SUCCESS) - { - SysLog(NID_APP, "[%s] Propagating.", GetErrorMessage(r)); - pMap->RemoveAll(true); - delete pMap; - return r; - } - - String* pKey = null; - String* pVal = null; - std::unique_ptr pEnum(pMap->GetMapEnumeratorN()); - SysTryCatch(NID_APP, pEnum.get(), r = E_OUT_OF_MEMORY , E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY] Memory error."); - - while(pEnum->MoveNext() == E_SUCCESS) - { - pKey = static_cast(pEnum->GetKey()); - pVal = static_cast(pEnum->GetValue()); - - __aliasAppId.Add(*pKey, *pVal); - //SysLog(NID_APP, "(%ls, %ls)", pKey->GetPointer(), pVal->GetPointer()); - } - - SysLog(NID_APP, "Loading %d alias sections", __aliasAppId.GetCount()); - -CATCH: - pMap->RemoveAll(true); - delete pMap; - - return r; -} - AppControl* _AppControlRegistry::GetTizenAppControlN(const String& aId, const String& oId) const @@ -289,6 +241,8 @@ _AppControlRegistry::GetTizenAppControlN(const String& aId, const String& oId) c int count = 0; const String* pAppId = &aId; const String* pOperation = &oId; + + // legacy check first do { const _AppControlAliasEntry* const pEntry = GetAppControlAliasEntry(*pAppId, *pOperation); @@ -312,35 +266,7 @@ _AppControlRegistry::GetTizenAppControlN(const String& aId, const String& oId) c const String& soName = GetTizenAppControlProvider(*pAppId, *pOperation); - if (soName.IsEmpty()) - { - AppControl* pAc = GetAppControlN(*pAppId, *pOperation); - if (pAc) - { - _AppControlImpl* pImpl = _AppControlImpl::GetInstance(*pAc); - pImpl->SetProperty(_APPCONTROL_PROPERTY_ALIAS); - - const _AppControlAliasEntry* pLookupEntry = GetReverseRuntimeAliasEntry(*pAppId, *pOperation); - if (pLookupEntry == null) - { - // no entry found : add new one - _AppControlAliasEntry* pEntry = new (std::nothrow) _AppControlAliasEntry(aId, oId, *pAppId, *pOperation); - if (pEntry) - { - // may fail - __runtimeAlias.Add(pEntry); - SysLog(NID_APP, "Setting alias app (%ls -> %ls).", aId.GetPointer(), pAppId->GetPointer()); - } - } - } - else - { - SysLog(NID_APP, "No AppControl instance for (%ls, %ls)", pAppId->GetPointer(), pOperation->GetPointer()); - } - return pAc; - } - - return _AppControlImpl::CreateN(soName, *pAppId, *pOperation, L"", _APPCONTROL_PROPERTY_PUBLIC | _APPCONTROL_PROPERTY_SLP); + return _AppControlImpl::CreateN(soName, *pAppId, *pOperation, _APPCONTROL_PROPERTY_PUBLIC); } @@ -355,8 +281,8 @@ _AppControlRegistry::GetTizenAppControlProvider(const String& appId, const Strin return val; } - SysLog(NID_APP, "No platform AppControl and use custom AppControl instead."); - return L""; + SysLog(NID_APP, "Default platform AppControl %ls is used.", ACTL_DEFAULT_PLUGIN); + return String(ACTL_DEFAULT_PLUGIN); } @@ -366,8 +292,9 @@ _AppControlRegistry::GetTizenAppControlProvider(const String& appId, const Strin struct AppSvcIterData { public: - AppSvcIterData(ArrayList* pArr, const String& op) : pArray(pArr), operation(op) {} + AppSvcIterData(const _AppControlRegistry* pRegs, ArrayList* pArr, const String& op) : pThis(pRegs), pArray(pArr), operation(op) {} + const _AppControlRegistry* pThis; ArrayList* pArray; const String& operation; }; @@ -383,6 +310,8 @@ AppSvcIterFnCb(const char* pAppId, void* pData) AppSvcIterData* pAppSvcIterData = static_cast(pData); ArrayList* pList = pAppSvcIterData->pArray; SysAssert(pList != null); + const _AppControlRegistry* pThis = pAppSvcIterData->pThis; + SysAssert(pThis != null); const String& operation = pAppSvcIterData->operation; if (pAppId == NULL) @@ -392,7 +321,7 @@ AppSvcIterFnCb(const char* pAppId, void* pData) } String appId = pAppId; - AppControl* pAc = _AppControlImpl::CreateN(appId, operation, false); + AppControl* pAc = pThis->GetTizenAppControlN(appId, operation); if (pAc == null) { SysLog(NID_APP, "AppControl allocation failure for %ls.", appId.GetPointer()); @@ -433,7 +362,7 @@ _AppControlRegistry::FindAppControlListN(const String* pOid, const String* pUri, SysTryReturn(NID_APP, pList != null, null, E_OUT_OF_MEMORY, "[E_OUT_OF_MEMORY] ArrayList creation failure."); pList->Construct(); - AppSvcIterData data(pList, operation); + AppSvcIterData data(this, pList, operation); appsvc_get_list(pBundle.get(), AppSvcIterFnCb, reinterpret_cast(&data)); @@ -474,108 +403,26 @@ _AppControlRegistry::GetAppControlAliasEntry(const String& aId, const String& oI } -const _AppControlRegistry::_AppControlAliasEntry* -_AppControlRegistry::GetReverseAppControlAliasEntry(const String& aId, const String& oId) const -{ - std::unique_ptr< IMapEnumeratorT > pEnum(__aliasList.GetMapEnumeratorN()); - - while (pEnum->MoveNext() == E_SUCCESS) - { - _AppControlAliasEntry* pEntry = null; - pEnum->GetValue(pEntry); - if (pEntry->provider2 == aId && pEntry->operation2 == oId) - { - SysLog(NID_APP, "Found matching AppControl (%ls, %ls)<-(%ls, %ls)", aId.GetPointer(), oId.GetPointer(), pEntry->provider.GetPointer(), pEntry->operation.GetPointer()); - - return pEntry; - } - } - - return null; -} - - -const _AppControlRegistry::_AppControlAliasEntry* -_AppControlRegistry::GetReverseRuntimeAliasEntry(const String& aId, const String& oId) const -{ - std::unique_ptr< IEnumeratorT<_AppControlAliasEntry*> > pEnum(__runtimeAlias.GetEnumeratorN()); - - while (pEnum->MoveNext() == E_SUCCESS) - { - _AppControlAliasEntry* pEntry = null; - pEnum->GetCurrent(pEntry); - if (pEntry->provider2 == aId && pEntry->operation2 == oId) - { - SysLog(NID_APP, "Found matching AppControl (%ls, %ls)->(%ls, %ls)", aId.GetPointer(), oId.GetPointer(), pEntry->provider2.GetPointer(), pEntry->operation2.GetPointer()); - - return pEntry; - } - } - - return null; -} - - -AppControl* -_AppControlRegistry::GetAppControlN(const String& appId, const String& operationId) const -{ - bool changeAppId = false; - - String actualAppId = appId; - if (appId.StartsWith(TIZEN_ALIAS_APPID_PREFIX, 0)) - { - const String& tmp = GetAliasAppId(appId); - - if (!tmp.IsEmpty()) - { - actualAppId = tmp; - SysLog(NID_APP, "Found alias app (%ls -> %ls).", appId.GetPointer(), tmp.GetPointer()); - - changeAppId = true; - } - } - - bool b = _Aul::IsInstalled(actualAppId); - SysTryReturn(NID_APP, b == true, null, E_APP_NOT_INSTALLED, "[E_APP_NOT_INSTALLED] %ls not installed.", actualAppId.GetPointer()); - - return _AppControlImpl::CreateN(actualAppId, operationId, changeAppId); -} - - AppId _AppControlRegistry::GetAliasAppId(const AppId& appId) const { - String tmp; - result r = __aliasAppId.GetValue(appId, tmp); - if (r != E_SUCCESS) - { - tmp.Clear(); - } - - return tmp; -} + std::unique_ptr pBundle(bundle_create()); + if (pBundle.get()) + { + std::unique_ptr pAppId(_StringConverter::CopyToCharArrayN(appId)); -AppId -_AppControlRegistry::GetReverseAliasAppId(const AppId& appId) const -{ - std::unique_ptr< IMapEnumeratorT > pEnum(__aliasAppId.GetMapEnumeratorN()); + // appsvc_set_appid() lookup for actual app ID internally + appsvc_set_appid(pBundle.get(), pAppId.get()); + const char* pTmp = appsvc_get_appid(pBundle.get()); - String key; - String value; - while (pEnum->MoveNext() == E_SUCCESS) - { - pEnum->GetKey(key); - pEnum->GetValue(value); - if (value == appId) + if (pTmp) { - return key; + return String(pTmp); } } - SysLog(NID_APP, "No entry found for %ls", appId.GetPointer()); - return L""; + return String(); } - } } // Tizen::App diff --git a/src/app/FApp_AppControlRegistry.h b/src/app/FApp_AppControlRegistry.h index 30c413e..05eb5be 100644 --- a/src/app/FApp_AppControlRegistry.h +++ b/src/app/FApp_AppControlRegistry.h @@ -79,7 +79,6 @@ public: const Tizen::Base::String operation2; }; - typedef Tizen::Base::Collection::ArrayListT<_AppControlAliasEntry*> RuntimeAliasType; typedef Tizen::Base::Collection::MultiHashMapT AppControlAliasList; typedef Tizen::Base::Collection::HashMapT AliasMapType; @@ -91,20 +90,12 @@ public: AppControl* GetTizenAppControlN(const Tizen::Base::String& aId, const Tizen::Base::String& oId) const; - AppControl* GetAppControlN(const Tizen::Base::String& appId, const Tizen::Base::String& operationId) const; - Tizen::Base::Collection::ArrayList* FindAppControlListN(const Tizen::Base::String* pOid, const Tizen::Base::String* pUri, const Tizen::Base::String* pMimeType, const Tizen::Base::String* pCategory) const; const _AppControlAliasEntry* GetAppControlAliasEntry(const Tizen::Base::String& aId, const Tizen::Base::String& oId) const; - const _AppControlAliasEntry* GetReverseAppControlAliasEntry(const Tizen::Base::String& aId, const Tizen::Base::String& oId) const; - - const _AppControlAliasEntry* GetReverseRuntimeAliasEntry(const Tizen::Base::String& aId, const Tizen::Base::String& oId) const; - AppId GetAliasAppId(const AppId& appId) const; - AppId GetReverseAliasAppId(const AppId& appId) const; - private: _AppControlRegistry(const _AppControlRegistry& rhs); @@ -114,8 +105,6 @@ private: result LoadLegacyList(void); - result LoadAliasList(void); - Tizen::Base::String GetTizenAppControlProvider(const Tizen::Base::String& appId, const Tizen::Base::String& opId) const; private: @@ -123,10 +112,6 @@ private: AppControlAliasList __aliasList; - AliasMapType __aliasAppId; - - mutable RuntimeAliasType __runtimeAlias; - static _AppControlRegistry* __pSelf; }; // _AppControlRegistry diff --git a/src/app/FApp_AppImpl.cpp b/src/app/FApp_AppImpl.cpp index b7485b0..e41f92a 100644 --- a/src/app/FApp_AppImpl.cpp +++ b/src/app/FApp_AppImpl.cpp @@ -322,10 +322,6 @@ _AppImpl::OnService(service_s* service, void* user_data) } free(pBuf); } - else - { - SysLog(NID_APP, "It is failed to get multi-window value: %d", errVal); - } // call for callbacks // ptr to member function @@ -515,7 +511,11 @@ _AppImpl::RegisterAppRequest(service_s* service, int& req, _AppHandler& handler) SysTryReturnResult(NID_APP, pManager != null, E_SYSTEM, "Wrong system state."); result r = pManager->RegisterRequest(service, req, handler); - SysTryReturn(NID_APP, !IsFailed(r), r, r, "[%s] Propagating.", GetErrorMessage(r)); + if (IsFailed(r)) + { + SysPropagate(NID_APP, r); + return r; + } int providerType = _AppInfo::GetAppHandlerType(); providerType |= (_APP_HANDLER_LAUNCH_NORMAL | _APP_HANDLER_LAUNCH_COND); diff --git a/src/app/FApp_AppInfo.cpp b/src/app/FApp_AppInfo.cpp index 8cec93c..bb8d05a 100644 --- a/src/app/FApp_AppInfo.cpp +++ b/src/app/FApp_AppInfo.cpp @@ -37,6 +37,7 @@ #include #include "FAppPkg_PackageInfoImpl.h" +#include "FApp_Aul.h" #include "FApp_AppInfo.h" using namespace Tizen::App::Package; @@ -99,6 +100,7 @@ _AppInfo::_AppInfo(void) : __appState(TERMINATED) , __appType(_APP_TYPE_NONE) , __appRootDirFd(-1) + , __appSdDirFd(-1) , __appHandlerType(_APP_HANDLER_NONE) , __parentWindowHandle(-1) , __pAppName(null) @@ -120,6 +122,7 @@ _AppInfo::~_AppInfo(void) // closing may or may not succeed close(__appRootDirFd); + close(__appSdDirFd); } _AppInfo* @@ -141,17 +144,21 @@ _AppInfo::Construct(void) const char* pPackageId = appinfo_get_packageid(); const char* pExecName = appinfo_get_execname(); - if (strncmp(pExecName, SUBMODE_NAME, strlen(SUBMODE_NAME)) == 0) { SysLog(NID_APP, "Handling for submode."); - const String& name = _PackageManagerImpl::GetInstance()->GetDefaultAppExecutableName(String(pPackageId)); - - __isSubMode = true; - std::unique_ptr pActualExec(_StringConverter::CopyToCharArrayN(name)); - appinfo_update_submode_execname_and_appid(pActualExec.get()); - SysLog(NID_APP, "Executable name is changed to %s.", pActualExec.get()); + const char* pAppId = appinfo_get_appid(); + const String& mainId = _Aul::GetMainAppId(pAppId); + if (!mainId.IsEmpty()) + { + std::unique_ptr pMainId(_StringConverter::CopyToCharArrayN(mainId)); + appinfo_update_submode_appid(pMainId.get()); + + __isSubMode = true; + + SysLog(NID_APP, "Executable name is changed to %s.", pMainId.get()); + } } result r = E_SUCCESS; @@ -177,6 +184,14 @@ _AppInfo::Construct(void) pFile = fdopen(fd, "r"); SysTryCatch(NID_APP, pFile != NULL, r = E_SYSTEM, E_SYSTEM, "[E_SYSTEM] Opening appinfo file (%s) failed : %s.", appInfoPath, strerror(errno)); + // sdcard + char sdInfoPath[PATH_MAX] = {0, }; + strncpy(sdInfoPath, "/opt/storage/sdcard/app2sd/", strlen("/opt/storage/sdcard/app2sd/")); + strncat(sdInfoPath, pPackageId, MAX_APPID); + + __appSdDirFd = open(sdInfoPath, O_RDONLY); + SysLog(NID_APP, "sd root directory (%s:%d) open.", sdInfoPath, __appSdDirFd); + char apiVersion[MAX_APIVERSION] = {0, }; char* pRet = fgets(apiVersion, MAX_APIVERSION - 1, pFile); SysTryCatch(NID_APP, pRet != NULL, r = E_SYSTEM, E_SYSTEM, "[E_SYSTEM] Reading appinfo file (%s) failed : %s.", appInfoPath, strerror(errno)); @@ -269,7 +284,12 @@ _AppInfo::UpdateAppInfoFromPackageInfo(const PackageId& packageId) result r = E_SUCCESS; std::unique_ptr pInfo(pPkg->GetPackageInfoN(packageId)); - SysTryReturn(NID_APP, pInfo != null, r, r, "[%s] Propagating.", GetErrorMessage(r)); + if (pInfo.get() == null) + { + r = GetLastResult(); + SysPropagate(NID_APP, r); + return r; + } const _PackageInfoImpl* pPkgInfo = _PackageInfoImpl::GetInstance(pInfo.get()); SysTryReturnResult(NID_APP, pPkgInfo != null, E_INVALID_STATE, "Invalid PackageInfo instance."); diff --git a/src/app/FApp_AppManagerImpl.cpp b/src/app/FApp_AppManagerImpl.cpp index 2528c1e..1fab392 100644 --- a/src/app/FApp_AppManagerImpl.cpp +++ b/src/app/FApp_AppManagerImpl.cpp @@ -196,14 +196,6 @@ _AppManagerImpl::FindAppControlN(const AppId& aId, const String& oId) AppControl* pAc = null; pAc = pRegs->GetTizenAppControlN(aId, oId); - if (pAc != null) - { - SetLastResult(E_SUCCESS); - return pAc; - } - - pAc = pRegs->GetAppControlN(aId, oId); - SysTryReturn(NID_APP, pAc != null, null, E_OBJ_NOT_FOUND, "[%s] No matching AppControl instance found (%ls, %ls).", GetErrorMessage(E_OBJ_NOT_FOUND), aId.GetPointer(), oId.GetPointer()); SetLastResult(E_SUCCESS); @@ -222,21 +214,7 @@ _AppManagerImpl::FindAppControlsN(const String* pOperationId, const String* pCat if (pDataType) { - if ((*pDataType)[0] == L'.') - { - SysLog(NID_APP, "Extension to MIME conversion for %ls", pDataType->GetPointer()); - - String ext; - pDataType->SubString(1, ext); - - result r = _AppControlManager::GetMimeFromExt(ext, mimeType); - - SysTryReturn(NID_APP, !IsFailed(r), null, r, "[%s] MIME type conversion failure for %ls.", GetErrorMessage(r), ext.GetPointer()); - - pMimeType = &mimeType; - - SysLog(NID_APP, "Conversion : %ls -> %ls.", pDataType->GetPointer(), pMimeType->GetPointer()); - } + mimeType = _AppControlManager::GetMimeTypeFromDataType(*pDataType); } if (pUriScheme) @@ -303,25 +281,7 @@ _AppManagerImpl::StartAppControl(const String* pOperationId, const String* pCate if (pDataType) { - String mimeType = *pDataType; - - if ((*pDataType)[0] == L'.') - { - SysLog(NID_APP, "Extension to MIME conversion for %ls", pDataType->GetPointer()); - -#if 0 - String ext; - pDataType->SubString(1, ext); - - result r = _AppControlManager::GetMimeFromExt(ext, mimeType); - - SysTryReturn(NID_APP, !IsFailed(r), null, r, "[%s] MIME type conversion failure for %ls.", GetErrorMessage(r), ext.GetPointer()); - - pMimeType = &mimeType; - - SysLog(NID_APP, "Conversion : %ls -> %ls.", pDataType->GetPointer(), pMimeType->GetPointer()); -#endif - } + const String& mimeType = _AppControlManager::GetMimeTypeFromDataType(*pDataType); _AppMessageImpl::SetMime(pBundle.get(), mimeType); } @@ -469,7 +429,7 @@ _AppManagerImpl::LaunchApplication(const String& appId, const IList* pArguments, // "The length of appid exceeded the limit(%d).", // WIDGET_APP_MAX_APPID_LENGTH); - std::unique_ptr pAc(_AppControlRegistry::GetInstance()->GetAppControlN(appId, TIZEN_OPERATION_MAIN)); + std::unique_ptr pAc(FindAppControlN(appId, TIZEN_OPERATION_MAIN)); SysTryReturnResult(NID_APP, pAc.get() != null, E_OBJ_NOT_FOUND, "The target application (%ls) is not found.", appId.GetPointer()); if (pArguments) @@ -751,7 +711,10 @@ _AppLifecycleManager::LaunchCallback(int pid, void* pData) _IAppEventListener* pListener = null; pEnum->GetCurrent(pListener); - pListener->OnApplicationLaunched(tmp, pid); + if (pListener && _AppInfo::GetAppState() == RUNNING) + { + pListener->OnApplicationLaunched(tmp, pid); + } } } @@ -775,7 +738,7 @@ _AppLifecycleManager::TerminateCallback(int pid, void* pData) result r = pImpl->__map.GetValue(pid, tmp); if (r != E_SUCCESS) { - SysLog(NID_APP, "Cannot acquire app from pid %d.", pid); + SysLog(NID_APP, "[%s] Cannot acquire app from pid %d.", GetErrorMessage(r), pid); return -1; } @@ -789,7 +752,10 @@ _AppLifecycleManager::TerminateCallback(int pid, void* pData) _IAppEventListener* pListener = null; pEnum->GetCurrent(pListener); - pListener->OnApplicationTerminated(tmp, pid); + if (pListener && _AppInfo::GetAppState() == RUNNING) + { + pListener->OnApplicationTerminated(tmp, pid); + } } } diff --git a/src/app/FApp_AppMessageImpl.cpp b/src/app/FApp_AppMessageImpl.cpp index 659ad7f..c10a292 100644 --- a/src/app/FApp_AppMessageImpl.cpp +++ b/src/app/FApp_AppMessageImpl.cpp @@ -22,6 +22,7 @@ #include #include +#include #include #include @@ -47,15 +48,42 @@ _AppMessageImpl::_AppMessageImpl(void) SysAssert(__pBundle != NULL); } +_AppMessageImpl::_AppMessageImpl(const bundle* pBundle) +: __pBundle(bundle_dup(const_cast(pBundle))) +{ + SysAssert(__pBundle != NULL); +} + _AppMessageImpl::_AppMessageImpl(const _AppMessageImpl&rhs) : __pBundle(bundle_dup(rhs.__pBundle)) { SysAssert(__pBundle != NULL); } -_AppMessageImpl::~_AppMessageImpl(void) +_AppMessageImpl::_AppMessageImpl(const String& appId, const String& oId, const String* pUri, const String* pMime, const IMap* pMap) +: __pBundle(bundle_create()) { SysAssert(__pBundle != NULL); + + SetApplicationId(__pBundle, appId); + + SetOperation(__pBundle, oId); + + if (pUri && !pUri->IsEmpty()) + { + SetUri(__pBundle, *pUri); + } + + if (pMime && !pMime->IsEmpty()) + { + SetMime(__pBundle, *pMime); + } + + AddData(pMap); +} + +_AppMessageImpl::~_AppMessageImpl(void) +{ bundle_free(__pBundle); } @@ -130,14 +158,49 @@ _AppMessageImpl::RemoveData(bundle* pBundle, const String& key) return E_SUCCESS; } +String +_AppMessageImpl::GetApplicationId(const bundle* pBundle) +{ + return String(appsvc_get_appid(const_cast(pBundle))); +} + +result +_AppMessageImpl::SetApplicationId(bundle* pBundle, const String& appId) +{ + std::unique_ptr pVal(_StringConverter::CopyToCharArrayN(appId)); + + // alias appid handling is done internally + appsvc_set_appid(pBundle, pVal.get()); + + return E_SUCCESS; +} + +String +_AppMessageImpl::GetOperation(const bundle* pBundle) +{ + return String(appsvc_get_operation(const_cast(pBundle))); +} + +result +_AppMessageImpl::SetOperation(bundle* pBundle, const char* pOperation) +{ + appsvc_set_operation(pBundle, pOperation); + + return E_SUCCESS; +} + result _AppMessageImpl::SetOperation(bundle* pBundle, const String& operation) { std::unique_ptr pVal(_StringConverter::CopyToCharArrayN(operation)); - appsvc_set_operation(pBundle, pVal.get()); + return SetOperation(pBundle, pVal.get()); +} - return E_SUCCESS; +String +_AppMessageImpl::GetUri(const bundle* pBundle) +{ + return String(appsvc_get_uri(const_cast(pBundle))); } result @@ -150,6 +213,12 @@ _AppMessageImpl::SetUri(bundle* pBundle, const String& uri) return E_SUCCESS; } +String +_AppMessageImpl::GetMime(const bundle* pBundle) +{ + return String(appsvc_get_mime(const_cast(pBundle))); +} + result _AppMessageImpl::SetMime(bundle* pBundle, const String& mime) { diff --git a/src/app/FApp_AppRegistryImpl.cpp b/src/app/FApp_AppRegistryImpl.cpp index 1914ff2..f3d39ed 100644 --- a/src/app/FApp_AppRegistryImpl.cpp +++ b/src/app/FApp_AppRegistryImpl.cpp @@ -76,6 +76,7 @@ _AppRegistryImpl::Construct(void) r = E_SUCCESS; } + reg.Flush(); delete pReglock; } return r; @@ -87,7 +88,12 @@ _AppRegistryImpl::Add(const String& key, const String& value) MutexGuard lock(__mutex); Registry* pReg = LoadN(ReadWrite); - SysTryReturnResult(NID_APP, pReg != null, GetLastResult(), "Propagating to caller..."); + if (pReg == null) + { + result r = GetLastResult(); + SysPropagate(NID_APP, r); + return r; + } result r = pReg->AddValue(__sectionName, key, value); SysTryCatch(NID_APP, !IsFailed(r), , r, "[%s] Adding value to the registry has failed.", GetErrorMessage(r)); @@ -106,7 +112,12 @@ _AppRegistryImpl::Add(const String& key, int value) MutexGuard lock(__mutex); Registry* pReg = LoadN(ReadWrite); - SysTryReturnResult(NID_APP, pReg != null, GetLastResult(), "Propagating to caller..."); + if (pReg == null) + { + result r = GetLastResult(); + SysPropagate(NID_APP, r); + return r; + } result r = pReg->AddValue(__sectionName, key, value); SysTryCatch(NID_APP, !IsFailed(r), , r, "[%s] Adding value to the registry has failed.", GetErrorMessage(r)); @@ -125,7 +136,12 @@ _AppRegistryImpl::Add(const String& key, double value) MutexGuard lock(__mutex); Registry* pReg = LoadN(ReadWrite); - SysTryReturnResult(NID_APP, pReg != null, GetLastResult(), "Propagating to caller..."); + if (pReg == null) + { + result r = GetLastResult(); + SysPropagate(NID_APP, r); + return r; + } result r = pReg->AddValue(__sectionName, key, value); SysTryCatch(NID_APP, !IsFailed(r), , r, "[%s] Adding value to the registry has failed.", GetErrorMessage(r)); @@ -144,7 +160,12 @@ _AppRegistryImpl::Set(const String& key, const String& value) MutexGuard lock(__mutex); Registry* pReg = LoadN(ReadWrite); - SysTryReturnResult(NID_APP, pReg != null, GetLastResult(), "Propagating to caller..."); + if (pReg == null) + { + result r = GetLastResult(); + SysPropagate(NID_APP, r); + return r; + } result r = pReg->SetValue(__sectionName, key, value); SysTryCatch(NID_APP, !IsFailed(r), , r, "[%s] Setting value to the registry has failed.", GetErrorMessage(r)); @@ -163,7 +184,12 @@ _AppRegistryImpl::Set(const String& key, int value) MutexGuard lock(__mutex); Registry* pReg = LoadN(ReadWrite); - SysTryReturnResult(NID_APP, pReg != null, GetLastResult(), "Propagating to caller..."); + if (pReg == null) + { + result r = GetLastResult(); + SysPropagate(NID_APP, r); + return r; + } result r = pReg->SetValue(__sectionName, key, value); SysTryCatch(NID_APP, !IsFailed(r), , r, "[%s] Setting value to the registry has failed.", GetErrorMessage(r)); @@ -182,7 +208,12 @@ _AppRegistryImpl::Set(const String& key, double value) MutexGuard lock(__mutex); Registry* pReg = LoadN(ReadWrite); - SysTryReturnResult(NID_APP, pReg != null, GetLastResult(), "Propagating to caller..."); + if (pReg == null) + { + result r = GetLastResult(); + SysPropagate(NID_APP, r); + return r; + } result r = pReg->SetValue(__sectionName, key, value); SysTryCatch(NID_APP, !IsFailed(r), , r, "[%s] Setting value to the registry has failed.", GetErrorMessage(r)); @@ -207,7 +238,12 @@ _AppRegistryImpl::Remove(const String& key) MutexGuard lock(__mutex); Registry* pReg = LoadN(ReadWrite); - SysTryReturnResult(NID_APP, pReg != null, GetLastResult(), "Propagating to caller..."); + if (pReg == null) + { + result r = GetLastResult(); + SysPropagate(NID_APP, r); + return r; + } result r = pReg->RemoveValue(__sectionName, key); SysTryLog(NID_APP, !IsFailed(r), "[%s] Removing value to the registry has failed.", GetErrorMessage(r)); @@ -223,7 +259,12 @@ _AppRegistryImpl::Get(const String& key, String& value) const MutexGuard lock(__mutex); Registry* pReg = LoadN(ReadOnly); - SysTryReturnResult(NID_APP, pReg != null, GetLastResult(), "Propagating to caller..."); + if (pReg == null) + { + result r = GetLastResult(); + SysPropagate(NID_APP, r); + return r; + } result r = pReg->GetValue(__sectionName, key, value); SysTryLog(NID_APP, !IsFailed(r), "[%s] Getting value to the registry has failed.", GetErrorMessage(r)); @@ -239,7 +280,12 @@ _AppRegistryImpl::Get(const String& key, int& value) const MutexGuard lock(__mutex); Registry* pReg = LoadN(ReadOnly); - SysTryReturnResult(NID_APP, pReg != null, GetLastResult(), "Propagating to caller..."); + if (pReg == null) + { + result r = GetLastResult(); + SysPropagate(NID_APP, r); + return r; + } result r = pReg->GetValue(__sectionName, key, value); SysTryLog(NID_APP, !IsFailed(r), "[%s] Getting value to the registry has failed.", GetErrorMessage(r)); @@ -255,7 +301,12 @@ _AppRegistryImpl::Get(const String& key, double& value) const MutexGuard lock(__mutex); Registry* pReg = LoadN(ReadOnly); - SysTryReturnResult(NID_APP, pReg != null, GetLastResult(), "Propagating to caller..."); + if (pReg == null) + { + result r = GetLastResult(); + SysPropagate(NID_APP, r); + return r; + } result r = pReg->GetValue(__sectionName, key, value); SysTryLog(NID_APP, !IsFailed(r), "[%s] Getting value to the registry has failed.", GetErrorMessage(r)); diff --git a/src/app/FApp_AppSettingImpl.cpp b/src/app/FApp_AppSettingImpl.cpp index f7aabd9..bf89fb3 100644 --- a/src/app/FApp_AppSettingImpl.cpp +++ b/src/app/FApp_AppSettingImpl.cpp @@ -34,7 +34,6 @@ #include #include #include -#include #include "FApp_AppSettingImpl.h" #include "FApp_AppInfo.h" #include "FAppPkg_PackageManagerImpl.h" @@ -45,7 +44,6 @@ using namespace Tizen::App::Package; using namespace Tizen::Base; using namespace Tizen::Base::Collection; using namespace Tizen::Io; -using namespace Tizen::Security; using namespace Tizen::App; @@ -53,7 +51,6 @@ namespace Tizen { namespace App { const int APP_ID_LENTH = 10; -const int MAX_CONTENT_LEN = 512; const int MAX_LOCAL_BUFSIZE = 128; const char* DBUS_PATH = "/setting/dbus_handler"; const char* DBUS_SIGNAL_INTERFACE = "org.tizen.setting.signal"; @@ -146,10 +143,6 @@ _AppSettingImpl::_MutiInstanceManager::GetInstanceByAppId(const AppId& appId) AppSetting* pAppSettingInstance = null; String* pKeyStr = null; - r = _AccessController::CheckUserPrivilege(_PRV_APPSETTING); - SysTryReturn(NID_APP, !IsFailed(r), null, E_PRIVILEGE_DENIED, - "[%s] The application does not have the privilege to call this method.", GetErrorMessage(E_PRIVILEGE_DENIED)); - // Convert AppId to package type id. String packageId; appId.SubString(0, APP_ID_LENTH, packageId); @@ -204,10 +197,6 @@ CATCH: result _AppSettingImpl::_MutiInstanceManager::ReleaseInstanceByAppId(const AppId& appId) { - result r = _AccessController::CheckUserPrivilege(_PRV_APPSETTING); - SysTryReturnResult(NID_APP, !IsFailed(r), E_PRIVILEGE_DENIED, - "The application does not have the privilege to call this method."); - // Convert AppId to package type id. String packageId; appId.SubString(0, APP_ID_LENTH, packageId); @@ -664,7 +653,7 @@ result _AppSettingImpl::Load(void) { SysTryReturnResult(NID_APP, File::IsFileExist(__filePath), E_OBJ_NOT_FOUND, - "The instance of specified AppId does not have setting information."); + "The instance of specified AppId does not have setting information. %ls", __filePath.GetPointer()); result r = E_SUCCESS; std::unique_ptr pfilePath(Tizen::Base::Utility::StringUtil::StringToUtf8N(__filePath)); diff --git a/src/app/FApp_Aul.cpp b/src/app/FApp_Aul.cpp index 104b4e0..6abde09 100644 --- a/src/app/FApp_Aul.cpp +++ b/src/app/FApp_Aul.cpp @@ -30,6 +30,7 @@ #include #include #include +#include #include #include @@ -282,27 +283,43 @@ _Aul::IsInstalled(const AppId& appId) } +String +_Aul::GetMainAppId(const char* appid) +{ + pkgmgrinfo_appinfo_h handle = NULL; + int ret = pkgmgrinfo_appinfo_get_appinfo(appid, &handle); + if (ret != PMINFO_R_OK) + { + return String(); + } + + char* mainid = NULL; + ret = pkgmgrinfo_appinfo_get_submode_mainid(handle, &mainid); + SysTryLog(NID_APP, ret == PMINFO_R_OK, "Cannot get main id for %s.", appid); + + const String tmp = String(mainid); + pkgmgrinfo_appinfo_destroy_appinfo(handle); + return tmp; +} + + AppId _Aul::GetRealAppId(const AppId& appId) { String temp; - // [INFO] ugly code for submode callee appId.SubString(11, temp); - if (temp == L"_AppControl") + if (temp == String(SUBMODE_NAME)) { - String id; - appId.SubString(0, 10, id); - const String& name = _PackageManagerImpl::GetInstance()->GetDefaultAppExecutableName(id); - - const String retVal = id + L'.' + name; - SysLog(NID_APP, "Converted caller Id is %ls", retVal.GetPointer()); - - return retVal; - } - else - { - return appId; + std::unique_ptr pAppId(_StringConverter::CopyToCharArrayN(appId)); + const String& main = GetMainAppId(pAppId.get()); + if (!main.IsEmpty()) + { + SysLog(NID_APP, "main Id is %ls", main.GetPointer()); + return main; + } } + + return appId; } } } // Tizen::App diff --git a/src/app/FApp_NotificationManagerImpl.cpp b/src/app/FApp_NotificationManagerImpl.cpp index 7b8233c..cbd7a03 100644 --- a/src/app/FApp_NotificationManagerImpl.cpp +++ b/src/app/FApp_NotificationManagerImpl.cpp @@ -19,89 +19,21 @@ * @brief This is the placeholder for _NotificationManagerImpl class. */ -#include - -#include -#include -#include -#include -#include -#include -#include - #include -#include -#include -#include +#include + #include "FApp_NotificationManagerImpl.h" -#include "FApp_AppInfo.h" -#include "FIoFile.h" -#include "FAppPkg_PackageManagerImpl.h" -#include "FApp_Aul.h" -#include "FApp_AppArg.h" -#include "FAppPkgPackageAppInfo.h" -#include "FAppPkg_PackageAppInfoImpl.h" +#include "FApp_INotificationManagerImpl.h" +#include "FAppNotificationManager.h" using namespace Tizen::Base; -using namespace Tizen::App; -using namespace Tizen::App::Package; -using namespace Tizen::Io; - -extern "C" int service_create_request(bundle *data, service_h *service); +using namespace Tizen::Base::Runtime; namespace { -result -ConvertNotificationResult(int error) -{ - switch (error) - { - case UI_NOTIFICATION_ERROR_NONE: - return E_SUCCESS; - case UI_NOTIFICATION_ERROR_INVALID_PARAMETER: - return E_INVALID_ARG; - case UI_NOTIFICATION_ERROR_OUT_OF_MEMORY: - return E_OUT_OF_MEMORY; - case UI_NOTIFICATION_ERROR_DB_FAILED: - return E_DATABASE; - case UI_NOTIFICATION_ERROR_NO_SUCH_FILE: - return E_SYSTEM; - case UI_NOTIFICATION_ERROR_INVALID_STATE: - return E_SYSTEM; - default: - return E_SYSTEM; - } -} - -bool -IsPosted(ui_notification_h handle) -{ - struct ui_notification_s - { - void* raw_handle; - bool ongoing; - bool posted; - bool removed; - char *icon; - struct tm *time; - char *title; - char *content; - service_h service; - char *sound; - bool vibration; - }; - - if (handle == NULL) - { - return false; - } - - ui_notification_s* pStruct = reinterpret_cast(handle); - - return pStruct->posted; -} +const wchar_t OSP_SHELL_SONAME[] = L"libosp-shell-core.so.1"; } @@ -109,504 +41,256 @@ namespace Tizen { namespace App { _NotificationManagerImpl::_NotificationManagerImpl(void) +: __pNotiImpl(null) { } -_NotificationManagerImpl::~_NotificationManagerImpl(void) -{ -} - -result -_NotificationManagerImpl::Construct(void) -{ - return E_SUCCESS; -} - -const _NotificationManagerImpl* -_NotificationManagerImpl::GetInstance(const NotificationManager& notiMgr) -{ - return notiMgr.__pNotificationManagerImpl; -} - -_NotificationManagerImpl* -_NotificationManagerImpl::GetInstance(NotificationManager& notiMgr) -{ - return notiMgr.__pNotificationManagerImpl; -} - -int -_NotificationManagerImpl::GetBadgeNumber(void) const -{ - unsigned int count = 0; - - badge_error_e badgeError = badge_get_count(appinfo_get_appid(), &count); - - if (badgeError == BADGE_ERROR_NONE) - { - SysLog(NID_APP, "badge_get_count(%d)", count); - } - else - { - SysLog(NID_APP, "badge_get_count failed(%d).", badgeError); - return -1; - } - return count; -} - -result -_NotificationManagerImpl::OngoingImpl(const String& messageText, const String& launchArguments) const -{ - return NotifyImpl(messageText, -1, launchArguments, true); -} - -result -_NotificationManagerImpl::OngoingImpl(const AppId& appId, const String& messageText, const String& launchArguments) const -{ - return NotifyImpl(appId, messageText, -1, launchArguments, true); -} - -result -_NotificationManagerImpl::NotifyImpl(const String& messageText, int badgeNumber, - const String& launchArguments, - bool isOngoing) const +_NotificationManagerImpl::~_NotificationManagerImpl(void) { - result r = E_SUCCESS; - int retcode = 0; - char* pMsg = null; - char* pkgname = NULL; - char* pIcon = NULL; - bundle* pKb = NULL; - service_h svc = NULL; - _AppArg arg; - String iconPath; - ui_notification_h core = NULL; - PackageAppInfo* pPackageAppInfo = NULL; - - if (!messageText.IsEmpty()) + if (__pNotiImpl) { - SysTryReturnResult(NID_APP, - messageText.GetLength() <= MAX_NOTIFICATION_MESSAGE_LENGTH, E_INVALID_ARG, - "MessageText is greater than MAX_NOTIFICATION_MESSAGE_LENGTH."); - - retcode = ui_notification_create(isOngoing, &core); - SysTryReturnResult(NID_APP, retcode == UI_NOTIFICATION_ERROR_NONE, E_SYSTEM, "Notification creation error : 0x%x.", retcode); - - pMsg = _StringConverter::CopyToCharArrayN(messageText); - - int ret = ui_notification_set_content(core, pMsg); - SysTryLog(NID_APP, ret == UI_NOTIFICATION_ERROR_NONE, "Setting notification content failure : %d.", ret); + typedef void (*NotificationDeletor)(_INotificationManagerImpl*); - const String& currappId = _AppInfo::GetApplicationId(); - - pPackageAppInfo = _PackageManagerImpl::GetInstance()->GetPackageAppInfoN(currappId); - iconPath = _PackageAppInfoImpl::GetInstance(pPackageAppInfo)->GetAppNotificationIconPath(); - - if (!iconPath.IsEmpty() && File::IsFileExist(iconPath)) + NotificationDeletor pDeleter = reinterpret_cast(__lib.GetProcAddress(L"DeleteNotificationManagerInstance")); + if (pDeleter) { - pIcon = _StringConverter::CopyToCharArrayN(iconPath); - r = ConvertNotificationResult(ui_notification_set_icon(core, pIcon)); - SysTryLog(NID_APP, !IsFailed(r), "[%s] Notification set icon failed.", GetErrorMessage(r)); + (*pDeleter)(__pNotiImpl); + SysLog(NID_APP, "NotificationManager stub deleted."); } - - app_get_package(&pkgname); - SysTryCatch(NID_APP, pkgname != NULL, r = E_OBJ_NOT_FOUND, E_OBJ_NOT_FOUND, "[E_OBJ_NOT_FOUND] Cannot acquire package name for current application."); - - r = arg.Construct(launchArguments); - SysTryCatch(NID_APP, !IsFailed(r), , r, "[%s] Propagating.", GetErrorMessage(r)); - - pKb = arg.GetBundle(); - service_create_request(pKb, &svc); - - service_set_package(svc, pkgname); - r = ConvertNotificationResult(ui_notification_set_service(core, svc)); - SysTryLog(NID_APP, !IsFailed(r), "[%s] Notification set service failed.", GetErrorMessage(r)); - - SysLog(NID_APP, "Sending notification[%ls] for package %s.", messageText.GetPointer(), pkgname); - - r = ConvertNotificationResult(ui_notification_post(core)); - SysTryLog(NID_APP, !IsFailed(r), "[%s] Notification post failure.", GetErrorMessage(r)); } - - if (badgeNumber >= 0) - { - badge_error_e badgeError = badge_set_count(appinfo_get_appid(), badgeNumber); - SysTryLog(NID_APP, badgeError == BADGE_ERROR_NONE, "badge_set_count failed(%d).", badgeError); - } - -CATCH: - delete pPackageAppInfo; - delete[] pMsg; - delete[] pIcon; - - if (pkgname) - { - free(pkgname); - } - if (core) - { - ui_notification_destroy(core); - } - service_destroy(svc); - return r; } + result -_NotificationManagerImpl::NotifyImpl(const AppId& appId, const String& messageText, int badgeNumber, - const String& launchArguments, - bool isOngoing) const +_NotificationManagerImpl::Construct(void) { - result r = E_SUCCESS; - int retcode = 0; - String iconPath; - char* pMsg = null; - char* pIcon = null; - char* pName = null; - ui_notification_h core = NULL; - char buffer[256]; - bundle* pKb = NULL; - service_h svc = NULL; - _AppArg arg; - PackageAppInfo* pPackageAppInfo = null; - - memset(buffer, 0, 256); - - bool inInstalled = _Aul::IsInstalled(appId); - SysTryReturnResult(NID_APP, inInstalled == true, E_APP_NOT_INSTALLED, "The application %ls is not installed", appId.GetPointer()); - - if (!isOngoing || !messageText.IsEmpty()) - { - SysTryReturnResult(NID_APP, - messageText.GetLength() <= MAX_NOTIFICATION_MESSAGE_LENGTH, E_INVALID_ARG, - "MessageText is greater than MAX_NOTIFICATION_MESSAGE_LENGTH."); - - retcode = ui_notification_create(isOngoing, &core); - SysTryReturnResult(NID_APP, retcode == UI_NOTIFICATION_ERROR_NONE, E_SYSTEM, "Notification creation error : 0x%x.", retcode); - - pMsg = _StringConverter::CopyToCharArrayN(messageText); - - int ret = ui_notification_set_content(core, pMsg); - SysTryLog(NID_APP, ret == UI_NOTIFICATION_ERROR_NONE, "Setting notification content failure : %d.", ret); + result r = __lib.Construct(OSP_SHELL_SONAME, _LIBRARY_LOAD_OPTION_NODELETE | _LIBRARY_LOAD_OPTION_LAZY); + SysTryReturnResult(NID_APP, !IsFailed(r), E_SYSTEM, "A system error has occurred : %s.", GetErrorMessage(r)); - snprintf(buffer, 256, "%ls", appId.GetPointer()); - - pPackageAppInfo = _PackageManagerImpl::GetInstance()->GetPackageAppInfoN(appId); - if (pPackageAppInfo) - { - iconPath = pPackageAppInfo->GetAppNotificationIconPath(); - - if (!iconPath.IsEmpty() && File::IsFileExist(iconPath)) - { - pIcon = _StringConverter::CopyToCharArrayN(iconPath); - r = ConvertNotificationResult(ui_notification_set_icon(core, pIcon)); - SysTryLog(NID_APP, !IsFailed(r), "[%s] Notification set icon failed.", GetErrorMessage(r)); - } - else - { - iconPath = pPackageAppInfo->GetAppMenuIconPath(); - pIcon = _StringConverter::CopyToCharArrayN(iconPath); - r = ConvertNotificationResult(ui_notification_set_icon(core, pIcon)); - SysTryLog(NID_APP, !IsFailed(r), "[%s] Notification Set icon path failed.", GetErrorMessage(r)); - } - - const String& displayName = pPackageAppInfo->GetAppDisplayName(); - pName = _StringConverter::CopyToCharArrayN(displayName); - - r = ConvertNotificationResult(ui_notification_set_title(core, pName)); - SysTryLog(NID_APP, !IsFailed(r), "[%s] Notification set title failed.", GetErrorMessage(r)); - } - else - { - SysLog(NID_APP, "No packageInfo found for %ls", appId.GetPointer()); - } + typedef _INotificationManagerImpl* (*NotificationCreator)(void); + NotificationCreator pCreator = reinterpret_cast(__lib.GetProcAddress(L"CreateNotificationManagerInstance")); + SysTryReturnResult(NID_APP, pCreator != null, E_SYSTEM, "No notification instance factory found."); + __pNotiImpl = (*pCreator)(); - r = arg.Construct(launchArguments); - SysTryCatch(NID_APP, !IsFailed(r), , r, "[%s] Propagating.", GetErrorMessage(r)); - - pKb = arg.GetBundle(); - service_create_request(pKb, &svc); - - service_set_app_id(svc, buffer); - r = ConvertNotificationResult(ui_notification_set_service(core, svc)); - SysTryLog(NID_APP, !IsFailed(r), "[%s] Notification set service failed.", GetErrorMessage(r)); - - SysLog(NID_APP, "Sending notification[%ls] for package %s.", messageText.GetPointer(), buffer); - - r = ConvertNotificationResult(ui_notification_post(core)); - SysTryLog(NID_APP, !IsFailed(r), "[%s] Notification post failure.", GetErrorMessage(r)); - } - - if (badgeNumber >= 0) - { - badge_error_e badgeError = badge_set_count(buffer, badgeNumber); - SysTryLog(NID_APP, badgeError == BADGE_ERROR_NONE, "badge_set_count failed(%d).", badgeError); - } - -CATCH: - delete pPackageAppInfo; - delete[] pMsg; - delete[] pIcon; - delete[] pName; - - if (core) - { - ui_notification_destroy(core); - } - service_destroy(svc); return r; } -result -_NotificationManagerImpl::RemoveImpl(const char* pAppId, notification_type_e type) +int +_NotificationManagerImpl::GetBadgeNumber(void) const { - result r = E_SUCCESS; + SysTryReturn(NID_APP, __pNotiImpl != null, -1, E_SYSTEM, "[E_SYSTEM] Notification interface error."); - notification_error_e err = notification_delete_all_by_type(pAppId, type); - switch (err) + int res = __pNotiImpl->GetBadgeNumber(); + if (GetLastResult() == E_OPERATION_FAILED) { - case NOTIFICATION_ERROR_NONE: - r = E_SUCCESS; - break; - - case NOTIFICATION_ERROR_INVALID_DATA: - r = E_INVALID_ARG; - break; - - default: - r = E_SYSTEM; - break; + SetLastResult(E_SUCCESS); + return -1; } - - return r; + return res; } result -_NotificationManagerImpl::RemoveImpl(const AppId& appId, bool isOngoing) -{ - const bool isValidAppId = _Aul::IsInstalled(appId); - SysTryReturnResult(NID_APP, isValidAppId, E_APP_NOT_INSTALLED, "The application %ls is not installed", appId.GetPointer()); - - std::unique_ptr pAppId(_StringConverter::CopyToCharArrayN(appId)); - const notification_type_e notiType = (isOngoing) ? NOTIFICATION_TYPE_ONGOING : NOTIFICATION_TYPE_NOTI; - - return RemoveImpl(pAppId.get(), notiType); -} - -result _NotificationManagerImpl::Notify(int badgeNumber) const { - SysTryReturnResult(NID_APP, badgeNumber >= 0, E_INVALID_ARG, "BadgeNumber is less than 0."); - - if (badgeNumber > MAX_NOTIFICATION_BADGE_NUMBER) - { - badgeNumber = MAX_NOTIFICATION_BADGE_NUMBER; - } + SysTryReturnResult(NID_APP, __pNotiImpl != null, E_SYSTEM, "Notification interface error."); + SysTryReturnResult(NID_APP, badgeNumber >= 0, E_INVALID_ARG, "badgeNumber is less than 0."); String messageText = String(L""); String appMessage = String(L""); - return NotifyImpl(messageText, badgeNumber, appMessage, false); + return __pNotiImpl->Notify(messageText, badgeNumber, appMessage); } + result _NotificationManagerImpl::Notify(const String& messageText) const { - SysTryReturnResult(NID_APP, messageText.GetLength() > 0, E_INVALID_ARG, "MessageText is less than 0."); + SysTryReturnResult(NID_APP, __pNotiImpl != null, E_SYSTEM, "Notification interface error."); String appMessage = String(L""); - return NotifyImpl(messageText, -1, appMessage, false); + return __pNotiImpl->Notify(messageText, -1, appMessage); } + result _NotificationManagerImpl::Notify(const String& messageText, int badgeNumber) const { - SysTryReturnResult(NID_APP, badgeNumber >= 0, E_INVALID_ARG, "BadgeNumber is less than 0."); - SysTryReturnResult(NID_APP, messageText.GetLength() > 0, E_INVALID_ARG, "MessageText is less than 0."); - - if (badgeNumber > MAX_NOTIFICATION_BADGE_NUMBER) - { - badgeNumber = MAX_NOTIFICATION_BADGE_NUMBER; - } + SysTryReturnResult(NID_APP, __pNotiImpl != null, E_SYSTEM, "Notification interface error."); + SysTryReturnResult(NID_APP, badgeNumber >= 0, E_INVALID_ARG, "badgeNumber is less than 0."); String appMessage = String(L""); - return NotifyImpl(messageText, badgeNumber, appMessage, false); + return __pNotiImpl->Notify(messageText, badgeNumber, appMessage); } + result _NotificationManagerImpl::Notify(const String& messageText, int badgeNumber, const String& launchArguments) const { - SysTryReturnResult(NID_APP, badgeNumber >= 0, E_INVALID_ARG, "BadgeNumber is less than 0."); - SysTryReturnResult(NID_APP, messageText.GetLength() > 0, E_INVALID_ARG, "MessageText is less than 0."); - SysTryReturnResult(NID_APP, - launchArguments != null && launchArguments.GetLength() > 0, E_INVALID_ARG, - "launchArguments is less than 0."); - - SysTryReturnResult(NID_APP, - launchArguments.GetLength() <= MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH, E_INVALID_ARG, - "launchArguments is greater than MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH."); + SysTryReturnResult(NID_APP, __pNotiImpl != null, E_SYSTEM, "Notification interface error."); + SysTryReturnResult(NID_APP, badgeNumber >= 0, E_INVALID_ARG, "badgeNumber is less than 0."); - if (badgeNumber > MAX_NOTIFICATION_BADGE_NUMBER) - { - badgeNumber = MAX_NOTIFICATION_BADGE_NUMBER; - } - - return NotifyImpl(messageText, badgeNumber, launchArguments, false); + return __pNotiImpl->Notify(messageText, badgeNumber, launchArguments); } int _NotificationManagerImpl::GetBadgeNumber(const AppId& appId) const { - bool b = _Aul::IsInstalled(appId); - - SysTryReturn(NID_APP, b == true, -1, E_OBJ_NOT_FOUND, "[E_OBJ_NOT_FOUND] The application %ls is not installed", - appId.GetPointer()); - - char buffer[256]; - unsigned int count = 0; + SysTryReturn(NID_APP, __pNotiImpl != null, -1, E_SYSTEM, "[E_SYSTEM] Notification interface error."); - memset(buffer, 0, 256); - snprintf(buffer, 256, "%ls", appId.GetPointer()); - - std::unique_ptr pAppId(_StringConverter::CopyToCharArrayN(appId)); - - badge_error_e badgeError = badge_get_count(pAppId.get(), &count); - - if (badgeError == BADGE_ERROR_NONE) + const int ret = __pNotiImpl->GetBadgeNumber(appId); + result r = GetLastResult(); + if (r == E_APP_NOT_INSTALLED) { - SysLog(NID_APP, "badge_get_count(%d)", count); + SetLastResult(E_OBJ_NOT_FOUND); } - else + + if (GetLastResult() == E_OPERATION_FAILED) { - SysLog(NID_APP, "badge_get_count failed(%d).", badgeError); + SetLastResult(E_SUCCESS); return -1; } - - return count; + return ret; } result _NotificationManagerImpl::NotifyOnBehalf(const AppId& appId, int badgeNumber) const { + SysTryReturnResult(NID_APP, __pNotiImpl != null, E_SYSTEM, "Notification interface error."); SysTryReturnResult(NID_APP, badgeNumber >= 0, E_INVALID_ARG, "BadgeNumber is less than 0."); String messageText = String(L""); String appMessage = String(L""); - return NotifyImpl(appId, messageText, badgeNumber, appMessage); + + return __pNotiImpl->NotifyByAppId(appId, messageText, -1, appMessage); } + result _NotificationManagerImpl::NotifyOnBehalf(const AppId& appId, const String& messageText) const { - SysTryReturnResult(NID_APP, messageText.GetLength() > 0, E_INVALID_ARG, "MessageText is less than 0."); + SysTryReturnResult(NID_APP, __pNotiImpl != null, E_SYSTEM, "Notification interface error."); - return NotifyImpl(appId, messageText, -1, String(L"")); + return __pNotiImpl->NotifyByAppId(appId, messageText, -1, String(L"")); } + result _NotificationManagerImpl::NotifyOnBehalf(const AppId& appId, const String& messageText, int badgeNumber) const { + SysTryReturnResult(NID_APP, __pNotiImpl != null, E_SYSTEM, "Notification interface error."); SysTryReturnResult(NID_APP, badgeNumber >= 0, E_INVALID_ARG, "BadgeNumber is less than 0."); - SysTryReturnResult(NID_APP, messageText.GetLength() > 0, E_INVALID_ARG, "MessageText is less than 0."); - return NotifyImpl(appId, messageText, badgeNumber, String(L"")); + return __pNotiImpl->NotifyByAppId(appId, messageText, badgeNumber, String(L"")); } + result _NotificationManagerImpl::NotifyOnBehalf(const AppId& appId, const String& messageText, const String& launchArguments) const { - SysTryReturnResult(NID_APP, messageText.GetLength() > 0, E_INVALID_ARG, "MessageText is less than 0."); - SysTryReturnResult(NID_APP, launchArguments.GetLength() > 0, E_INVALID_ARG, "launchArguments is less than 0."); - SysTryReturnResult(NID_APP, - launchArguments.GetLength() <= MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH, E_INVALID_ARG, - "launchArguments is greater than MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH."); + SysTryReturnResult(NID_APP, __pNotiImpl != null, E_SYSTEM, "Notification interface error."); + SysTryReturnResult(NID_APP, launchArguments.GetLength() <= MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH, E_INVALID_ARG, + "launchArguments is greater than MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH."); - return NotifyImpl(appId, messageText, -1, launchArguments); + return __pNotiImpl->NotifyByAppId(appId, messageText, -1, launchArguments); } + result _NotificationManagerImpl::NotifyOnBehalf(const AppId& appId, const String& messageText, int badgeNumber, const String& launchArguments) const { + SysTryReturnResult(NID_APP, __pNotiImpl != null, E_SYSTEM, "Notification interface error."); SysTryReturnResult(NID_APP, badgeNumber >= 0, E_INVALID_ARG, "BadgeNumber is less than 0."); - SysTryReturnResult(NID_APP, messageText.GetLength() > 0, E_INVALID_ARG, "MessageText is less than 0."); - SysTryReturnResult(NID_APP, launchArguments.GetLength() > 0, E_INVALID_ARG, "launchArguments is less than 0."); - SysTryReturnResult(NID_APP, - launchArguments.GetLength() <= MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH, E_INVALID_ARG, - "launchArguments is greater than MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH."); - return NotifyImpl(appId, messageText, badgeNumber, launchArguments); + SysTryReturnResult(NID_APP, launchArguments.GetLength() <= MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH, E_INVALID_ARG, + "launchArguments is greater than MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH."); + + return __pNotiImpl->NotifyByAppId(appId, messageText, badgeNumber, launchArguments); } + result _NotificationManagerImpl::NotifyOngoingActivity(const String& messageText) const { - SysTryReturnResult(NID_APP, messageText.GetLength() > 0, E_INVALID_ARG, "MessageText is less than 0."); + SysTryReturnResult(NID_APP, __pNotiImpl != null, E_SYSTEM, "Notification interface error."); - return OngoingImpl(messageText, String(L"")); + return __pNotiImpl->NotifyOngoingActivity(messageText); } + result _NotificationManagerImpl::NotifyOngoingActivity(const String& messageText, const String& launchArguments) const { - SysTryReturnResult(NID_APP, messageText.GetLength() > 0, E_INVALID_ARG, "MessageText is less than 0."); - SysTryReturnResult(NID_APP, launchArguments.GetLength() > 0, E_INVALID_ARG, "launchArguments is less than 0."); - SysTryReturnResult(NID_APP, - launchArguments.GetLength() <= MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH, E_INVALID_ARG, - "launchArguments is greater than MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH."); + SysTryReturnResult(NID_APP, __pNotiImpl != null, E_SYSTEM, "Notification interface error."); + SysTryReturnResult(NID_APP, launchArguments.GetLength() <= MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH, E_INVALID_ARG, + "launchArguments is greater than MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH."); - return OngoingImpl(messageText, launchArguments); + return __pNotiImpl->NotifyOngoingActivity(messageText, launchArguments); } + result _NotificationManagerImpl::NotifyOngoingActivityOnBehalf(const AppId& appId, const String& messageText) const { - SysTryReturnResult(NID_APP, messageText.GetLength() > 0, E_INVALID_ARG, "MessageText is less than 0."); + SysTryReturnResult(NID_APP, __pNotiImpl != null, E_SYSTEM, "Notification interface error."); + SysTryReturnResult(NID_APP, !messageText.IsEmpty(), E_INVALID_ARG, "MessageText is less than 0."); - return OngoingImpl(appId, messageText, String(L"")); + return __pNotiImpl->NotifyOngoingActivityByAppId(appId, messageText, String(L"")); } + result _NotificationManagerImpl::NotifyOngoingActivityOnBehalf(const AppId& appId, const String& messageText, const String& launchArguments) const { - SysTryReturnResult(NID_APP, messageText.GetLength() > 0, E_INVALID_ARG, "MessageText is less than 0."); - SysTryReturnResult(NID_APP, launchArguments.GetLength() > 0, E_INVALID_ARG, "launchArguments is less than 0."); - SysTryReturnResult(NID_APP, - launchArguments.GetLength() <= MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH, E_INVALID_ARG, - "launchArguments is greater than MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH."); + SysTryReturnResult(NID_APP, __pNotiImpl != null, E_SYSTEM, "Notification interface error."); + SysTryReturnResult(NID_APP, !messageText.IsEmpty(), E_INVALID_ARG, "MessageText is less than 0."); - return OngoingImpl(appId, messageText, launchArguments); + return __pNotiImpl->NotifyOngoingActivityByAppId(appId, messageText, launchArguments); } + result _NotificationManagerImpl::RemoveOngoingActivityNotification(void) { - return RemoveImpl(NULL, NOTIFICATION_TYPE_ONGOING); + SysTryReturnResult(NID_APP, __pNotiImpl != null, E_SYSTEM, "Notification interface error."); + + return __pNotiImpl->RemoveOngoingActivityNotification(); } + result _NotificationManagerImpl::RemoveOngoingActivityNotificationOnBehalf(const AppId& appId) { - return RemoveImpl(appId, true); + SysTryReturnResult(NID_APP, __pNotiImpl != null, E_SYSTEM, "Notification interface error."); + + return __pNotiImpl->RemoveOngoingActivityNotificationByAppId(appId); } + result _NotificationManagerImpl::RemoveNotification(void) { - return RemoveImpl(NULL, NOTIFICATION_TYPE_NOTI); + SysTryReturnResult(NID_APP, __pNotiImpl != null, E_SYSTEM, "Notification interface error."); + + return __pNotiImpl->RemoveNotification(); } + result _NotificationManagerImpl::RemoveNotificationOnBehalf(const AppId& appId) { - return RemoveImpl(appId, false); + SysTryReturnResult(NID_APP, __pNotiImpl != null, E_SYSTEM, "Notification interface error."); + + return __pNotiImpl->RemoveNotificationByAppId(appId); } }; diff --git a/src/app/FApp_NotificationManagerImpl.h b/src/app/FApp_NotificationManagerImpl.h index 77868e8..af580a0 100644 --- a/src/app/FApp_NotificationManagerImpl.h +++ b/src/app/FApp_NotificationManagerImpl.h @@ -22,16 +22,17 @@ #ifndef _FAPP_INTERNAL_NOTIFICATION_MANAGER_IMPL_H_ #define _FAPP_INTERNAL_NOTIFICATION_MANAGER_IMPL_H_ -#include - #include #include #include +#include + + namespace Tizen { namespace App { -class NotificationManager; +class _INotificationManagerImpl; class _NotificationManagerImpl { @@ -49,7 +50,7 @@ public: * * @since 1.0 */ - virtual ~_NotificationManagerImpl(void); + ~_NotificationManagerImpl(void); /** * Initializes this instance of %_NotificationManagerImpl. @@ -422,28 +423,14 @@ public: */ result RemoveNotificationOnBehalf(const AppId& appId); - static const _NotificationManagerImpl* GetInstance(const NotificationManager& notiMgr); - - static _NotificationManagerImpl* GetInstance(NotificationManager& notiMgr); - private: - result NotifyImpl(const Tizen::Base::String& messageText, int badgeNumber, const Tizen::Base::String& launchArguments, bool isOngoing = false) const; - - result NotifyImpl(const AppId& appId, const Tizen::Base::String& messageText, int badgeNumber, const Tizen::Base::String& launchArguments, bool isOngoing = false) const; - - inline result OngoingImpl(const Tizen::Base::String& messageText, const Tizen::Base::String& launchArguments) const; - - inline result OngoingImpl(const AppId& appId, const Tizen::Base::String& messageText, const Tizen::Base::String& launchArguments) const; - - result RemoveImpl(const AppId& appId, bool isOngoing); - - result RemoveImpl(const char* pAppId, notification_type_e type); - _NotificationManagerImpl(const _NotificationManagerImpl& rhs); _NotificationManagerImpl& operator =(const _NotificationManagerImpl& rhs); private: + _INotificationManagerImpl* __pNotiImpl; + Tizen::Base::Runtime::_LibraryImpl __lib; }; //_NotificationManagerImpl } } // Tizen::App diff --git a/src/app/FApp_RequestManagerT.cpp b/src/app/FApp_RequestManagerT.cpp index 8d1ea46..d1ba185 100644 --- a/src/app/FApp_RequestManagerT.cpp +++ b/src/app/FApp_RequestManagerT.cpp @@ -21,11 +21,11 @@ #include -#include - #include "FApp_RequestManagerT.h" #include "FApp_LaunchInfo.h" #include "FApp_AppArg.h" +#include "FApp_IAppControlPluginProvider.h" + using namespace Tizen::Base::Runtime; @@ -41,10 +41,13 @@ _ResultInfo::~_ResultInfo(void) _InProcessInfo::~_InProcessInfo(void) { - delete pLib; + if (pProvider) + { + pProvider->Release(); + } } -_LaunchInfo::~_LaunchInfo(void) +_DataControlInfo::~_DataControlInfo(void) { delete pArg; } @@ -162,6 +165,32 @@ _RequestManagerT::FindItem(int reqId) const return (r == E_SUCCESS) ? pItem : null; } +template T* +_RequestManagerT::FindItemWithListener(Pred pred, IEventListener* pListener) const +{ + RequestListEnumType* pIter = __requestList.GetMapEnumeratorN(); + if (pIter == null) + { + return null; + } + + while (pIter->MoveNext() == E_SUCCESS) + { + T* pInfo = null; + result r = pIter->GetValue(pInfo); + + if (pInfo) + { + if (pred(*pInfo, pListener)) + { + return pInfo; + } + } + } + + return null; +} + // specialization template<> @@ -218,7 +247,7 @@ _RequestManagerT<_ResultInfo>::RemoveItem(int reqId) // explicit template initialization -template class _RequestManagerT<_LaunchInfo>; +template class _RequestManagerT<_DataControlInfo>; template class _RequestManagerT<_InProcessInfo>; template class _RequestManagerT<_ResultInfo>; diff --git a/src/app/inc/FAppPkg_PackageParser.h b/src/app/inc/FAppPkg_PackageParser.h index c445f57..09ab5b9 100755 --- a/src/app/inc/FAppPkg_PackageParser.h +++ b/src/app/inc/FAppPkg_PackageParser.h @@ -145,6 +145,7 @@ private: bool ParseAppAttribute(_PackageXmlAttribute* pAttr, bool isUiApp); bool FindElement(const char* pName); + result GetLocale(Tizen::Base::String& value); private: _PackageInfoImpl* __pPackageInfoImpl; diff --git a/src/app/inc/FApp_AppArg.h b/src/app/inc/FApp_AppArg.h index f61782d..49975e2 100644 --- a/src/app/inc/FApp_AppArg.h +++ b/src/app/inc/FApp_AppArg.h @@ -40,7 +40,6 @@ class HashMap; namespace Tizen { namespace App { -class _AppControlImpl; class _AppMessageImpl; class _SqlDataControlImpl; class _MapDataControlImpl; @@ -86,12 +85,6 @@ public: result Construct(const Tizen::Base::String* pUri, const Tizen::Base::String* pMime, const Tizen::Base::Collection::IMap* pMap); - result Construct(const _AppControlImpl& ac, const Tizen::Base::Collection::IList* pList); - - result Construct(const _AppControlImpl& ac, const Tizen::Base::String* pUri, const Tizen::Base::String* pMime, const Tizen::Base::Collection::IMap* pMap); - - result Construct(const _AppMessageImpl& msg, const Tizen::Base::String& oId, const Tizen::Base::String* pUri, const Tizen::Base::String* pMime); - result Construct(const _SqlDataControlImpl& dc, _DataControlRequestType requestType, const Tizen::Base::Collection::IList* pList); result Construct(const _MapDataControlImpl& dc, _DataControlRequestType requestType, const Tizen::Base::Collection::IList* pList); @@ -100,7 +93,7 @@ public: result ConstructResult(const _AppArg& arg, const Tizen::Base::Collection::IMap* pMap); - result Construct(bundle* b); + result Construct(const bundle* b); result ConstructForAppLaunchCondition(const Tizen::Base::String& condition, const Tizen::Base::Collection::IList* pList); result ConstructForAppLaunchCondition(const Tizen::Base::String& condition, const Tizen::Base::Collection::IList* pList, const Tizen::Base::Collection::IMap* pMap); @@ -130,7 +123,10 @@ public: return GetCallerPid(__pBundle); } - AppId GetCalleeAppId(void) const; + AppId GetCalleeAppId(void) const + { + return GetCalleeAppId(__pBundle); + } void Print() const { @@ -186,6 +182,8 @@ public: static void UpdateServiceApp(bundle* b); static bool IsServiceApp(bundle* b); + + static AppId GetCalleeAppId(bundle* b); static result UpdateWindowHandle(bundle* b, long handle); @@ -208,12 +206,6 @@ private: static result CreateLaunchArg(bundle* b, const Tizen::Base::Collection::IList* pList); - static result CreateAppControlArg(bundle* b, const _AppControlImpl& ac, const Tizen::Base::Collection::IList* pList); - - static result CreateAppControlArg(bundle* b, const _AppControlImpl& ac, const Tizen::Base::String* pUri, const Tizen::Base::String* pMime, const Tizen::Base::Collection::IMap* pList); - - static result CreateAppControlArg(bundle* b, const Tizen::Base::String& oId, const Tizen::Base::String* pUri, const Tizen::Base::String* pMime, const Tizen::Base::Collection::IMap* pMap); - static result CreateSqlDataControlArg(bundle* b, const _SqlDataControlImpl& dc, _DataControlRequestType requestType, const Tizen::Base::Collection::IList* pList); static result CreateMapDataControlArg(bundle* b, const _MapDataControlImpl& dc, _DataControlRequestType requestType, const Tizen::Base::Collection::IList* pList); diff --git a/src/app/inc/FApp_AppControlImpl.h b/src/app/inc/FApp_AppControlImpl.h index abee74d..4996ccf 100644 --- a/src/app/inc/FApp_AppControlImpl.h +++ b/src/app/inc/FApp_AppControlImpl.h @@ -22,8 +22,6 @@ #ifndef _FAPP_INTERNAL_APP_CONTROL_IMPL_H_ #define _FAPP_INTERNAL_APP_CONTROL_IMPL_H_ -#include - #include #include #include @@ -40,6 +38,7 @@ typedef struct _bundle_t bundle; namespace Tizen { namespace Base { class String; } } namespace Tizen { namespace Base { namespace Collection { class IList; } } } +namespace Tizen { namespace Base { namespace Runtime { class IEventListener; } } } namespace Tizen { namespace App { @@ -47,22 +46,18 @@ namespace Tizen { namespace App class AppControl; class IAppControlEventListener; class IAppControlResponseListener; -class _AppArg; +class _IAppControlPluginProvider; +class _AppMessageImpl; enum _AppControlProperty { _APPCONTROL_PROPERTY_NONE = 0x0, _APPCONTROL_PROPERTY_PUBLIC = 0x01, - _APPCONTROL_PROPERTY_PERSISTENT_DLL = 0x08, - _APPCONTROL_PROPERTY_SLP = 0x100, - _APPCONTROL_PROPERTY_OSP = 0x200, - _APPCONTROL_PROPERTY_ALIAS = 0x400, - _APPCONTROL_PROPERTY_APPID_CHANGE = 0x800, _APPCONTROL_PROPERTY_SUBMODE = 0x1000, _APPCONTROL_PROPERTY_SERVICE_CALLEE = 0x2000, }; -class _OSP_EXPORT_ _AppControlImpl +class _OSP_LOCAL_ _AppControlImpl : public Tizen::Base::Object , public Tizen::App::_IAppControlResponseEventListener , virtual public Tizen::Base::Runtime::IEventListener @@ -71,53 +66,49 @@ public: /** * AppControl delegate constructor */ - static AppControl* CreateN(const Tizen::Base::String& path, const Tizen::Base::String& aId, const Tizen::Base::String& oId, const Tizen::Base::String& name, int prop); - - /** - * AppControl delegate constructor - */ - static AppControl* CreateN(const AppId& appId, const Tizen::Base::String& operationId, bool changeAppId); - - /** - * AppControl delegate constructor - */ - static AppControl* CreateN(const AppControl& ac); + static AppControl* CreateN(const Tizen::Base::String& path, const Tizen::Base::String& aId, const Tizen::Base::String& oId, int prop); /** * Internal GetImpl() method. */ - static const _AppControlImpl* GetInstance(const AppControl& ac); + static const _AppControlImpl* GetInstance(const AppControl& ac) + { + return ac.__pAppControlImpl; + } /** * Internal GetImpl() method. */ - static _AppControlImpl* GetInstance(AppControl& ac); + static _AppControlImpl* GetInstance(AppControl& ac) + { + return ac.__pAppControlImpl; + } /** - * Starts the resolved application control. @n - * Once the application starts, it goes to the background and the target - * application control is displayed. - * - * @return An error code - * @param[in] pDataList The data list to deliver to the resolved application control @n - * The maximum size of the list is 4096 bytes. - * @param[in] pListener The application control callback listener @n - * Some application controls need to get the callback result by implementing - * the IAppControlEventListener interface. - * @exception E_SUCCESS The method is successful. - * @exception E_MAX_EXCEEDED The size of @c pDataList has exceeded the maximum limit. - * @exception E_OUT_OF_MEMORY The memory is insufficient. - * @exception E_OBJ_NOT_FOUND The target application control resource is not found. - * @exception E_IN_PROGRESS The application control is in progress: @n - * - The application has already started an _AppControlImpl. @n - * - The target application has already started. - * @exception E_SYSTEM A system error has occurred. - * @remarks If the %IAppControlEventListener instance (@c pListener) needs to get the - * callback result for an application control, it should be valid till - * IAppControlEventListener::OnAppControlCompleted() is invoked. - * For example, a form object listener should not be deleted before the - * system invokes IAppControlEventListener::OnAppControlCompleted(). - */ + * Starts the resolved application control. @n + * Once the application starts, it goes to the background and the target + * application control is displayed. + * + * @return An error code + * @param[in] pDataList The data list to deliver to the resolved application control @n + * The maximum size of the list is 4096 bytes. + * @param[in] pListener The application control callback listener @n + * Some application controls need to get the callback result by implementing + * the IAppControlEventListener interface. + * @exception E_SUCCESS The method is successful. + * @exception E_MAX_EXCEEDED The size of @c pDataList has exceeded the maximum limit. + * @exception E_OUT_OF_MEMORY The memory is insufficient. + * @exception E_OBJ_NOT_FOUND The target application control resource is not found. + * @exception E_IN_PROGRESS The application control is in progress: @n + * - The application has already started an _AppControlImpl. @n + * - The target application has already started. + * @exception E_SYSTEM A system error has occurred. + * @remarks If the %IAppControlEventListener instance (@c pListener) needs to get the + * callback result for an application control, it should be valid till + * IAppControlEventListener::OnAppControlCompleted() is invoked. + * For example, a form object listener should not be deleted before the + * system invokes IAppControlEventListener::OnAppControlCompleted(). + */ result Start(const Tizen::Base::Collection::IList* pDataList, IAppControlEventListener* pListener); /** @@ -151,28 +142,37 @@ public: * * @return The name of the application providing this %_AppControlImpl instance */ - Tizen::Base::String GetAppName(void); + Tizen::Base::String GetAppName(void) const; /** * Gets the associated application ID. @n * * @return The application control ID */ - Tizen::Base::String GetAppId(void) const; + Tizen::Base::String GetAppId(void) const + { + return _appId; + } /** * Gets the associated application control provider ID. @n * * @return The application control provider ID */ - const Tizen::Base::String& GetAppControlProviderId(void) const; + Tizen::Base::String GetAppControlProviderId(void) const + { + return _appId; + } /** * Gets the associated operation ID. @n * * @return The operation ID */ - const Tizen::Base::String& GetOperationId(void) const; + Tizen::Base::String GetOperationId(void) const + { + return _opId; + } /** * Returns the associated application control categories. @@ -218,7 +218,7 @@ public: * @exception E_SYSTEM The method cannot proceed due to a severe system error. * @see IAppControlResponseListener, IAppControlProviderEventListener */ - static result FindAndStart(const Tizen::Base::String& operationId, const Tizen::Base::String* pUriPattern, const Tizen::Base::String* pDataType, const Tizen::Base::String* pCategory, const Tizen::Base::Collection::IMap* pExtraData, IAppControlResponseListener* pListener); + _OSP_EXPORT_ static result FindAndStart(const Tizen::Base::String& operationId, const Tizen::Base::String* pUriPattern, const Tizen::Base::String* pDataType, const Tizen::Base::String* pCategory, const Tizen::Base::Collection::IMap* pExtraData, IAppControlResponseListener* pListener); /** * Stops the event listener for receiving application control result. @@ -231,6 +231,8 @@ public: static result StartImplicit(bundle* pBundle, const Tizen::Base::Collection::IMap* pData, IAppControlResponseListener* pListener); + static result StartImplicit(const _AppMessageImpl& msg, Tizen::Base::Runtime::IEventListener* pListener, bool isLegacy); + bool IsPublic(void) const { return (_property & _APPCONTROL_PROPERTY_PUBLIC); @@ -243,7 +245,7 @@ public: virtual void OnAppControlResponseEventReceivedN(const Tizen::Base::Runtime::IEventArg* arg); private: - _AppControlImpl(const AppControl& value); + explicit _AppControlImpl(const AppControl& value); /** * This is the default constructor for this class. @@ -259,21 +261,13 @@ private: */ virtual ~_AppControlImpl(void); - result StartOsp(const Tizen::Base::Collection::IList* pDataList, IAppControlEventListener* pListener); - - result StartOsp(const Tizen::Base::String* pUriData, const Tizen::Base::String* pMimeType, const Tizen::Base::Collection::IMap* pExtraData, IAppControlResponseListener* pListener); - - result StartNative(const Tizen::Base::Collection::IList* pDataList, IAppControlEventListener* pListener); - - result StartNative(const Tizen::Base::String* pUriData, const Tizen::Base::String* pMimeType, const Tizen::Base::Collection::IMap* pExtraData, IAppControlResponseListener* pListener); - - static result InvokeStartAppControl(Tizen::Base::Runtime::_LibraryImpl& lib, int req, const Tizen::Base::String& appId, const Tizen::Base::String& oId, const Tizen::Base::String* pUri, const Tizen::Base::String* pMime, const Tizen::Base::Collection::IMap* pMap); + static _IAppControlPluginProvider* GetAppControlPluginProvider(const Tizen::Base::String& path); - static result InvokeStartAppControl(Tizen::Base::Runtime::_LibraryImpl& lib, int req, const Tizen::Base::String& appId, const Tizen::Base::String& oId, const Tizen::Base::Collection::IList* pList); + static result InvokeStartAppControl(_IAppControlPluginProvider* pProvider, int req, const Tizen::Base::String& appId, const Tizen::Base::String& oId, const Tizen::Base::String* pUri, const Tizen::Base::String* pMime, const Tizen::Base::Collection::IMap* pMap); - static result AppControlCbLegacy(void* data, _AppArg* pArg, _AppArg* pResArg, service_result_e res, int prop, int reqId); + static result InvokeStartAppControl(_IAppControlPluginProvider* pProvider, int req, const Tizen::Base::String& appId, const Tizen::Base::String& oId, const Tizen::Base::Collection::IList* pList); - static result AppControlCb(void* data, _AppArg* pArg, _AppArg* pResArg, service_result_e res, int prop, int reqId); + static result InvokeStartAppControl(_IAppControlPluginProvider* pProvider, int req, const Tizen::Base::String& appId, const _AppMessageImpl& message); protected: static const unsigned long _LIBRARY_OPTION = Tizen::Base::Runtime::_LIBRARY_LOAD_OPTION_LAZY | Tizen::Base::Runtime::_LIBRARY_LOAD_OPTION_NODELETE; @@ -281,9 +275,9 @@ protected: const AppControl& _appControl; Tizen::Base::String _path; - Tizen::Base::String _provider; + Tizen::Base::String _appId; Tizen::Base::String _opId; - Tizen::Base::String _appName; + mutable Tizen::Base::String _appName; int _reqId; int _property; int _processId; @@ -292,7 +286,6 @@ private: Tizen::Base::Collection::ArrayListT __appControlResponseEventList; friend class AppControl; - friend class _AppArg; }; // _AppControlImpl } } // Tizen::App diff --git a/src/app/inc/FApp_AppControlManager.h b/src/app/inc/FApp_AppControlManager.h index 1c229c8..e3cf44b 100644 --- a/src/app/inc/FApp_AppControlManager.h +++ b/src/app/inc/FApp_AppControlManager.h @@ -112,7 +112,7 @@ public: virtual void OnAppControlEventReceivedN(int reqId, _AppArg* pAppArg, int res); - virtual void OnAppControlEventReceivedN(int reqId, int res, const Tizen::Base::Collection::IMap* pArgs, int prop); + virtual void OnAppControlPluginEventReceivedN(int reqId, int res, const AppId& appId, const Tizen::Base::String& oId, const Tizen::Base::Collection::IMap* pArgs, int prop); virtual void OnAppControlEventReceivedN(int reqId, const AppId& appId, const Tizen::Base::String& operationId); @@ -128,31 +128,31 @@ public: void FinishAppControl(int reqId, int res, Tizen::Base::Collection::IMap* pArg); + void FinishAppControl(int reqId, int res, const AppId& appId, const Tizen::Base::String& oId, Tizen::Base::Collection::IMap* pArg, int prop = 0); + result LaunchApp(const AppId& appId, _AppArg* pArg, int req = -1); int Launch(const AppId& appId, _AppArg* pArg, int req = -1); int Launch(const AppId& appId, _AppArg* pArg, AppSvcResFn pCb, void* pData, int req); - int Launch(const _AppMessageImpl& msg, const AppId& aId, const Tizen::Base::String& oId, const Tizen::Base::String* pUriData, const Tizen::Base::String* pMimeType, AppSvcResFn pCb, void* pData); - - result LaunchAppImplicit(_AppArg* pArg, int req); - - result LaunchPkg(const char* pkg_name, const char* op, const char* mime, const char* uri, AppSvcResFn pCb, void* data); + int Launch(const _AppMessageImpl& msg, AppSvcResFn pCb, void* pData, int req = -1); + /** + * Launch with pkgname.(osp-uifw : FUiCtrl_EditCopyPasteManager.cpp) + */ result LaunchPkg(_AppMessageImpl& msg, const char* pkg_name, const char* op, const char* mime, const char* uri, AppSvcResFn pCb, void* data); - int LaunchPkg(_AppMessageImpl& msg, const AppId& appId, const Tizen::Base::String& opId, const Tizen::Base::String* pUri, const Tizen::Base::String* pMime, AppSvcResFn pCb, void* data); + /** + * Launch with pkgname.(osp-app-controls) + */ + int LaunchPkg(_AppMessageImpl& msg, AppSvcResFn pCb, void* data); int Launch(_AppMessageImpl& msg, const char* pkg_name, const char* op, const char* mime, const char* uri, AppSvcResFn pCb, void* data); - result LaunchAppWithCondition(const AppId& appId, const Tizen::Base::String& condition, Tizen::Base::Collection::IList* pArgs); - result SendAppControlStartResponse(int req, const char* pValue, const char* pOp); - static bool IsAllowedAppControl(const char aTable[][2][96], int count, const Tizen::Base::String& aId, const Tizen::Base::String& oId); - - static AppId GetAliasAppId(const AppId& appId); + _OSP_LOCAL_ static Tizen::Base::String GetMimeTypeFromDataType(const Tizen::Base::String& dataType); static result GetMimeFromExt(const Tizen::Base::String& ext, Tizen::Base::String& out); @@ -162,6 +162,8 @@ public: static AppCtrlResult ConvertAppControlResultCode(int res); + void StopAppControlResponseListener(IAppControlResponseListener* pLisetener); + static void InvokeAppControlCompleteListener(IAppControlResponseListener& listener, const AppId& appId, const Tizen::Base::String& op, AppCtrlResult res, const Tizen::Base::Collection::IMap* pExtraData, bool noRaise); static void InvokeLegacyAppControlCompleteListener(IAppControlEventListener& listener, const AppId& appId, const Tizen::Base::String& op, const Tizen::Base::Collection::IList* pList, bool noRaise); @@ -179,10 +181,9 @@ private: private: _AppControlEvent __appControlEvent; - _RequestManagerT<_LaunchInfo> __launchManager; + _RequestManagerT<_DataControlInfo> __launchManager; _RequestManagerT<_InProcessInfo> __inAppManager; _RequestManagerT<_ResultInfo> __resultManager; - Tizen::Base::Collection::ArrayListT __listenerList; Tizen::Base::Collection::HashMapT __appControlResponseEventContainer; Tizen::Base::Collection::ArrayListT __appControlResponseEventList; diff --git a/src/app/inc/FApp_AppInfo.h b/src/app/inc/FApp_AppInfo.h index 48bfd3b..2916c44 100644 --- a/src/app/inc/FApp_AppInfo.h +++ b/src/app/inc/FApp_AppInfo.h @@ -231,6 +231,7 @@ private: AppState __appState; int __appType; int __appRootDirFd; + int __appSdDirFd; int __appHandlerType; int __parentWindowHandle; Tizen::Base::String __appRootPath; diff --git a/src/app/inc/FApp_AppMessageImpl.h b/src/app/inc/FApp_AppMessageImpl.h index c6f417d..6875d4d 100644 --- a/src/app/inc/FApp_AppMessageImpl.h +++ b/src/app/inc/FApp_AppMessageImpl.h @@ -45,11 +45,16 @@ namespace Tizen { namespace App * */ class _OSP_EXPORT_ _AppMessageImpl + : public Tizen::Base::Object { public: _AppMessageImpl(void); - ~_AppMessageImpl(void); + _AppMessageImpl(const Tizen::Base::String& appId, const Tizen::Base::String& oId, const Tizen::Base::String* pUri, const Tizen::Base::String* pMime, const Tizen::Base::Collection::IMap* pMap); + + explicit _AppMessageImpl(const bundle* pBundle); + + virtual ~_AppMessageImpl(void); _AppMessageImpl(const _AppMessageImpl& rhs); @@ -81,10 +86,43 @@ public: result RemoveData(const Tizen::Base::String& key); + Tizen::Base::String GetApplicationId(void) const { return GetApplicationId(GetBundle()); } + + result SetApplicationId(const Tizen::Base::String& appId) { return SetApplicationId(GetBundle(), appId); } + + Tizen::Base::String GetOperation(void) const { return GetOperation(GetBundle()); } + + result SetOperation(const char* pOperation) { return SetOperation(GetBundle(), pOperation); } + + result SetOperation(const Tizen::Base::String& operation) { return SetOperation(GetBundle(), operation); } + + Tizen::Base::String GetUri(void) const { return GetUri(GetBundle()); } + + result SetUri(const Tizen::Base::String& uri) { return SetUri(GetBundle(), uri); } + + Tizen::Base::String GetMime(void) const { return GetMime(GetBundle()); } + + result SetMime(const Tizen::Base::String& mime) { return SetMime(GetBundle(), mime); } + + result SetCategory(const Tizen::Base::String& category) { return SetCategory(GetBundle(), category); } + + + static Tizen::Base::String GetApplicationId(const bundle* pBundle); + + static result SetApplicationId(bundle* pBundle, const Tizen::Base::String& appId); + + static Tizen::Base::String GetOperation(const bundle* pBundle); + + static result SetOperation(bundle* pBundle, const char* pOperation); + static result SetOperation(bundle* pBundle, const Tizen::Base::String& operation); + static Tizen::Base::String GetUri(const bundle* pBundle); + static result SetUri(bundle* pBundle, const Tizen::Base::String& uri); + static Tizen::Base::String GetMime(const bundle* pBundle); + static result SetMime(bundle* pBundle, const Tizen::Base::String& mime); static result SetCategory(bundle* pBundle, const Tizen::Base::String& category); @@ -98,9 +136,11 @@ public: static result AddStringMap(bundle* pBundle, const Tizen::Base::Collection::IMap* pMap); static Tizen::Base::Collection::ArrayList* GetValueArrayN(bundle* pBundle, const char* pKey); + static Tizen::Base::Collection::ArrayList* GetValueArrayN(bundle* pBundle, const Tizen::Base::String& key); static result AddValueArray(bundle* pBundle, const char* pKey, const Tizen::Base::Collection::IList* pList); + static result AddValueArray(bundle* pBundle, const Tizen::Base::String& key, const Tizen::Base::Collection::IList* pList); private: diff --git a/src/app/inc/FApp_Aul.h b/src/app/inc/FApp_Aul.h index 08133c2..39abc37 100644 --- a/src/app/inc/FApp_Aul.h +++ b/src/app/inc/FApp_Aul.h @@ -60,6 +60,8 @@ public: static bool IsInstalled(const AppId& appId); + _OSP_LOCAL_ static Tizen::Base::String GetMainAppId(const char* appid); + _OSP_LOCAL_ static AppId GetRealAppId(const AppId& appId); public: diff --git a/src/app/inc/FApp_IAppControlPluginProvider.h b/src/app/inc/FApp_IAppControlPluginProvider.h new file mode 100644 index 0000000..170ccdd --- /dev/null +++ b/src/app/inc/FApp_IAppControlPluginProvider.h @@ -0,0 +1,78 @@ +// +// Copyright (c) 2012 Samsung Electronics Co., Ltd. +// +// Licensed under the Apache License, Version 2.0 (the License); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +/** + * @file FApp_IAppControlPluginProvider.h + * @brief This is the header file for _IAppControlPluginProvider class. + */ + +#ifndef _FAPP_INTERNAL_IAPP_CONTROL_PLUGIN_PROVIDER_H_ +#define _FAPP_INTERNAL_IAPP_CONTROL_PLUGIN_PROVIDER_H_ + +#include +#include + +namespace Tizen { namespace App { + +class _AppMessageImpl; + +/** +* @interface _IAppControlPluginProvider +* @brief This is a tagging interface that all event listeners must implement. +* +*/ +class _IAppControlPluginProvider + : virtual public Tizen::Base::Runtime::IEventListener +{ +public: + /** + * This is the destructor for this class. + */ + virtual ~_IAppControlPluginProvider(void) {} + + /** + * This method is called when the AppControl is about to start. + * + * @return An error code + * @param[in] req The request ID + * @param[in] appId Application ID + * @param[in] message AppControl request detail + * @param[out] pPid Output process ID + */ + virtual result StartAppControlPlugin(int req, const AppId& appId, const _AppMessageImpl& message, int* pPid) = 0; + + /** + * This method is called when the AppControl is about to stop. + * + * @return An error code + * @param[in] req The request ID + */ + virtual result StopAppControlPlugin(int req) = 0; + + /** + * Release the plugin instance itself + * + * @return An error code + */ + virtual result Release(void) =0; +}; // _IAppControlPluginProvider + +typedef _IAppControlPluginProvider* (*APP_CONTROL_PROVIDER_GET_FN)(void); + +}} //Tizen::App + +#endif // _FAPP_INTERNAL_IAPP_CONTROL_PLUGIN_PROVIDER_H_ + diff --git a/src/app/inc/FApp_IAppControlSysEventListener.h b/src/app/inc/FApp_IAppControlSysEventListener.h index 5165a2a..9bded34 100644 --- a/src/app/inc/FApp_IAppControlSysEventListener.h +++ b/src/app/inc/FApp_IAppControlSysEventListener.h @@ -46,7 +46,7 @@ public: virtual void OnAppControlEventReceivedN(int reqId, _AppArg* pArg, int res) = 0; - virtual void OnAppControlEventReceivedN(int reqId, int res, const Tizen::Base::Collection::IMap* pArgs, int prop) = 0; + virtual void OnAppControlPluginEventReceivedN(int reqId, int res, const AppId& appId, const Tizen::Base::String& oId, const Tizen::Base::Collection::IMap* pArgs, int prop) = 0; virtual void OnAppControlEventReceivedN(int reqId, const AppId& appId, const Tizen::Base::String& operationId) = 0; }; // _IAppControlSysEventListener diff --git a/src/app/inc/FApp_INotificationManagerImpl.h b/src/app/inc/FApp_INotificationManagerImpl.h new file mode 100644 index 0000000..8cec396 --- /dev/null +++ b/src/app/inc/FApp_INotificationManagerImpl.h @@ -0,0 +1,215 @@ +// +// Copyright (c) 2013 Samsung Electronics Co., Ltd. +// +// Licensed under the Apache License, Version 2.0 (the License); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +/** + * @file FApp_INotificationManagerImpl.h + * @brief This is the header file for the _INotificationManagerImpl class. + * + * This file contains the declarations of _INotificationManagerImpl. + */ + +#ifndef _FAPP_INTERNAL_INOTIFICATION_MANAGER_IMPL_H_ +#define _FAPP_INTERNAL_INOTIFICATION_MANAGER_IMPL_H_ + +#include +#include +#include + + +namespace Tizen { namespace App +{ + +class _INotificationManagerImpl +{ +public: + virtual ~_INotificationManagerImpl(void) {} + + /** + * Gets the badge number of the application icon. + * + * @return The current badge number + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM A system error has occurred. + * @exception E_OBJ_NOT_FOUND The application is not installed. + * @exception E_INVALID_STATE This instance is in an invalid state. @n + * The Construct() method is not called. + */ + virtual int GetBadgeNumber(void) const = 0; + + /** + * Notifies the user using a message and badge number. @n + * If the user checks the message, @c launchArguments is delivered to the application. @n + * @c launchArguments is specified as input parameter for Application::OnUserEventReceivedN() or can be obtained by + * invoking Application::GetAppArgumentListN(), especially within Application::OnAppInitializing(). + * + * @return An error code + * @param[in] messageText The notification message + * @param[in] badgeNumber The badge number + * @param[in] launchArguments The message for application + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * - A specified input parameter is invalid. @n + * - The specified @c badgeNumber is less than @c 0. @n + * - The length of the specified @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH. @n + * - The length of the specified @c launchArguments is greater than Shell::MAX_NOTIFICATION_LAUUNCH_ARGUMENTS_LENGTH. + * @exception E_SYSTEM A system error has occurred. + * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy. + * @exception E_INVALID_STATE This instance is in an invalid state. @n + * The Construct() method is not called. + */ + virtual result Notify(const Tizen::Base::String& messageText, int badgeNumber, const Tizen::Base::String& launchArguments) = 0; + + /** + * Removes the notification message. + * + * @return An error code + * @exception E_SUCCESS The method was successful. + * @exception E_SYSTEM A system error occurred. + * @exception E_INVALID_STATE This instance is in an invalid state: @n + * - The Construct() method is not called. @n + */ + virtual result RemoveNotification(void) = 0; + + /** + * Notifies the user about the ongoing activity using a message. + * + * @return An error code + * @param[in] messageText The notification message + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified input parameter is invalid, or + * the length of @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH. + * @exception E_SYSTEM A system error has occurred. + * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy. + * @exception E_INVALID_STATE This instance is in an invalid state. @n + * The Construct() method is not called. + */ + virtual result NotifyOngoingActivity(const Tizen::Base::String& messageText) = 0; + + /** + * Notifies the user about the ongoing activity using a message. @n + * @c launchArguments is specified as input parameter for Application::OnUserEventReceivedN() or can be obtained by + * invoking Application::GetAppArgumentListN(), especially within Application::OnAppInitializing(). + * + * @return An error code + * @param[in] messageText The notification message + * @param[in] launchArguments The launch arguments for the application + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * - A specified input parameter is invalid. @n + * @exception E_SYSTEM A system error has occurred. + * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy. + * @exception E_INVALID_STATE This instance is in an invalid state. @n + * The Construct() method is not called. + */ + virtual result NotifyOngoingActivity(const Tizen::Base::String& messageText, const Tizen::Base::String& launchArguments) = 0; + + /** + * Removes the notification message for the ongoing activity. + * + * @return An error code + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM A system error has occurred. + * @exception E_INVALID_STATE This instance is in an invalid state. @n + * The Construct() method is not called. + */ + virtual result RemoveOngoingActivityNotification(void) = 0; + + /** + * Gets the badge number of the application icon. + * + * @return The current badge number + * @param[in] appId The application ID + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM A system error has occurred. + * @exception E_OBJ_NOT_FOUND The application is not installed. + * @exception E_INVALID_STATE This instance is in an invalid state. @n + * The Construct() method is not called. + */ + virtual int GetBadgeNumber(const Tizen::App::AppId& appId) const = 0; + + /** + * Notifies the user using a message and badge number on behalf of the specified application. @n + * If the user checks the message, the @c launchArguments is delivered to the application. + * + * @return An error code + * @param[in] appId The application ID + * @param[in] messageText The notification message + * @param[in] badgeNumber The badge number + * @param[in] launchArguments The launch arguments for the application + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * - A specified input parameter is invalid. @n + * - The length of the specified @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH. @n + * - The length of the specified @c launchArguments is greater than Shell::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH. + * @exception E_APP_NOT_INSTALLED The application is not installed. + * @exception E_INVALID_OPERATION The target application with the specified application ID is not permitted to receive any notification as per the Tizen platform policy. + * @exception E_SYSTEM A system error has occurred. + * @exception E_INVALID_STATE This instance is in an invalid state. @n + * The Construct() method is not called. + */ + virtual result NotifyByAppId(const Tizen::App::AppId& appId, const Tizen::Base::String& messageText, int badgeNumber, const Tizen::Base::String& launchArguments) = 0; + + /** + * Notifies the user about the ongoing activity using a message on behalf of the specified application. + * + * @return An error code + * @param[in] appId The application ID + * @param[in] messageText The notification message + * @param[in] launchArguments The launch arguments for application + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG Either of the following conditions has occurred: @n + * - A specified input parameter is invalid. @n + * - The length of @c messageText is greater than Shell::MAX_NOTIFICATION_MESSAGE_LENGTH. @n + * - The length of @c launchArguments is greater than Shell::MAX_NOTIFICATION_LAUNCH_ARGUMENTS_LENGTH. + * @exception E_APP_NOT_INSTALLED The application is not installed. + * @exception E_SYSTEM A system error has occurred. + * @exception E_INVALID_OPERATION The type of application calling this method is invalid as per the Tizen platform policy. + * @exception E_INVALID_STATE This instance is in an invalid state. @n + * The Construct() method is not called. + */ + virtual result NotifyOngoingActivityByAppId(const Tizen::App::AppId& appId, const Tizen::Base::String& messageText, const Tizen::Base::String& launchArguments) = 0; + + /** + * Removes the notification message for ongoing activity on behalf of the specified application. + * + * @return An error code + * @param[in] appId The application ID + * @exception E_SUCCESS The method is successful. + * @exception E_APP_NOT_INSTALLED The application is not installed. + * @exception E_SYSTEM A system error has occurred. + * @exception E_INVALID_STATE This instance is in an invalid state. @n + * The Construct() method is not called. + */ + virtual result RemoveOngoingActivityNotificationByAppId(const Tizen::App::AppId& appId) = 0; + + /** + * Removes the notification message on behalf of the specified application. + * + * @return An error code + * @param[in] appId The application ID + * @exception E_SUCCESS The method was successful. + * @exception E_APP_NOT_INSTALLED The application is not installed. + * @exception E_SYSTEM A system error occurred. + * @exception E_INVALID_STATE This instance is in an invalid state: @n + * - The Construct() method is not called. @n + */ + virtual result RemoveNotificationByAppId(const Tizen::App::AppId& appId) = 0; + +}; + +} } // Tizen::App + +#endif // _FAPP_INTERNAL_INOTIFICATION_MANAGER_IMPL_H_ diff --git a/src/app/inc/FApp_LaunchInfo.h b/src/app/inc/FApp_LaunchInfo.h index 4fc6360..7d9cfc0 100644 --- a/src/app/inc/FApp_LaunchInfo.h +++ b/src/app/inc/FApp_LaunchInfo.h @@ -33,28 +33,27 @@ namespace Tizen { namespace Base { namespace Runtime { -class _LibraryImpl; class IEventListener; } }} namespace Tizen { namespace App { - +class _IAppControlPluginProvider; class _AppArg; typedef result (*LaunchCbType)(void* data, _AppArg* pArg, _AppArg* pResArg, service_result_e res, int prop, int reqId); //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// -// _LaunchInfo handles the launch request from this process +// _DataControlInfo handles the launch request from this process //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// const long LAUNCH_INFO_MAGIC = 0x494C; -class _LaunchInfo +class _DataControlInfo { public: - _LaunchInfo(_AppArg* pArg, LaunchCbType pCb, void* pData, int prop) + _DataControlInfo(_AppArg* pArg, LaunchCbType pCb, void* pData, int prop) : magic(LAUNCH_INFO_MAGIC) , reqId(-1) , pArg(pArg) @@ -64,11 +63,11 @@ public: { } - ~_LaunchInfo(void); + ~_DataControlInfo(void); private: - _LaunchInfo(const _LaunchInfo& rhs); - _LaunchInfo& operator =(const _LaunchInfo& rhs); + _DataControlInfo(const _DataControlInfo& rhs); + _DataControlInfo& operator =(const _DataControlInfo& rhs); public: const long magic; @@ -77,7 +76,7 @@ public: const LaunchCbType launchCb; void* pUserData; const int property; -}; // _LaunchInfo +}; // _DataControlInfo //////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////////// @@ -86,12 +85,22 @@ public: struct _InProcessInfo { public: - _InProcessInfo(const Tizen::Base::String& aId, const Tizen::Base::String& oId, int prop, bool legacy, Tizen::Base::Runtime::_LibraryImpl& lib, Tizen::Base::Runtime::IEventListener* pListener) + _InProcessInfo(const Tizen::Base::String& aId, const Tizen::Base::String& oId, int prop, bool legacy, _IAppControlPluginProvider* pProvider, Tizen::Base::Runtime::IEventListener* pListener) : reqId(-1) , providerId(aId) , operationId(oId) , property(prop) - , pLib(&lib) + , pProvider(pProvider) + , pListener(pListener) + , isLegacy(legacy) + { + } + + // implicit process info + _InProcessInfo(bool legacy, _IAppControlPluginProvider* pProvider, Tizen::Base::Runtime::IEventListener* pListener) + : reqId(-1) + , property(0) + , pProvider(pProvider) , pListener(pListener) , isLegacy(legacy) { @@ -108,7 +117,7 @@ public: const Tizen::Base::String providerId; const Tizen::Base::String operationId; const int property; - Tizen::Base::Runtime::_LibraryImpl* pLib; // non-empty + _IAppControlPluginProvider* pProvider; Tizen::Base::Runtime::IEventListener* pListener; const bool isLegacy; }; // _InProcessInfo diff --git a/src/app/inc/FApp_RequestManagerT.h b/src/app/inc/FApp_RequestManagerT.h index ff1e57a..1661874 100644 --- a/src/app/inc/FApp_RequestManagerT.h +++ b/src/app/inc/FApp_RequestManagerT.h @@ -26,6 +26,11 @@ #include #include +namespace Tizen { namespace Base { namespace Runtime +{ +class IEventListener; +}}} + namespace Tizen { namespace App { @@ -35,6 +40,7 @@ class _RequestManagerT public: typedef Tizen::Base::Collection::HashMapT RequestListType; typedef Tizen::Base::Collection::IMapEnumeratorT RequestListEnumType; + typedef bool (*Pred)(const T&, Tizen::Base::Runtime::IEventListener*); _RequestManagerT(void); @@ -46,8 +52,12 @@ public: void RemoveItem(T* pItem); + T* FindItemWithListener(Pred, Tizen::Base::Runtime::IEventListener* pListener) const; + T* FindItem(int reqId) const; + void Dump(void) const; + private: _RequestManagerT(const T& rhs); diff --git a/src/app/inc/FApp_Types.h b/src/app/inc/FApp_Types.h index 8245989..cc12c86 100644 --- a/src/app/inc/FApp_Types.h +++ b/src/app/inc/FApp_Types.h @@ -104,6 +104,7 @@ const int APPSVC_OSP_RES_FAIL = -13; const int APPSVC_OSP_RES_TERMINATE = -14; const int LAUNCH_ARG_META_COUNT = 3; +const int APPCONTROL_REQUEST_ID_INVALID = -1; _OSP_LOCAL_ extern const wchar_t LEGACY_LAUNCH_REASON_NORMAL[]; _OSP_LOCAL_ extern const wchar_t LEGACY_LAUNCH_REASON_CONDITIONAL[]; @@ -111,6 +112,7 @@ _OSP_LOCAL_ extern const wchar_t LEGACY_OPERATION_MAIN[]; _OSP_LOCAL_ extern const wchar_t TIZEN_OPERATION_MAIN[]; _OSP_EXPORT_ extern const wchar_t TIZEN_OPERATION_PICK[]; _OSP_LOCAL_ extern const char TIZEN_NOTIFICATION_DATA[]; +_OSP_LOCAL_ extern const char SUBMODE_NAME[]; _OSP_EXPORT_ extern const char IPC_SERVER_NAME[]; _OSP_EXPORT_ extern const char CONDITION_MANAGER_IPC_NAME[]; diff --git a/src/app/package/FAppPkg_PackageManagerImpl.cpp b/src/app/package/FAppPkg_PackageManagerImpl.cpp index 7e04367..b89c17a 100755 --- a/src/app/package/FAppPkg_PackageManagerImpl.cpp +++ b/src/app/package/FAppPkg_PackageManagerImpl.cpp @@ -58,8 +58,6 @@ using namespace Tizen::System; namespace Tizen { namespace App { namespace Package { -PackageManager* pPackageManagerInstance = null; - Tizen::Base::Collection::HashMap _PackageManagerImpl::__installationList; void diff --git a/src/app/package/FAppPkg_PackageParser.cpp b/src/app/package/FAppPkg_PackageParser.cpp index 043ba99..1083428 100755 --- a/src/app/package/FAppPkg_PackageParser.cpp +++ b/src/app/package/FAppPkg_PackageParser.cpp @@ -20,6 +20,8 @@ #include #include +#include +#include #include #include @@ -29,7 +31,6 @@ #include #include #include -#include using namespace Tizen::App; using namespace Tizen::Base; @@ -41,6 +42,18 @@ using namespace Tizen::System; namespace Tizen { namespace App { namespace Package { +struct charDeleter +{ + void operator()(char* pValue) + { + if(pValue != null) + { + free(pValue); + pValue = null; + } + } +}; + _PackageXmlAttribute::_PackageXmlAttribute(void) :__pName(null) ,__pValue(null) @@ -753,7 +766,7 @@ _PackageParser::OnDisplayNamesEndElement(void) SysTryReturn(NID_APP, pNameList, false, E_SYSTEM, "pNameList is null."); String locale; - result r = _SettingInfoImpl::GetValue(L"http://tizen.org/setting/locale.language", locale); + result r = GetLocale(locale); SysTryReturn(NID_APP, !IsFailed(r), false, E_SYSTEM, "GetValue(http://tizen.org/setting/locale.language) failed."); locale.Replace(L"_", L"-"); @@ -1160,4 +1173,35 @@ _PackageParser::FindElement(const char* pName) return res; } +result +_PackageParser::GetLocale(String& value) +{ + int errorCode = 0; + result r = E_SUCCESS; + char* pTemp = null; + std::unique_ptr pLocale(null); + + errorCode = runtime_info_get_value_string(RUNTIME_INFO_KEY_LANGUAGE, &pTemp); + SysTryReturnResult(NID_APP, (errorCode == RUNTIME_INFO_ERROR_NONE) && (pTemp != null), E_SYSTEM, "runtime_info_get_value_string() failed."); + + pLocale.reset(pTemp); + icu::Locale icuLocale(pLocale.get()); + String localeString(icuLocale.getISO3Language()); + String languageScriptTmp(icuLocale.getScript()); + + if (!languageScriptTmp.IsEmpty()) + { + String languageScript; + languageScriptTmp.ToLowerCase(languageScript); + localeString.Append(L"-"); + localeString.Append(languageScript); + } + localeString.Append("_"); + localeString.Append(icuLocale.getCountry()); + + value = localeString; + + return r; +} + } } } // Tizen::App::Package diff --git a/src/base/FBaseDateTime.cpp b/src/base/FBaseDateTime.cpp index 5195df3..7ab7d56 100644 --- a/src/base/FBaseDateTime.cpp +++ b/src/base/FBaseDateTime.cpp @@ -54,8 +54,6 @@ enum DateTimeLimits }; static const int TICKS_PER_MILLISECOND = 1; -static const long SEC_IN_A_DAY = (24L * 60L * 60L); -static const long long MINIMUM_VALUE_IN_SEC = 86400LL; static const int DAYS_IN_LEAP_YEAR[] = { 0, 31, 60, 91, 121, 152, 182, 213, 244, 274, 305, 335, 366 }; static const int DAYS[] = { 0, 31, 59, 90, 120, 151, 181, 212, 243, 273, 304, 334, 365 }; static const int INT_HALF_BIT = 16; diff --git a/src/base/FBaseString.cpp b/src/base/FBaseString.cpp index 709adb9..32e8e6a 100644 --- a/src/base/FBaseString.cpp +++ b/src/base/FBaseString.cpp @@ -893,7 +893,7 @@ result String::Replace(const String& org, const String& rep) { result r = Replace(org, rep, 0); - SysTryReturn(NID_BASE, r == E_SUCCESS, r, r, "[%s] Propagating.", GetErrorMessage(r)); + SysTryReturnResult(NID_BASE, r == E_SUCCESS, r, "Propagating."); return r; } @@ -901,8 +901,7 @@ String::Replace(const String& org, const String& rep) result String::Replace(const String& org, const String& rep, int startIndex) { - const int orgLen = org.__length; - SysTryReturnResult(NID_BASE, orgLen > 0, E_INVALID_ARG, "The length of org(%d) MUST be greater than 0.", orgLen); + SysTryReturnResult(NID_BASE, org.__length > 0, E_INVALID_ARG, "The length of org MUST be greater than 0."); SysTryReturnResult(NID_BASE, startIndex >= 0 && startIndex < __length, E_OUT_OF_RANGE, @@ -914,68 +913,55 @@ String::Replace(const String& org, const String& rep, int startIndex) return E_SUCCESS; } + int orgLen = org.__length; + int repLen = rep.__length; if ((orgLen == __length) && (*this == org)) { - const int newLength = rep.__length; - if (EnsureCapacity(newLength) != E_SUCCESS) - { - SetCapacity(newLength); - } + result r = AboutToModify(__capacity); + SysTryReturnResult(NID_BASE, r == E_SUCCESS, E_OUT_OF_MEMORY, "Memory allocation failed."); - wcsncpy(__pValue, rep.__pValue, rep.__length); + r = EnsureCapacity(repLen); + SysTryReturnResult(NID_BASE, r == E_SUCCESS, r, "Propagating."); - __length = rep.__length; + wcsncpy(__pValue, rep.__pValue, repLen); + + __length = repLen; __pValue[__length] = '\0'; __hash = 0; return E_SUCCESS; } - int repLen = rep.__length; + int matchedCount = 0; - wchar_t* pOrg = org.__pValue; - wchar_t* pRep = rep.__pValue; + wchar_t* pBeg = __pValue + startIndex; + wchar_t* pMatch = null; - int count = 0; + while ((pMatch = wcsstr(pBeg, org.__pValue)) != null) { - wchar_t* pBeg = (__pValue + startIndex); - wchar_t* pEnd = pBeg + __length; - while (pBeg < pEnd) - { - wchar_t* pTarget = null; - while ((pTarget = (wchar_t*) wcsstr(pBeg, pOrg)) != null) - { - ++count; - pBeg = pTarget + orgLen; - } - pBeg += wcslen(pBeg) + 1; - } + ++matchedCount; + pBeg = pMatch + orgLen; } - if (count > 0) + if (matchedCount > 0) { result r = AboutToModify(__capacity); SysTryReturnResult(NID_BASE, r == E_SUCCESS, E_OUT_OF_MEMORY, "Memory allocation failed."); - const int newLength = (count * (repLen - orgLen)) + __length; + const int newLength = (matchedCount * (repLen - orgLen)) + __length; r = EnsureCapacity(newLength); - SysTryReturn(NID_BASE, r == E_SUCCESS, r, r, "[%s] Propagating.", GetErrorMessage(r)); + SysTryReturnResult(NID_BASE, r == E_SUCCESS, r, "Propagating."); - wchar_t* pBeg = (__pValue + startIndex); - wchar_t* pEnd = pBeg + __length; - while (pBeg < pEnd) + pBeg = __pValue + startIndex; + while ((pMatch = wcsstr(pBeg, org.__pValue)) != null) { - wchar_t* pTarget = null; - while ((pTarget = (wchar_t*) wcsstr(pBeg, pOrg)) != null) - { - int balance = __length - int(pTarget - (__pValue + startIndex) + orgLen); - wmemmove(pTarget + repLen, pTarget + orgLen, balance); - wmemcpy(pTarget, pRep, repLen); - pBeg = pTarget + repLen; - pTarget[repLen + balance] = 0; - __length += (repLen - orgLen); - } - pBeg += (wcslen(pBeg) + 1); + int count = __length - (pMatch - __pValue) - orgLen; + wmemmove(pMatch + repLen, pMatch + orgLen, count); + wmemcpy(pMatch, rep.__pValue, repLen); + + pBeg = pMatch + repLen; + pMatch[repLen + count] = '\0'; + __length += (repLen - orgLen); } __length = newLength; diff --git a/src/base/utility/FBaseUtilUri.cpp b/src/base/utility/FBaseUtilUri.cpp index 32522d7..a6fd68b 100644 --- a/src/base/utility/FBaseUtilUri.cpp +++ b/src/base/utility/FBaseUtilUri.cpp @@ -1399,13 +1399,13 @@ Uri::ParseHierarchicalUri(const Tizen::Base::String& str, int startSsp, Tizen::B curIndex += 2; String special(L"/?#"); - int index = Scan(str, curIndex, special); - if (index > curIndex) + int matchedIndex = Scan(str, curIndex, special); + if (matchedIndex > curIndex) { - r = str.SubString(curIndex, index - curIndex, authority); + r = str.SubString(curIndex, matchedIndex - curIndex, authority); SysTryCatch(NID_BASE_UTIL, r == E_SUCCESS, , r, "[%s] Propagating.", GetErrorMessage(r)); } - else if (index >= str.GetLength()) + else if (matchedIndex >= str.GetLength()) { r = E_INVALID_FORMAT; goto CATCH; diff --git a/src/locales/FLcl_CalendarImpl.cpp b/src/locales/FLcl_CalendarImpl.cpp index d4e6e08..5479719 100644 --- a/src/locales/FLcl_CalendarImpl.cpp +++ b/src/locales/FLcl_CalendarImpl.cpp @@ -38,8 +38,6 @@ using namespace Tizen::Base; namespace Tizen { namespace Locales { -static const int ONE_MINUTE_IN_MILLISEC = 60000; - _CalendarImpl::_CalendarImpl() : __type(CALENDAR_GREGORIAN) , __locale(LANGUAGE_INVALID, COUNTRY_INVALID) diff --git a/src/osp-string/ar.po b/src/osp-string/ar.po index 77da9d8..234ac28 100644 --- a/src/osp-string/ar.po +++ b/src/osp-string/ar.po @@ -388,6 +388,21 @@ msgstr "النص في الإطار المنبثق الأساسي" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "متابعة" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "اختر اللون" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "اختر التاريخ" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "ضبط التاريخ والوقت" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "اختر الشهر" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "اختر الوقت" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "إلغاء تفعيل قارئ الشاشة" @@ -409,3 +424,15 @@ msgstr "شريط التمرير السريع" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "صفحة الويب هذه" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "حفظ كلمة المرور؟" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "متابعة" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "بقاء" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "مغادرة" + diff --git a/src/osp-string/az.po b/src/osp-string/az.po index d3c89c9..69cd072 100644 --- a/src/osp-string/az.po +++ b/src/osp-string/az.po @@ -388,6 +388,21 @@ msgstr "Menyunun məzmununda mətn" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Davam et" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Rəngi təyin et" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Tarixi təyin et" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Tarixi və vaxtı təyin et" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Ayı təyin et" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Vaxtı təyin et" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Ekran oxuyucsnu deaktiv et" @@ -409,3 +424,15 @@ msgstr "Ä°lk sürüşkən panel" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Bu veb-səhifə" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Parol saxlansın?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Davam edin" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Qal" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Çıxın" + diff --git a/src/osp-string/bg.po b/src/osp-string/bg.po index d97edd5..4d7c9e9 100644 --- a/src/osp-string/bg.po +++ b/src/osp-string/bg.po @@ -26,7 +26,7 @@ msgid "IDS_COM_BUTTON_LOGIN" msgstr "Вход" msgid "IDS_COM_BODY_FLASH_CONTENT_C_PS_IS_TRYING_TO_ACCESS_REMOTE_LOCATION_C_PS_MSG" -msgstr "Flash съдържание: %s опитва достъп до отдалечено място: %s. Разрешаване? Ако изберете Да, трябва да рестартирате приложението" +msgstr "Flash съдържание: %s опитва достъп до отдалечено място: %s. Разрешаване? Ако изберете Да, трябва да рестартирате приложението." msgid "IDS_BR_BODY_AUTHUSERNAME" msgstr "Потребителско име" @@ -388,6 +388,21 @@ msgstr "Текст в основната част на изскачащ проз msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Продължи" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Избор на цвят" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Задаване на дата" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Настройка на дата и час" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Задаване на месец" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Задаване на час" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Деактивир. екранен четец" @@ -409,3 +424,15 @@ msgstr "Лента за бързо превъртане" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Тази уеб страница" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Запаметяване на паролата?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Продължи" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Оставане" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Напускане" + diff --git a/src/osp-string/ca.po b/src/osp-string/ca.po index 5746288..1ecb8dd 100644 --- a/src/osp-string/ca.po +++ b/src/osp-string/ca.po @@ -388,6 +388,21 @@ msgstr "Text al cos del missatge emergent" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Continuar" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Definir color" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Definir data" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Definir data i hora" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Definir mes" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Definir hora" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Deshab lector pantalla" @@ -409,3 +424,15 @@ msgstr "Barra de desplaçament ràpid" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Aquesta pàgina web" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Desar la contrasenya?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Continuar" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Mantenir" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Deixar" + diff --git a/src/osp-string/cs.po b/src/osp-string/cs.po index 1c2f743..0982896 100644 --- a/src/osp-string/cs.po +++ b/src/osp-string/cs.po @@ -26,7 +26,7 @@ msgid "IDS_COM_BUTTON_LOGIN" msgstr "Přihl" msgid "IDS_COM_BODY_FLASH_CONTENT_C_PS_IS_TRYING_TO_ACCESS_REMOTE_LOCATION_C_PS_MSG" -msgstr "Obsah flash: %s se pokouší použít vzdálené umístění: %s. Povolit? Pokud ano, musíte restartovat aplikaci" +msgstr "Obsah flash: %s se pokouší použít vzdálené umístění: %s. Povolit? Pokud ano, musíte restartovat aplikaci." msgid "IDS_BR_BODY_AUTHUSERNAME" msgstr "Uživatelské jméno" @@ -388,6 +388,21 @@ msgstr "Text v kontextovém okně" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Pokračovat" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Nastavit barvu" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Nastavit datum" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Nastavit datum a čas" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Nastavit měsíc" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Nastavit čas" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Vypnout čtečku obrazovky" @@ -409,3 +424,15 @@ msgstr "Rychlý posuvník" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Tato webová stránka" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Uložit heslo?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Pokračovat" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Zůstat" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Opustit" + diff --git a/src/osp-string/da.po b/src/osp-string/da.po index 9c7638b..d3a74f5 100644 --- a/src/osp-string/da.po +++ b/src/osp-string/da.po @@ -388,6 +388,21 @@ msgstr "Brødtekst i pop op-vindue" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Fortsæt" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Angiv farve" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Angiv dato" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Angiv dato og tid" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Angiv mÃ¥ned" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Angiv tid" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Deaktivér skærmlæser" @@ -409,3 +424,15 @@ msgstr "Hurtig rullelinje" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Denne hjemmeside" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Gem adgangskode?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Fortsæt" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Forbliv" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Forlad" + diff --git a/src/osp-string/de_DE.po b/src/osp-string/de_DE.po index 512acf5..6746167 100644 --- a/src/osp-string/de_DE.po +++ b/src/osp-string/de_DE.po @@ -317,7 +317,7 @@ msgid "IDS_TPLATFORM_HEADER_SECURITY_CERTIFICATE_ABB" msgstr "Sicherheitszertifikat" msgid "IDS_TPLATFORM_BUTTON2_CANCEL" -msgstr "Abbre-chen" +msgstr "Abbrechen" msgid "IDS_TPLATFORM_BODY_SERIAL_NUMBER_C" msgstr "Seriennummer:" @@ -388,6 +388,21 @@ msgstr "Text innerhalb eines Popup" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Weiter" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Farbe einstellen" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Datum einstellen" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Datum und Uhrzeit festlegen" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Monat einstellen" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Uhrzeit einstellen" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Bildschirmlesepr. deakt." @@ -409,3 +424,15 @@ msgstr "Schnelle Bildlaufleiste" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Diese Webseite" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Passwort speichern?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Fortsetzen" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Hier bleiben" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Verlassen" + diff --git a/src/osp-string/el_GR.po b/src/osp-string/el_GR.po index 7b4038f..274eb7d 100644 --- a/src/osp-string/el_GR.po +++ b/src/osp-string/el_GR.po @@ -26,7 +26,7 @@ msgid "IDS_COM_BUTTON_LOGIN" msgstr "Σύνδεση" msgid "IDS_COM_BODY_FLASH_CONTENT_C_PS_IS_TRYING_TO_ACCESS_REMOTE_LOCATION_C_PS_MSG" -msgstr "Περιεχόμενο Flash: Η εφαρμογή %s προσπαθεί να αποκτήσει πρόσβαση στην τοποθεσία: %s. Να επιτραπεί; Εάν ναι, θα πρέπει να επανεκκινήσετε την εφαρμογή" +msgstr "Περιεχόμενο Flash: Η εφαρμογή %s προσπαθεί να αποκτήσει πρόσβαση στην τοποθεσία: %s. Να επιτραπεί; Εάν ναι, θα πρέπει να επανεκκινήσετε την εφαρμογή." msgid "IDS_BR_BODY_AUTHUSERNAME" msgstr "Όνομα χρήστη" @@ -388,6 +388,21 @@ msgstr "Κείμενο στο κύριο μέρος του αναδυόμενο msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Συνέχεια;" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Ορισμός χρώματος" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Ορισμός ημερομηνίας" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Ρύθμιση ώρας και ημερομηνίας" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Ορισμός μήνα" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Ορισμός ώρας" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Απεν. ανάγνωσης οθόνης" @@ -409,3 +424,15 @@ msgstr "Γραμμή γρήγορης κύλισης" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Αυτή η ιστοσελίδα" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Αποθήκευση κωδικού;" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Συνέχεια" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Παραμονή" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Αποχώρηση" + diff --git a/src/osp-string/en.po b/src/osp-string/en.po index 236127d..7b0e0b4 100644 --- a/src/osp-string/en.po +++ b/src/osp-string/en.po @@ -388,6 +388,21 @@ msgstr "Text in body of pop-up" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Continue" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Set colour" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Set date" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Set date and time" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Set month" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Set time" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Disable screen reader" @@ -409,3 +424,15 @@ msgstr "Fast scroll bar" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "This webpage" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Save password?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Continue" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Stay" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Leave" + diff --git a/src/osp-string/en_PH.po b/src/osp-string/en_PH.po index 8da375c..d669194 100644 --- a/src/osp-string/en_PH.po +++ b/src/osp-string/en_PH.po @@ -388,6 +388,21 @@ msgstr "Text in body of pop-up" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Continue" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Set color" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Set date" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Set date and time" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Set month" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Set time" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Disable screen reader" @@ -409,3 +424,15 @@ msgstr "Fast scroll bar" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "This webpage" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Save password?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Continue" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Stay" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Leave" + diff --git a/src/osp-string/en_US.po b/src/osp-string/en_US.po index 9b9694d..01174da 100644 --- a/src/osp-string/en_US.po +++ b/src/osp-string/en_US.po @@ -388,6 +388,21 @@ msgstr "Text in body of pop-up" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Continue" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Set color" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Set date" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Set date and time" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Set month" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Set time" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Turn off screen reader" @@ -409,3 +424,15 @@ msgstr "Fast scroll bar" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "This webpage" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Save password?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Continue" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Stay" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Leave" + diff --git a/src/osp-string/es_ES.po b/src/osp-string/es_ES.po index 8770bca..101cbbc 100644 --- a/src/osp-string/es_ES.po +++ b/src/osp-string/es_ES.po @@ -388,6 +388,21 @@ msgstr "Texto en el cuerpo del mensaje emergente" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Continuar" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Definir color" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Definir fecha" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Definir fecha y hora" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Definir mes" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Definir hora" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Desactivar lector pantalla" @@ -409,3 +424,15 @@ msgstr "Barra de desplazamiento rápido" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Esta página web" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "¿Guardar contraseña?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Continuar" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Permanecer" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Salir" + diff --git a/src/osp-string/es_MX.po b/src/osp-string/es_MX.po index 00b53b2..4228735 100644 --- a/src/osp-string/es_MX.po +++ b/src/osp-string/es_MX.po @@ -71,7 +71,7 @@ msgid "IDS_TPLATFORM_OPT_CLIPBOARD" msgstr "Portapapeles" msgid "IDS_TPLATFORM_OPT_COPY" -msgstr "Copiando" +msgstr "Copiar" msgid "IDS_TPLATFORM_OPT_CUT" msgstr "Cortar" @@ -388,6 +388,21 @@ msgstr "Texto del cuerpo de la ventana emergente" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Continuar" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Definir color" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Definir fecha" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Ajustar fecha y hora" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Definir mes" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Definir hora" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Desact. lector de pantalla" @@ -409,3 +424,15 @@ msgstr "Barra de desplazamiento rápido" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Esta página web" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "¿Guardar contraseña?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Continuar" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Permanecer" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Salir" + diff --git a/src/osp-string/et.po b/src/osp-string/et.po index e788d76..544ad41 100644 --- a/src/osp-string/et.po +++ b/src/osp-string/et.po @@ -26,7 +26,7 @@ msgid "IDS_COM_BUTTON_LOGIN" msgstr "Sisselogimine" msgid "IDS_COM_BODY_FLASH_CONTENT_C_PS_IS_TRYING_TO_ACCESS_REMOTE_LOCATION_C_PS_MSG" -msgstr "Välksisu: %s proovib juurde pääseda kaugasukohale: %s. Kas lubate? Kui jah, peate taaskäivitama rakenduse" +msgstr "Välksisu: %s proovib juurde pääseda kaugasukohale: %s. Kas lubate? Kui jah, peate taaskäivitama rakenduse." msgid "IDS_BR_BODY_AUTHUSERNAME" msgstr "Kasutajanimi" @@ -388,6 +388,21 @@ msgstr "Hüpiku tekst" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Jätka" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Määrake värv" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Määrake kuupäev" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Määra kuupäev ja kellaaeg" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Määrake kuu" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Määrake kellaaeg" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Desaktiv. ekraanilugeja" @@ -409,3 +424,15 @@ msgstr "Kiirkerimise riba" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "See veebileht" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Kas salvestada parool?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Jätka" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Jää" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Lahku" + diff --git a/src/osp-string/eu.po b/src/osp-string/eu.po index deb48a7..20496d0 100644 --- a/src/osp-string/eu.po +++ b/src/osp-string/eu.po @@ -388,6 +388,21 @@ msgstr "Agerkariaren gorputzeko testua" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Jarraitu" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Ezarri kolorea" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Ezarri data" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Ezarri eguna eta ordua" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Ezarri hila" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Ezarri ordua" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Ezgaitu pant. irakurgailua" @@ -409,3 +424,15 @@ msgstr "Korritze azkarreko barra" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Web orri hau" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Gorde pasahitza?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Jarraitu" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Geratu" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Irten" + diff --git a/src/osp-string/fa.po b/src/osp-string/fa.po index d4c76ae..e3ea56e 100644 --- a/src/osp-string/fa.po +++ b/src/osp-string/fa.po @@ -388,6 +388,21 @@ msgstr "متن داخل پنجره بازشو" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "ادامه" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "تنظیم رنگ" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "تنظیم تاریخ" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "تنظیم تاریخ و زمان" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "تنظیم ماه" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "تنظيم ساعت" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "غیرفعال کردن صفحه خوان" @@ -409,3 +424,15 @@ msgstr "نوار پیمایش سریع" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "این صفحه وب" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "ذخیره رمز عبور؟" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "ادامه" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "ماندن" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "ترک" + diff --git a/src/osp-string/fi.po b/src/osp-string/fi.po index 1689129..d1753f9 100644 --- a/src/osp-string/fi.po +++ b/src/osp-string/fi.po @@ -388,6 +388,21 @@ msgstr "Ponnahdusikkunan tekstiosa" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Jatka" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Aseta väri" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Aseta päivämäärä" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Määritä päiväys ja kellonaika" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Aseta kuukausi" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Aseta aika" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Poista näytönluk. käytöstä" @@ -409,3 +424,15 @@ msgstr "Pikavierityspalkki" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Tämä verkkosivu" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Tallennetaanko salasana?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Jatka" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Jää" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Poistu" + diff --git a/src/osp-string/fr_CA.po b/src/osp-string/fr_CA.po index 2135b0c..d42a2b9 100644 --- a/src/osp-string/fr_CA.po +++ b/src/osp-string/fr_CA.po @@ -254,7 +254,7 @@ msgid "IDS_TPLATFORM_BUTTON_CANCEL_ABB" msgstr "Annuler" msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB" -msgstr "Cont." +msgstr "Continuer" msgid "IDS_TPLATFORM_BUTTON_DONE" msgstr "OK" @@ -388,6 +388,21 @@ msgstr "Texte dans le corps de la fenêtre contextuelle" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Continuer" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Définir la couleur" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Définir la date" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Définir la date et l'heure" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Définir le mois" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Définir l'heure" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Désactiver lecteur d'écran" @@ -409,3 +424,15 @@ msgstr "Barre de défilement rapide" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Cette page Web" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Enreg. mot de passe ?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Continuer" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Rester" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Quitter" + diff --git a/src/osp-string/fr_FR.po b/src/osp-string/fr_FR.po index 98486cd..59ae4d6 100644 --- a/src/osp-string/fr_FR.po +++ b/src/osp-string/fr_FR.po @@ -388,6 +388,21 @@ msgstr "Texte dans le corps de la fenêtre pop-up" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Continuer" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Définir la couleur" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Définir la date" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Définir la date et l'heure" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Définir le mois" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Définir l'heure" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Désactiver lecteur d'écran" @@ -409,3 +424,15 @@ msgstr "Barre de défilement rapide" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Cette page Web" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Enreg. mot de passe ?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Continuer" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Rester" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Quitter" + diff --git a/src/osp-string/ga.po b/src/osp-string/ga.po index 5e04571..4204280 100644 --- a/src/osp-string/ga.po +++ b/src/osp-string/ga.po @@ -388,6 +388,21 @@ msgstr "Téacs i gcorp na míre aníos" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Ar aghaidh" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Socraigh dath" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Socraigh dáta" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Socraigh dáta agus am" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Socraigh mí" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Socraigh am" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Díchumasaigh léith. scáil." @@ -409,3 +424,15 @@ msgstr "Barra mearscrollaithe" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "An leathanach gréasáin seo" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Sábháil pasfhocal?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Ar aghaidh" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Fan" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Imigh as" + diff --git a/src/osp-string/gl.po b/src/osp-string/gl.po index 869e8f5..5f0bd6c 100644 --- a/src/osp-string/gl.po +++ b/src/osp-string/gl.po @@ -388,6 +388,21 @@ msgstr "Texto do corpo da ventá emerxente" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Continuar" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Definir cor" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Definir data" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Definir data e hora" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Definir mes" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Definir hora" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Desactivar lector pantalla" @@ -409,3 +424,15 @@ msgstr "A barra de desprazamento rápido" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Esta páxina web" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Gardar contrasinal?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Continuar" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Permanecer" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Abandonar" + diff --git a/src/osp-string/he.po b/src/osp-string/he.po index 85fe14a..d2e9bc2 100644 --- a/src/osp-string/he.po +++ b/src/osp-string/he.po @@ -388,6 +388,21 @@ msgstr "טקסט בגוף חלון מוקפץ" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "המשך" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "הגדר צבע" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "הגדר תאריך" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "הגדר תאריך ושעה" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "הגדר חודש" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "הגדר שעה" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "השבת קורא מסך" @@ -409,3 +424,15 @@ msgstr "סרגל גלילה מהירה" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "דף אינטרנט זה" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "לשמור סיסמה?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "המשך" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "הישאר" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "עזוב" + diff --git a/src/osp-string/hi.po b/src/osp-string/hi.po index 3d41da3..93b398b 100644 --- a/src/osp-string/hi.po +++ b/src/osp-string/hi.po @@ -20,7 +20,7 @@ msgid "IDS_TPLATFORM_OPT_NFC" msgstr "NFC" msgid "IDS_TPLATFORM_OPT_WI_FI_DIRECT_ABB" -msgstr "Wi-Fi डायरेक्ट" +msgstr "Wi-Fi Direct" msgid "IDS_COM_BUTTON_LOGIN" msgstr "लॉगिन" @@ -254,7 +254,7 @@ msgid "IDS_TPLATFORM_BUTTON_CANCEL_ABB" msgstr "रद्द करें" msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB" -msgstr "जारी रखें" +msgstr "जारी" msgid "IDS_TPLATFORM_BUTTON_DONE" msgstr "हुआ" @@ -388,6 +388,21 @@ msgstr "पॉप-अप के मुख्य भाग वाला टेक msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "जारी रखें" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "रंग सेट करें" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "तिथि सेट करें" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "तिथि और समय सेट करें" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "महीना सेट करें" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "समय सेट करें" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "स्क्रीन रीडर अक्षम करें" @@ -409,3 +424,15 @@ msgstr "त्वरित स्क्रॉल बार" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "यह वेबपेज" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "पासवर्ड सेव करें?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "जारी" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "ठहरें" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "छोड़ें" + diff --git a/src/osp-string/hr.po b/src/osp-string/hr.po index 741c551..f8a8b0e 100644 --- a/src/osp-string/hr.po +++ b/src/osp-string/hr.po @@ -26,7 +26,7 @@ msgid "IDS_COM_BUTTON_LOGIN" msgstr "Prijava" msgid "IDS_COM_BODY_FLASH_CONTENT_C_PS_IS_TRYING_TO_ACCESS_REMOTE_LOCATION_C_PS_MSG" -msgstr "Flash sadržaj: %s pokuÅ¡ava pristupiti udaljenoj lokaciji: %s. Dopustiti? Ako je odgovor da, morate ponovno pokrenuti aplikaciju" +msgstr "Flash sadržaj: %s pokuÅ¡ava pristupiti udaljenoj lokaciji: %s. Dopustiti? Ako je odgovor da, morate ponovno pokrenuti aplikaciju." msgid "IDS_BR_BODY_AUTHUSERNAME" msgstr "Korisničko ime" @@ -388,6 +388,21 @@ msgstr "Tekst u glavnom dijelu skočnog prozora" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Nastavak" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Postavi boju" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Postavi datum" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Postavi datum i vrijeme" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Postavi mjesec" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Postavi vrijeme" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Isključi čitač zaslona" @@ -409,3 +424,15 @@ msgstr "Traka brzog pomicanja" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Ova web-stranica" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Spremiti lozinku?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Nastavi" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Ostani" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Napusti" + diff --git a/src/osp-string/hu.po b/src/osp-string/hu.po index 3d46391..dcb345c 100644 --- a/src/osp-string/hu.po +++ b/src/osp-string/hu.po @@ -26,7 +26,7 @@ msgid "IDS_COM_BUTTON_LOGIN" msgstr "Bejelentkezés" msgid "IDS_COM_BODY_FLASH_CONTENT_C_PS_IS_TRYING_TO_ACCESS_REMOTE_LOCATION_C_PS_MSG" -msgstr "A(z) %s Flash-tartalom a(z) %s távoli helyhez próbál hozzáférni. Engedélyezi ezt? Ha igen, akkor újra kell indítania az alkalmazást" +msgstr "A(z) %s Flash-tartalom a(z) %s távoli helyhez próbál hozzáférni. Engedélyezi ezt? Ha igen, akkor újra kell indítania az alkalmazást." msgid "IDS_BR_BODY_AUTHUSERNAME" msgstr "Felhasználónév" @@ -388,6 +388,21 @@ msgstr "Előugró ablak törzsének szövege" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Folytatás" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Szín beállítása" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Dátum beállítása" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Dátum és idő beállítása" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Hónap beállítása" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Idő beállítása" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Képernyőolvasó letiltása" @@ -409,3 +424,15 @@ msgstr "Gyorsgörgető sáv" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Ez a weboldal" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Menti a jelszót?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Folytatás" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Marad" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Kilép" + diff --git a/src/osp-string/hy.po b/src/osp-string/hy.po index 45f9411..4ceeb13 100644 --- a/src/osp-string/hy.po +++ b/src/osp-string/hy.po @@ -388,6 +388,21 @@ msgstr "Տեքստ՝ Õ¥Õ¬Õ¶Õ¸Õ² պատուհանում" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Շարունակել" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Ô´Õ¶Õ¥Õ¬ գույն" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Ô´Õ¶Õ¥Õ¬ Õ©Õ¾Õ¡Õ¯Õ¡Õ¶" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Նախադրել Õ©Õ¾Õ¡Õ¯Õ¡Õ¶ և ÕªÕ¡Õ´" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Ô´Õ¶Õ¥Õ¬ Õ¡Õ´Õ«Õ½" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Ô´Õ¶Õ¥Õ¬ ÕªÕ¡Õ´" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Կասեցնել էկրանի ընթերցիչը" @@ -409,3 +424,15 @@ msgstr "Արագ ոլորագոտի" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Ô±ÕµÕ½ կայքէջը" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Պահպանե՞լ Õ£Õ¡Õ²Õ¿Õ¶Õ¡Õ¢Õ¡Õ¼Õ¨:" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Շարունակել" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Մնալ" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Ô¹Õ¸Õ²Õ¶Õ¥Õ¬" + diff --git a/src/osp-string/is.po b/src/osp-string/is.po index f9c11be..e37df7a 100644 --- a/src/osp-string/is.po +++ b/src/osp-string/is.po @@ -388,6 +388,21 @@ msgstr "Texti í meginmáli sprettiglugga" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Halda áfram" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Veldu lit" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Veldu dag" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Stilla dag og tíma" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Veldu mánuð" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Stilltu tíma" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Slökkva á skjálesara" @@ -409,3 +424,15 @@ msgstr "Flýtiflettistika" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Þessi vefsíða" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Viltu vista lykilorð?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Halda áfram" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Vera áfram" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Yfirgefa" + diff --git a/src/osp-string/it_IT.po b/src/osp-string/it_IT.po index aeca39b..0307da4 100644 --- a/src/osp-string/it_IT.po +++ b/src/osp-string/it_IT.po @@ -388,6 +388,21 @@ msgstr "Testo nel corpo del popup" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Continua" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Imposta colore" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Imposta data" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Imposta data e ora" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Imposta mese" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Imposta ora" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Disattiva lettura schermo" @@ -409,3 +424,15 @@ msgstr "Barra di scorrimento rapido" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Questa pagina Web" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Salvare password?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Continua" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Resta" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Esci" + diff --git a/src/osp-string/ja_JP.po b/src/osp-string/ja_JP.po index dae67a0..68bd430 100644 --- a/src/osp-string/ja_JP.po +++ b/src/osp-string/ja_JP.po @@ -388,6 +388,21 @@ msgstr "ポップアップの本文テキストです。" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "続行" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "色を設定" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "日付を設定" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "日付と時刻を設定" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "月を設定" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "時刻を設定" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "ｽｸﾘｰﾝﾘｰﾀﾞｰを無効にする" @@ -409,3 +424,15 @@ msgstr "高速スクロールバーです。" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "このWebページ" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "暗証番号を保存しますか？" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "続行" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "保持する" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "離れる" + diff --git a/src/osp-string/ka.po b/src/osp-string/ka.po index 6206efc..3128d4b 100644 --- a/src/osp-string/ka.po +++ b/src/osp-string/ka.po @@ -388,6 +388,21 @@ msgstr "დიალოგის სარკმელში ნაჩვენ msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "გაგრძელება" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "ფერის დაყენება" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "თარიღის დაყენება" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "თარიღისა და დროის დაყენება" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "თვის დაყენება" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "საათის დაყენება" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "გამორთე ეკრანის წამკითხვ." @@ -409,3 +424,15 @@ msgstr "სწრაფად გადახვევის ზოლი" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "ეს ვებსაიტი" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "შეინახავთ პაროლს?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "გაგრძელება" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "დაჩენა" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "დატოვება" + diff --git a/src/osp-string/kk.po b/src/osp-string/kk.po index 42c3c92..4f2738e 100644 --- a/src/osp-string/kk.po +++ b/src/osp-string/kk.po @@ -388,6 +388,21 @@ msgstr "Қалқымалы терезенің мәтіні" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Жалғастыру" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Түсін орнату" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Күнді орнату" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Күні мен уақытын оранту" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Айды орнату" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Уақытты орнату" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Экран оқу құралын өшіру" @@ -409,3 +424,15 @@ msgstr "Жылдам айналдыру жолағы" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Бұл веб-бет" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Құпиясөзді сақтау керек пе?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Жалғастыру" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Қалу" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Қалдыру" + diff --git a/src/osp-string/ko_KR.po b/src/osp-string/ko_KR.po index 912558c..614b27a 100644 --- a/src/osp-string/ko_KR.po +++ b/src/osp-string/ko_KR.po @@ -388,6 +388,21 @@ msgstr "팝업의 본문입니다" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "계속" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "색상 설정" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "날짜 설정" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "날짜 및 시간 설정" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "월 설정" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "시간 설정" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "스크린 리더 해제" @@ -409,3 +424,15 @@ msgstr "빠른 스크롤바" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "이 웹페이지" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "비밀번호를 저장할까요?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "계속" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "남기" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "나가기" + diff --git a/src/osp-string/lt.po b/src/osp-string/lt.po index 865965c..841f76d 100644 --- a/src/osp-string/lt.po +++ b/src/osp-string/lt.po @@ -26,7 +26,7 @@ msgid "IDS_COM_BUTTON_LOGIN" msgstr "Prisijungimas" msgid "IDS_COM_BODY_FLASH_CONTENT_C_PS_IS_TRYING_TO_ACCESS_REMOTE_LOCATION_C_PS_MSG" -msgstr "„Flash“ turinys: %s bando pasiekti nutolusią vietą: %s. Leisti? Jei taip, turite iÅ¡ naujo paleisti programą" +msgstr "„Flash“ turinys: %s bando pasiekti nutolusią vietą: %s. Leisti? Jei taip, turite iÅ¡ naujo paleisti programą." msgid "IDS_BR_BODY_AUTHUSERNAME" msgstr "Naudotojo vardas" @@ -388,6 +388,21 @@ msgstr "IÅ¡kylančiojo lango teksto turinys" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Tęsti" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Nustatykite spalvą" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Nustatykite datą" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Nustatyti datą ir laiką" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Nustatykite mėnesį" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Nustatykite laiką" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "IÅ¡jungti ekrano skaitytuvą" @@ -409,3 +424,15 @@ msgstr "Greitosios slinkties juosta" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Å i svetainė" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "IÅ¡saugoti slaptažodį?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Tęsti" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Likti" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "IÅ¡eiti" + diff --git a/src/osp-string/lv.po b/src/osp-string/lv.po index 7aab4ae..08daf64 100644 --- a/src/osp-string/lv.po +++ b/src/osp-string/lv.po @@ -26,7 +26,7 @@ msgid "IDS_COM_BUTTON_LOGIN" msgstr "PieteikÅ¡anās" msgid "IDS_COM_BODY_FLASH_CONTENT_C_PS_IS_TRYING_TO_ACCESS_REMOTE_LOCATION_C_PS_MSG" -msgstr "Zibatmiņas saturs: %s mēģina piekļūt attālajai atraÅ¡anās vietai: %s. Vai atļaut? Ja jā, programmu ir jārestartē" +msgstr "Zibatmiņas saturs: %s mēģina piekļūt attālajai atraÅ¡anās vietai: %s. Vai atļaut? Ja jā, programmu ir jārestartē." msgid "IDS_BR_BODY_AUTHUSERNAME" msgstr "Lietotājvārds" @@ -388,6 +388,21 @@ msgstr "Uznirstošā loga pamatteksts" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Turpināt" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "IestatÄ«t krāsu" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "IestatÄ«t datumu" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "IestatÄ«t datumu un laiku" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "IestatÄ«t mēnesi" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "IestatÄ«t laiku" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Deaktivizēt ekr. lasÄ«tāju" @@ -409,3 +424,15 @@ msgstr "Ātrās ritināšanas josla" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Å Ä« tÄ«mekļa vietne" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Vai saglabāt paroli?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Turpināt" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Palikt" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Iziet" + diff --git a/src/osp-string/mk.po b/src/osp-string/mk.po index 432f4ba..cbb347b 100644 --- a/src/osp-string/mk.po +++ b/src/osp-string/mk.po @@ -26,7 +26,7 @@ msgid "IDS_COM_BUTTON_LOGIN" msgstr "Најава" msgid "IDS_COM_BODY_FLASH_CONTENT_C_PS_IS_TRYING_TO_ACCESS_REMOTE_LOCATION_C_PS_MSG" -msgstr "Содржина Flash: %s се обидува да пристапи до оддалечена локација: %s. Дозволи? Ако да, треба да ја рестартирате апликацијата" +msgstr "Содржина Flash: %s се обидува да пристапи до оддалечена локација: %s. Дозволи? Ако да, треба да ја рестартирате апликацијата." msgid "IDS_BR_BODY_AUTHUSERNAME" msgstr "Корисничко име" @@ -388,6 +388,21 @@ msgstr "Текст во телото на појавната порака" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Продолжи" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Одреди боја" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Одреди датум" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Постави датум и време" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Одреди месец" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Одреди час" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Исклучи екрански читач" @@ -409,3 +424,15 @@ msgstr "Лента за брзо листање" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Оваа интернет-страница" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Сочувај лозинка?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Продолжи" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Остани" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Напушти" + diff --git a/src/osp-string/nb.po b/src/osp-string/nb.po index 3549b1e..0036831 100644 --- a/src/osp-string/nb.po +++ b/src/osp-string/nb.po @@ -53,7 +53,7 @@ msgid "IDS_COM_POP_DEFAULT_APPLICATION" msgstr "Standardprogram" msgid "IDS_COM_POP_SELECT_DEFAULT_APPLICATION" -msgstr "Velg standardprogram" +msgstr "Velg standardapp" msgid "IDS_TPLATFORM_BODY_NO_IMAGES" msgstr "Ingen bilder" @@ -388,6 +388,21 @@ msgstr "Tekst i hoveddelen til popup-vinduet" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Fortsett" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Angi farge" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Angi dato" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Angi dato og tid" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Angi mÃ¥ned" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Angi klokkeslett" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Deaktiver skjermleser" @@ -409,3 +424,15 @@ msgstr "Hurtigrullefelt" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Denne nettsiden" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Lagre passord?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Fortsett" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Bli" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Lukk" + diff --git a/src/osp-string/nl_NL.po b/src/osp-string/nl_NL.po index 6de574a..5ba1783 100644 --- a/src/osp-string/nl_NL.po +++ b/src/osp-string/nl_NL.po @@ -113,7 +113,7 @@ msgid "IDS_BR_OPT_VIEW" msgstr "Tonen" msgid "IDS_BR_OPT_CANCEL" -msgstr "Annuleren" +msgstr "Annul." msgid "IDS_BR_BODY_PS_REQUESTS_YOUR_LOCATION" msgstr "%s vraagt om uw locatie" @@ -388,6 +388,21 @@ msgstr "Tekst in hoofdpop-up" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Doorgaan" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Kleur instellen" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Datum instellen" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Datum en tijd instellen" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Maand instellen" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Tijd instellen" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Schermlezer uitschakelen" @@ -409,3 +424,15 @@ msgstr "Snelschuifbalk" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Deze webpagina" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Wachtwoord opslaan?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Doorgaan" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Blijven" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Verlaten" + diff --git a/src/osp-string/osp_string.xls b/src/osp-string/osp_string.xls index 7ec16cc..14aa19f 100644 Binary files a/src/osp-string/osp_string.xls and b/src/osp-string/osp_string.xls differ diff --git a/src/osp-string/pl.po b/src/osp-string/pl.po index dd5a083..26096d9 100644 --- a/src/osp-string/pl.po +++ b/src/osp-string/pl.po @@ -26,7 +26,7 @@ msgid "IDS_COM_BUTTON_LOGIN" msgstr "Logowanie" msgid "IDS_COM_BODY_FLASH_CONTENT_C_PS_IS_TRYING_TO_ACCESS_REMOTE_LOCATION_C_PS_MSG" -msgstr "Zawartość Flash: %s próbuje uzyskać dostęp do lokalizacji zdalnej: %s. Zezwolić? Jeśli tak, musisz ponownie uruchomić aplikację" +msgstr "Zawartość Flash: %s próbuje uzyskać dostęp do lokalizacji zdalnej: %s. Zezwolić? Jeśli tak, musisz ponownie uruchomić aplikację." msgid "IDS_BR_BODY_AUTHUSERNAME" msgstr "Nazwa użytkownika" @@ -38,7 +38,7 @@ msgid "IDS_BR_BODY_AUTHPASSWORD" msgstr "Hasło" msgid "IDS_TPLATFORM_OPT_LOCATION" -msgstr "Miejsce" +msgstr "Lokalizacja" msgid "IDS_COM_SK_CANCEL" msgstr "Anuluj" @@ -388,6 +388,21 @@ msgstr "Tekst w treści wyskakującego okna" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Kontynuuj" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Ustaw kolor" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Ustaw datę" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Ustaw datę i godzinę" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Ustaw miesiąc" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Ustaw godzinę" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Wyłącz czytnik ekranu" @@ -409,3 +424,15 @@ msgstr "Pasek szybkiego przewijania" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Ta strona WWW" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Zapisać hasło?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Kontynuuj" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Pozostań" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Opuść" + diff --git a/src/osp-string/pt_BR.po b/src/osp-string/pt_BR.po index 30b0a4a..e897f39 100644 --- a/src/osp-string/pt_BR.po +++ b/src/osp-string/pt_BR.po @@ -388,6 +388,21 @@ msgstr "Texto no corpo da pop-up" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Continuar" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Definir cor" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Definir data" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Definir data e hora" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Definir mês" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Definir hora" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Desativar leitor de tela" @@ -409,3 +424,15 @@ msgstr "Barra de rolagem rápida" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Esta página" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Salvar senha?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Continuar" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Ficar" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Sair" + diff --git a/src/osp-string/pt_PT.po b/src/osp-string/pt_PT.po index 4a66f8f..ef5b103 100644 --- a/src/osp-string/pt_PT.po +++ b/src/osp-string/pt_PT.po @@ -388,6 +388,21 @@ msgstr "Texto no corpo do pop-up" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Continuar" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Definir cor" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Definir data" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Definir data e hora" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Definir mês" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Definir hora" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Desactivar leitor de ecrã" @@ -409,3 +424,15 @@ msgstr "Barra de deslocamento rápido" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Esta página Web" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Guardar palavra-passe?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Continuar" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Ficar" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Sair" + diff --git a/src/osp-string/ro.po b/src/osp-string/ro.po index 2f0e823..f9f0166 100644 --- a/src/osp-string/ro.po +++ b/src/osp-string/ro.po @@ -26,7 +26,7 @@ msgid "IDS_COM_BUTTON_LOGIN" msgstr "Conect." msgid "IDS_COM_BODY_FLASH_CONTENT_C_PS_IS_TRYING_TO_ACCESS_REMOTE_LOCATION_C_PS_MSG" -msgstr "ConÅ£inut Flash: %s încearcă să acceseze o locaÅ£ie de la distanţă: %s. PermiteÅ£i? În caz afirmativ, trebuie să reporniÅ£i aplicaÅ£ia" +msgstr "ConÅ£inut Flash: %s încearcă să acceseze o locaÅ£ie de la distanţă: %s. PermiteÅ£i? În caz afirmativ, trebuie să reporniÅ£i aplicaÅ£ia." msgid "IDS_BR_BODY_AUTHUSERNAME" msgstr "Nume utilizator" @@ -388,6 +388,21 @@ msgstr "Text în corpul ferestrei de tip pop-up" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Continuare" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "SetaÅ£i culoarea" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "SetaÅ£i data" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Setare dată şi oră" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "SetaÅ£i luna" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "SetaÅ£i ora" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Dezactivare cititor ecran" @@ -409,3 +424,15 @@ msgstr "Bară de derulare rapidă" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Această pagină web" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "SalvaÅ£i parola?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Continuare" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "RămâneÅ£i" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "PărăsiÅ£i" + diff --git a/src/osp-string/ru_RU.po b/src/osp-string/ru_RU.po index ee52eb8..c68be93 100644 --- a/src/osp-string/ru_RU.po +++ b/src/osp-string/ru_RU.po @@ -388,6 +388,21 @@ msgstr "Текст во всплывающем окне" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Продолжить" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Выберите цвет" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Выберите дату" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Задать дату и время" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Выберите месяц" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Выберите время" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Отключить чтение с экрана" @@ -409,3 +424,15 @@ msgstr "Полоса быстрой прокрутки" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Эта веб-страница" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Сохранить пароль?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Продолжить" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Не закрывать" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Покинуть" + diff --git a/src/osp-string/sk.po b/src/osp-string/sk.po index 430cd06..80abeed 100644 --- a/src/osp-string/sk.po +++ b/src/osp-string/sk.po @@ -26,7 +26,7 @@ msgid "IDS_COM_BUTTON_LOGIN" msgstr "Prihlásenie" msgid "IDS_COM_BODY_FLASH_CONTENT_C_PS_IS_TRYING_TO_ACCESS_REMOTE_LOCATION_C_PS_MSG" -msgstr "Obsah s formátom Flash: %s sa pokúša o prístup k vzdialenému umiestneniu: %s. PovoliÅ¥? Ak áno, musíte reÅ¡tartovaÅ¥ aplikáciu" +msgstr "Obsah s formátom Flash: %s sa pokúša o prístup k vzdialenému umiestneniu: %s. PovoliÅ¥? Ak áno, musíte reÅ¡tartovaÅ¥ aplikáciu." msgid "IDS_BR_BODY_AUTHUSERNAME" msgstr "Užívateľské meno" @@ -388,6 +388,21 @@ msgstr "Text v tele kontextového okna" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "PokračovaÅ¥" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Nastavte farbu" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Nastavte dátum" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "NastaviÅ¥ dátum a čas" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Nastavte mesiac" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Nastavte čas" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Vypnúť čítačku obrazovky" @@ -409,3 +424,15 @@ msgstr "Rýchly posúvač" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Táto webová stránka" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "UložiÅ¥ heslo?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "PokračovaÅ¥" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "ZostaÅ¥" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "OpustiÅ¥" + diff --git a/src/osp-string/sl.po b/src/osp-string/sl.po index e8e9c6a..8a24897 100644 --- a/src/osp-string/sl.po +++ b/src/osp-string/sl.po @@ -26,7 +26,7 @@ msgid "IDS_COM_BUTTON_LOGIN" msgstr "Prijava" msgid "IDS_COM_BODY_FLASH_CONTENT_C_PS_IS_TRYING_TO_ACCESS_REMOTE_LOCATION_C_PS_MSG" -msgstr "Vsebina Flash: %s poskuÅ¡a dostopati na oddaljeno lokacijo: %s. Želite dovoliti? Če da, morate znova zagnati program" +msgstr "Vsebina Flash: %s poskuÅ¡a dostopati na oddaljeno lokacijo: %s. Želite dovoliti? Če da, morate znova zagnati program." msgid "IDS_BR_BODY_AUTHUSERNAME" msgstr "UporabniÅ¡ko ime" @@ -388,6 +388,21 @@ msgstr "Besedilo v telesu pojavnega okna" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Nadaljuj" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Nastavite barvo" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Nastavite datum" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Nastavitev datuma in ure" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Nastavite mesec" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Nastavite čas" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Onemogoči bralnik zaslona" @@ -409,3 +424,15 @@ msgstr "Vrstica za hitro drsenje" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Ta spletna stran" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Shranim geslo?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Nadaljuj" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Ostani" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Zapusti" + diff --git a/src/osp-string/sr.po b/src/osp-string/sr.po index ab39ec9..db71f7e 100644 --- a/src/osp-string/sr.po +++ b/src/osp-string/sr.po @@ -26,7 +26,7 @@ msgid "IDS_COM_BUTTON_LOGIN" msgstr "Prijava" msgid "IDS_COM_BODY_FLASH_CONTENT_C_PS_IS_TRYING_TO_ACCESS_REMOTE_LOCATION_C_PS_MSG" -msgstr "Flash sadržaj: %s pokuÅ¡ava da pristupi udaljenoj lokaciji: %s. Dozvoliti? Ukoliko dozvoljavaÅ¡, moraÅ¡ da restartujeÅ¡ aplikaciju" +msgstr "Flash sadržaj: %s pokuÅ¡ava da pristupi udaljenoj lokaciji: %s. Dozvoliti? Ukoliko dozvoljavaÅ¡, moraÅ¡ da restartujeÅ¡ aplikaciju." msgid "IDS_BR_BODY_AUTHUSERNAME" msgstr "Korisničko ime" @@ -388,6 +388,21 @@ msgstr "Tekst u telu iskačućeg prozora" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Nastavi" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Podesi boju" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Podesi datum" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Podesi datum i vreme" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Podesi mesec" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Podesi vreme" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Onemogući čitač ekrana" @@ -409,3 +424,15 @@ msgstr "Traka za brzo listanje" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Ova web stranica" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Sačuvaj Å¡ifru?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Nastavi" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Ostani" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Napusti" + diff --git a/src/osp-string/sv.po b/src/osp-string/sv.po index ae721b4..97a88be 100644 --- a/src/osp-string/sv.po +++ b/src/osp-string/sv.po @@ -388,6 +388,21 @@ msgstr "Popup-fönstrets brödtext" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Fortsätt" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Ställ in färg" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Ställ in datum" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Ange datum och tid" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Ställ in mÃ¥nad" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Ställ in tid" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Inaktivera skärmläsare" @@ -409,3 +424,15 @@ msgstr "Snabbrullningslist" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Den här webbplatsen" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Spara lösenord?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Fortsätt" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Stanna" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Lämna" + diff --git a/src/osp-string/th.po b/src/osp-string/th.po index a6113e2..30d1ce0 100644 --- a/src/osp-string/th.po +++ b/src/osp-string/th.po @@ -388,6 +388,21 @@ msgstr "ข้อความในเนื้อหาของป็อปอ msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "ดำเนิน​การ" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "ตั้งค่าสี" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "ตั้งวันที่" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "ตั้งค่าวันที่และเวลา" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "ตั้งเดือน" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "ตั้งเวลา" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "ปิดใช้งานตัวอ่านหน้าจอ" @@ -409,3 +424,15 @@ msgstr "แถบเลื่อนเร็ว" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "เว็บเพจนี้" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "บันทึก​รหัส​ผ่าน?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "ดำเนินการต่อ" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "พัก" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "ออก" + diff --git a/src/osp-string/tr_TR.po b/src/osp-string/tr_TR.po index 675f1e4..ac3d0dc 100644 --- a/src/osp-string/tr_TR.po +++ b/src/osp-string/tr_TR.po @@ -388,6 +388,21 @@ msgstr "Açılır pencere yerindeki metin" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Devam" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Renk ata" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Tarihi ayarla" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Tarih ve saati ayarla" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Ay ayarla" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Süreyi ayarla" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Ekran okuyucuyu kapat" @@ -409,3 +424,15 @@ msgstr "Hızlı kaydırma çubuğu" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Bu web sayfası" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Şifre kaydedilsin mi?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Devam" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Kal" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Ayrıl" + diff --git a/src/osp-string/uk.po b/src/osp-string/uk.po index af28b30..19f93e3 100644 --- a/src/osp-string/uk.po +++ b/src/osp-string/uk.po @@ -388,6 +388,21 @@ msgstr "Текст всередині спливаючого повідомле msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Продовжити" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Виберіть колір" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Оберіть дату" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Встановити дату й час" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Оберіть місяць" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Встановіть час" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Вимкнути читання з екрана" @@ -409,3 +424,15 @@ msgstr "Смуга швидкого прокручування" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Дана веб-сторінка" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Зберегти пароль?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Продовжити" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Залишитися" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Залишити" + diff --git a/src/osp-string/ur.po b/src/osp-string/ur.po index 966a287..af33484 100644 --- a/src/osp-string/ur.po +++ b/src/osp-string/ur.po @@ -388,6 +388,21 @@ msgstr "پاپ-اپ کے بدن میں متن" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "جاری" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "رنگ سیٹ کریں" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "تاریخ سیٹ کریں" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "تاریخ اور وقت سیٹ کریں" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "مہینہ سیٹ کریں" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "وقت سیٹ کریں" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "اسکرین ریڈر نا اہل بنائیں۔" @@ -409,3 +424,15 @@ msgstr "تیز-اسکرال بار" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "یہ ویب صفحہ" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "پاس ورڈ محفوظ کریں؟" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "جاری رکھیں" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "ٹھہریں" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "چھوڑ دیں" + diff --git a/src/osp-string/uz.po b/src/osp-string/uz.po index 65a24c2..9795cb9 100644 --- a/src/osp-string/uz.po +++ b/src/osp-string/uz.po @@ -388,6 +388,21 @@ msgstr "Qalqib chiquvchi oynaga matn kiritish" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "Davom ettirish" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "Rangni sozlash" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "Sana o‘rnat" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "Sana va vaqtni o‘rnatish" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "Oy o‘rnat" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "Vaqtni o‘rnat" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "Ekran o‘qish vos-ni o‘chir" @@ -409,3 +424,15 @@ msgstr "Tez aylantirish paneli" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "Ushbu veb-sahifa" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "Parol saqlansinmi?" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "Davom etish" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "Turish" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "Tark etish" + diff --git a/src/osp-string/zh_CN.po b/src/osp-string/zh_CN.po index 2e8d941..8923d23 100644 --- a/src/osp-string/zh_CN.po +++ b/src/osp-string/zh_CN.po @@ -26,7 +26,7 @@ msgid "IDS_COM_BUTTON_LOGIN" msgstr "登录" msgid "IDS_COM_BODY_FLASH_CONTENT_C_PS_IS_TRYING_TO_ACCESS_REMOTE_LOCATION_C_PS_MSG" -msgstr "Flash内容：%s正尝试访问远程位置：%s。允许吗？如果是，必须重启应用程序" +msgstr "Flash内容：%s正尝试访问远程位置：%s。允许吗？如果是，必须重启应用程序。" msgid "IDS_BR_BODY_AUTHUSERNAME" msgstr "用户名" @@ -388,6 +388,21 @@ msgstr "提示窗口正文文本" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "继续" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "设置颜色" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "设置日期" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "设置日期与时间" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "设置月份" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "设置时间" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "禁用屏幕阅读器" @@ -409,3 +424,15 @@ msgstr "快速滚动条" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "该网页" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "储存密码？" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "继续" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "保持" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "离开" + diff --git a/src/osp-string/zh_HK.po b/src/osp-string/zh_HK.po index 3235a63..1e665d1 100644 --- a/src/osp-string/zh_HK.po +++ b/src/osp-string/zh_HK.po @@ -26,7 +26,7 @@ msgid "IDS_COM_BUTTON_LOGIN" msgstr "登入" msgid "IDS_COM_BODY_FLASH_CONTENT_C_PS_IS_TRYING_TO_ACCESS_REMOTE_LOCATION_C_PS_MSG" -msgstr "Flash 內容：%s 正嘗試存取遠端位置：%s。 允許嗎？若是，必須重新啟動應用程式" +msgstr "Flash 內容：%s 正嘗試存取遠端位置：%s。 允許嗎？若是，必須重新啟動應用程式。" msgid "IDS_BR_BODY_AUTHUSERNAME" msgstr "用戶名稱" @@ -388,6 +388,21 @@ msgstr "彈出視窗內文中的文字" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "繼續" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "設定顏色" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "設定日期" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "設定日期與時間" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "設定月份" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "設定時間" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "停用螢幕閱讀器" @@ -409,3 +424,15 @@ msgstr "快速捲動列" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "此網頁" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "儲存密碼嗎？" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "繼續" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "保留" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "離開" + diff --git a/src/osp-string/zh_SG.po b/src/osp-string/zh_SG.po index d833427..c44dc1b 100644 --- a/src/osp-string/zh_SG.po +++ b/src/osp-string/zh_SG.po @@ -388,6 +388,21 @@ msgstr "提示窗口正文文本" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "继续" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "设置颜色" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "设置日期" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "设置日期与时间" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "设置月份" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "设置时间" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "关闭屏幕阅读器" @@ -409,3 +424,15 @@ msgstr "快速滚动条" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "该网页" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "储存密码？" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "继续" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "保持" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "离开" + diff --git a/src/osp-string/zh_TW.po b/src/osp-string/zh_TW.po index 2c86163..6205400 100644 --- a/src/osp-string/zh_TW.po +++ b/src/osp-string/zh_TW.po @@ -26,7 +26,7 @@ msgid "IDS_COM_BUTTON_LOGIN" msgstr "登入" msgid "IDS_COM_BODY_FLASH_CONTENT_C_PS_IS_TRYING_TO_ACCESS_REMOTE_LOCATION_C_PS_MSG" -msgstr "Flash 內容：%s 正在嘗試存取遠端位置：%s。允許嗎？如果是，必須重新啟動應用程式" +msgstr "Flash 內容：%s 正在嘗試存取遠端位置：%s。允許嗎？如果是，必須重新啟動應用程式。" msgid "IDS_BR_BODY_AUTHUSERNAME" msgstr "使用者名稱" @@ -388,6 +388,21 @@ msgstr "彈出視窗內文中的文字" msgid "IDS_TPLATFORM_BUTTON_CONTINUE" msgstr "繼續" +msgid "IDS_TPLATFORM_HEADER_SET_COLOUR" +msgstr "設定顏色" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE" +msgstr "設定日期" + +msgid "IDS_TPLATFORM_HEADER_SET_DATE_AND_TIME_ABB" +msgstr "設定日期與時間" + +msgid "IDS_TPLATFORM_HEADER_SET_MONTH" +msgstr "設定月份" + +msgid "IDS_TPLATFORM_HEADER_SET_TIME" +msgstr "設定時間" + msgid "IDS_TPLATFORM_OPT_DISABLE_SCREEN_READER_ABB" msgstr "停用螢幕閱讀器" @@ -409,3 +424,15 @@ msgstr "快速捲動列" msgid "IDS_BR_BODY_THIS_WEBPAGE" msgstr "此網頁" +msgid "IDS_TPLATFORM_POP_SAVE_PASSWORD_Q" +msgstr "儲存密碼？" + +msgid "IDS_TPLATFORM_BUTTON_CONTINUE_ABB2" +msgstr "繼續" + +msgid "IDS_TPLATFORM_BUTTON_STAY" +msgstr "保留" + +msgid "IDS_TPLATFORM_BUTTON_LEAVE" +msgstr "離開" + diff --git a/src/security/FSecAccessController.cpp b/src/security/FSecAccessController.cpp index 0249383..fbc43b9 100644 --- a/src/security/FSecAccessController.cpp +++ b/src/security/FSecAccessController.cpp @@ -28,6 +28,8 @@ #include #include #include +#include +#include #include #include #include @@ -101,18 +103,32 @@ AccessController::Initialize(void) std::unique_ptr pChecksum(new (std::nothrow) String()); SysTryReturnVoidResult(NID_SEC, pChecksum != null, E_OUT_OF_MEMORY, "The memory is insufficient."); - std::unique_ptr pPrivilegeList(new ArrayList()); - SysTryReturnVoidResult(NID_SEC, pPrivilegeList != null, E_OUT_OF_MEMORY, "The memory is insufficient."); + std::unique_ptr< ArrayListT< String > > pPrivilegeListT(new ArrayListT< String >()); + SysTryReturnVoidResult(NID_SEC, pPrivilegeListT != null, E_OUT_OF_MEMORY, "The memory is insufficient."); - pPrivilegeList->Construct(); + pPrivilegeListT->Construct(); - std::unique_ptr pCipherPrivilegeMessage(new (std::nothrow) PrivilegeManagerMsg_retrieve(pEncryptedPrivileges.get(), pChecksum.get(), pPrivilegeList.get(), &r)); + std::unique_ptr pCipherPrivilegeMessage(new (std::nothrow) PrivilegeManagerMsg_retrieve(pEncryptedPrivileges.get(), pChecksum.get(), pPrivilegeListT.get(), &r)); SysTryReturnVoidResult(NID_SEC, pCipherPrivilegeMessage != null, E_OUT_OF_MEMORY, "The memory is insufficient."); result ipcResult = pIpcClient->SendRequest(pCipherPrivilegeMessage.get()); SysTryReturnVoidResult(NID_SEC, ipcResult == E_SUCCESS, E_SYSTEM, "Failed to send IPC message."); SysTryReturnVoidResult(NID_SEC, r == E_SUCCESS, r, "Failed to retrieve privilege information"); + std::unique_ptr pPrivilegeList(new ArrayList()); + SysTryReturnVoidResult(NID_SEC, pPrivilegeList != null, E_OUT_OF_MEMORY, "The memory is insufficient."); + + pPrivilegeList->Construct(); + + std::unique_ptr > pEnum(pPrivilegeListT->GetEnumeratorN()); + while (pEnum->MoveNext() == E_SUCCESS) + { + String tempString; + pEnum->GetCurrent(tempString); + pPrivilegeList->Add(new String(tempString)); + } + pPrivilegeListT->RemoveAll(); + std::unique_ptr pEncryptedVisibility(new (std::nothrow) String()); SysTryReturnVoidResult(NID_SEC, pEncryptedVisibility != null, E_OUT_OF_MEMORY, "The memory is insufficient."); diff --git a/src/security/FSecRsaKeyConverter.cpp b/src/security/FSecRsaKeyConverter.cpp index b8f9bff..84107e0 100644 --- a/src/security/FSecRsaKeyConverter.cpp +++ b/src/security/FSecRsaKeyConverter.cpp @@ -248,10 +248,9 @@ RsaKeyConverter::ConvertPublicKeyFormatN(RsaKeyFormat format, const IPublicKey& if (isPemFormat == true) { PublicKey nKey; - r = nKey.SetKey(*pOutBuffer); + r = nKey.SetKey(*pOutBuffer.get()); SysTryCatch(NID_SEC, !IsFailed(r), r = E_INVALID_ARG, E_INVALID_ARG, "[E_INVALID_ARG] The specified input parameter is invalid."); - pOutBuffer.reset(ConvertDerToPemN(format, nKey)); - //pOutBuffer = std::unique_ptr< ByteBuffer >(ConvertDerToPemN(format, nKey)); + pOutBuffer = std::unique_ptr< ByteBuffer >(ConvertDerToPemN(format, nKey)); SysTryCatch(NID_SEC, pOutBuffer != null, r = GetLastResult(), GetLastResult(), "[%s] Failed to convert der to pem encoded byte buffer"); } diff --git a/src/security/FSec_AccessController.cpp b/src/security/FSec_AccessController.cpp index d7a7420..958c2f0 100644 --- a/src/security/FSec_AccessController.cpp +++ b/src/security/FSec_AccessController.cpp @@ -28,6 +28,7 @@ #include #include #include +#include #include #include #include @@ -312,17 +313,31 @@ _AccessController::Initialize(void) pChecksum.reset(new (std::nothrow) String()); SysTryReturnVoidResult(NID_SEC, pChecksum != null, E_OUT_OF_MEMORY, "The memory is insufficient."); - pPrivilegeList.reset(new ArrayList()); - SysTryReturnVoidResult(NID_SEC, pPrivilegeList != null, E_OUT_OF_MEMORY, "The memory is insufficient."); - pPrivilegeList->Construct(); + std::unique_ptr< ArrayListT< String > > pPrivilegeListT(new ArrayListT< String >()); + SysTryReturnVoidResult(NID_SEC, pPrivilegeListT != null, E_OUT_OF_MEMORY, "The memory is insufficient."); + + pPrivilegeListT->Construct(); - std::unique_ptr pCipherPrivilegeMessage(new (std::nothrow) PrivilegeManagerMsg_retrieve(pEncryptedPrivileges.get(), pChecksum.get(), pPrivilegeList.get(), &r)); + std::unique_ptr pCipherPrivilegeMessage(new (std::nothrow) PrivilegeManagerMsg_retrieve(pEncryptedPrivileges.get(), pChecksum.get(), pPrivilegeListT.get(), &r)); SysTryReturnVoidResult(NID_SEC, pCipherPrivilegeMessage != null, E_OUT_OF_MEMORY, "The memory is insufficient."); result ipcResult = pIpcClient->SendRequest(pCipherPrivilegeMessage.get()); SysTryReturnVoidResult(NID_SEC, ipcResult == E_SUCCESS, E_SYSTEM, "Failed to send IPC message."); SysTryReturnVoidResult(NID_SEC, r == E_SUCCESS, r, "Failed to retrieve privilege information"); + pPrivilegeList.reset(new ArrayList(SingleObjectDeleter)); + SysTryReturnVoidResult(NID_SEC, pPrivilegeList != null, E_OUT_OF_MEMORY, "The memory is insufficient."); + pPrivilegeList->Construct(); + + std::unique_ptr > pEnum(pPrivilegeListT->GetEnumeratorN()); + while (pEnum->MoveNext() == E_SUCCESS) + { + String tempString; + pEnum->GetCurrent(tempString); + pPrivilegeList->Add(new String(tempString)); + } + pPrivilegeListT->RemoveAll(); + pEncryptedVisibility.reset(new (std::nothrow) String()); SysTryReturnVoidResult(NID_SEC, pEncryptedVisibility != null, E_OUT_OF_MEMORY, "The memory is insufficient."); @@ -594,7 +609,7 @@ _AccessController::CheckPrivacy(const PackageId & packageId, _Privilege privileg if (ret != PRIV_MGR_ERROR_SUCCESS) { r = E_USER_NOT_CONSENTED; - SysLog(NID_SEC, "Result : FALSE [Privacy]"); + SysLog(NID_SEC, "Result: FALSE [Privacy]"); } return r; @@ -617,7 +632,7 @@ _AccessController::CheckPrivacy(const PackageId & packageId, const String& privi if (ret != PRIV_MGR_ERROR_SUCCESS) { r = E_USER_NOT_CONSENTED; - SysLog(NID_SEC, "Result : FALSE [Privacy]"); + SysLog(NID_SEC, "Result: FALSE [Privacy]"); } return r; diff --git a/src/security/FSec_PrivilegeInfo.cpp b/src/security/FSec_PrivilegeInfo.cpp index 48b125b..bc6621c 100644 --- a/src/security/FSec_PrivilegeInfo.cpp +++ b/src/security/FSec_PrivilegeInfo.cpp @@ -481,13 +481,10 @@ _PrivilegeInfo::HasPrivilege(_Privilege privilege) const byte bitwiseTargetPrivilege = 0; byte tempBitwisePrivilege = 0; - if (__apiVisibility != _API_VISIBILITY_NONE) // To be removed + if (visibilityLevelListTable[privilege] > __apiVisibility) { - if (visibilityLevelListTable[privilege] > __apiVisibility) - { - SysLog(NID_SEC, "Result : FALSE [Visibility]"); - return ret; - } + SysLog(NID_SEC, "Result : FALSE [Visibility]"); + return ret; } bitwiseTargetPrivilege = bitwiseTargetPrivilege | (1 << privilegeBit); @@ -515,12 +512,9 @@ _PrivilegeInfo::HasPrivilegeEx(_Privilege privilege) const byte bitwiseTargetPrivilege = 0; byte tempBitwisePrivilege = 0; - if (__apiVisibility != _API_VISIBILITY_NONE) // To be removed + if (visibilityLevelListTable[privilege] > __apiVisibility) { - if (visibilityLevelListTable[privilege] > __apiVisibility) - { - return ret; - } + return ret; } bitwiseTargetPrivilege = bitwiseTargetPrivilege | (1 << privilegeBit); @@ -571,17 +565,14 @@ _PrivilegeInfo::HasPrivilege(const String& privilege) const ret = __privilegeList.ContainsKey(privilege); if (ret) { - if (__apiVisibility != _API_VISIBILITY_NONE) // To be removed + const String* pPrivilegeLevel = static_cast< const String* >(__privilegeList.GetValue(privilege)); + SysTryReturn(NID_SEC, pPrivilegeLevel != null, E_SYSTEM, E_SYSTEM, "[E_SYSTEM] An unexpected system error occurred."); + + int privilegeLevel = GetPrivilegeLevel(*pPrivilegeLevel); + if (privilegeLevel > __apiVisibility) { - const String* pPrivilegeLevel = static_cast< const String* >(__privilegeList.GetValue(privilege)); - SysTryReturn(NID_SEC, pPrivilegeLevel != null, E_SYSTEM, E_SYSTEM, "[E_SYSTEM] An unexpected system error occurred."); - - int privilegeLevel = GetPrivilegeLevel(*pPrivilegeLevel); - if (privilegeLevel > __apiVisibility) - { - SysLog(NID_SEC, "Result : FALSE [Visibility]"); - return false; - } + SysLog(NID_SEC, "Result : FALSE [Visibility]"); + return false; } SysLog(NID_SEC, "Result : TRUE"); diff --git a/src/security/cert/FSecCert_X509CertificateStoreImpl.cpp b/src/security/cert/FSecCert_X509CertificateStoreImpl.cpp index 1df2b3b..93a8645 100644 --- a/src/security/cert/FSecCert_X509CertificateStoreImpl.cpp +++ b/src/security/cert/FSecCert_X509CertificateStoreImpl.cpp @@ -84,10 +84,16 @@ _X509CertificateStoreImpl::_X509CertificateStoreImpl(void) _X509CertificateStoreImpl::~_X509CertificateStoreImpl(void) { - if ((__certType > _CERT_TYPE_NOT_BOUNDED) && (__certType < _CERT_TYPE_MAX)) + int prevIndex = GetIndexFromCertType(__certType); + if (__certType == _CERT_TYPE_USER_CERT) { __pCertServiceProxy->CloseCertificateStore(__certType); } + else if (prevIndex > -1 && __context[prevIndex] != 0) + { + _CertServer::CloseCertificateStore(reinterpret_cast< CertificateStoreCtx >(__context[prevIndex])); + __context[prevIndex] = 0; + } } result @@ -381,7 +387,7 @@ _X509CertificateStoreImpl::Update(CertificateType certificateType, const Tizen:: oldBufferLen = pOldEncodedData->GetRemaining(); SysTryReturnResult(NID_SEC_CERT, oldBufferLen > 0, E_INVALID_ARG, "Input old certificate length is not positive."); - pOldEncodedData.reset(null); + //pOldEncodedData.reset(null); std::unique_ptr< ByteBuffer > pNewEncodedData(newCert.GetEncodedDataN()); SysTryReturnResult(NID_SEC_CERT, pNewEncodedData != null, E_INVALID_ARG, "Failed to get encoded data on new input certificate."); @@ -552,4 +558,4 @@ InsertPkcs12Content(const char* pPath, const char* pPassword) } -} } } // Tizen::Security::Cert +} } } // Tizen::Security::Cert diff --git a/src/security/inc/FSec_AccessControlTypes.h b/src/security/inc/FSec_AccessControlTypes.h index 3df87bc..e023abb 100644 --- a/src/security/inc/FSec_AccessControlTypes.h +++ b/src/security/inc/FSec_AccessControlTypes.h @@ -425,7 +425,7 @@ const static Tizen::Base::_ApiVisibility visibilityLevelListTable[_MAX_PRIVILEGE Tizen::Base::_API_VISIBILITY_PLATFORM, // settingmanager.read Tizen::Base::_API_VISIBILITY_PLATFORM, // settingmanager.write Tizen::Base::_API_VISIBILITY_PARTNER, // appmanager.certificate - Tizen::Base::_API_VISIBILITY_PARTNER, // datacontrol.consumer + Tizen::Base::_API_VISIBILITY_PUBLIC, // datacontrol.consumer Tizen::Base::_API_VISIBILITY_PUBLIC, // datasync Tizen::Base::_API_VISIBILITY_PUBLIC, // filesystem.read Tizen::Base::_API_VISIBILITY_PUBLIC, // filesystem.write @@ -472,8 +472,8 @@ const static bool privacyListTable[_MAX_PRIVILEGE_ENUM] = true, // calendar.read true, // calendar.write false, // callforward - false, // callhistory.read - false, // callhistory.write + true, // callhistory.read + true, // callhistory.write false, // camera false, // cellbroadcast false, // certificate.read diff --git a/src/security/inc/FSec_PrivilegeManagerMessage.h b/src/security/inc/FSec_PrivilegeManagerMessage.h index 7222d14..22f7930 100644 --- a/src/security/inc/FSec_PrivilegeManagerMessage.h +++ b/src/security/inc/FSec_PrivilegeManagerMessage.h @@ -25,5 +25,5 @@ #define IPC_MESSAGE_START PrivilegeManagerMsgStart -IPC_SYNC_MESSAGE_CONTROL0_4(PrivilegeManagerMsg_retrieve, Tizen::Base::String, Tizen::Base::String, Tizen::Base::Collection::ArrayList, result) +IPC_SYNC_MESSAGE_CONTROL0_4(PrivilegeManagerMsg_retrieve, Tizen::Base::String, Tizen::Base::String, Tizen::Base::Collection::ArrayListT< Tizen::Base::String >, result) IPC_SYNC_MESSAGE_CONTROL0_3(PrivilegeManagerMsg_retrieveEx, Tizen::Base::String, Tizen::Base::String, result) diff --git a/src/server/CMakeLists.txt b/src/server/CMakeLists.txt index 4d0b47e..e6ef5b3 100644 --- a/src/server/CMakeLists.txt +++ b/src/server/CMakeLists.txt @@ -1,78 +1,2 @@ -SET (this_target osp-appfw-server) - -INCLUDE_DIRECTORIES ( - ${SLP_INCLUDE_DIRS} - ${CMAKE_SOURCE_DIR}/inc - ${CMAKE_SOURCE_DIR}/src/base/inc - ${CMAKE_SOURCE_DIR}/src/io/inc - ${CMAKE_SOURCE_DIR}/src/system/inc - ${CMAKE_SOURCE_DIR}/src/security/inc - ${CMAKE_SOURCE_DIR}/src/security - ${CMAKE_SOURCE_DIR}/src/app/inc - inc - ) - -SET (${this_target}_SOURCE_FILES - app/FApp_AulServer.cpp - app/FApp_AppLaunchCondition.cpp - app/FApp_AppLaunchConditionHandlerBase.cpp - app/FApp_AppManagerEvent.cpp - app/package/FAppPkg_PackageManagerServer.cpp - io/FIo_IpcServer.cpp - security/FSec_PrivilegeManagerServer.cpp - ) - -INCLUDE(FindPkgConfig) -pkg_check_modules(server_pkgs REQUIRED - appsvc - chromium - dukgenerator - glib-2.0 - pkgmgr-info -) - -FOREACH(flag ${server_pkgs_CFLAGS}) - SET(EXTRA_CFLAGS "${EXTRA_CFLAGS} ${flag}") -ENDFOREACH(flag) - -## SET EXTRA COMPILER FLAGS -SET(EXTRA_CFLAGS "${EXTRA_CFLAGS} -fPIC -Wall -Wno-unused") - -## SET C COMPILER FLAGS -SET(CMAKE_C_FLAGS "${OSP_DEBUG_FLAGS} ${OSP_OPT_FLAGS} ${CMAKE_C_FLAGS} ${EXTRA_CFLAGS} ${OSP_COMPILER_FLAGS}") - -## SET CPP COMPILER FLAGS -SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fvisibility=hidden") -SET(CMAKE_CXX_FLAGS "${OSP_DEBUG_FLAGS} ${OSP_OPT_FLAGS} ${CMAKE_CXX_FLAGS} ${EXTRA_CFLAGS} ${OSP_COMPILER_FLAGS}") - -## Create Library -ADD_LIBRARY (${this_target} SHARED ${${this_target}_SOURCE_FILES}) - -SET(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,--no-undefined -Wl,--as-needed") - -TARGET_LINK_LIBRARIES(${this_target} osp-appfw) -TARGET_LINK_LIBRARIES(${this_target} ${server_pkgs_LDFLAGS}) - - -SET_TARGET_PROPERTIES(${this_target} - PROPERTIES - VERSION ${FULLVER} - SOVERSION ${MAJORVER} - CLEAN_DIRECT_OUTPUT 1 -) -ADD_CUSTOM_COMMAND(TARGET ${this_target} - POST_BUILD - COMMAND ${CMAKE_COMMAND} -E copy ${LIBRARY_OUTPUT_PATH}/${CMAKE_SHARED_LIBRARY_PREFIX}${this_target}${CMAKE_SHARED_LIBRARY_SUFFIX} ${LIBRARY_OUTPUT_PATH}/debug/${CMAKE_SHARED_LIBRARY_PREFIX}${this_target}${CMAKE_SHARED_LIBRARY_SUFFIX}.${FULLVER} - COMMAND ${CMAKE_COMMAND} -E create_symlink ${CMAKE_SHARED_LIBRARY_PREFIX}${this_target}${CMAKE_SHARED_LIBRARY_SUFFIX}.${FULLVER} ${LIBRARY_OUTPUT_PATH}/debug/${CMAKE_SHARED_LIBRARY_PREFIX}${this_target}${CMAKE_SHARED_LIBRARY_SUFFIX}.${MAJORVER} - COMMAND ${CMAKE_STRIP} --strip-unneeded ${LIBRARY_OUTPUT_PATH}/${CMAKE_SHARED_LIBRARY_PREFIX}${this_target}${CMAKE_SHARED_LIBRARY_SUFFIX} - COMMENT "strip ${this_target}" -) - -SET(PC_NAME ${this_target}) -SET(PC_REQUIRED ${pc_requires}) -SET(PC_LDFLAGS -l${this_target}) -SET(VERSION ${FULLVER}) - -# pkgconfig file -CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/${this_target}.pc.in ${CMAKE_SOURCE_DIR}/${this_target}.pc @ONLY) - +## Add SubModules +ADD_SUBDIRECTORY(appfw) diff --git a/src/server/app/FApp_AulServer.cpp b/src/server/app/FApp_AulServer.cpp deleted file mode 100755 index fd37fc9..0000000 --- a/src/server/app/FApp_AulServer.cpp +++ /dev/null @@ -1,648 +0,0 @@ -// -// Copyright (c) 2012 Samsung Electronics Co., Ltd. -// -// Licensed under the Apache License, Version 2.0 (the License); -// you may not use this file except in compliance with the License. -// You may obtain a copy of the License at -// -// http://www.apache.org/licenses/LICENSE-2.0 -// -// Unless required by applicable law or agreed to in writing, software -// distributed under the License is distributed on an "AS IS" BASIS, -// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -// See the License for the specific language governing permissions and -// limitations under the License. -// - -/** - * @file FApp_AulServer.cpp - * @brief This is the implementation for the _AulServer.cpp class. - */ -#include -#include -#include -#include -#include -#include -#include - -#include -#include -#include - -#include -#include -#include -#include -#include -#include - -#include -#include -#include "FAppPkg_PackageManagerImpl.h" -#include "FApp_Types.h" -#include "FApp_AulServer.h" -#include "FApp_TemplateUtil.h" - -#ifdef __cplusplus -extern "C" { -#endif -extern int aul_listen_app_dead_signal(int (* func)(int, void*), void* data); -#ifdef __cplusplus -} -#endif - -using namespace Tizen::App::Package; -using namespace Tizen::Base; -using namespace Tizen::Base::Collection; -using namespace Tizen::Base::Runtime; -using namespace Tizen::Base::Utility; - -namespace -{ - -const char _DESKTOP_FILE_PATH[] = "/opt/share/applications"; -const char _DESKTOP_FILE_PATH_FORMAT[] = "%s/%s.desktop"; - -const char _X_TIZEN_SVC[] = "x-tizen-svc"; //X-TIZEN-SVC=[operation1] | [URI1] | [MIME1] ; [operation2] | [URI2] | [MIME2] -const int _MAX_TIZEN_SVC_DESC_LEN = 1024; - -const int _MAX_CATEGORY = 12; -const int _MAX_PACKAGE_ID_LENGTH = 10; - -const char _APP_PATH_FORMAT[] = "/opt/usr/apps/0000000000/bin/%ls"; -const char _APP_PATH_FORMAT2[] = "/opt/apps/0000000000/bin/%ls"; -const char PATH_ROOT[] = "/opt/usr/apps/"; -const char PATH_ROOT2[] = "/opt/apps/"; - -} - -namespace Tizen { namespace App -{ - -struct _CategoryList -{ - const char category[_MAX_CATEGORY]; - _AppType type; -}; - -static const _CategoryList _CATEGORY_LIST[] = -{ - {"home-screen", _APP_TYPE_HOME_APP}, - {"lock-screen", _APP_TYPE_LOCK_APP}, - {"ime", _APP_TYPE_IME_APP}, -}; - -static const int _NUM_CATEGORY = sizeof(_CATEGORY_LIST) / sizeof(_CategoryList); - - -result -_AulServer::SendResult(bundle* b, appsvc_result_val res) -{ - result r = E_SUCCESS; - - int ret = appsvc_send_result(b, res); - - switch (ret) - { - case AUL_R_EINVAL: - r = E_INVALID_ARG; - SysLogException(NID_APP, r, "Invalid result bundle."); - break; - - case AUL_R_ECOMM: - r = E_SYSTEM; - SysLogException(NID_APP, r, "Internal IPC error."); - break; - - case AUL_R_ERROR: - r = E_SYSTEM; - SysLogException(NID_APP, r, "General error."); - break; - - default: - break; - } - - SysLog(NID_APP, "SendResult() ok"); - - return r; -} - - -bool -_AulServer::IsRunning(const AppId& appId, const String& exeName) -{ - char slpPackageName[MAX_SLP_PACKAGE_ID] = {0, }; - - _PackageManagerImpl* pPackageManagerImpl = _PackageManagerImpl::GetInstance(); - SysTryReturn(NID_APP, pPackageManagerImpl != null, false, E_INVALID_STATE, "[E_INVALID_STATE] Invalid package instance."); - - pPackageManagerImpl->GetPackageName(appId, &exeName, slpPackageName, MAX_SLP_PACKAGE_ID); - - const bool isRunning = (aul_app_is_running(slpPackageName) > 0); - - SysLog(NID_APP, "'%s' %s running now.", slpPackageName, (isRunning) ? "is" : "is NOT"); - - return isRunning; -} - -bool -_AulServer::IsRunning(const String& packageName) -{ - std::unique_ptr pPackageId(_StringConverter::CopyToCharArrayN(packageName)); - - const bool isRunning = (aul_app_is_running(pPackageId.get()) > 0); - - SysLog(NID_APP, "'%ls' %s running now.", packageName.GetPointer(), (isRunning) ? "is" : "is NOT"); - return isRunning; -} - - -void -_AulServer::SetOnAppTerminatedCb(int (* pf_app_dead_handler)(int pid, void* pData), void* pData) -{ - aul_listen_app_dead_signal(pf_app_dead_handler, pData); - SysLog(NID_APP, "'app_dead_handler is set."); -} - - -result -_AulServer::TerminateApplicationByPid(int pid) -{ - int ret_aul = aul_subapp_terminate_request_pid(pid); - result r = E_SUCCESS; - - switch (ret_aul) - { - case AUL_R_EINVAL: - r = E_INVALID_ARG; - SysLogException(NID_APP, r, "invaild pid.\n"); - break; - - case AUL_R_ECOMM: - r = E_SYSTEM; - SysLogException(NID_APP, r, "internal AUL IPC error.\n"); - break; - - case AUL_R_ERROR: - r = E_SYSTEM; - SysLogException(NID_APP, r, "general error.\n"); - break; - - default: - SysLog(NID_APP, "'%d' is terminated.", pid); - break; - } - - return r; -} - -result -_AulServer::SetOomAdj(int pid, int adj) -{ - // set oom_adj to -17 for system service - result r = E_SUCCESS; - char buf[FILENAME_MAX]; - FILE *fP = NULL; - - snprintf(buf, FILENAME_MAX, "/proc/%d/oom_adj", pid); - fP = fopen(buf, "w"); - SysTryReturnResult(NID_APP, fP != NULL, E_SYSTEM, "oom_adj change failed with %s.", strerror(errno)); - - fprintf(fP, "%d", adj); - fclose(fP); - - return r; -} - -int -_AulServer::GetAppType(const String& category) -{ - int ret = 0; - - HashMapT map; - map.Construct(); - - StringTokenizer strTok(category, L';'); - - String token; - while (strTok.HasMoreTokens()) - { - result r = strTok.GetNextToken(token); - if (r == E_SUCCESS) - { - map.Add(token, 0); - } - } - - SysLog(NID_APP, "%d category items .", map.GetCount()); - - String key; - - for (int i = 0; i < _NUM_CATEGORY; i++) - { - bool b = false; - key = _CATEGORY_LIST[i].category; - result r = map.ContainsKey(key, b); - if (r == E_SUCCESS && b) - { - ret |= _CATEGORY_LIST[i].type; - } - } - - return ret; -} - -bool _AulServer::IsInstalled(const AppId& appId) -{ - String packageId; - packageId = _PackageManagerImpl::GetPackageIdByAppId(appId); - - return _PackageManagerImpl::GetInstance()->IsPackageInstalled(packageId); -} - -int _AulServer::CreateProcess(const AppId& appId) -{ - SysTryReturn(NID_APP, appId.GetLength() > 10 && appId[10] == L'.', -1, E_INVALID_ARG, "[E_INVALID_ARG] Wrong appId %ls.", appId.GetPointer()); - - int pid = fork(); - - if (pid == -1) - { - return -1; - } - else if (pid == 0) - { - char path[FILENAME_MAX]; - memset(path, '\0', FILENAME_MAX); - -#if 0 - snprintf(path, FILENAME_MAX, _APP_PATH_FORMAT2, appId.GetPointer() + 11); - - int ret = wcstombs(path + strlen(PATH_ROOT2), appId.GetPointer(), 10); - if (ret == -1) - { - SysLogException(NID_APP, E_SYSTEM, "Launching service (%ls)(%s) failed with [%s].", appId.GetPointer(), path, strerror(errno)); - _Process::Exit(1); - } -#else - snprintf(path, FILENAME_MAX, _APP_PATH_FORMAT2, appId.GetPointer() + 11); - - int ret = wcstombs(path + strlen(PATH_ROOT2), appId.GetPointer(), 10); - if (ret == -1) - { - SysLogException(NID_APP, E_SYSTEM, "Launching service (%ls)(%s) failed with [%s].", appId.GetPointer(), path, strerror(errno)); - _Process::Exit(1); - } - - if (euidaccess(path, R_OK) != 0) - { - snprintf(path, FILENAME_MAX, _APP_PATH_FORMAT, appId.GetPointer() + 11); - - ret = wcstombs(path + strlen(PATH_ROOT), appId.GetPointer(), 10); - if (ret == -1) - { - SysLogException(NID_APP, E_SYSTEM, "Launching service (%ls)(%s) failed with [%s].", appId.GetPointer(), path, strerror(errno)); - _Process::Exit(1); - } - } -#endif - - SysLog(NID_APP, "Launching %s.", path); - - int currentPid = getpid(); - - //SetOomAdj(currentPid, -17); // set oom_adj to -17 for system service - - prctl(PR_SET_PDEATHSIG, SIGTERM); - - setpgid(currentPid, currentPid); - - ret = execl(path, path, static_cast(NULL)); - if (ret < 0) - { - SysLogException(NID_APP, E_SYSTEM, "Launching service (%ls)(%s) failed with [%s].", appId.GetPointer(), path, strerror(errno)); - _Process::Exit(1); - } - } - - return pid; - -} - -bool -_AulServer::IsUserPreferredAppForAppControlResolution(const AppId& appId) -{ - std::unique_ptr pAppId(_StringConverter::CopyToCharArrayN(appId)); - - int ret = appsvc_is_defapp(pAppId.get()); - SysTryReturn(NID_APP, ret == 1, false, E_SUCCESS,"%ls is not an UserPreferredAppForAppControlResolution. ret(%d)", appId.GetPointer(), ret); - - SysLog(NID_APP, "%ls is an UserPreferredAppForAppControlResolution.", appId.GetPointer()); - return true; -} - -result -_AulServer::ClearUserPreferenceForAppControlResolution(const AppId& appId) -{ - std::unique_ptr pAppId(_StringConverter::CopyToCharArrayN(appId)); - - int ret_aul = appsvc_unset_defapp(pAppId.get()); - SysTryReturnResult(NID_APP, ret_aul == APPSVC_RET_OK, E_SYSTEM, "Fail to clear UserPreferredAppForAppControlResolution of %ls. ret_aul(%d)", appId.GetPointer(), ret_aul); - - SysLog(NID_APP, "Succeed to clear UserPreferredAppForAppControlResolution of %ls.", appId.GetPointer()); - return E_SUCCESS; -} - -result -_AulServer::_DesktopFile::MakePath(const AppId& appId, const String* pExeName, char* path, int size) -{ - SysTryReturnResult(NID_APP, path != null, E_INVALID_ARG, ""); - - char packageName[MAX_SLP_PACKAGE_ID] = {0, }; - result r = E_SUCCESS; - _PackageManagerImpl* pPackageManagerImpl = _PackageManagerImpl::GetInstance(); - SysTryReturnResult(NID_APP, pPackageManagerImpl, E_INVALID_STATE, "Invalid package manager instance."); - - r = pPackageManagerImpl->GetPackageName(appId, pExeName, packageName, MAX_SLP_PACKAGE_ID); - SysTryReturn(NID_APP, !IsFailed(r), r, r, "%s", GetErrorMessage(r)); - - snprintf(path, size, _DESKTOP_FILE_PATH_FORMAT, _DESKTOP_FILE_PATH, packageName); - - return r; -} - -result -_AulServer::_DesktopFile::UpdateService(const AppId& appId, const char* value) -{ - char path[FILENAME_MAX] = {0, }; - MakePath(appId, null, path, FILENAME_MAX); - - return UpdateField(path, _X_TIZEN_SVC, value); -} - - -result -_AulServer::_DesktopFile::RemoveService(const AppId& appId, const char* operationOnlyValue) -{ - char path[FILENAME_MAX] = {0, }; - MakePath(appId, null, path, FILENAME_MAX); - - return UpdateField(path, _X_TIZEN_SVC, operationOnlyValue, true); -} - - -// -// Update value of specified field. -// currently only "x-slp-svc" field is supported. -// -#define BUFFER_SIZE 1024 -result -_AulServer::_DesktopFile::UpdateField(const char* path, const char* fieldName, const char* value, bool isRemove) -{ - SysTryReturnResult(NID_APP, path != null, E_INVALID_ARG, "path should not be null."); - SysTryReturnResult(NID_APP, fieldName != null, E_INVALID_ARG, "fieldName should not be null."); - SysTryReturnResult(NID_APP, value != null, E_INVALID_ARG, "value should not be null."); - - FILE* fp = fopen(path, "r+"); - SysTryReturnResult(NID_APP, fp != null, E_SYSTEM, "falied to open '%s' due to %s", path, strerror(errno)); - - char buffer[BUFFER_SIZE] = {0, }; - bool found = false; - int len = 0; - int pos = 0; - int foundpos = 0; - result r = E_SUCCESS; - int remains = 0; - - ArrayListT buffers; - buffers.Construct(); - - char* pCurrent = null; - - while (fgets(buffer, BUFFER_SIZE, fp) != NULL) - { - len = strlen(buffer); - SysTryCatch(NID_APP, len < BUFFER_SIZE, , r = E_INVALID_ARG, "strlen returns invalid value. (%d)", len ); - - if (found) - { - pCurrent = new (std::nothrow) char[len + 1]; - SysTryCatch(NID_APP, pCurrent != null, , r = E_OUT_OF_MEMORY, "failed to allocate mem pCurrent"); - - strncpy(pCurrent, buffer, len); - buffers.Add(pCurrent); - } - else - { - if (strncmp(buffer, fieldName, len) == 0) - { - int fieldNameLen = strlen(fieldName); - SysTryCatch(NID_APP, len > fieldNameLen, , E_INVALID_ARG, "[E_INVALID_ARG] fieldName(%s)", fieldName); - - pCurrent = UpdateServiceValueN(buffer + fieldNameLen, value, isRemove); - SysTryCatch(NID_APP, pCurrent != null, , r = GetLastResult(), "[%s] UpdateServiceValue failed", GetErrorMessage(GetLastResult())); - - buffers.Add(pCurrent); - - foundpos = pos; - found = true; - } - } - - pos += len; - } - - if (found) - { - fsetpos(fp, (fpos_t*) &foundpos); - - remains = buffers.GetCount(); // prevent infinite loop - while (buffers.GetCount() > 0 && remains-- > 0) - { - pCurrent = null; - buffers.GetAt(0, pCurrent); - buffers.RemoveAt(0); - SysTryCatch(NID_APP, pCurrent != null, , r = E_INVALID_STATE, ""); - - fputs(pCurrent, fp); - len = strlen(pCurrent); - pos += len; - delete[] pCurrent; - } - - int ret = truncate(path, pos); - SysTryLog(NID_APP, ret == 0, "Truncate failure (%s).", strerror(errno)); - } - else - { - char svctext[_MAX_TIZEN_SVC_DESC_LEN] = {0, }; - snprintf(svctext, _MAX_TIZEN_SVC_DESC_LEN, "%s=%s\n", fieldName, value); - fputs(svctext, fp); - } - fclose(fp); - - return E_SUCCESS; - -CATCH: - - remains = buffers.GetCount(); // prevent infinite loop - while (buffers.GetCount() > 0 && remains-- > 0) - { - pCurrent = null; - buffers.GetAt(0, pCurrent); - buffers.RemoveAt(0); - if (pCurrent != null) - { - delete[] pCurrent; - } - } - - fclose(fp); - - return r; -} - -// -// Tizen service string example -// X-TIZEN-SVC= http://tizen.org/appcontrol/operation/pick|NULL|image/jpge; http://tizen.org/appcontrol/operation/pick|NULL|video/mp4; http://tizen.org/appcontrol/operation/pick|NULL|NULL; http://tizen.org/appcontrol/operation/pview|NULL|NULL -// -char* -_AulServer::_DesktopFile::UpdateServiceValueN(char* buffer, const char* newValue, bool isRemove) -{ - SysTryReturn(NID_APP, buffer != null, null, E_INVALID_ARG, ""); - SysTryReturn(NID_APP, newValue != null, null, E_INVALID_ARG, ""); - - SysLog(NID_APP, "current(%s), new(%s), isRemove(%s)", buffer, newValue, (isRemove) ? "true" : "false"); - - String buf(buffer); - bool found = false; - - const String& servicePattern(L"([A-Za-z&=:/\\.\\-]*);?"); - - ArrayList services; - String resultString; - - Utility::RegularExpression regex; - result r = regex.Construct(servicePattern); - SysTryReturn(NID_APP, !IsFailed(r), null, r, ""); - - String newOperation; - String newUrl; - String newMimeType; - String newService(newValue); - - if (isRemove == false) - { - ParseService(newService, newOperation, newUrl, newMimeType); - } - else - { - newOperation = newValue; - } - - services.Construct(); - - while (regex.Consume(buf, &services) == true) - { - String* pCurrentService = (String*) services.GetAt(1); - services.RemoveAll(false); - - String operation; - String url; - String mimeType; - - ParseService(*pCurrentService, operation, url, mimeType); - - if (operation == newOperation) - { - if (isRemove == true) - { - SysLog(NID_APP, "opreration '%ls' will be removed", operation.GetPointer()); - } - else - { - SysAssertf(found == false, "It's assumed that service doesn't have duplicated operation in tizen desktop file. But it isn't, so now we have to check this case."); - // replace operation. - if (found == false) // ( if duplicated operation is already exist, It will be keeped. - { - // update value - AppendServiceValueToString(resultString, newService); - SysLog(NID_APP, "opreration '%ls;%ls;%ls' will be updated to ;%ls;%ls", operation.GetPointer(), url.GetPointer(), mimeType.GetPointer(), newUrl.GetPointer(), mimeType.GetPointer()); - } - } - found = true; - } - else - { - // add not specified service. - AppendServiceValueToString(resultString, *pCurrentService); - } - - delete pCurrentService; - } - - if (found == false && isRemove == false) - { - AppendServiceValueToString(resultString, newService); - SysLog(NID_APP, "opreration '%ls;%ls;%ls' will be added", newOperation.GetPointer(), newUrl.GetPointer(), newMimeType.GetPointer()); - } - - SysLog(NID_APP, "updated string is '%ls'", resultString.GetPointer()); - return _StringConverter::CopyToCharArrayN(resultString); -} - - -void -_AulServer::_DesktopFile::AppendServiceValueToString(String& serviceString, const String& newVaue) -{ - if (serviceString.GetLength() > 0) - { - serviceString += ";"; - } - - serviceString += newVaue; -} - - -result -_AulServer::_DesktopFile::ParseService(const String& service, String& operation, String& url, String& mimeType) -{ - SysLog(NID_APP, "service(%ls)", service.GetPointer()); - - const String& serviceDetailPattern(L"([A-Za-z&=/\\.\\-]*):(.*://[A-Za-z&=/\\.\\-]*|[A-Za-z&=/\\.\\-]*):([A-Za-z&=/\\.\\-]*)"); - - Utility::RegularExpression regexDetail; - result r = regexDetail.Construct(serviceDetailPattern); - SysTryReturn(NID_APP, !IsFailed(r), null, r, "[%s] RegularExpression::Construct(L\"%ls\") failed.", GetErrorMessage(r), serviceDetailPattern.GetPointer()); - - ArrayList matchedItems; - matchedItems.Construct(); - regexDetail.Match(service, true, &matchedItems); - - int matchedCount = matchedItems.GetCount(); - SysTryLog(NID_APP, matchedCount == 4, "It's assumed that x-slp-svc value always have operation:url:mime in tizen desktop file. But it isn't or our parser is invalid. so now we have to check this case. %d", matchedItems.GetCount()); - - if (matchedCount > 1) - { - operation = *(String*) matchedItems.GetAt(1); - } - - if (matchedCount > 2) - { - url = *(String*) matchedItems.GetAt(2); - } - - if (matchedCount > 3) - { - mimeType = *(String*) matchedItems.GetAt(3); - } - - SysLog(NID_APP, "matched(%d) : (%ls;%ls;%ls)", matchedItems.GetCount(), operation.GetPointer(), url.GetPointer(), mimeType.GetPointer()); - matchedItems.RemoveAll(true); - - return E_SUCCESS; -} - -} } // Tizen::App diff --git a/src/server/appfw/CMakeLists.txt b/src/server/appfw/CMakeLists.txt new file mode 100644 index 0000000..3c1f56c --- /dev/null +++ b/src/server/appfw/CMakeLists.txt @@ -0,0 +1,78 @@ +SET (this_target osp-appfw-server) + +INCLUDE_DIRECTORIES ( + ${SLP_INCLUDE_DIRS} + ${CMAKE_SOURCE_DIR}/inc + ${CMAKE_SOURCE_DIR}/src/base/inc + ${CMAKE_SOURCE_DIR}/src/io/inc + ${CMAKE_SOURCE_DIR}/src/system/inc + ${CMAKE_SOURCE_DIR}/src/security/inc + ${CMAKE_SOURCE_DIR}/src/security + ${CMAKE_SOURCE_DIR}/src/app/inc + inc + ) + +SET (${this_target}_SOURCE_FILES + app/FApp_AulServer.cpp + app/FApp_AppLaunchCondition.cpp + app/FApp_AppLaunchConditionHandlerBase.cpp + app/FApp_AppManagerEvent.cpp + app/package/FAppPkg_PackageManagerServer.cpp + io/FIo_IpcServer.cpp + security/FSec_PrivilegeManagerServer.cpp + ) + +INCLUDE(FindPkgConfig) +pkg_check_modules(server_pkgs REQUIRED + appsvc + chromium + dukgenerator + glib-2.0 + pkgmgr-info +) + +FOREACH(flag ${server_pkgs_CFLAGS}) + SET(EXTRA_CFLAGS "${EXTRA_CFLAGS} ${flag}") +ENDFOREACH(flag) + +## SET EXTRA COMPILER FLAGS +SET(EXTRA_CFLAGS "${EXTRA_CFLAGS} -fPIC -Wall -Wno-unused") + +## SET C COMPILER FLAGS +SET(CMAKE_C_FLAGS "${OSP_DEBUG_FLAGS} ${OSP_OPT_FLAGS} ${CMAKE_C_FLAGS} ${EXTRA_CFLAGS} ${OSP_COMPILER_FLAGS}") + +## SET CPP COMPILER FLAGS +SET(CMAKE_CXX_FLAGS "${CMAKE_CXX_FLAGS} -fvisibility=hidden") +SET(CMAKE_CXX_FLAGS "${OSP_DEBUG_FLAGS} ${OSP_OPT_FLAGS} ${CMAKE_CXX_FLAGS} ${EXTRA_CFLAGS} ${OSP_COMPILER_FLAGS}") + +## Create Library +ADD_LIBRARY (${this_target} SHARED ${${this_target}_SOURCE_FILES}) + +SET(CMAKE_SHARED_LINKER_FLAGS "${CMAKE_SHARED_LINKER_FLAGS} -Wl,--no-undefined -Wl,--as-needed") + +TARGET_LINK_LIBRARIES(${this_target} osp-appfw) +TARGET_LINK_LIBRARIES(${this_target} ${server_pkgs_LDFLAGS}) + + +SET_TARGET_PROPERTIES(${this_target} + PROPERTIES + VERSION ${FULLVER} + SOVERSION ${MAJORVER} + CLEAN_DIRECT_OUTPUT 1 +) +ADD_CUSTOM_COMMAND(TARGET ${this_target} + POST_BUILD + COMMAND ${CMAKE_COMMAND} -E copy ${LIBRARY_OUTPUT_PATH}/${CMAKE_SHARED_LIBRARY_PREFIX}${this_target}${CMAKE_SHARED_LIBRARY_SUFFIX} ${LIBRARY_OUTPUT_PATH}/debug/${CMAKE_SHARED_LIBRARY_PREFIX}${this_target}${CMAKE_SHARED_LIBRARY_SUFFIX}.${FULLVER} + COMMAND ${CMAKE_COMMAND} -E create_symlink ${CMAKE_SHARED_LIBRARY_PREFIX}${this_target}${CMAKE_SHARED_LIBRARY_SUFFIX}.${FULLVER} ${LIBRARY_OUTPUT_PATH}/debug/${CMAKE_SHARED_LIBRARY_PREFIX}${this_target}${CMAKE_SHARED_LIBRARY_SUFFIX}.${MAJORVER} + COMMAND ${CMAKE_STRIP} --strip-unneeded ${LIBRARY_OUTPUT_PATH}/${CMAKE_SHARED_LIBRARY_PREFIX}${this_target}${CMAKE_SHARED_LIBRARY_SUFFIX} + COMMENT "strip ${this_target}" +) + +SET(PC_NAME ${this_target}) +SET(PC_REQUIRED ${pc_requires}) +SET(PC_LDFLAGS -l${this_target}) +SET(VERSION ${FULLVER}) + +# pkgconfig file +CONFIGURE_FILE(${CMAKE_SOURCE_DIR}/${this_target}.pc.in ${CMAKE_SOURCE_DIR}/${this_target}.pc @ONLY) + diff --git a/src/server/app/FApp_AppLaunchCondition.cpp b/src/server/appfw/app/FApp_AppLaunchCondition.cpp similarity index 100% rename from src/server/app/FApp_AppLaunchCondition.cpp rename to src/server/appfw/app/FApp_AppLaunchCondition.cpp diff --git a/src/server/app/FApp_AppLaunchConditionHandlerBase.cpp b/src/server/appfw/app/FApp_AppLaunchConditionHandlerBase.cpp similarity index 100% rename from src/server/app/FApp_AppLaunchConditionHandlerBase.cpp rename to src/server/appfw/app/FApp_AppLaunchConditionHandlerBase.cpp diff --git a/src/server/app/FApp_AppManagerEvent.cpp b/src/server/appfw/app/FApp_AppManagerEvent.cpp similarity index 100% rename from src/server/app/FApp_AppManagerEvent.cpp rename to src/server/appfw/app/FApp_AppManagerEvent.cpp diff --git a/src/server/appfw/app/FApp_AulServer.cpp b/src/server/appfw/app/FApp_AulServer.cpp new file mode 100644 index 0000000..d6ef48b --- /dev/null +++ b/src/server/appfw/app/FApp_AulServer.cpp @@ -0,0 +1,374 @@ +// +// Copyright (c) 2012 Samsung Electronics Co., Ltd. +// +// Licensed under the Apache License, Version 2.0 (the License); +// you may not use this file except in compliance with the License. +// You may obtain a copy of the License at +// +// http://www.apache.org/licenses/LICENSE-2.0 +// +// Unless required by applicable law or agreed to in writing, software +// distributed under the License is distributed on an "AS IS" BASIS, +// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +// See the License for the specific language governing permissions and +// limitations under the License. +// + +/** + * @file FApp_AulServer.cpp + * @brief This is the implementation for the _AulServer.cpp class. + */ +#include +#include +#include +#include +#include +#include +#include + +#include +#include +#include + +#include +#include +#include +#include +#include +#include + +#include +#include +#include "FAppPkg_PackageManagerImpl.h" +#include "FApp_Types.h" +#include "FApp_AulServer.h" +#include "FApp_TemplateUtil.h" + + +using namespace Tizen::App::Package; +using namespace Tizen::Base; +using namespace Tizen::Base::Collection; +using namespace Tizen::Base::Runtime; +using namespace Tizen::Base::Utility; + +namespace +{ + +const int _MAX_CATEGORY = 12; +const int _MAX_PACKAGE_ID_LENGTH = 10; + +const char _APP_PATH_FORMAT[] = "/opt/usr/apps/0000000000/bin/%ls"; +const char _APP_PATH_FORMAT2[] = "/opt/apps/0000000000/bin/%ls"; +const char PATH_ROOT[] = "/opt/usr/apps/"; +const char PATH_ROOT2[] = "/opt/apps/"; + +} + +namespace Tizen { namespace App +{ + +struct _CategoryList +{ + const char category[_MAX_CATEGORY]; + _AppType type; +}; + +static const _CategoryList _CATEGORY_LIST[] = +{ + {"home-screen", _APP_TYPE_HOME_APP}, + {"lock-screen", _APP_TYPE_LOCK_APP}, + {"ime", _APP_TYPE_IME_APP}, +}; + +static const int _NUM_CATEGORY = sizeof(_CATEGORY_LIST) / sizeof(_CategoryList); + + +result +_AulServer::SendResult(bundle* b, appsvc_result_val res) +{ + result r = E_SUCCESS; + + int ret = appsvc_send_result(b, res); + + switch (ret) + { + case AUL_R_EINVAL: + r = E_INVALID_ARG; + SysLogException(NID_APP, r, "Invalid result bundle."); + break; + + case AUL_R_ECOMM: + r = E_SYSTEM; + SysLogException(NID_APP, r, "Internal IPC error."); + break; + + case AUL_R_ERROR: + r = E_SYSTEM; + SysLogException(NID_APP, r, "General error."); + break; + + default: + break; + } + + SysLog(NID_APP, "SendResult() ok"); + + return r; +} + + +bool +_AulServer::IsRunning(const AppId& appId, const String& exeName) +{ + char slpPackageName[MAX_SLP_PACKAGE_ID] = {0, }; + + _PackageManagerImpl* pPackageManagerImpl = _PackageManagerImpl::GetInstance(); + SysTryReturn(NID_APP, pPackageManagerImpl != null, false, E_INVALID_STATE, "[E_INVALID_STATE] Invalid package instance."); + + pPackageManagerImpl->GetPackageName(appId, &exeName, slpPackageName, MAX_SLP_PACKAGE_ID); + + const bool isRunning = (aul_app_is_running(slpPackageName) > 0); + + SysLog(NID_APP, "'%s' %s running now.", slpPackageName, (isRunning) ? "is" : "is NOT"); + + return isRunning; +} + +bool +_AulServer::IsRunning(const String& packageName) +{ + std::unique_ptr pPackageId(_StringConverter::CopyToCharArrayN(packageName)); + + const bool isRunning = (aul_app_is_running(pPackageId.get()) > 0); + + SysLog(NID_APP, "'%ls' %s running now.", packageName.GetPointer(), (isRunning) ? "is" : "is NOT"); + return isRunning; +} + + +result +_AulServer::Launch(const String& appId) +{ + std::unique_ptr pPackageName(_StringConverter::CopyToCharArrayN(appId)); + + int ret = aul_launch_app(pPackageName.get(), NULL); + if (ret < 0) + { + result r = E_SYSTEM; + switch (ret) + { + case AUL_R_EILLACC: + r = E_ILLEGAL_ACCESS; + break; + case AUL_R_EINVAL: + r = E_MAX_EXCEEDED; + break; + default: + break; + } + + SysLogException(NID_APP, r, "[%s] Error occurred.", GetErrorMessage(r)); + return r; + } + + return E_SUCCESS; +} + + +void +_AulServer::SetOnAppTerminatedCb(int (* pf_app_dead_handler)(int pid, void* pData), void* pData) +{ + aul_listen_app_dead_signal(pf_app_dead_handler, pData); + SysLog(NID_APP, "'app_dead_handler is set."); +} + + +result +_AulServer::TerminateApplicationByPid(int pid) +{ + int ret_aul = aul_terminate_pid(pid); + result r = E_SUCCESS; + + switch (ret_aul) + { + case AUL_R_EINVAL: + r = E_INVALID_ARG; + SysLogException(NID_APP, r, "invaild pid.\n"); + break; + + case AUL_R_ECOMM: + r = E_SYSTEM; + SysLogException(NID_APP, r, "internal AUL IPC error.\n"); + break; + + case AUL_R_ERROR: + r = E_SYSTEM; + SysLogException(NID_APP, r, "general error.\n"); + break; + + default: + SysLog(NID_APP, "'%d' is terminated.", pid); + break; + } + + return r; +} + +result +_AulServer::SetOomAdj(int pid, int adj) +{ + // set oom_adj to -17 for system service + result r = E_SUCCESS; + char buf[FILENAME_MAX]; + FILE *fP = NULL; + + snprintf(buf, FILENAME_MAX, "/proc/%d/oom_adj", pid); + fP = fopen(buf, "w"); + SysTryReturnResult(NID_APP, fP != NULL, E_SYSTEM, "oom_adj change failed with %s.", strerror(errno)); + + fprintf(fP, "%d", adj); + fclose(fP); + + return r; +} + +int +_AulServer::GetAppType(const String& category) +{ + int ret = 0; + + HashMapT map; + map.Construct(); + + StringTokenizer strTok(category, L';'); + + String token; + while (strTok.HasMoreTokens()) + { + result r = strTok.GetNextToken(token); + if (r == E_SUCCESS) + { + map.Add(token, 0); + } + } + + SysLog(NID_APP, "%d category items .", map.GetCount()); + + String key; + + for (int i = 0; i < _NUM_CATEGORY; i++) + { + bool b = false; + key = _CATEGORY_LIST[i].category; + result r = map.ContainsKey(key, b); + if (r == E_SUCCESS && b) + { + ret |= _CATEGORY_LIST[i].type; + } + } + + return ret; +} + +bool _AulServer::IsInstalled(const AppId& appId) +{ + String packageId; + packageId = _PackageManagerImpl::GetPackageIdByAppId(appId); + + return _PackageManagerImpl::GetInstance()->IsPackageInstalled(packageId); +} + +int _AulServer::CreateProcess(const AppId& appId) +{ + SysTryReturn(NID_APP, appId.GetLength() > 10 && appId[10] == L'.', -1, E_INVALID_ARG, "[E_INVALID_ARG] Wrong appId %ls.", appId.GetPointer()); + + int pid = fork(); + + if (pid == -1) + { + return -1; + } + else if (pid == 0) + { + char path[FILENAME_MAX]; + memset(path, '\0', FILENAME_MAX); + +#if 0 + snprintf(path, FILENAME_MAX, _APP_PATH_FORMAT2, appId.GetPointer() + 11); + + int ret = wcstombs(path + strlen(PATH_ROOT2), appId.GetPointer(), 10); + if (ret == -1) + { + SysLogException(NID_APP, E_SYSTEM, "Launching service (%ls)(%s) failed with [%s].", appId.GetPointer(), path, strerror(errno)); + _Process::Exit(1); + } +#else + snprintf(path, FILENAME_MAX, _APP_PATH_FORMAT2, appId.GetPointer() + 11); + + int ret = wcstombs(path + strlen(PATH_ROOT2), appId.GetPointer(), 10); + if (ret == -1) + { + SysLogException(NID_APP, E_SYSTEM, "Launching service (%ls)(%s) failed with [%s].", appId.GetPointer(), path, strerror(errno)); + _Process::Exit(1); + } + + if (euidaccess(path, R_OK) != 0) + { + snprintf(path, FILENAME_MAX, _APP_PATH_FORMAT, appId.GetPointer() + 11); + + ret = wcstombs(path + strlen(PATH_ROOT), appId.GetPointer(), 10); + if (ret == -1) + { + SysLogException(NID_APP, E_SYSTEM, "Launching service (%ls)(%s) failed with [%s].", appId.GetPointer(), path, strerror(errno)); + _Process::Exit(1); + } + } +#endif + + SysLog(NID_APP, "Launching %s.", path); + + int currentPid = getpid(); + + //SetOomAdj(currentPid, -17); // set oom_adj to -17 for system service + + prctl(PR_SET_PDEATHSIG, SIGTERM); + + setpgid(currentPid, currentPid); + + ret = execl(path, path, static_cast(NULL)); + if (ret < 0) + { + SysLogException(NID_APP, E_SYSTEM, "Launching service (%ls)(%s) failed with [%s].", appId.GetPointer(), path, strerror(errno)); + _Process::Exit(1); + } + } + + return pid; + +} + +bool +_AulServer::IsUserPreferredAppForAppControlResolution(const AppId& appId) +{ + std::unique_ptr pAppId(_StringConverter::CopyToCharArrayN(appId)); + + int ret = appsvc_is_defapp(pAppId.get()); + SysTryReturn(NID_APP, ret == 1, false, E_SUCCESS,"%ls is not an UserPreferredAppForAppControlResolution. ret(%d)", appId.GetPointer(), ret); + + SysLog(NID_APP, "%ls is an UserPreferredAppForAppControlResolution.", appId.GetPointer()); + return true; +} + +result +_AulServer::ClearUserPreferenceForAppControlResolution(const AppId& appId) +{ + std::unique_ptr pAppId(_StringConverter::CopyToCharArrayN(appId)); + + int ret_aul = appsvc_unset_defapp(pAppId.get()); + SysTryReturnResult(NID_APP, ret_aul == APPSVC_RET_OK, E_SYSTEM, "Fail to clear UserPreferredAppForAppControlResolution of %ls. ret_aul(%d)", appId.GetPointer(), ret_aul); + + SysLog(NID_APP, "Succeed to clear UserPreferredAppForAppControlResolution of %ls.", appId.GetPointer()); + return E_SUCCESS; +} + +} } // Tizen::App diff --git a/src/server/app/package/FAppPkg_PackageManagerServer.cpp b/src/server/appfw/app/package/FAppPkg_PackageManagerServer.cpp similarity index 100% rename from src/server/app/package/FAppPkg_PackageManagerServer.cpp rename to src/server/appfw/app/package/FAppPkg_PackageManagerServer.cpp diff --git a/src/server/inc/FAppPkg_PackageManagerServer.h b/src/server/appfw/inc/FAppPkg_PackageManagerServer.h similarity index 100% rename from src/server/inc/FAppPkg_PackageManagerServer.h rename to src/server/appfw/inc/FAppPkg_PackageManagerServer.h diff --git a/src/server/inc/FApp_AppLaunchCondition.h b/src/server/appfw/inc/FApp_AppLaunchCondition.h similarity index 100% rename from src/server/inc/FApp_AppLaunchCondition.h rename to src/server/appfw/inc/FApp_AppLaunchCondition.h diff --git a/src/server/inc/FApp_AppLaunchConditionHandlerBase.h b/src/server/appfw/inc/FApp_AppLaunchConditionHandlerBase.h similarity index 100% rename from src/server/inc/FApp_AppLaunchConditionHandlerBase.h rename to src/server/appfw/inc/FApp_AppLaunchConditionHandlerBase.h diff --git a/src/server/inc/FApp_AppManagerEvent.h b/src/server/appfw/inc/FApp_AppManagerEvent.h similarity index 100% rename from src/server/inc/FApp_AppManagerEvent.h rename to src/server/appfw/inc/FApp_AppManagerEvent.h diff --git a/src/server/inc/FApp_AppManagerEventArg.h b/src/server/appfw/inc/FApp_AppManagerEventArg.h similarity index 100% rename from src/server/inc/FApp_AppManagerEventArg.h rename to src/server/appfw/inc/FApp_AppManagerEventArg.h diff --git a/src/server/inc/FApp_AulServer.h b/src/server/appfw/inc/FApp_AulServer.h old mode 100755 new mode 100644 similarity index 53% rename from src/server/inc/FApp_AulServer.h rename to src/server/appfw/inc/FApp_AulServer.h index 22c34dc..ccda307 --- a/src/server/inc/FApp_AulServer.h +++ b/src/server/appfw/inc/FApp_AulServer.h @@ -49,6 +49,8 @@ public: static bool IsRunning(const Tizen::Base::String& packageName); + static result Launch(const Tizen::Base::String& appId); + static void SetOnAppTerminatedCb(int (* pf_app_dead_handler)(int pid, void* pData), void* pData); static result SetOomAdj(int pid, int adj); @@ -64,55 +66,6 @@ public: static result ClearUserPreferenceForAppControlResolution(const AppId& appId); public: - /** - * This is static helper class for desktop file. - */ - class _DesktopFile - { - public: - /** - * Updates the service value - * @param[in] appId The application's ID to be executed - * @param[in] value value to be added or updated. - * - * @remark If operations is new, it will be appended. - * but, if same operation is already exist, 'url' and 'mimeType' will be updated. - */ - static result UpdateService(const AppId& appId, const char* value); - - /** - * Removes the service value by operation - * @param[in] appId The application's ID to be executed - * @param[in] operationOnlyValue operationId of service to be removed - */ - static result RemoveService(const AppId& appId, const char* operationOnlyValue); - - private: - /** - * Updates value of specified field - */ - static result UpdateField(const char* path, const char* key, const char* value, bool isRemove = false); - - /** - * Makes desktop file path from appId (retrives appName using _PackageMamagerImpl) - */ - static result MakePath(const AppId& appId, const Tizen::Base::String* pExeName, char* path, int size); - - /** - * Update service value of input buffer with specified value - */ - static char* UpdateServiceValueN(char* buffer, const char* newValue, bool isRemove = false); - - /** - * Extracts each informations from one service string. - */ - static result ParseService(const Tizen::Base::String& service, Tizen::Base::String& operation, Tizen::Base::String& url, Tizen::Base::String& mimeType); - - static void AppendServiceValueToString(Tizen::Base::String& string, const Tizen::Base::String& newVaue); - - friend class UTs_AulServer; - }; // _DesktopFile - friend class UTs_AulServer; }; // _AulServer diff --git a/src/server/inc/FApp_IAppLaunchConditionEventListener.h b/src/server/appfw/inc/FApp_IAppLaunchConditionEventListener.h similarity index 100% rename from src/server/inc/FApp_IAppLaunchConditionEventListener.h rename to src/server/appfw/inc/FApp_IAppLaunchConditionEventListener.h diff --git a/src/server/inc/FApp_IAppManagerEventListener.h b/src/server/appfw/inc/FApp_IAppManagerEventListener.h similarity index 100% rename from src/server/inc/FApp_IAppManagerEventListener.h rename to src/server/appfw/inc/FApp_IAppManagerEventListener.h diff --git a/src/server/inc/FIo_IpcServer.h b/src/server/appfw/inc/FIo_IpcServer.h similarity index 100% rename from src/server/inc/FIo_IpcServer.h rename to src/server/appfw/inc/FIo_IpcServer.h diff --git a/src/server/inc/FSec_PrivilegeManagerServer.h b/src/server/appfw/inc/FSec_PrivilegeManagerServer.h similarity index 96% rename from src/server/inc/FSec_PrivilegeManagerServer.h rename to src/server/appfw/inc/FSec_PrivilegeManagerServer.h index 1021c4b..c62920e 100644 --- a/src/server/inc/FSec_PrivilegeManagerServer.h +++ b/src/server/appfw/inc/FSec_PrivilegeManagerServer.h @@ -61,7 +61,7 @@ private: _PrivilegeManagerServer(void); virtual ~_PrivilegeManagerServer(void); - static result RetrievePrivilege(const Tizen::App::AppId& appId, Tizen::Base::String* pEncryptedBitwise, Tizen::Base::String* pHmac, Tizen::Base::Collection::ArrayList*& pPrivilegeList); + static result RetrievePrivilege(const Tizen::App::AppId& appId, Tizen::Base::String* pEncryptedBitwise, Tizen::Base::String* pHmac, Tizen::Base::Collection::ArrayListT < Tizen::Base::String >*& pPrivilegeList); static result GenerateVisibilityString(Tizen::App::AppId appId, Tizen::Base::String* pEncryptedVisibility, Tizen::Base::String* pHmac); static result GetEncryptedVisibility(int visibility, Tizen::Base::String& encryptedVisibility); static result GetChecksum(Tizen::App::AppId appId, int visibility, Tizen::Base::String& checksum); diff --git a/src/server/io/FIo_IpcServer.cpp b/src/server/appfw/io/FIo_IpcServer.cpp similarity index 100% rename from src/server/io/FIo_IpcServer.cpp rename to src/server/appfw/io/FIo_IpcServer.cpp diff --git a/src/server/security/FSec_PrivilegeManagerServer.cpp b/src/server/appfw/security/FSec_PrivilegeManagerServer.cpp similarity index 98% rename from src/server/security/FSec_PrivilegeManagerServer.cpp rename to src/server/appfw/security/FSec_PrivilegeManagerServer.cpp index b6fcecc..b2abdb3 100644 --- a/src/server/security/FSec_PrivilegeManagerServer.cpp +++ b/src/server/appfw/security/FSec_PrivilegeManagerServer.cpp @@ -61,7 +61,7 @@ _PrivilegeManagerServer::~_PrivilegeManagerServer(void) } result -_PrivilegeManagerServer::RetrievePrivilege(const AppId& appId, String* pEncryptedBitwise, String* pHmac, ArrayList*& pPrivilegeList) +_PrivilegeManagerServer::RetrievePrivilege(const AppId& appId, String* pEncryptedBitwise, String* pHmac, ArrayListT < String >*& pPrivilegeList) { result r = E_SUCCESS; String encryptedBitwise; @@ -81,7 +81,7 @@ _PrivilegeManagerServer::RetrievePrivilege(const AppId& appId, String* pEncrypte while (pEnum->MoveNext() == E_SUCCESS) { String* tempString = static_cast(pEnum->GetCurrent()); - pPrivilegeList->Add(new String(*tempString)); + pPrivilegeList->Add(*tempString); } delete pEnum; diff --git a/src/system-server/CMakeLists.txt b/src/server/system/CMakeLists.txt similarity index 98% rename from src/system-server/CMakeLists.txt rename to src/server/system/CMakeLists.txt index feadf23..59f1039 100644 --- a/src/system-server/CMakeLists.txt +++ b/src/server/system/CMakeLists.txt @@ -6,7 +6,7 @@ INCLUDE_DIRECTORIES ( ${CMAKE_SOURCE_DIR}/inc ${CMAKE_SOURCE_DIR}/src/app/inc ${CMAKE_SOURCE_DIR}/src/base/inc - ${CMAKE_SOURCE_DIR}/src/system-server/inc + ${CMAKE_SOURCE_DIR}/src/server/system/inc ${CMAKE_SOURCE_DIR}/src/io/inc ${CMAKE_SOURCE_DIR}/src/server/inc ${CMAKE_SOURCE_DIR}/src/system/inc diff --git a/src/system-server/device/FSys_DeviceManager.cpp b/src/server/system/device/FSys_DeviceManager.cpp similarity index 100% rename from src/system-server/device/FSys_DeviceManager.cpp rename to src/server/system/device/FSys_DeviceManager.cpp diff --git a/src/system-server/inc/FSys_DeviceManager.h b/src/server/system/inc/FSys_DeviceManager.h similarity index 100% rename from src/system-server/inc/FSys_DeviceManager.h rename to src/server/system/inc/FSys_DeviceManager.h diff --git a/src/system-server/inc/FSys_PowerManager.h b/src/server/system/inc/FSys_PowerManager.h similarity index 100% rename from src/system-server/inc/FSys_PowerManager.h rename to src/server/system/inc/FSys_PowerManager.h diff --git a/src/system-server/inc/FSys_RuntimeInfo.h b/src/server/system/inc/FSys_RuntimeInfo.h similarity index 100% rename from src/system-server/inc/FSys_RuntimeInfo.h rename to src/server/system/inc/FSys_RuntimeInfo.h diff --git a/src/system-server/inc/FSys_SettingInfo.h b/src/server/system/inc/FSys_SettingInfo.h similarity index 100% rename from src/system-server/inc/FSys_SettingInfo.h rename to src/server/system/inc/FSys_SettingInfo.h diff --git a/src/system-server/inc/FSys_SystemInfo.h b/src/server/system/inc/FSys_SystemInfo.h similarity index 100% rename from src/system-server/inc/FSys_SystemInfo.h rename to src/server/system/inc/FSys_SystemInfo.h diff --git a/src/system-server/power/FSys_PowerManager.cpp b/src/server/system/power/FSys_PowerManager.cpp similarity index 100% rename from src/system-server/power/FSys_PowerManager.cpp rename to src/server/system/power/FSys_PowerManager.cpp diff --git a/src/system-server/runtime/FSys_RuntimeInfo.cpp b/src/server/system/runtime/FSys_RuntimeInfo.cpp similarity index 100% rename from src/system-server/runtime/FSys_RuntimeInfo.cpp rename to src/server/system/runtime/FSys_RuntimeInfo.cpp diff --git a/src/system-server/setting/FSys_SettingInfo.cpp b/src/server/system/setting/FSys_SettingInfo.cpp similarity index 100% rename from src/system-server/setting/FSys_SettingInfo.cpp rename to src/server/system/setting/FSys_SettingInfo.cpp diff --git a/src/system-server/setting/providers/FSys_ISettingProvider.h b/src/server/system/setting/providers/FSys_ISettingProvider.h similarity index 100% rename from src/system-server/setting/providers/FSys_ISettingProvider.h rename to src/server/system/setting/providers/FSys_ISettingProvider.h diff --git a/src/system-server/setting/providers/FSys_Icu.cpp b/src/server/system/setting/providers/FSys_Icu.cpp similarity index 95% rename from src/system-server/setting/providers/FSys_Icu.cpp rename to src/server/system/setting/providers/FSys_Icu.cpp index c5f590d..d404687 100644 --- a/src/system-server/setting/providers/FSys_Icu.cpp +++ b/src/server/system/setting/providers/FSys_Icu.cpp @@ -30,10 +30,6 @@ namespace Tizen { namespace System { -static const int _MAX_COUNTRY_LENTH = 2; -static const int _LANGUAGE_START_INDEX = 0; -static const int _MAX_LANGUAGE_LENTH = 2; - _Icu::_Icu() { } diff --git a/src/system-server/setting/providers/FSys_Icu.h b/src/server/system/setting/providers/FSys_Icu.h similarity index 100% rename from src/system-server/setting/providers/FSys_Icu.h rename to src/server/system/setting/providers/FSys_Icu.h diff --git a/src/system-server/setting/providers/FSys_SettingApplicationProvider.cpp b/src/server/system/setting/providers/FSys_SettingApplicationProvider.cpp similarity index 100% rename from src/system-server/setting/providers/FSys_SettingApplicationProvider.cpp rename to src/server/system/setting/providers/FSys_SettingApplicationProvider.cpp diff --git a/src/system-server/setting/providers/FSys_SettingApplicationProvider.h b/src/server/system/setting/providers/FSys_SettingApplicationProvider.h similarity index 100% rename from src/system-server/setting/providers/FSys_SettingApplicationProvider.h rename to src/server/system/setting/providers/FSys_SettingApplicationProvider.h diff --git a/src/system-server/setting/providers/FSys_SettingFontProvider.cpp b/src/server/system/setting/providers/FSys_SettingFontProvider.cpp similarity index 100% rename from src/system-server/setting/providers/FSys_SettingFontProvider.cpp rename to src/server/system/setting/providers/FSys_SettingFontProvider.cpp diff --git a/src/system-server/setting/providers/FSys_SettingFontProvider.h b/src/server/system/setting/providers/FSys_SettingFontProvider.h similarity index 100% rename from src/system-server/setting/providers/FSys_SettingFontProvider.h rename to src/server/system/setting/providers/FSys_SettingFontProvider.h diff --git a/src/system-server/setting/providers/FSys_SettingGeneralProvider.cpp b/src/server/system/setting/providers/FSys_SettingGeneralProvider.cpp similarity index 100% rename from src/system-server/setting/providers/FSys_SettingGeneralProvider.cpp rename to src/server/system/setting/providers/FSys_SettingGeneralProvider.cpp diff --git a/src/system-server/setting/providers/FSys_SettingGeneralProvider.h b/src/server/system/setting/providers/FSys_SettingGeneralProvider.h similarity index 100% rename from src/system-server/setting/providers/FSys_SettingGeneralProvider.h rename to src/server/system/setting/providers/FSys_SettingGeneralProvider.h diff --git a/src/system-server/setting/providers/FSys_SettingLocaleProvider.cpp b/src/server/system/setting/providers/FSys_SettingLocaleProvider.cpp similarity index 100% rename from src/system-server/setting/providers/FSys_SettingLocaleProvider.cpp rename to src/server/system/setting/providers/FSys_SettingLocaleProvider.cpp diff --git a/src/system-server/setting/providers/FSys_SettingLocaleProvider.h b/src/server/system/setting/providers/FSys_SettingLocaleProvider.h similarity index 100% rename from src/system-server/setting/providers/FSys_SettingLocaleProvider.h rename to src/server/system/setting/providers/FSys_SettingLocaleProvider.h diff --git a/src/system-server/setting/providers/FSys_SettingLocationProvider.cpp b/src/server/system/setting/providers/FSys_SettingLocationProvider.cpp similarity index 100% rename from src/system-server/setting/providers/FSys_SettingLocationProvider.cpp rename to src/server/system/setting/providers/FSys_SettingLocationProvider.cpp diff --git a/src/system-server/setting/providers/FSys_SettingLocationProvider.h b/src/server/system/setting/providers/FSys_SettingLocationProvider.h similarity index 100% rename from src/system-server/setting/providers/FSys_SettingLocationProvider.h rename to src/server/system/setting/providers/FSys_SettingLocationProvider.h diff --git a/src/system-server/setting/providers/FSys_SettingNetworkProvider.cpp b/src/server/system/setting/providers/FSys_SettingNetworkProvider.cpp similarity index 100% rename from src/system-server/setting/providers/FSys_SettingNetworkProvider.cpp rename to src/server/system/setting/providers/FSys_SettingNetworkProvider.cpp diff --git a/src/system-server/setting/providers/FSys_SettingNetworkProvider.h b/src/server/system/setting/providers/FSys_SettingNetworkProvider.h similarity index 100% rename from src/system-server/setting/providers/FSys_SettingNetworkProvider.h rename to src/server/system/setting/providers/FSys_SettingNetworkProvider.h diff --git a/src/system-server/setting/providers/FSys_SettingScreenProvider.cpp b/src/server/system/setting/providers/FSys_SettingScreenProvider.cpp similarity index 100% rename from src/system-server/setting/providers/FSys_SettingScreenProvider.cpp rename to src/server/system/setting/providers/FSys_SettingScreenProvider.cpp diff --git a/src/system-server/setting/providers/FSys_SettingScreenProvider.h b/src/server/system/setting/providers/FSys_SettingScreenProvider.h similarity index 100% rename from src/system-server/setting/providers/FSys_SettingScreenProvider.h rename to src/server/system/setting/providers/FSys_SettingScreenProvider.h diff --git a/src/system-server/setting/providers/FSys_SettingSoundProvider.cpp b/src/server/system/setting/providers/FSys_SettingSoundProvider.cpp similarity index 100% rename from src/system-server/setting/providers/FSys_SettingSoundProvider.cpp rename to src/server/system/setting/providers/FSys_SettingSoundProvider.cpp diff --git a/src/system-server/setting/providers/FSys_SettingSoundProvider.h b/src/server/system/setting/providers/FSys_SettingSoundProvider.h similarity index 100% rename from src/system-server/setting/providers/FSys_SettingSoundProvider.h rename to src/server/system/setting/providers/FSys_SettingSoundProvider.h diff --git a/src/system-server/setting/providers/FSys_SettingSpeechProvider.cpp b/src/server/system/setting/providers/FSys_SettingSpeechProvider.cpp similarity index 100% rename from src/system-server/setting/providers/FSys_SettingSpeechProvider.cpp rename to src/server/system/setting/providers/FSys_SettingSpeechProvider.cpp diff --git a/src/system-server/setting/providers/FSys_SettingSpeechProvider.h b/src/server/system/setting/providers/FSys_SettingSpeechProvider.h similarity index 100% rename from src/system-server/setting/providers/FSys_SettingSpeechProvider.h rename to src/server/system/setting/providers/FSys_SettingSpeechProvider.h diff --git a/src/system-server/setting/providers/FSys_SettingStorageProvider.cpp b/src/server/system/setting/providers/FSys_SettingStorageProvider.cpp similarity index 100% rename from src/system-server/setting/providers/FSys_SettingStorageProvider.cpp rename to src/server/system/setting/providers/FSys_SettingStorageProvider.cpp diff --git a/src/system-server/setting/providers/FSys_SettingStorageProvider.h b/src/server/system/setting/providers/FSys_SettingStorageProvider.h similarity index 100% rename from src/system-server/setting/providers/FSys_SettingStorageProvider.h rename to src/server/system/setting/providers/FSys_SettingStorageProvider.h diff --git a/src/system-server/setting/providers/FSys_SettingVibrationProvider.cpp b/src/server/system/setting/providers/FSys_SettingVibrationProvider.cpp similarity index 100% rename from src/system-server/setting/providers/FSys_SettingVibrationProvider.cpp rename to src/server/system/setting/providers/FSys_SettingVibrationProvider.cpp diff --git a/src/system-server/setting/providers/FSys_SettingVibrationProvider.h b/src/server/system/setting/providers/FSys_SettingVibrationProvider.h similarity index 100% rename from src/system-server/setting/providers/FSys_SettingVibrationProvider.h rename to src/server/system/setting/providers/FSys_SettingVibrationProvider.h diff --git a/src/system-server/system/FSys_SystemInfo.cpp b/src/server/system/system/FSys_SystemInfo.cpp similarity index 100% rename from src/system-server/system/FSys_SystemInfo.cpp rename to src/server/system/system/FSys_SystemInfo.cpp diff --git a/src/system/FSysSettingInfo.cpp b/src/system/FSysSettingInfo.cpp index 751b562..786b125 100644 --- a/src/system/FSysSettingInfo.cpp +++ b/src/system/FSysSettingInfo.cpp @@ -116,6 +116,9 @@ SettingInfo::SetVolume(const String& soundCategory, int level) result SettingInfo::GetValueForPrivilegedKey(const String& key, bool& value) { + result r = _AccessController::CheckUserPrivilege(_PRV_SETTINGMANAGER_READ); + SysTryReturn(NID_SYS, r == E_SUCCESS, E_PRIVILEGE_DENIED, E_PRIVILEGE_DENIED, ("[E_PRIVILEGE_DENIED] The application does not have the privilege to call this method.")); + return _SettingInfoImpl::GetValueForPrivilegedKey(key, value); } diff --git a/src/system/FSys_AlarmManager.cpp b/src/system/FSys_AlarmManager.cpp index 7ddeb62..88e0eee 100644 --- a/src/system/FSys_AlarmManager.cpp +++ b/src/system/FSys_AlarmManager.cpp @@ -86,6 +86,30 @@ _AlarmManager::~_AlarmManager() alarm_cancel_all(); } +int alarm_callback(alarm_id_t alarmId, void *user_param) +{ + _AlarmManager* pAlarmManager = _AlarmManager::GetInstance(); + SysTryReturn(NID_SYS, pAlarmManager, -1, E_SYSTEM, "It is fail to get AlarmManager."); + pAlarmManager->OnAlarmExpired((int)alarmId); + return 0; +} + +result +_AlarmManager::Construct(void) +{ + int errorCode; + Tizen::App::App* pApp = null; + pApp = Tizen::App::App::GetInstance(); + SysTryReturnResult(NID_SYS, pApp, E_SYSTEM, "It is failed to get app instance."); + String appId = pApp->GetAppId(); + std::unique_ptr pAppId(_StringConverter::CopyToCharArrayN(appId)); + errorCode = alarmmgr_init(pAppId.get()); + SysTryReturnResult(NID_SYS, errorCode == ALARMMGR_RESULT_SUCCESS, E_SYSTEM, "It is failed to init alarmmgr. error [%d]", errorCode); + errorCode = alarmmgr_set_cb(alarm_callback, null); + SysTryReturnResult(NID_SYS, errorCode == ALARMMGR_RESULT_SUCCESS, E_SYSTEM, "It is failed to set cb to alarmmgr. error [%d]", errorCode); + return E_SUCCESS; +} + _AlarmManager* _AlarmManager::GetInstance(void) { @@ -100,11 +124,13 @@ _AlarmManager::GetInstance(void) void _AlarmManager::InitSingleton(void) { - _AlarmManager* pAlarmManager = new (std::nothrow) _AlarmManager(); + result r = E_SUCCESS; + std::unique_ptr<_AlarmManager> pAlarmManager(new (std::nothrow) _AlarmManager()); SysTryReturnVoidResult(NID_SYS, pAlarmManager, E_OUT_OF_MEMORY, "[%s] Memory allocation failed.", GetErrorMessage(E_OUT_OF_MEMORY)); - - __pAlarmManager = pAlarmManager; + r = pAlarmManager->Construct(); + SysTryReturnVoidResult(NID_SYS, r == E_SUCCESS, E_SYSTEM, "It is failed to construct alarm manager."); + __pAlarmManager = pAlarmManager.release(); std::atexit(DestroySingleton); } @@ -163,7 +189,7 @@ _AlarmManager::ReserveAlarm(Tizen::Base::String appId, Tizen::Base::DateTime sta ret = alarmmgr_set_type(pAlarmInfo, ALARM_TYPE_NOLAUNCH); SysTryCatch(NID_SYS, ret == ALARMMGR_RESULT_SUCCESS, r = E_SYSTEM, r, "It is failed to set repeat mode"); - ret = alarmmgr_add_alarm_appsvc_with_localtime(pAlarmInfo,(void *)pBundle, &reservedAlarmId); + ret = alarmmgr_add_alarm_with_localtime(pAlarmInfo, null, &reservedAlarmId); SysTryCatch(NID_SYS, ret == ALARMMGR_RESULT_SUCCESS, r = E_SYSTEM, r, "Alarm creation failed!!! Alrmgr error code is %d", ret); CATCH: diff --git a/src/system/FSys_EnvironmentImpl.cpp b/src/system/FSys_EnvironmentImpl.cpp index 3bd668d..b964525 100644 --- a/src/system/FSys_EnvironmentImpl.cpp +++ b/src/system/FSys_EnvironmentImpl.cpp @@ -43,7 +43,7 @@ static const wchar_t _EXTERNAL_MMC_VIDEOS_PATH[] = L"/opt/storage/sdcard/Videos/ static const wchar_t _EXTERNAL_MMC_CAMERA_PATH[] = L"/opt/storage/sdcard/Camera/"; static const wchar_t _EXTERNAL_MMC_DOWNLOADS_PATH[] = L"/opt/storage/sdcard/Downloads/"; static const wchar_t _EXTERNAL_MMC_OTHERS_PATH[] = L"/opt/storage/sdcard/Others/"; -static const wchar_t _RINGTONE_PATH[] = L"/opt/share/settings/Ringtones"; +static const wchar_t _RINGTONE_PATH[] = L"/opt/share/settings/Ringtones/"; static const wchar_t _APPLICATIONS_PATH[] = L"/opt/usr/apps/"; static const wchar_t _EXTERNAL_APPLICATIONS_PATH[] = L"/opt/storage/sdcard/app2sd/"; diff --git a/src/system/FSys_PowerManagerImpl.cpp b/src/system/FSys_PowerManagerImpl.cpp index bcf55bd..98bd6d7 100644 --- a/src/system/FSys_PowerManagerImpl.cpp +++ b/src/system/FSys_PowerManagerImpl.cpp @@ -71,6 +71,8 @@ static const wchar_t* POWER_MANAGER_SERVICE_ID = L"osp.sys.ipcserver.powermanage #endif bool _activeApp = false; +unsigned int _dimmingFlag = GOTO_STATE_NOW; +unsigned int _screenOnState = LCD_DIM; bool _deviceCpuPowerOn = false; bool _keepCpuAwake = false; bool _keepScreenOnState = false; @@ -96,11 +98,18 @@ void _ActiveEventListener::OnActiveAppChanged(const Tizen::App::AppId& appId) { int ret = 0; - SysLog(NID_SYS, "Active App is %ls.", appId.GetPointer()); + SysLog(NID_SYS, "Active App is %ls. GetApp id %ls", appId.GetPointer(), _AppInfo::GetApplicationId().GetPointer()); if(appId == _AppInfo::GetApplicationId()) { _activeApp = true; + if (_keepScreenOnState == true) + { + int ret = -1; + ret = pm_lock_state(_screenOnState, _dimmingFlag, 0); + SysTryReturnVoidResult(NID_SYS, ret == 0,E_SYSTEM, "[E_SYSTEM] It failed to lock the screen state. error code [%d]", ret); + SysLog(NID_SYS, "Screen on state is recoveryed."); + } } else { @@ -110,7 +119,6 @@ _ActiveEventListener::OnActiveAppChanged(const Tizen::App::AppId& appId) { ret = pm_unlock_state(LCD_NORMAL, GOTO_STATE_NOW); SysTryReturnVoidResult(NID_SYS, ret == 0, E_SYSTEM, "[E_SYSTEM] It failed to unlock the power state"); - _keepScreenOnState = false; } if (_keepCpuAwake == true || _deviceCpuPowerOn == true) //In case of CPU power control, it has to be keep despite of deactive state. @@ -400,6 +408,8 @@ _PowerManagerImpl::KeepScreenOnState(bool keepOn, bool dimming) { state = LCD_NORMAL; } + _dimmingFlag = flag; + _screenOnState = state; ret = pm_lock_state(state, flag, 0); SysTryReturnResult(NID_SYS, ret == 0, E_SYSTEM, "[E_SYSTEM] It failed to lock the screen state"); _keepScreenOnState = true; diff --git a/src/system/FSys_RuntimeInfoImpl.cpp b/src/system/FSys_RuntimeInfoImpl.cpp index 9454f75..b74a1c4 100644 --- a/src/system/FSys_RuntimeInfoImpl.cpp +++ b/src/system/FSys_RuntimeInfoImpl.cpp @@ -393,15 +393,19 @@ _RuntimeInfoImpl::GetDirectorySize(const char* path) } String appId(pApp->GetAppId()); - unique_ptr appIdPath(_StringConverter::CopyToCharArrayN(appId)); + unique_ptr appIdPath(_StringConverter::CopyToCharArrayN(appId)); fileLength = strlen(appIdPath.get()) + 29; pFileName = (char*)malloc(fileLength); + SysTryCatch(NID_SYS, pFileName, E_OUT_OF_MEMORY, E_OUT_OF_MEMORY, "It is not enough memory."); + ret = sprintf(pFileName, "/tmp/size_of_directory_%s.tmp", appIdPath.get()); SysTryCatch(NID_SYS, ret > 0, E_SYSTEM, E_SYSTEM, "It is failed to write file path."); commandLength = strlen(pFileName) + 8; pCommand = (char*) malloc(commandLength); + SysTryCatch(NID_SYS, pCommand, E_OUT_OF_MEMORY, E_OUT_OF_MEMORY, "It is not enough memory."); + ret = sprintf(pCommand, "rm -rf %s", pFileName); SysTryCatch(NID_SYS, ret > 0, E_SYSTEM, E_SYSTEM, "It is failed to write remove pCommand."); @@ -415,6 +419,8 @@ _RuntimeInfoImpl::GetDirectorySize(const char* path) commandLength = strlen(pFileName) + strlen(path) + 16; pCommand = (char*)malloc(commandLength); + SysTryCatch(NID_SYS, pCommand, E_OUT_OF_MEMORY, E_OUT_OF_MEMORY, "It is not enough memory."); + ret = sprintf(pCommand, "du -skb -P %s >> %s", path, pFileName); SysTryCatch(NID_SYS, ret > 0, E_SYSTEM, E_SYSTEM, "It is failed to write du pCommand."); @@ -440,7 +446,7 @@ CATCH: } if (pCommand) { - free(pFileName); + free(pCommand); } if (pFile) { diff --git a/src/system/FSys_SettingClient.cpp b/src/system/FSys_SettingClient.cpp index f0a039f..fe2eaac 100644 --- a/src/system/FSys_SettingClient.cpp +++ b/src/system/FSys_SettingClient.cpp @@ -196,6 +196,12 @@ _SettingClient::GetInstance(void) if(__pSettingClient == null) { pthread_once(&once_block, InitSettingClient); + + result r = GetLastResult(); + if (IsFailed(r)) + { + once_block = PTHREAD_ONCE_INIT; + } } return __pSettingClient; } diff --git a/src/system/FSys_SettingInfoImpl.cpp b/src/system/FSys_SettingInfoImpl.cpp index 08eb519..4dd0031 100644 --- a/src/system/FSys_SettingInfoImpl.cpp +++ b/src/system/FSys_SettingInfoImpl.cpp @@ -26,6 +26,7 @@ #include #include +#include #include #include #include @@ -105,7 +106,7 @@ _SettingInfoImpl::GetValue(const Tizen::Base::String& key, Tizen::Base::String& if(key == _FONTSIZE) { - if(_AppInfo::GetApiVersion() == _API_VERSION_2_0 && _AppInfo::IsOspCompat() == true) + if(_AppInfo::GetApiVersion() == _API_VERSION_2_0 && _AppInfo::IsOspCompat()) { if(value == _FONT_SIZE_GIANT || value == _FONT_SIZE_HUGE) { @@ -119,6 +120,16 @@ _SettingInfoImpl::GetValue(const Tizen::Base::String& key, Tizen::Base::String& InitSettingClient(); SysTryReturnResult(NID_SYS, pSettingClient != null, E_SYSTEM, "It is failed to intialize setting manager"); r = pSettingClient->GetValue(key, value); + + if(key == L"Wallpaper") + { + if(_AppInfo::GetApiVersion() == _API_VERSION_2_0 && _AppInfo::IsOspCompat()) + { + String physicalFilePath = value; + r = Tizen::Io::_FileImpl::ConvertPhysicalToVirtualPath(physicalFilePath, value); + SysTryReturn(NID_SYS, r == E_SUCCESS, r, r, "[%s] It is failed to converting virtual path", GetErrorMessage(r)); + } + } } return r; } @@ -170,7 +181,16 @@ _SettingInfoImpl::SetWallpaper(const Tizen::Base::String& filePath) result r = E_SUCCESS; SysTryReturnResult(NID_SYS, pSettingClient != null, E_SYSTEM, "It is failed to intialize setting manager"); - r = pSettingClient->SetValue(_SETTING_SCREEN_WALLPAPER, filePath); + + String physicalFilePath = filePath; + + if(Tizen::App::_AppInfo::GetApiVersion() == _API_VERSION_2_0 && Tizen::App::_AppInfo::IsOspCompat()) + { + r = Tizen::Io::_FileImpl::ConvertVirtualToPhysicalPath(filePath, physicalFilePath); + SysTryReturn(NID_SYS, r == E_SUCCESS, r, r, "[%s] It is failed to converting physical path", GetErrorMessage(r)); + } + + r = pSettingClient->SetValue(_SETTING_SCREEN_WALLPAPER, physicalFilePath); if(r == E_INVALID_ARG) r = E_FILE_NOT_FOUND; @@ -213,13 +233,23 @@ _SettingInfoImpl::SetValue(const String& key, String value) { result r = E_SUCCESS; if (key == _FONT_SIZE || key == _FONT_TYPE) - { + { r = SetValueForFont(key, value); - } + } else { InitSettingClient(); SysTryReturnResult(NID_SYS, pSettingClient != null, E_SYSTEM, "It is failed to intialize setting manager"); + + if(key == _SETTING_SCREEN_WALLPAPER) + { + if(_AppInfo::GetApiVersion() == _API_VERSION_2_0 && _AppInfo::IsOspCompat()) + { + String virtualFilePath = value; + r = Tizen::Io::_FileImpl::ConvertVirtualToPhysicalPath(virtualFilePath, value); + SysTryReturn(NID_SYS, r == E_SUCCESS, r, r, "[%s] It is failed to converting physical path", GetErrorMessage(r)); + } + } return pSettingClient->SetValue(key, value); } return r; diff --git a/src/system/FSys_SystemInfoImpl.cpp b/src/system/FSys_SystemInfoImpl.cpp index 5f9708f..8cc29b0 100644 --- a/src/system/FSys_SystemInfoImpl.cpp +++ b/src/system/FSys_SystemInfoImpl.cpp @@ -446,7 +446,7 @@ _SystemInfoImpl::GetSysInfo(const String& key, String& value) { r = GetFromRegistry(tizenKey, value); - if(r != E_SUCCESS) + if(r != E_SUCCESS || value == L"ERROR") { ArrayList requestMessage; ArrayList responseMessage; @@ -502,8 +502,11 @@ _SystemInfoImpl::GetSysInfo(const String& key, String& value) SysTryReturn(NID_SYS, r == E_SUCCESS, E_SYSTEM, r, "[%s] StringUtil::StringToUtf8N It is failed", GetErrorMessage(r)); int ret = system_info_get_platform_string(systemKey.get(), &pStringValue); - SysTryReturnResult(NID_SYS, ret == SYSTEM_INFO_ERROR_NONE, E_OBJ_NOT_FOUND, "It is failed to get system information %ls from configration file.", tizenKey.GetPointer()); - + if (ret != SYSTEM_INFO_ERROR_NONE) + { + ret = system_info_get_custom_string(systemKey.get(), &pStringValue); + SysTryReturnResult(NID_SYS, ret == SYSTEM_INFO_ERROR_NONE, E_OBJ_NOT_FOUND, "It is failed to get system information %ls from configration file.", tizenKey.GetPointer()); + } r = StringUtil::Utf8ToString(pStringValue, value); free(pStringValue); r = E_SUCCESS; @@ -569,7 +572,12 @@ _SystemInfoImpl::GetSysInfo(const String& key, int& value) SysTryReturn(NID_SYS, r == E_SUCCESS, E_SYSTEM, r, "[%s] StringUtil::StringToUtf8N It is failed", GetErrorMessage(r)); ret = system_info_get_platform_int(systemKey.get(), &value); - SysTryReturnResult(NID_SYS, ret == SYSTEM_INFO_ERROR_NONE, E_OBJ_NOT_FOUND, "It is failed to get system information %ls from configration file.", tizenKey.GetPointer()); + if (ret != SYSTEM_INFO_ERROR_NONE) + { + ret = system_info_get_custom_int(systemKey.get(), &value); + SysTryReturnResult(NID_SYS, ret == SYSTEM_INFO_ERROR_NONE, E_OBJ_NOT_FOUND, + "It is failed to get system information %ls from configration file.", tizenKey.GetPointer()); + } r = E_SUCCESS; } } @@ -631,13 +639,17 @@ _SystemInfoImpl::GetSysInfo(const String& key, bool& value) int ret = system_info_get_platform_bool(systemKey.get(), &supported); if(ret != SYSTEM_INFO_ERROR_NONE) { - String screenKey(L"http://tizen.org/feature/screen.size"); - String requiredKey; - tizenKey.SubString(0, screenKey.GetLength(), requiredKey); - - if(requiredKey == screenKey) + ret = system_info_get_custom_bool(systemKey.get(), &supported); + if (ret != SYSTEM_INFO_ERROR_NONE) { - value = false; + String screenKey(L"http://tizen.org/feature/screen.size"); + String requiredKey; + tizenKey.SubString(0, screenKey.GetLength(), requiredKey); + + if(requiredKey == screenKey) + { + value = false; + } } } diff --git a/src/system/inc/FSys_AlarmManager.h b/src/system/inc/FSys_AlarmManager.h index 9fea083..66cc3eb 100644 --- a/src/system/inc/FSys_AlarmManager.h +++ b/src/system/inc/FSys_AlarmManager.h @@ -33,9 +33,9 @@ class _AlarmManager { private: _AlarmManager(); - ~_AlarmManager(); -public: +public: + ~_AlarmManager(); result RegisterAlarm(_AlarmImpl* pAlarmImpl); result UnregisterAlarm(_AlarmImpl* pAlarmImpl); result UpdateAlarm(_AlarmImpl* pAlarmImpl); @@ -45,6 +45,7 @@ public: static _AlarmManager* GetInstance(void); private: + result Construct(void); int ReserveAlarm(Tizen::Base::String appId, Tizen::Base::DateTime startTime, int period); result AddAlarmList(int alarmId, int period, Tizen::Base::String appId, Tizen::Base::DateTime* endTime); result RemoveAlarmList(int alarmId);