From 1d92090e3351c4534673850bc0d3159588911521 Mon Sep 17 00:00:00 2001 From: hyun lee Date: Wed, 16 Oct 2013 11:21:17 +0900 Subject: [PATCH] Apply reviewed doxygen Change-Id: I8b554d883afeb0bb670459a30307d9508acb8422 Signed-off-by: hyun lee --- inc/FWebBookmarkItem.h | 19 +- inc/FWebControls.h | 4 +- inc/FWebCtrlAuthenticationChallenge.h | 18 +- inc/FWebCtrlGeolocationPermissionManager.h | 22 +-- inc/FWebCtrlHitElementResult.h | 6 +- inc/FWebCtrlIJavaScriptBridge.h | 9 +- inc/FWebCtrlILoadingListener.h | 52 ++--- inc/FWebCtrlITextSearchListener.h | 9 +- inc/FWebCtrlIWebDownloadListener.h | 7 +- inc/FWebCtrlIWebKeypadEventListener.h | 7 +- inc/FWebCtrlIWebUiEventListener.h | 11 +- inc/FWebCtrlIWebUiEventListenerF.h | 13 +- inc/FWebCtrlPageNavigationList.h | 14 +- inc/FWebCtrlWeb.h | 308 ++++++++++++++--------------- inc/FWebCtrlWebSetting.h | 126 ++++++------ inc/FWebCtrlWebStorageManager.h | 48 ++--- inc/FWebHistoryItem.h | 7 +- inc/FWebWebBookmark.h | 34 ++-- inc/FWebWebHistory.h | 8 +- 19 files changed, 362 insertions(+), 360 deletions(-) mode change 100755 => 100644 inc/FWebCtrlIWebDownloadListener.h mode change 100755 => 100644 inc/FWebCtrlWeb.h mode change 100755 => 100644 inc/FWebWebBookmark.h diff --git a/inc/FWebBookmarkItem.h b/inc/FWebBookmarkItem.h index 63a8ae8..3cb4e16 100644 --- a/inc/FWebBookmarkItem.h +++ b/inc/FWebBookmarkItem.h @@ -55,14 +55,14 @@ const RecordId ROOT_FOLDER_ID = -1; /** * @class BookmarkItem -* @brief This class is used for accessing a bookmark item stored in the WebBookmark class. +* @brief This class is used for accessing a bookmark item stored in the %WebBookmark class. * * @since 2.1 * * @final This class is not intended for extension. * * The %BookmarkItem class provides access to the WebBookmark class. -* Each item contains the title, the URL of the page, the item type, and the parent folder ID. +* Each item contains the title, the URL of a page, the item type, and the parent folder ID. */ class _OSP_EXPORT_ BookmarkItem : public Tizen::Base::Object @@ -76,7 +76,7 @@ public: * * @since 2.1 * - * @param[in] rhs An instance of %BookmarkItem + * @param[in] rhs An instance of %BookmarkItem to copy */ BookmarkItem(const BookmarkItem& rhs); @@ -102,7 +102,7 @@ public: * @since 2.1 * * @return The URL of the current bookmark item @n - * If the item type is folder, this method will return an empty string. + * If the item type is folder, this method returns an empty string. * @see IsFolder() */ Tizen::Base::String GetUrl(void) const; @@ -114,8 +114,7 @@ public: * * @return The image * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM Either of the following conditions has occurred: @n - * - The method cannot proceed due to a severe system error. @n + * @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::Graphics::Bitmap* GetFaviconN(void) const; @@ -126,7 +125,7 @@ public: * @since 2.1 * * @return The parent folder ID of the current bookmark item @n - * If the current bookmark item is the one in topmost level, this method will return ::ROOT_FOLDER_ID. + * If the current bookmark item is the one at the topmost level, this method returns ::ROOT_FOLDER_ID. */ RecordId GetParentFolderId(void) const; @@ -136,7 +135,7 @@ public: * @since 2.1 * * @return @c true if the type of the current bookmark item is folder, @n - * else @c false + * else @c false */ bool IsFolder(void) const; @@ -155,7 +154,7 @@ public: * @since 2.1 * * @return @c true if the two instances match, or if and only if the two instances contain the same elements, @n - * else @c false @n + * else @c false * @param[in] obj The object to compare with the current instance * @see Tizen::Base::Object::Equals() */ @@ -166,7 +165,7 @@ public: * * @since 2.1 * - * @param[in] rhs The instance of the %BookmarkItem class to assign from + * @param[in] rhs An instance of the %BookmarkItem class to assign */ BookmarkItem& operator =(const BookmarkItem& rhs); diff --git a/inc/FWebControls.h b/inc/FWebControls.h index fc11bf0..f9618d5 100644 --- a/inc/FWebControls.h +++ b/inc/FWebControls.h @@ -47,8 +47,8 @@ * @remarks @b Header @b %file: @b \#include @b @n * @b Library : @b osp-web * - * The %Controls namespace allows you to embed the %Web browser as a control within an application, to upload and download content, and retrieve the HyperText Markup Language (HTML) element and history details. - * @n + * The %Controls namespace allows you to embed the %Web browser as a control within an application, upload and download content, and retrieve the HyperText Markup Language (HTML) element and history details. + * * For more information on the %Controls namespace features, see Web Controls Guide. * * The following diagram illustrates the relationships between the classes belonging to the %Controls namespace. diff --git a/inc/FWebCtrlAuthenticationChallenge.h b/inc/FWebCtrlAuthenticationChallenge.h index e4a5b0f..5e44b08 100644 --- a/inc/FWebCtrlAuthenticationChallenge.h +++ b/inc/FWebCtrlAuthenticationChallenge.h @@ -35,7 +35,7 @@ namespace Tizen { namespace Web { namespace Controls /** * * @class AuthenticationChallenge - * @brief This class handles the HyperText Transfer Protocol (HTTP) authentication requests. + * @brief This class handles the HyperText Transfer Protocol (HTTP) authentication requests. * * @since 2.0 * @@ -61,11 +61,11 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/web.service * - * @param[in] userId The user ID for authentication - * @param[in] password The password for authentication - * @exception E_SUCCESS The method is successful. - * @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. @b Since: @b 2.1 + * @param[in] userId The user ID for authentication + * @param[in] password The password for authentication + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @remarks The specific error code can be accessed using the GetLastResult() method. */ void Process(const UserId& userId, const Tizen::Base::String& password); @@ -77,9 +77,9 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/web.service * - * @exception E_SUCCESS The method is successful. - * @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. @b Since: @b 2.1 + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @remarks The specific error code can be accessed using the GetLastResult() method. */ void Cancel(void); diff --git a/inc/FWebCtrlGeolocationPermissionManager.h b/inc/FWebCtrlGeolocationPermissionManager.h index 2687bc8..1690033 100644 --- a/inc/FWebCtrlGeolocationPermissionManager.h +++ b/inc/FWebCtrlGeolocationPermissionManager.h @@ -17,7 +17,6 @@ /** * @file FWebCtrlGeolocationPermissionManager.h * @brief This is the header file for the %GeolocationPermissionManager class. - * @privlevel platform * * This header file contains the declarations of the %GeolocationPermissionManager class. * @@ -44,8 +43,7 @@ class _GeolocationPermissionManagerImpl; * * @since 2.0 * - * The %GeolocationPermissionManager class provides methods to manage geolocation permissions decided by a user from origins using html5 JavaScript geolocation APIs. - * @n + * The %GeolocationPermissionManager class provides methods to manage geolocation permissions decided by a user from origins using html5 JavaScript geolocation APIs. @n * Origin consists of the scheme, host, and port. */ @@ -61,10 +59,10 @@ public: * @privlevel platform * @privilege %http://tizen.org/privilege/geolocationpermission.read * - * @return A pointer to Tizen::Base::Collection::IList containing origin(Tizen::Base::String) list, @n + * @return A pointer to Tizen::Base::Collection::IList that contains the origin(Tizen::Base::String) list, @n * else @c null if no geolocation permission data exists - * @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. * @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. */ @@ -78,8 +76,8 @@ public: * @privilege %http://tizen.org/privilege/geolocationpermission.read * * @return @c true if geolocation permission is allowed, @n - * else @c false - * @param[in] origin The origin + * else @c false + * @param[in] origin The origin * @exception E_SUCCESS The method is successful. * @exception E_DATA_NOT_FOUND There is no permission data for the specified @c origin. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -96,7 +94,7 @@ public: * @privilege %http://tizen.org/privilege/geolocationpermission.write * * @return An error code - * @param[in] origin The origin + * @param[in] origin The origin * @exception E_SUCCESS The method is successful. * @exception E_DATA_NOT_FOUND There is no permission data for the specified @c origin. * @exception E_SYSTEM The method cannot proceed due to a severe system error. @@ -106,7 +104,7 @@ public: result Remove(const Tizen::Base::String& origin); /** - * Removes all elements in the list. + * Removes all the elements from the list. * * @since 2.0 * @privlevel platform @@ -126,9 +124,9 @@ public: * @since 2.0 * * @return A pointer to the %GeolocationPermissionManager instance, @n - * else @c null if it fails + * else @c null if it fails * @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 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/FWebCtrlHitElementResult.h b/inc/FWebCtrlHitElementResult.h index ab907a1..0698376 100644 --- a/inc/FWebCtrlHitElementResult.h +++ b/inc/FWebCtrlHitElementResult.h @@ -47,7 +47,7 @@ namespace Tizen { namespace Web { namespace Controls * * @since 2.0 * - * The %HitElementResult class provides methods to retrieve information from the HTML element, such as tag name, attributes and content. + * The %HitElementResult class provides methods to retrieve information such as tag name, attributes and content from the HTML element. * @n * For more information on the class features, see Web Controls Guide. * @@ -79,7 +79,7 @@ public: * @since 2.0 * * @return The value of the specified attribute - * @param[in] attributeName The name of attribute + * @param[in] attributeName The name of the attribute */ Tizen::Base::String GetAttributeValue(const Tizen::Base::String& attributeName) const; @@ -126,7 +126,7 @@ public: * @since 2.0 * * @return @c true if there is a URL linked to the element, @n - * else @c false + * else @c false */ bool HasUrl(void) const; diff --git a/inc/FWebCtrlIJavaScriptBridge.h b/inc/FWebCtrlIJavaScriptBridge.h index 5651c75..9d30b61 100644 --- a/inc/FWebCtrlIJavaScriptBridge.h +++ b/inc/FWebCtrlIJavaScriptBridge.h @@ -36,11 +36,11 @@ namespace Tizen { namespace Web { namespace Controls /** * @interface IJavaScriptBridge - * @brief This interface provides a communication channel between JavaScript and native object. + * @brief This interface provides a communication channel between JavaScript and a native object. * * @since 2.0 * - * The %IJavaScriptBridge interface provides a communication channel between JavaScript and native object. + * The %IJavaScriptBridge interface provides a communication channel between JavaScript and a native object. * * For more information on the class features, see Web Controls Guide. * @@ -49,14 +49,15 @@ class _OSP_EXPORT_ IJavaScriptBridge { 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 ~IJavaScriptBridge(void) {} /** - * Called asynchronously on invocation request from JavaScript side through the requestToNative() method. + * Called asynchronously on an invocation request from JavaScript through the requestToNative() method. * * @since 2.0 * diff --git a/inc/FWebCtrlILoadingListener.h b/inc/FWebCtrlILoadingListener.h index d181c36..3858f92 100644 --- a/inc/FWebCtrlILoadingListener.h +++ b/inc/FWebCtrlILoadingListener.h @@ -56,9 +56,9 @@ enum WebNavigationType { WEB_NAVIGATION_LINK_CLICKED, /**< The clicking of a link on the page */ WEB_NAVIGATION_FORM_SUBMITTED, /**< The submission of a form */ - WEB_NAVIGATION_BACKFORWARD, /**< The back and forward navigation*/ + WEB_NAVIGATION_BACKFORWARD, /**< The back and forward navigation */ WEB_NAVIGATION_RELOAD, /**< The reloading of the page */ - WEB_NAVIGATION_FORM_RESUBMITTED, /**< The resubmission of the form */ + WEB_NAVIGATION_FORM_RESUBMITTED, /**< The resubmission of the form */ WEB_NAVIGATION_OTHER /**< A navigation other than any of the above */ }; @@ -71,16 +71,16 @@ enum WebNavigationType */ enum LoadingErrorType { - WEB_ERROR_UNKNOWN, /**< An unknown error*/ - WEB_REQUEST_TIMEOUT, /**< The request timeout */ + WEB_ERROR_UNKNOWN, /**< An unknown error */ + WEB_REQUEST_TIMEOUT, /**< The request timeout */ WEB_NO_CONNECTION, /**< The network is not in service */ WEB_MIME_NOT_SUPPORTED, /**< The content type is not supported */ WEB_BAD_URL, /**< The URL is invalid */ - WEB_HTTP_RESPONSE, /**< The hypertext transfer protocol (HTTP) response */ - WEB_OUT_OF_MEMORY, /**< The memory is not enough to load the page */ - WEB_FILE_ACCESS_FAILED, /**< The file access has failed */ - WEB_REQUEST_MAX_EXCEEDED, /**< The request has failed because the total number of requests have exceeded the maximum limit */ - WEB_INVALID_CERTIFICATE /**< The hypertext transfer protocol secure (HTTPS) request has failed due to an invalid certificate or CA */ + WEB_HTTP_RESPONSE, /**< The hypertext transfer protocol (HTTP) response */ + WEB_OUT_OF_MEMORY, /**< The memory is not enough to load the page */ + WEB_FILE_ACCESS_FAILED, /**< The file access has failed */ + WEB_REQUEST_MAX_EXCEEDED, /**< The request has failed because the total number of requests have exceeded the maximum limit */ + WEB_INVALID_CERTIFICATE /**< The hypertext transfer protocol secure (HTTPS) request has failed due to an invalid certificate or CA */ }; /** @@ -92,9 +92,9 @@ enum LoadingErrorType */ enum DecisionPolicy { - WEB_DECISION_DOWNLOAD, /**< The download policy*/ - WEB_DECISION_CONTINUE, /**< The usage policy*/ - WEB_DECISION_IGNORE, /**< The ignore policy*/ + WEB_DECISION_DOWNLOAD, /**< The download policy */ + WEB_DECISION_CONTINUE, /**< The usage policy */ + WEB_DECISION_IGNORE, /**< The ignore policy */ }; /** @@ -104,7 +104,7 @@ enum DecisionPolicy * @since 2.0 * * The %ILoadingListener interface receives the events that occur during the loading of data. - * To listen to the events occurred during a data loading operation, implement this listener. If there is no + * To listen to the events that occur during a data loading operation, implement this listener. If there is no * registered load event listener, the browser engine handles these events according to its own settings. * @n * For more information on the class features, see Web Controls Guide. @@ -114,7 +114,8 @@ class _OSP_EXPORT_ ILoadingListener { 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 */ @@ -128,8 +129,8 @@ public: * @return @c true if the ownership is taken by the application, @n * else @c false, and a default dialog for the ID and password is displayed @n * If this method returns @c true, the application must delete the AuthenticationChallenge instance. - * @param[in] host The host requiring the authentication - * @param[in] realm The description to help save the user credentials for future visits + * @param[in] host The host requiring the authentication + * @param[in] realm The description to help save the user credentials for future visits * @param[in] authentication The handler to send a user response to the server that requested the authentication */ virtual bool OnHttpAuthenticationRequestedN(const Tizen::Base::String& host, const Tizen::Base::String& realm, const Tizen::Web::Controls::AuthenticationChallenge& authentication) = 0; @@ -160,11 +161,11 @@ public: * * @since 2.0 * - * @param[in] error The error that occurred during loading + * @param[in] error The error that occurs during loading * @param[in] reason The reason for the loading failure: - * - @c WEB_HTTP_RESPONSE: The HTTP state code such as "404" - * - @c WEB_MIME_NOT_SUPPORTED: The Multipurpose Internet Mail Extensions (MIME) type such as "application/rdf+xml" is not supported. - * - @c WEB_BAD_URL: The URL is incorrect. + * - @c WEB_HTTP_RESPONSE: The HTTP state code such as "404" + * - @c WEB_MIME_NOT_SUPPORTED: The Multipurpose Internet Mail Extensions (MIME) type such as "application/rdf+xml" is not supported. + * - @c WEB_BAD_URL: The URL is incorrect. */ virtual void OnLoadingErrorOccurred(LoadingErrorType error, const Tizen::Base::String& reason) = 0; @@ -199,10 +200,10 @@ public: * * @since 2.0 * - * @return @c true if the application handles the URL after the request is canceled in the browser engine, @n - * else @c false if the browser engine proceeds with the requested URL + * @return @c true if the application handles the URL after the request is cancelled in the browser engine, @n + * else @c false if the browser engine proceeds with the requested URL * @param[in] url The URL that is requested - * @param[in] type The type indicating how the URL is triggered + * @param[in] type The type that indicates how the URL is triggered */ virtual bool OnLoadingRequested(const Tizen::Base::String& url, WebNavigationType type) = 0; @@ -214,7 +215,7 @@ public: * * @since 2.0 * - * @return A value of the enumerator DecisionPolicy + * @return A value of the enumerator DecisionPolicy * @param[in] mime The content type of the data that is downloaded * @param[in] httpHeader The HTTP header string */ @@ -222,12 +223,11 @@ public: /** * Called when the favicon of the new page is received. @n - * If this callback is received once, an application can get favicon by using Tizen::Web::Controls::Web::GetFaviconN(). + * If this callback is received once, an application can get the favicon by using Tizen::Web::Controls::Web::GetFaviconN(). * * @since 2.1 * * @param[in] favicon The favicon image - * @see Tizen::Web::Controls::Web::GetFaviconN() */ virtual void OnFaviconReceived(const Tizen::Graphics::Bitmap& favicon) {} diff --git a/inc/FWebCtrlITextSearchListener.h b/inc/FWebCtrlITextSearchListener.h index 0799c79..2d0ba97 100644 --- a/inc/FWebCtrlITextSearchListener.h +++ b/inc/FWebCtrlITextSearchListener.h @@ -45,7 +45,8 @@ class _OSP_EXPORT_ ITextSearchListener 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 */ @@ -56,9 +57,9 @@ public: * * @since 2.0 * - * @param[in] totalCount The total count of matches - * @param[in] currentOrdinal The ordinal of currently selected match @n - * If there is no match, it will be set to zero. + * @param[in] totalCount The total count of the matches + * @param[in] currentOrdinal The ordinal of the currently selected match @n + * If there is no match, it is set to zero. */ virtual void OnTextFound(int totalCount, int currentOrdinal) = 0; diff --git a/inc/FWebCtrlIWebDownloadListener.h b/inc/FWebCtrlIWebDownloadListener.h old mode 100755 new mode 100644 index b5d48eb..163b615 --- a/inc/FWebCtrlIWebDownloadListener.h +++ b/inc/FWebCtrlIWebDownloadListener.h @@ -96,7 +96,8 @@ class _OSP_EXPORT_ IWebDownloadListener { 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 */ @@ -120,11 +121,11 @@ public: virtual void OnWebDataDownloadCompleted(void) = 0; /** - * Called when an error has occurred while downloading content. + * Called when an error occurs while downloading content. * * @since 2.0 * - * @param[in] error The type of error that occurred while downloading data + * @param[in] error The type of error that occurs while downloading data */ virtual void OnWebDownloadFailed(LoadingErrorType error) = 0; diff --git a/inc/FWebCtrlIWebKeypadEventListener.h b/inc/FWebCtrlIWebKeypadEventListener.h index b07360e..e7feba6 100644 --- a/inc/FWebCtrlIWebKeypadEventListener.h +++ b/inc/FWebCtrlIWebKeypadEventListener.h @@ -48,7 +48,8 @@ class _OSP_EXPORT_ IWebKeypadEventListener { 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 */ @@ -70,7 +71,7 @@ public: * * @param[in] source The source of the event * @remarks When the overlay keypad appears on the screen, the current Form's - * area is adjusted to account for the space that is taken up by the overlay keypad. + * area is adjusted to account for the space that is taken up by the overlay keypad. * @see Tizen::Ui::Controls::Form::GetClientAreaBounds() */ virtual void OnWebKeypadOpened(Tizen::Web::Controls::Web& source) = 0; @@ -86,7 +87,7 @@ public: virtual void OnWebKeypadClosed(Tizen::Web::Controls::Web& source) = 0; /** - * Called when the keypad bounds are changed, for instance when the predictive text window which is located in the upper side of the keypad is shown. + * Called when the keypad bounds are changed, for instance when the predictive text window which is located in the upper part of the keypad is shown. * * @since 2.0 * diff --git a/inc/FWebCtrlIWebUiEventListener.h b/inc/FWebCtrlIWebUiEventListener.h index 96725d0..34f3ba5 100644 --- a/inc/FWebCtrlIWebUiEventListener.h +++ b/inc/FWebCtrlIWebUiEventListener.h @@ -45,7 +45,8 @@ class _OSP_EXPORT_ IWebUiEventListener { 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 */ @@ -89,7 +90,7 @@ public: * * @since 2.0 * - * @param[in] source The source of the event + * @param[in] source The source of the event * @param[in] startPoint The starting point of the selected block * @param[in] endPoint The ending point of the selected block */ @@ -97,14 +98,14 @@ public: /** * Called just after the touch move event to determine whether the preventDefault() method is triggered or not. @n - * The application that wants to support W3C preventDefault() feature is recommended to use this callback and delay to handle the touch move event until this callback is received. + * The application that wants to support the W3C preventDefault() feature is recommended to use this callback and delay the handling of the touch move event until this callback is received. * * @since 2.1 * * @param[in] source The source of the event * @param[in] trigger Set to @c true if the preventDefault() method is triggered, @n - * else @c false - * @remarks This callback is always called just after the touch move event and returns @c true when preventDefault() is triggered on the touch start or touch move event. + * else @c false + * @remarks This callback is always called just after the touch move event and returns @c true when preventDefault() is triggered on the touch start or touch move event. */ virtual void OnWebPreventDefaultTriggered(Tizen::Web::Controls::Web& source, bool trigger) {}; diff --git a/inc/FWebCtrlIWebUiEventListenerF.h b/inc/FWebCtrlIWebUiEventListenerF.h index 3dd03ef..219b94d 100644 --- a/inc/FWebCtrlIWebUiEventListenerF.h +++ b/inc/FWebCtrlIWebUiEventListenerF.h @@ -17,7 +17,7 @@ /** * @file FWebCtrlIWebUiEventListenerF.h -* @brief This is the header file for the %IWebUiEventListenerF interface. +* @brief This is the header file for the %IWebUiEventListenerF interface. * * This header file contains the declarations of the %IWebUiEventListenerF interface. */ @@ -45,7 +45,8 @@ class _OSP_EXPORT_ IWebUiEventListenerF { 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.1 */ @@ -87,7 +88,7 @@ public: * * @since 2.1 * - * @param[in] source The source of the event + * @param[in] source The source of the event * @param[in] startPoint The starting point of the selected block * @param[in] endPoint The ending point of the selected block */ @@ -95,14 +96,14 @@ public: /** * Called just after the touch move event to determine whether the preventDefault() method is triggered or not. @n - * The application that wants to support W3C preventDefault() feature is recommended to use this callback and delay to handle the touch move event until this callback is received. + * The application that wants to support the W3C preventDefault() feature is recommended to use this callback and delay the handling of the touch move event until this callback is received. * * @since 2.1 * * @param[in] source The source of the event * @param[in] trigger Set to @c true if the preventDefault() method is triggered, @n - * else @c false - * @remarks This callback is always called just after the touch move event and returns @c true when preventDefault() is triggered on the touch start or touch move event. + * else @c false + * @remarks This callback is always called just after the touch move event and returns @c true when preventDefault() is triggered on the touch start or touch move event. */ virtual void OnWebPreventDefaultTriggered(Tizen::Web::Controls::Web& source, bool trigger) {}; diff --git a/inc/FWebCtrlPageNavigationList.h b/inc/FWebCtrlPageNavigationList.h index 94c882a..34f3d5e 100644 --- a/inc/FWebCtrlPageNavigationList.h +++ b/inc/FWebCtrlPageNavigationList.h @@ -68,7 +68,7 @@ public: * @since 2.0 * * @return The current history item, @n - * else @c null if no history item exists + * else @c null if no history item exists */ const Tizen::Web::HistoryItem* GetCurrentItem(void) const; @@ -78,25 +78,25 @@ public: * @since 2.0 * * @return The index of the currently viewed page in the web page navigation list, @n - * else @c -1 if no history item exists + * else @c -1 if no history item exists */ int GetCurrentIndex(void) const; /** - * Gets the history item pointed to by the specified @c index. + * Gets the history item that the specified @c index points to. * * @since 2.0 * * @return A pointer to the history item at the specified @c index - * @param[in] index The index of an element @n - * The value of the index must be greater than or equal to @c 0. - * @exception E_OUT_OF_RANGE The specified @c index is out of range. + * @param[in] index The index of the element @n + * The value of the index must be greater than or equal to @c 0. + * @exception E_OUT_OF_RANGE The specified @c index is out of the valid range. * @remarks The specific error code can be accessed using the GetLastResult() method. */ const Tizen::Web::HistoryItem* GetItemAt(int index) const; /** - * Gets the total number of the history items. + * Gets the total number of history items. * * @since 2.0 * diff --git a/inc/FWebCtrlWeb.h b/inc/FWebCtrlWeb.h old mode 100755 new mode 100644 index 4e2422b..09420ce --- a/inc/FWebCtrlWeb.h +++ b/inc/FWebCtrlWeb.h @@ -216,12 +216,12 @@ public: * @privilege %http://tizen.org/privilege/web.service * * @return An error code - * @param[in] rect The rectangle size of the control - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM The method has failed. - * @exception E_INVALID_ARG The specified @c rect is invalid. - * @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. @b Since: @b 2.1 + * @param[in] rect The rectangle size of the control + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM The method has failed. + * @exception E_INVALID_ARG The specified @c rect is invalid. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 */ result Construct(const Tizen::Graphics::Rectangle& rect); @@ -233,12 +233,12 @@ public: * @privilege %http://tizen.org/privilege/web.service * * @return An error code - * @param[in] rect The rectangle size of the control - * @exception E_SUCCESS The method is successful. - * @exception E_SYSTEM The method has failed. - * @exception E_INVALID_ARG The specified @c rect is invalid. - * @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. + * @param[in] rect The rectangle size of the control + * @exception E_SUCCESS The method is successful. + * @exception E_SYSTEM The method has failed. + * @exception E_INVALID_ARG The specified @c rect is invalid. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. */ result Construct(const Tizen::Graphics::FloatRectangle& rect); @@ -249,47 +249,47 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/web.service * - * @param[in] url The resource to load - * @exception E_SUCCESS The method is successful. - * @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. @b Since: @b 2.1 + * @param[in] url The resource to load + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @remarks The specific error code can be accessed using the GetLastResult() method. */ void LoadUrl(const Tizen::Base::String& url); /** - * Loads the resource specified by the URL with a given header of HTTP request. + * Loads the resource specified by the URL along with the given header of the HTTP request. * * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/web.service * * @return An error code - * @param[in] url The resource to load - * @param[in] header The header of the HTTP request - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_HEADER The header object does not contain any header fields. - * @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. @b Since: @b 2.1 + * @param[in] url The resource to load + * @param[in] header The header of the HTTP request + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_HEADER The header object does not contain any header fields. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 */ result LoadUrl(const Tizen::Base::String& url, const Tizen::Net::Http::HttpHeader& header); /** - * Loads the resource specified by the URL with a given header and body of HTTP request. @n - * The header must include content-type entity-header field that is needed to check mime-type of the message body. + * Loads the resource specified by the URL along with the given header and body of the HTTP request. @n + * The header must include the content-type entity-header field that is needed to check the mime-type of the message body. * * @since 2.0 * @privlevel public * @privilege %http://tizen.org/privilege/web.service * * @return An error code - * @param[in] url The resource to load - * @param[in] header The header of the HTTP request - * @param[in] body The message body of the HTTP request - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_HEADER The header object does not contain any header fields. - * @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. @b Since: @b 2.1 + * @param[in] url The resource to load + * @param[in] header The header of the HTTP request + * @param[in] body The message body of the HTTP request + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_HEADER The header object does not contain any header fields. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 */ result LoadUrlWithPostRequest(const Tizen::Base::String& url, const Tizen::Net::Http::HttpHeader& header, const Tizen::Base::ByteBuffer& body); @@ -300,14 +300,14 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/web.service * - * @param[in] baseUrl The uniform resource locator (URL) of the content - * @param[in] content The content - * @param[in] mime The MIME type of the content - * @param[in] encoding The text encoding of the content - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The content buffer is empty. @b Since: @b 2.1 - * @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. @b Since: @b 2.1 + * @param[in] baseUrl The uniform resource locator (URL) of the content + * @param[in] content The content + * @param[in] mime The MIME type of the content + * @param[in] encoding The text encoding of the content + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The content buffer is empty. @b Since: @b 2.1 + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @remarks The specific error code can be accessed using the GetLastResult() method. */ void LoadData(const Tizen::Base::String& baseUrl, const Tizen::Base::ByteBuffer& content, const Tizen::Base::String& mime, const Tizen::Base::String& encoding = "UTF-8"); @@ -319,9 +319,9 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/web.service * - * @exception E_SUCCESS The method is successful. - * @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. @b Since: @b 2.1 + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @remarks The specific error code can be accessed using the GetLastResult() method. */ void StopLoading(void); @@ -333,9 +333,9 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/web.service * - * @exception E_SUCCESS The method is successful. - * @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. @b Since: @b 2.1 + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @remarks The specific error code can be accessed using the GetLastResult() method. */ void Reload(void); @@ -345,8 +345,8 @@ public: * * @since 2.0 * - * @return @c true if a page is loading, @n - * else @c false + * @return @c true if the page is loading, @n + * else @c false */ bool IsLoading(void) const; @@ -356,7 +356,7 @@ public: * @since 2.0 * * @return @c true if a back history item exists, @n - * else @c false + * else @c false */ bool CanGoBack(void) const; @@ -366,7 +366,7 @@ public: * @since 2.0 * * @return @c true if a forward history item exists, @n - * else @c false + * else @c false */ bool CanGoForward(void) const; @@ -377,9 +377,9 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/web.service * - * @exception E_SUCCESS The method is successful. - * @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. @b Since: @b 2.1 + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @remarks The specific error code can be accessed using the GetLastResult() method. */ void GoBack(void); @@ -391,9 +391,9 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/web.service * - * @exception E_SUCCESS The method is successful. - * @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. @b Since: @b 2.1 + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @remarks The specific error code can be accessed using the GetLastResult() method. */ void GoForward(void); @@ -403,7 +403,7 @@ public: * * @since 2.0 * - * @return A pointer to PageNavigationList containing the history items of the %Web control + * @return A pointer to PageNavigationList that contains the history items of the %Web control * @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. @@ -418,10 +418,10 @@ public: * @since 2.0 * * @return @c true if the specified @c word is found, @n - * else @c false + * else @c false * @param[in] word The string to search for * @param[in] searchForward Set to @c true to search for the word in the forward direction from the current position, @n - * else @c false to search for the word in the backward direction from the current position + * else @c false to search for the word in the backward direction from the current position */ bool SearchText(const Tizen::Base::String& word, bool searchForward = true); @@ -434,10 +434,10 @@ public: * @privilege %http://tizen.org/privilege/web.service * * @return An error code - * @param[in] setting The setting to update - * @exception E_SUCCESS The method is successful. - * @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. @b Since: @b 2.1 + * @param[in] setting The setting to update + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 */ result SetSetting(const Tizen::Web::Controls::WebSetting& setting); @@ -457,11 +457,11 @@ public: * @since 2.0 * * @return A HitElementResult of the pointed element - * @param[in] point The x and y coordinates - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c point is invalid. + * @param[in] point The x and y coordinates + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified @c point is invalid. * @exception E_UNSUPPORTED_FORMAT The image format is not supported. - * @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. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Web::Controls::HitElementResult* GetElementByPointN(const Tizen::Graphics::Point& point) const; @@ -472,11 +472,11 @@ public: * @since 2.1 * * @return A HitElementResult of the pointed element - * @param[in] point The x and y coordinates - * @exception E_SUCCESS The method is successful. - * @exception E_INVALID_ARG The specified @c point is invalid. + * @param[in] point The x and y coordinates + * @exception E_SUCCESS The method is successful. + * @exception E_INVALID_ARG The specified @c point is invalid. * @exception E_UNSUPPORTED_FORMAT The image format is not supported. - * @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. * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Web::Controls::HitElementResult* GetElementByPointN(const Tizen::Graphics::FloatPoint& point) const; @@ -489,11 +489,11 @@ public: * @privilege %http://tizen.org/privilege/web.service * * @return The result of the evaluated JavaScript, @n - * else @c null if an error occurs - * @param[in] scriptCode The JavaScript code as string - * @exception E_SUCCESS The method is successful. - * @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. @b Since: @b 2.1 + * else @c null if an error occurs + * @param[in] scriptCode The JavaScript code as a string + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @remarks The specific error code can be accessed using the GetLastResult() method. */ Tizen::Base::String* EvaluateJavascriptN(const Tizen::Base::String& scriptCode); @@ -504,12 +504,12 @@ public: * @since 2.0 * * @return An error code - * @param[in] level The zoom-out level @n - * The value ranges between @c 0.3 and @c 2.0. When the page view is at its original size, the level is @c 1.0. @n If the - * specified level is less than @c 1.0, the page view is reduced. @n If the specified level is greater than @c 1.0, the page view is - * magnified. + * @param[in] level The zoom-out level @n + * The value lies between the range @c 0.3 and @c 2.0. When the page view is at its original size, the level is @c 1.0. @n If the + * specified level is less than @c 1.0, the page view is reduced. @n If the specified level is greater than @c 1.0, the page view is + * magnified. * @exception E_SUCCESS The method is successful. - * @exception E_OUT_OF_RANGE The specified @c level is less than @c 0.3 or greater than @c 2.0. + * @exception E_OUT_OF_RANGE The specified @c level is either less than @c 0.3 or greater than @c 2.0. */ result SetZoomLevel(float level); @@ -518,7 +518,7 @@ public: * * @since 2.0 * - * @return The value ranges between @c 0.3 and @c 2.0 + * @return The value lies between the range @c 0.3 and @c 2.0 */ float GetZoomLevel(void) const; @@ -546,7 +546,7 @@ public: * @since 2.0 * * @return @c true if the specified MIME type is supported, @n - * else @c false + * else @c false * @param[in] mime The MIME type */ bool IsMimeSupported(const Tizen::Base::String& mime) const; @@ -558,10 +558,10 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/web.service * - * @param[in] pLoadingListener The listener receives the events that occurs while loading the data - * @exception E_SUCCESS The method is successful. - * @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. @b Since: @b 2.1 + * @param[in] pLoadingListener The listener receives the events that occur while loading the data + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @remarks The specific error code can be accessed using the GetLastResult() method. */ void SetLoadingListener(Tizen::Web::Controls::ILoadingListener* pLoadingListener); @@ -573,10 +573,10 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/web.service * - * @param[in] pDownLoadListener The listener to receive the data from a network incrementally - * @exception E_SUCCESS The method is successful. - * @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. @b Since: @b 2.1 + * @param[in] pDownLoadListener The listener to receive the data from a network incrementally + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 * @remarks The specific error code can be accessed using the GetLastResult() method. */ void SetDownloadListener(Tizen::Web::Controls::IWebDownloadListener* pDownLoadListener); @@ -588,7 +588,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] startPoint The starting point for the text selection block + * @param[in] startPoint The starting point for the text selection block * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG There is nothing to select from the specified starting point. */ @@ -601,7 +601,7 @@ public: * @since 2.1 * * @return An error code - * @param[in] startPoint The starting point for the text selection block + * @param[in] startPoint The starting point for the text selection block * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG There is nothing to select from the specified starting point. */ @@ -625,8 +625,8 @@ public: * @since 2.0 * * @return An error code - * @param[out] startPoint The starting point of the selected text block - * @param[out] endPoint The ending point of the selected text block + * @param[out] startPoint The starting point of the selected text block + * @param[out] endPoint The ending point of the selected text block * @exception E_SUCCESS The method is successful. */ result GetBlockRange(Tizen::Graphics::Point& startPoint, Tizen::Graphics::Point& endPoint) const; @@ -638,8 +638,8 @@ public: * @since 2.1 * * @return An error code - * @param[out] startPoint The starting point of the selected text block - * @param[out] endPoint The ending point of the selected text block + * @param[out] startPoint The starting point of the selected text block + * @param[out] endPoint The ending point of the selected text block * @exception E_SUCCESS The method is successful. */ result GetBlockRange(Tizen::Graphics::FloatPoint& startPoint, Tizen::Graphics::FloatPoint& endPoint) const; @@ -651,7 +651,7 @@ public: * @since 2.0 * * @return The selected text, @n - * else an empty string if there is no selection block + * else an empty string if there is no selection block */ Tizen::Base::String GetTextFromBlock(void) const; @@ -660,10 +660,10 @@ public: * * @since 2.0 * - * @param[in] enable Set to @c true to enable the scrolling of the web page, @n + * @param[in] enable Set to @c true to enable the scrolling of the web page, @n * else @c false * @exception E_SUCCESS The method is successful. - * @remarks This method does not affect javascript touch event. + * @remarks This method does not affect the JavaScript touch event. */ result SetScrollEnabled(bool enable); @@ -674,7 +674,7 @@ public: * @since 2.0 * * @return @c true if the web page scroll is enabled, @n - * else @c false + * else @c false */ bool IsScrollEnabled(void) const; @@ -702,7 +702,7 @@ public: * @since 2.0 * * @return @c true if private browsing is enabled, @n - * else @c false + * else @c false */ bool IsPrivateBrowsingEnabled(void) const; @@ -714,11 +714,11 @@ public: * @privilege %http://tizen.org/privilege/web.service * * @return The result of setting the private browsing - * @param[in] enable Set to @c true to enable private browsing, @n - * else @c false - * @exception E_SUCCESS The method is successful. - * @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. @b Since: @b 2.1 + * @param[in] enable Set to @c true to enable private browsing, @n + * else @c false + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 */ result SetPrivateBrowsingEnabled(bool enable); @@ -730,9 +730,9 @@ public: * @privilege %http://tizen.org/privilege/web.service * * @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_USER_NOT_CONSENTED The user blocks an application from calling this method. + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. * @see CanGoBack() * @see CanGoForward() * @see GoBack() @@ -748,9 +748,9 @@ public: * @privilege %http://tizen.org/privilege/web.service * * @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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 */ result ClearCache(void); @@ -762,48 +762,47 @@ public: * @privilege %http://tizen.org/privilege/web.service * * @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_USER_NOT_CONSENTED The user blocks an application from calling this method. @b Since: @b 2.1 + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 */ result ClearCookie(void); /** - * Clears the application's all stored form datas. + * Clears the application's all stored form data. * * @since 2.1 * @privlevel public * @privilege %http://tizen.org/privilege/web.service * * @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_USER_NOT_CONSENTED The user blocks an application from calling this method. + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. */ result ClearFormData(void); /** - * Clears the application's all stored ID/password datas. + * Clears the application's all stored ID/password data. * * @since 2.1 * @privlevel public * @privilege %http://tizen.org/privilege/web.service * * @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_USER_NOT_CONSENTED The user blocks an application from calling this method. + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. */ result ClearLoginFormData(void); /** - * Checks whether the %Web control allows cookie. @n - * Returns @c true if cookie is enabled. + * Checks whether the %Web control allows cookies. @n * * @since 2.0 * - * @return @c true if cookie is allowed, @n - * else @c false + * @return @c true if the cookie is allowed, @n + * else @c false */ bool IsCookieEnabled(void) const; @@ -814,24 +813,25 @@ public: * @privlevel public * @privilege %http://tizen.org/privilege/web.service * - * @return The result of enabling or disabling cookie - * @param[in] enable Set to @c true if the web control allows a cookie, @n - * else @c false - * @exception E_SUCCESS The method is successful. - * @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. @b Since: @b 2.1 + * @return The result of enabling or disabling a cookie + * @param[in] enable Set to @c true if the web control allows a cookie, @n + * else @c false + * @exception E_SUCCESS The method is successful. + * @exception E_PRIVILEGE_DENIED The application does not have the privilege to call this method. + * @exception E_USER_NOT_CONSENTED The user has blocked the application from calling this method. @b Since: @b 2.1 */ result SetCookieEnabled(bool enable); /** - * Saves the current web page as a pdf file. @n The size parameter is used to set size of the pdf file using millimeter. + * Saves the current web page as a pdf file. @n + * The size parameter is used to set the size of a pdf file using millimeters. * * @since 2.0 * * @return An error code - * @param[in] filePath The path of the pdf file that is created - * @param[in] pSize The width and height of the pdf file in millimeter. The width and height must be greater than @c 0. @n - * If the parameter contains @c null, the method uses the default size of the web page that is shown on the screen. + * @param[in] filePath The path of the pdf file that is created + * @param[in] pSize The width and height of the pdf file in millimeters. The width and height must be greater than @c 0. @n + * If the parameter contains @c null, the method uses the default size of the web page that is shown on the screen. * @exception E_SUCCESS The method is successful. * @exception E_INVALID_ARG Either of the following conditions has occurred: @n * - The specified path is invalid. @@ -846,7 +846,7 @@ public: * @since 2.0 * * @return An error code - * @param[in] jsBridge The JavaScript bridge to add + * @param[in] jsBridge The JavaScript bridge to add * @exception E_SUCCESS The method is successful. * @exception E_OBJ_ALREADY_EXIST A JavaScript bridge with the same name already exists. */ @@ -858,15 +858,15 @@ public: * @since 2.0 * * @return An error code - * @param[in] jsBridge The JavaScript bridge to remove + * @param[in] jsBridge The JavaScript bridge to remove * @exception E_SUCCESS The method is successful. - * @exception E_OBJ_NOT_FOUND The specified element is not found. + * @exception E_OBJ_NOT_FOUND The specified element is not found. */ result RemoveJavaScriptBridge(const IJavaScriptBridge& jsBridge); /** * Registers a keypad event listener. @n - * The registered listener is notified when the keypad associated with tag or with