[WebView] Update API reference

Update API reference for API Doc.

Change-Id: I2f5c83fd5eed611c99bb34ad868ba10ec202785e
Signed-off-by: yh106.jung <yh106.jung@samsung.com>

diff --git a/src/Tizen.WebView/Tizen.WebView/Chromium.cs b/src/Tizen.WebView/Tizen.WebView/Chromium.cs
index 8511dcd..ca220ed 100644 (file)
--- a/src/Tizen.WebView/Tizen.WebView/Chromium.cs
+++ b/src/Tizen.WebView/Tizen.WebView/Chromium.cs
@@ -16,10 +16,13 @@
 
 namespace Tizen.WebView
 {
+    /// <summary>
+    /// This class provides methods to initialize and shutdown Chromium-efl.
+    /// </summary>
     public static class Chromium
     {
         /// <summary>
-        /// Initializes Chromium's instance
+        /// Initializes Chromium's instance.
         /// </summary>
         /// <returns>A reference count of Chromium's instance</returns>
         public static int Initialize()
@@ -28,7 +31,7 @@ namespace Tizen.WebView
         }
 
         /// <summary>
-        /// Decreases a reference count of WebKit's instance, possibly destroying it
+        /// Decreases a reference count of WebKit's instance, possibly destroying it.
         /// </summary>
         /// <returns>A reference count of Chromium's instance</returns>
         public static int Shutdown()

diff --git a/src/Tizen.WebView/Tizen.WebView/Context.cs b/src/Tizen.WebView/Tizen.WebView/Context.cs
index 6e58cad..097da62 100644 (file)
--- a/src/Tizen.WebView/Tizen.WebView/Context.cs
+++ b/src/Tizen.WebView/Tizen.WebView/Context.cs
@@ -23,11 +23,27 @@ namespace Tizen.WebView
     /// </summary>
     public enum CacheModel
     {
-        DocumentViewer,     /* Use the smallest cache capacity */
-        DocumentBrowser,    /* Use bigger cache capacity than DocumentBrowser */
-        PrimaryWebBrowser   /* Use the biggest cache capacity. */
+        /// <summary>
+        /// Use the smallest cache capacity.
+        /// </summary>
+        DocumentViewer,
+        /// <summary>
+        /// Use bigger cache capacity than DocumentBrowser.
+        /// </summary>
+        DocumentBrowser,
+        /// <summary>
+        /// Use the biggest cache capacity.
+        /// </summary>
+        PrimaryWebBrowser
     }
 
+    /// <summary>
+    /// This class encapsulates all pages related to the specific use of Chromium-efl.
+    /// </summary>
+    /// <remarks>
+    /// Applications have the option of creating a context different from the default one and using it for a group of pages.
+    /// All pages in the same context share the same preferences, visited link set, local storage, and so on.
+    /// </remarks>
     public class Context
     {
         private IntPtr _handle;

diff --git a/src/Tizen.WebView/Tizen.WebView/CookieManager.cs b/src/Tizen.WebView/Tizen.WebView/CookieManager.cs
index 487e88b..f7ed538 100644 (file)
--- a/src/Tizen.WebView/Tizen.WebView/CookieManager.cs
+++ b/src/Tizen.WebView/Tizen.WebView/CookieManager.cs
@@ -22,9 +22,18 @@ namespace Tizen.WebView
     /// </summary>
     public enum CookieAcceptPolicy
     {
-        Always,         /* Accepts every cookie sent from any page */
-        Never,          /* Rejects all cookies */
-        NoThirdParty    /* Accepts only cookies set by the main document loaded */
+        /// <summary>
+        /// Accepts every cookie sent from any page.
+        /// </summary>
+        Always,
+        /// <summary>
+        /// Rejects all cookies.
+        /// </summary>
+        Never,
+        /// <summary>
+        /// Accepts only cookies set by the main document loaded.
+        /// </summary>
+        NoThirdParty
     }
 
     /// <summary>
@@ -32,10 +41,19 @@ namespace Tizen.WebView
     /// </summary>
     public enum CookiePersistentStorage
     {
-        Text,       /* Cookies are stored in a text file in the Mozilla "cookies.txt" format */
-        SqlLite     /* Cookies are stored in a SQLite file in the current Mozilla format. */
+        /// <summary>
+        /// Cookies are stored in a text file in the Mozilla "cookies.txt" format.
+        /// </summary>
+        Text,
+        /// <summary>
+        /// Cookies are stored in a SQLite file in the current Mozilla format.
+        /// </summary>
+        SqlLite
     }
 
+    /// <summary>
+    /// This class provides methods for the cookie manager.
+    /// </summary>
     public class CookieManager
     {
         private IntPtr _handle;
@@ -68,10 +86,8 @@ namespace Tizen.WebView
         /// <summary>
         /// Sets the storage where non-session cookies are stored persistently to read/write the cookies.
         /// </summary>
-        ///<privilege>
-        /// http://tizen.org/privilege/mediastorage
-        /// http://tizen.org/privilege/externalstorage
-        /// </privilege>
+        /// <privilege>http://tizen.org/privilege/mediastorage</privilege>
+        /// <privilege>http://tizen.org/privilege/externalstorage</privilege>
         /// <param name="path">The path where to read/write Cookies</param>
         /// <param name="storage">The type of storage</param>
         public void SetPersistentStorage(string path, CookiePersistentStorage storage)

diff --git a/src/Tizen.WebView/Tizen.WebView/Settings.cs b/src/Tizen.WebView/Tizen.WebView/Settings.cs
index 8e1f349..b9fcba3 100644 (file)
--- a/src/Tizen.WebView/Tizen.WebView/Settings.cs
+++ b/src/Tizen.WebView/Tizen.WebView/Settings.cs
@@ -18,6 +18,9 @@ using System;
 
 namespace Tizen.WebView
 {
+    /// <summary>
+    /// This class provides properties for setting the preference of a specific WebView.
+    /// </summary>
     public class Settings
     {
         private IntPtr _handle;

diff --git a/src/Tizen.WebView/Tizen.WebView/SmartCallbackLoadErrorArgs.cs b/src/Tizen.WebView/Tizen.WebView/SmartCallbackLoadErrorArgs.cs
index 8aa6704..28323bb 100644 (file)
--- a/src/Tizen.WebView/Tizen.WebView/SmartCallbackLoadErrorArgs.cs
+++ b/src/Tizen.WebView/Tizen.WebView/SmartCallbackLoadErrorArgs.cs
@@ -33,7 +33,7 @@ namespace Tizen.WebView
         /// </summary>
         Canceled,
         /// <summary>
-        /// Can't show page for this MIME Type
+        /// Can't show page for this MIME Type.
         /// </summary>
         CantSupportMimetype,
         /// <summary>
@@ -41,19 +41,19 @@ namespace Tizen.WebView
         /// </summary>
         FailedFileIo,
         /// <summary>
-        /// Cannot connect to network
+        /// Cannot connect to network.
         /// </summary>
         CantConnect,
         /// <summary>
-        /// Fail to look up host from DNS
+        /// Fail to look up host from DNS.
         /// </summary>
         CantLookupHost,
         /// <summary>
-        /// Fail to SSL/TLS handshake
+        /// Fail to SSL/TLS handshake.
         /// </summary>
         FailedTlsHandshake,
         /// <summary>
-        /// Received certificate is invalid
+        /// Received certificate is invalid.
         /// </summary>
         InvalidCertificate,
         /// <summary>
@@ -81,7 +81,7 @@ namespace Tizen.WebView
         /// </summary>
         Authentication,
         /// <summary>
-        /// Web server has internal server error
+        /// Web server has internal server error.
         /// </summary>
         InternalServer,
     }