From b126f4810f21282db830ea2baae61d39742e085c Mon Sep 17 00:00:00 2001 From: Editor Date: Thu, 28 Dec 2017 15:17:06 +0530 Subject: [PATCH] Review WebView API cs files Change-Id: I959fa181418d9dc51fb7caca9bffb3cbbc9fd701 --- src/Tizen.WebView/Tizen.WebView/Chromium.cs | 10 ++-- src/Tizen.WebView/Tizen.WebView/Context.cs | 8 +-- src/Tizen.WebView/Tizen.WebView/CookieManager.cs | 18 +++---- .../Tizen.WebView/JavaScriptMessage.cs | 22 ++++---- src/Tizen.WebView/Tizen.WebView/Settings.cs | 6 +-- .../Tizen.WebView/SmartCallbackArgs.cs | 18 +++---- .../Tizen.WebView/SmartCallbackLoadErrorArgs.cs | 30 +++++------ src/Tizen.WebView/Tizen.WebView/WebView.cs | 62 +++++++++++----------- 8 files changed, 87 insertions(+), 87 deletions(-) diff --git a/src/Tizen.WebView/Tizen.WebView/Chromium.cs b/src/Tizen.WebView/Tizen.WebView/Chromium.cs index c6e6288..e457e53 100644 --- a/src/Tizen.WebView/Tizen.WebView/Chromium.cs +++ b/src/Tizen.WebView/Tizen.WebView/Chromium.cs @@ -17,15 +17,15 @@ namespace Tizen.WebView { /// - /// This class provides methods to initialize and shutdown Chromium-efl. + /// This class provides the methods to initialize and shutdown the Chromium-efl. /// /// 4 public static class Chromium { /// - /// Initializes Chromium's instance. + /// Initializes the Chromium's instance. /// - /// A reference count of Chromium's instance + /// A reference count of the Chromium's instance. /// 4 public static int Initialize() { @@ -33,9 +33,9 @@ namespace Tizen.WebView } /// - /// Decreases a reference count of WebKit's instance, possibly destroying it. + /// Decreases a reference count of the WebKit's instance, possibly destroying it. /// - /// A reference count of Chromium's instance + /// A reference count of the Chromium's instance. /// 4 public static int Shutdown() { diff --git a/src/Tizen.WebView/Tizen.WebView/Context.cs b/src/Tizen.WebView/Tizen.WebView/Context.cs index 81cec38..ddf2490 100644 --- a/src/Tizen.WebView/Tizen.WebView/Context.cs +++ b/src/Tizen.WebView/Tizen.WebView/Context.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.WebView { /// - /// Enumeration that contains option for cache model. + /// Enumeration for cache model options. /// /// 4 public enum CacheModel @@ -29,7 +29,7 @@ namespace Tizen.WebView /// DocumentViewer, /// - /// Use bigger cache capacity than DocumentBrowser. + /// Use the bigger cache capacity than DocumentBrowser. /// DocumentBrowser, /// @@ -39,7 +39,7 @@ namespace Tizen.WebView } /// - /// This class encapsulates all pages related to the specific use of Chromium-efl. + /// This class encapsulates all the pages related to the specific use of the Chromium-efl. /// /// /// Applications have the option of creating a context different from the default one and using it for a group of pages. @@ -79,7 +79,7 @@ namespace Tizen.WebView /// /// Gets the CookieManager object for this context. /// - /// The CookieManager object + /// The CookieManager object. /// 4 public CookieManager GetCookieManager() { diff --git a/src/Tizen.WebView/Tizen.WebView/CookieManager.cs b/src/Tizen.WebView/Tizen.WebView/CookieManager.cs index 2122f12..aebd8fe 100644 --- a/src/Tizen.WebView/Tizen.WebView/CookieManager.cs +++ b/src/Tizen.WebView/Tizen.WebView/CookieManager.cs @@ -18,7 +18,7 @@ using System; namespace Tizen.WebView { /// - /// Enumeration that contains accept policies for the cookies. + /// Enumeration for the cookies accept policies. /// /// 4 public enum CookieAcceptPolicy @@ -28,17 +28,17 @@ namespace Tizen.WebView /// Always, /// - /// Rejects all cookies. + /// Rejects all the cookies. /// Never, /// - /// Accepts only cookies set by the main document loaded. + /// Accepts only cookies set by the main document that is loaded. /// NoThirdParty } /// - /// Enumeration that creates a type name for the storage of persistent cookies. + /// Enumeration for creating a type name for the storage of persistent cookies. /// /// 4 public enum CookiePersistentStorage @@ -70,9 +70,9 @@ namespace Tizen.WebView /// Sets the cookie acceptance policy. /// /// - /// By default, only cookies set by the main document loaded are accepted. + /// By default, only cookies set by the main document that is loaded, are accepted. /// - /// The cookie acceptance policy + /// The cookie acceptance policy. /// 4 public void SetCookieAcceptPolicy(CookieAcceptPolicy policy) { @@ -89,12 +89,12 @@ namespace Tizen.WebView } /// - /// Sets the storage where non-session cookies are stored persistently to read/write the cookies. + /// Sets the storage where the non-session cookies are stored persistently, to read/write the cookies. /// /// http://tizen.org/privilege/mediastorage /// http://tizen.org/privilege/externalstorage - /// The path where to read/write Cookies - /// The type of storage + /// The path where to read/write cookies. + /// The type of storage. /// 4 public void SetPersistentStorage(string path, CookiePersistentStorage storage) { diff --git a/src/Tizen.WebView/Tizen.WebView/JavaScriptMessage.cs b/src/Tizen.WebView/Tizen.WebView/JavaScriptMessage.cs index 999ae23..f8aa308 100644 --- a/src/Tizen.WebView/Tizen.WebView/JavaScriptMessage.cs +++ b/src/Tizen.WebView/Tizen.WebView/JavaScriptMessage.cs @@ -23,12 +23,12 @@ namespace Tizen.WebView /// /// The callback function that is invoked when the message is received from the script. /// - /// The JavaScriptMessage returned by the script + /// The JavaScriptMessage returned by the script. /// 4 public delegate void JavaScriptMessageHandler(JavaScriptMessage message); /// - /// A Script message contains information that sent from JavaScript runtime. + /// A script message contains information that is sent from the JavaScript runtime. /// /// 4 public class JavaScriptMessage @@ -43,7 +43,7 @@ namespace Tizen.WebView } /// - /// Obect name in JavaScript. + /// The object name in JavaScript. /// /// 4 public string Name @@ -55,9 +55,9 @@ namespace Tizen.WebView } /// - /// Gets the value of body as integer type. + /// Gets the value of the body as an integer type. /// - /// The value of body as integer type + /// The value of the body as an integer type. /// 4 public int GetBodyAsInteger() { @@ -69,9 +69,9 @@ namespace Tizen.WebView } /// - /// Gets the value of body as double type. + /// Gets the value of the body as a double type. /// - /// The value of body as double type + /// The value of the body as a double type. /// 4 public double GetBodyAsDouble() { @@ -85,9 +85,9 @@ namespace Tizen.WebView } /// - /// Gets the value of body as boolean type. + /// Gets the value of the body as a boolean type. /// - /// The value of body as boolean type + /// The value of the body as boolean type. /// 4 public bool GetBodyAsBoolean() { @@ -99,9 +99,9 @@ namespace Tizen.WebView } /// - /// Gets the value of body as string type. + /// Gets the value of the body as a string type. /// - /// The value of body as string type + /// The value of the body as a string type. /// 4 public string GetBodyAsString() { diff --git a/src/Tizen.WebView/Tizen.WebView/Settings.cs b/src/Tizen.WebView/Tizen.WebView/Settings.cs index 5cd0a9d..88d7a74 100644 --- a/src/Tizen.WebView/Tizen.WebView/Settings.cs +++ b/src/Tizen.WebView/Tizen.WebView/Settings.cs @@ -19,7 +19,7 @@ using System; namespace Tizen.WebView { /// - /// This class provides properties for setting the preference of a specific WebView. + /// This class provides the properties for setting the preference of a specific WebView. /// /// 4 public class Settings @@ -32,7 +32,7 @@ namespace Tizen.WebView } /// - /// Whether JavaScript can be executable. + /// Whether the JavaScript can be executed. /// /// 4 public bool JavaScriptEnabled @@ -49,7 +49,7 @@ namespace Tizen.WebView } /// - /// Whether images can be loaded automatically. + /// Whether the images can be loaded automatically. /// /// 4 public bool LoadImageAutomatically diff --git a/src/Tizen.WebView/Tizen.WebView/SmartCallbackArgs.cs b/src/Tizen.WebView/Tizen.WebView/SmartCallbackArgs.cs index 1bdc513..0701a10 100644 --- a/src/Tizen.WebView/Tizen.WebView/SmartCallbackArgs.cs +++ b/src/Tizen.WebView/Tizen.WebView/SmartCallbackArgs.cs @@ -20,7 +20,7 @@ using System.Runtime.InteropServices; namespace Tizen.WebView { /// - /// Argument from the SmartCallback. + /// The argument from the SmartCallback. /// /// 4 public class SmartCallbackArgs : EventArgs @@ -33,9 +33,9 @@ namespace Tizen.WebView } /// - /// Gets argument as integer type. + /// Gets the argument as an integer type. /// - /// Argument as integer type + /// Argument as an integer type. /// 4 public int GetAsInteger() { @@ -47,9 +47,9 @@ namespace Tizen.WebView } /// - /// Gets argument as double type. + /// Gets the argument as a double type. /// - /// Argument as double type + /// Argument as a double type. /// 4 public double GetAsDouble() { @@ -63,9 +63,9 @@ namespace Tizen.WebView } /// - /// Gets argument as boolean type. + /// Gets the argument as a boolean type. /// - /// Argument as boolean type + /// Argument as a boolean type. /// 4 public bool GetAsBoolean() { @@ -77,9 +77,9 @@ namespace Tizen.WebView } /// - /// Gets argument as string type. + /// Gets the argument as a string type. /// - /// Argument as string type + /// Argument as a string type. /// 4 public string GetAsString() { diff --git a/src/Tizen.WebView/Tizen.WebView/SmartCallbackLoadErrorArgs.cs b/src/Tizen.WebView/Tizen.WebView/SmartCallbackLoadErrorArgs.cs index 8107192..1be1a80 100644 --- a/src/Tizen.WebView/Tizen.WebView/SmartCallbackLoadErrorArgs.cs +++ b/src/Tizen.WebView/Tizen.WebView/SmartCallbackLoadErrorArgs.cs @@ -20,33 +20,33 @@ using System.Runtime.InteropServices; namespace Tizen.WebView { /// - /// Enumeration that provides an option to error codes. + /// Enumeration for providing an option to the error codes. /// /// 4 public enum LoadErrorCode { /// - /// Unknown + /// Unknown. /// Unknown = 0, /// - /// User canceled + /// User canceled. /// Canceled, /// - /// Can't show page for this MIME Type. + /// Can't show the page for this MIME type. /// CantSupportMimetype, /// - /// File IO error + /// File IO error. /// FailedFileIo, /// - /// Cannot connect to network. + /// Cannot connect to the network. /// CantConnect, /// - /// Fail to look up host from DNS. + /// Fail to look up host from the DNS. /// CantLookupHost, /// @@ -58,37 +58,37 @@ namespace Tizen.WebView /// InvalidCertificate, /// - /// Connection timeout + /// Connection timeout. /// RequestTimeout, /// - /// Too many redirects + /// Too many redirects. /// TooManyRedirects, /// - /// Too many requests during this load + /// Too many requests during this load. /// TooManyRequests, /// - /// Malformed url + /// Malformed URL. /// BadUrl, /// - /// Unsupported scheme + /// Unsupported scheme. /// UnsupportedScheme, /// - /// User authentication failed on server + /// User authentication failed on the server. /// Authentication, /// - /// Web server has internal server error. + /// Web server has an internal server error. /// InternalServer, } /// - /// Argument from the LoadError SmartCallback. + /// Arguments from the LoadError SmartCallback. /// /// 4 public class SmartCallbackLoadErrorArgs : EventArgs diff --git a/src/Tizen.WebView/Tizen.WebView/WebView.cs b/src/Tizen.WebView/Tizen.WebView/WebView.cs index a7f218d..80de63b 100644 --- a/src/Tizen.WebView/Tizen.WebView/WebView.cs +++ b/src/Tizen.WebView/Tizen.WebView/WebView.cs @@ -22,7 +22,7 @@ using System.Runtime.InteropServices; namespace Tizen.WebView { /// - /// A view used to render web contents. + /// A view used to render the web contents. /// /// 4 public class WebView: EvasObject @@ -48,31 +48,31 @@ namespace Tizen.WebView /// - /// Event that occurs when load started. + /// Event that occurs when the load is started. /// /// 4 public event EventHandler LoadStarted; /// - /// Event that occurs when load finished. + /// Event that occurs when the load is finished. /// /// 4 public event EventHandler LoadFinished; /// - /// Event that occurs when load error. + /// Event that occurs when the load throws an error. /// /// 4 public event EventHandler LoadError; /// - /// Event that occurs when title of main frame was changed. + /// Event that occurs when the title of the main frame is changed. /// /// 4 public event EventHandler TitleChanged; /// - /// Event that occurs when URL of main frame was changed. + /// Event that occurs when the URL of the main frame is changed. /// /// 4 public event EventHandler UrlChanged; @@ -131,9 +131,9 @@ namespace Tizen.WebView } /// - /// Create a WebView object. + /// Creates a WebView object. /// - /// Parent object of WebView + /// Parent object of the WebView. /// 4 public WebView(EvasObject parent) : base(parent) { @@ -141,9 +141,9 @@ namespace Tizen.WebView } /// - /// Gets the Context object of this view. + /// Gets the context object of this view. /// - /// The Context object of this view + /// The context object of this view. /// 4 public Context GetContext() { @@ -160,9 +160,9 @@ namespace Tizen.WebView } /// - /// Gets the Settings object of this view. + /// Gets the settings object of this view. /// - /// The Settings object of this view + /// The settings object of this view. /// 4 public Settings GetSettings() { @@ -182,9 +182,9 @@ namespace Tizen.WebView /// Asks the object to load the given URL. /// /// - /// You can only be sure that url changed after UrlChanged event. + /// You can only be sure that the URL changes after UrlChanged event. /// - /// The uniform resource identifier to load + /// The uniform resource identifier to load. /// 4 public void LoadUrl(string url) { @@ -192,10 +192,10 @@ namespace Tizen.WebView } /// - /// Loads the specified html string as the content of the view. + /// Loads the specified HTML string as the content of the view. /// - /// HTML data to load - /// Base URL used for relative paths to external objects + /// HTML data to load. + /// Base URL used for relative paths to external objects. /// 4 public void LoadHtml(string html, string baseUrl) { @@ -239,9 +239,9 @@ namespace Tizen.WebView } /// - /// Checks whether it is possible to navigate backwards one item in history. + /// Checks whether it is possible to navigate backward one item in history. /// - /// Whether it is possible to navigate backwards one item in history + /// Whether it is possible to navigate backward one item in history. /// 4 public bool CanGoBack() { @@ -249,9 +249,9 @@ namespace Tizen.WebView } /// - /// Checks whether it is possible to navigate forwards one item in history. + /// Checks whether it is possible to navigate forward one item in history. /// - /// Whether it is possible to navigate forwards one item in history + /// Whether it is possible to navigate forward one item in history. /// 4 public bool CanGoForward() { @@ -261,9 +261,9 @@ namespace Tizen.WebView /// /// Injects the supplied javascript message handler into the view. /// - /// The message callback - /// The name used to expose the object in JavaScript - /// 'true' on success, otherwise 'false' + /// The message callback. + /// The name used to expose the object in JavaScript. + /// 'true' on success, otherwise 'false'. /// 4 public bool AddJavaScriptMessageHandler(string name, JavaScriptMessageHandler handler) { @@ -298,10 +298,10 @@ namespace Tizen.WebView } /// - /// Requests the execution of given name and result to the JavaScript runtime. + /// Requests the execution of a given name and the result to the JavaScript runtime. /// - /// The name used to expose the object in JavaScript - /// The result to the JavaScript runtime + /// The name used to expose the object in JavaScript. + /// The result to the JavaScript runtime. /// 4 public void EvalWithResult(string name, string result) { @@ -311,7 +311,7 @@ namespace Tizen.WebView /// /// Requests the execution of the given script. /// - /// The JavaScript code string to execute + /// The JavaScript code string to execute. /// 4 public void Eval(string script) { @@ -321,7 +321,7 @@ namespace Tizen.WebView /// /// Requests to set or unset a view as the currently focused one. /// - /// 'true' to set the focus on the view, 'false' to remove the focus from the view + /// 'true' to set the focus on the view, 'false' to remove the focus from the view. /// 4 public void SetFocus(bool focused) { @@ -331,8 +331,8 @@ namespace Tizen.WebView /// /// Creates a widget handle. /// - /// Parent EvasObject - /// IntPtr of the widget handle + /// Parent EvasObject. + /// IntPtr of the widget handle. /// 4 protected override IntPtr CreateHandle(EvasObject parent) { -- 2.7.4