From: Hyun Lee Date: Tue, 26 Mar 2013 02:02:55 +0000 (+0900) Subject: Update doxygen X-Git-Tag: 2.1b_release~59 X-Git-Url: http://review.tizen.org/git/?a=commitdiff_plain;h=c0c2e8844417b5511e4f56fe687ea44efa9451c9;p=framework%2Fosp%2Fweb.git Update doxygen Change-Id: I2b583eae179d4da0d2a9723bdd9619545be775a3 Signed-off-by: Hyun Lee --- diff --git a/inc/FWebCtrlAuthenticationChallenge.h b/inc/FWebCtrlAuthenticationChallenge.h index 218edea..59ace10 100755 --- a/inc/FWebCtrlAuthenticationChallenge.h +++ b/inc/FWebCtrlAuthenticationChallenge.h @@ -34,7 +34,7 @@ namespace Tizen { namespace Web { namespace Controls /** * - * @class AuthenticationChallenge + * @class AuthenticationChallenge * @brief This class handles the HyperText Transfer Protocol (HTTP) authentication requests. * * @since 2.0 @@ -59,14 +59,14 @@ public: * * @since 2.0 * - * @privlevel public - * @privilege %http://tizen.org/privilege/web.privacy + * @privlevel public + * @privilege %http://tizen.org/privilege/web.privacy * - * @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. - * @remarks The specific error code can be accessed using the GetLastResult() method. + * @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. + * @remarks The specific error code can be accessed using the GetLastResult() method. */ void Process(const UserId& userId, const Tizen::Base::String& password); @@ -75,12 +75,12 @@ public: * * @since 2.0 * - * @privlevel public - * @privilege %http://tizen.org/privilege/web.privacy + * @privlevel public + * @privilege %http://tizen.org/privilege/web.privacy * - * @exception E_SUCCESS The method is successful. - * @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. + * @exception E_SUCCESS The method is successful. + * @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. */ void Cancel(void); diff --git a/inc/FWebCtrlGeolocationPermissionManager.h b/inc/FWebCtrlGeolocationPermissionManager.h index 7aea3b9..e1c4ca2 100755 --- a/inc/FWebCtrlGeolocationPermissionManager.h +++ b/inc/FWebCtrlGeolocationPermissionManager.h @@ -59,15 +59,15 @@ public: * * @since 2.0 * - * @privlevel platform + * @privlevel platform * @privilege %http://tizen.org/privilege/geolocationpermission.read * - * @return A pointer to IList containing 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. + * @return A pointer to Tizen::Base::Collection::IList containing 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_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. */ Tizen::Base::Collection::IList* GetOriginListN(void) const; diff --git a/inc/FWebCtrlHitElementResult.h b/inc/FWebCtrlHitElementResult.h index a22edd6..ab907a1 100755 --- a/inc/FWebCtrlHitElementResult.h +++ b/inc/FWebCtrlHitElementResult.h @@ -42,10 +42,10 @@ namespace Tizen { namespace Web { namespace Controls { /** - * @class HitElementResult + * @class HitElementResult * @brief This class provides methods to retrieve information from the HyperText Markup Language (HTML) element, pointed by the x and y coordinates. * - * @since 2.0 + * @since 2.0 * * The %HitElementResult class provides methods to retrieve information from the HTML element, such as tag name, attributes and content. * @n @@ -97,7 +97,7 @@ public: * * @since 2.0 * - * @return The URL linked to the element + * @return The URL linked to the element */ Tizen::Base::String GetUrl(void) const; @@ -115,7 +115,7 @@ public: * * @since 2.0 * - * @return @c true if the element is an image element, @n + * @return @c true if the element is an image element, @n * else @c false */ bool HasImage(void) const; @@ -125,7 +125,7 @@ public: * * @since 2.0 * - * @return @c true if there is a URL linked to the element, @n + * @return @c true if there is a URL linked to the element, @n * else @c false */ bool HasUrl(void) const; diff --git a/inc/FWebCtrlIJavaScriptBridge.h b/inc/FWebCtrlIJavaScriptBridge.h index 2ac521f..1acd071 100755 --- a/inc/FWebCtrlIJavaScriptBridge.h +++ b/inc/FWebCtrlIJavaScriptBridge.h @@ -20,9 +20,6 @@ * @brief This is the header file for the %IJavaScriptBridge interface. * * This header file contains the declarations of the %IJavaScriptBridge interface. - * @n - * For more information on the class features, see Web Controls Guide. - * */ #ifndef _FWEB_CTRL_IJAVA_SCRIPT_BRIDGE_H_ #define _FWEB_CTRL_IJAVA_SCRIPT_BRIDGE_H_ @@ -43,7 +40,10 @@ namespace Tizen { namespace Web { namespace Controls * * @since 2.0 * - * The %IJavaScriptBridge interface provides a communication channel between JavaScript and C++ object. + * The %IJavaScriptBridge interface provides a communication channel between JavaScript and native object. + * + * For more information on the class features, see Web Controls Guide. + * */ class _OSP_EXPORT_ IJavaScriptBridge { @@ -51,16 +51,16 @@ 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. * - * @since 2.0 + * @since 2.0 */ virtual ~IJavaScriptBridge(void) {} /** * Called asynchronously on invocation request from JavaScript side through the requestToNative() method. * - * @since 2.0 + * @since 2.0 * - * @param[in] pArg The parameters delivered by JavaScript + * @param[in] pArg The parameters delivered by JavaScript */ virtual void HandleJavaScriptRequestN(Tizen::Web::Json::IJsonValue* pArg) = 0; @@ -69,7 +69,7 @@ public: * * @since 2.0 * - * @return The name of %IJavaScriptBridge + * @return The name of %IJavaScriptBridge */ virtual Tizen::Base::String GetName(void) = 0; diff --git a/inc/FWebCtrlILoadingListener.h b/inc/FWebCtrlILoadingListener.h index d53b17e..e5ef6ff 100755 --- a/inc/FWebCtrlILoadingListener.h +++ b/inc/FWebCtrlILoadingListener.h @@ -50,7 +50,7 @@ namespace Tizen { namespace Web { namespace Controls * * Defines the type of %Web navigation. * - * @since 2.0 + * @since 2.0 */ enum WebNavigationType { @@ -67,7 +67,7 @@ enum WebNavigationType * * Defines the types of loading errors. * - * @since 2.0 + * @since 2.0 */ enum LoadingErrorType { @@ -78,7 +78,7 @@ enum LoadingErrorType 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 failed */ + 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 */ }; @@ -88,7 +88,7 @@ enum LoadingErrorType * * Defines the decision policy. * - * @since 2.0 + * @since 2.0 */ enum DecisionPolicy { @@ -101,7 +101,7 @@ enum DecisionPolicy * @interface ILoadingListener * @brief This interface is for receiving the events that occur during the loading of data. * - * @since 2.0 + * @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 @@ -123,55 +123,55 @@ public: /** * Called when an authentication is requested. * - * @since 2.0 + * @since 2.0 * * @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 + * 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] authentication The handler to send a user response to the server that requested the authentication + * @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; /** * Called when the authentication request is cancelled. * - * @since 2.0 + * @since 2.0 */ virtual void OnHttpAuthenticationCanceled(void) = 0; /** * Called when the loading operation starts. * - * @since 2.0 + * @since 2.0 */ virtual void OnLoadingStarted(void) = 0; /** * Called when the loading operation is cancelled. * - * @since 2.0 + * @since 2.0 */ virtual void OnLoadingCanceled(void) = 0; /** * Called when the loading operation fails. * - * @since 2.0 + * @since 2.0 * - * @param[in] error The error that occurred during loading - * @param[in] reason The reason for the loading failure, @n - * - @c WEB_HTTP_RESPONSE: The HTTP state code such as "404" @n - * - @c WEB_MIME_NOT_SUPPORTED: The Multipurpose Internet Mail Extensions (MIME) type such as "application/rdf+xml" is not supported @n - * - @c WEB_BAD_URL: The URL is incorrect + * @param[in] error The error that occurred during loading + * @param[in] reason The reason for the loading failure, @n + * - @c WEB_HTTP_RESPONSE: The HTTP state code such as "404" @n + * - @c WEB_MIME_NOT_SUPPORTED: The Multipurpose Internet Mail Extensions (MIME) type such as "application/rdf+xml" is not supported @n + * - @c WEB_BAD_URL: The URL is incorrect */ virtual void OnLoadingErrorOccurred(LoadingErrorType error, const Tizen::Base::String& reason) = 0; /** * Called when the loading operation is completed. * - * @since 2.0 + * @since 2.0 */ virtual void OnLoadingCompleted(void) = 0; @@ -179,7 +179,7 @@ public: * Called when the loading progress for the current page is requested. @n * The progress rate is displayed as a percentage. * - * @since 2.0 + * @since 2.0 * * @param[in] progress The progress rate ranging from [@c 0 ~ @c 100] */ @@ -188,7 +188,7 @@ public: /** * Called when the title of the new page has been received. * - * @since 2.0 + * @since 2.0 */ virtual void OnPageTitleReceived(const Tizen::Base::String& title) = 0; @@ -214,7 +214,7 @@ public: * * @since 2.0 * - * @return DecisionPolicy 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 */ @@ -232,7 +232,6 @@ public: virtual void OnFaviconReceived(const Tizen::Graphics::Bitmap& favicon) {} protected: - // // This method is for internal use only. Using this method can cause behavioral, security-related, and consistency-related issues in the application. // diff --git a/inc/FWebCtrlIWebKeypadEventListener.h b/inc/FWebCtrlIWebKeypadEventListener.h index 85c3e27..02f9ad6 100755 --- a/inc/FWebCtrlIWebKeypadEventListener.h +++ b/inc/FWebCtrlIWebKeypadEventListener.h @@ -55,25 +55,25 @@ public: virtual ~IWebKeypadEventListener(void) {} /** - * Called when the keypad is about to be shown on the screen. @n - * 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. + * Called when the keypad is about to be shown on the screen. * * @since 2.0 * * @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. * @see Tizen::Ui::Controls::Form::GetClientAreaBounds() */ virtual void OnWebKeypadWillOpen(Tizen::Web::Controls::Web& source) = 0; /** - * Called when the keypad is shown on the screen. @n - * 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. + * Called when the keypad is shown on the screen. * * @since 2.0 * * @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. * @see Tizen::Ui::Controls::Form::GetClientAreaBounds() */ virtual void OnWebKeypadOpened(Tizen::Web::Controls::Web& source) = 0; diff --git a/inc/FWebCtrlIWebUiEventListener.h b/inc/FWebCtrlIWebUiEventListener.h index c96ab9f..1f3fe13 100755 --- a/inc/FWebCtrlIWebUiEventListener.h +++ b/inc/FWebCtrlIWebUiEventListener.h @@ -76,7 +76,7 @@ public: /** * Called when a request for closing the window is received. @n * This event is called from the parent window's listener that invoked the child window. @n - * The application must free the resource allocated for the %Web Control. + * The application must free the resource allocated for the Web Control. * * @since 2.0 * diff --git a/inc/FWebCtrlPageNavigationList.h b/inc/FWebCtrlPageNavigationList.h index 78f35e5..94c882a 100755 --- a/inc/FWebCtrlPageNavigationList.h +++ b/inc/FWebCtrlPageNavigationList.h @@ -47,7 +47,7 @@ namespace Tizen { namespace Web { namespace Controls * * @since 2.0 * - * The %PageNavigationList class provides the back and forward list for a Web control. + * The %PageNavigationList class provides the back and forward list for a %Web control. * @n * For more information on the class features, see Web Controls Guide. */ diff --git a/inc/FWebCtrlWeb.h b/inc/FWebCtrlWeb.h index 626bbc7..19877a5 100755 --- a/inc/FWebCtrlWeb.h +++ b/inc/FWebCtrlWeb.h @@ -209,7 +209,7 @@ public: result LoadUrl(const Tizen::Base::String& url, const Tizen::Net::Http::HttpHeader& header); /** - * Load the resource specified by the URL with the given header and body of HTTP request. + * Load the resource specified by the URL with the 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. * * @since 2.0 @@ -554,7 +554,7 @@ public: /** * Gets the starting point and the ending point of the selected text block. @n - * When this method is called without the selection block, the startPoint and endPoint have (0,0) values for the x and y coordinates. + * When the %GetBlockRange() method is called without the selection block, the @c startPoint and @c endPoint have (0,0) values for the x and y coordinates. * * @since 2.0 * @@ -757,7 +757,7 @@ public: result SetCookieEnabled(bool enable); /** - * Saves the current web page as a pdf file. 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 size of the pdf file using millimeter. * * @since 2.0 * @@ -828,7 +828,7 @@ public: result SearchTextAllAsync(const Tizen::Base::String& text, bool caseSensitive); /** - * Scrolls the current matched block to the next text matched by SearchTextAllAsync() + * Scrolls the current matched block to the next text matched by SearchTextAllAsync(). * * @since 2.0 * @@ -878,7 +878,7 @@ public: void Resume(void); /** - * Scrolls the web page by the given dx and dy. + * Scrolls the web page with the given coordinates. * * @since 2.1 * @@ -905,11 +905,11 @@ public: Tizen::Graphics::Point GetScrollPosition(void) const; /** - * Gets the size of current web page. + * Gets the size of the current web page. * * @since 2.1 * - * @return The size of current web page. + * @return The size of the current web page */ Tizen::Graphics::Dimension GetPageSize(void) const; diff --git a/inc/FWebCtrlWebSetting.h b/inc/FWebCtrlWebSetting.h index 5f47a33..1d9ba5e 100755 --- a/inc/FWebCtrlWebSetting.h +++ b/inc/FWebCtrlWebSetting.h @@ -391,10 +391,11 @@ public: * * @since 2.0 * - * @return @c true if the two instances match, or if and only if the two instances contain the same elements, @n + * @return @c true if the two instances match, @n * else @c false * @param[in] obj The object to compare with the current instance - * @see Tizen::Base::Object::Equals() + * @remarks This method returns @c true if and only if the two instances contain the same elements. + * @see Tizen::Base::Object::Equals() */ virtual bool Equals(const Object& obj) const; diff --git a/inc/FWebHistoryItem.h b/inc/FWebHistoryItem.h index 3e58549..e6d10f7 100755 --- a/inc/FWebHistoryItem.h +++ b/inc/FWebHistoryItem.h @@ -85,7 +85,7 @@ public: Tizen::Base::String GetUrl(void) const; /** - * Gets the favicon image from HistoryItem + * Gets the favicon image from HistoryItem. * * @since 2.0 * diff --git a/inc/FWebWebHistory.h b/inc/FWebWebHistory.h index b0582f5..6bd1bcc 100755 --- a/inc/FWebWebHistory.h +++ b/inc/FWebWebHistory.h @@ -79,7 +79,6 @@ public: * Gets the history item pointed to by the specified @c index. * * @since 2.0 - * * @privlevel public * @privilege %http://tizen.org/privilege/web.privacy * @@ -97,7 +96,6 @@ public: * Gets the total number of items. * * @since 2.0 - * * @privlevel public * @privilege %http://tizen.org/privilege/web.privacy *