WebKit: iOS 11 parameter drive (complete, drive complete)

xamarin · Jan 22, 2018 · e7275d6 · e7275d6
1 parent c89e898
commit e7275d6
Show file tree

Hide file tree

Showing 9 changed files with 65 additions and 62 deletions.
diff --git a/en/MonoTouch.WebKit/IWKUrlSchemeHandler.xml b/en/MonoTouch.WebKit/IWKUrlSchemeHandler.xml
@@ -59,8 +59,8 @@
         <Parameter Name="urlSchemeTask" Type="MonoTouch.WebKit.IWKUrlSchemeTask" />
       </Parameters>
       <Docs>
-        <param name="webView">To be added.</param>
-        <param name="urlSchemeTask">To be added.</param>
+        <param name="webView">The web view that is making the request.</param>
+        <param name="urlSchemeTask">The task for which to load data.</param>
         <summary>Starts a URL scheme task that processes a URL and loads data for the specified <paramref name="webView" />.</summary>
         <remarks>To be added.</remarks>
       </Docs>
@@ -89,8 +89,8 @@
         <Parameter Name="urlSchemeTask" Type="MonoTouch.WebKit.IWKUrlSchemeTask" />
       </Parameters>
       <Docs>
-        <param name="webView">To be added.</param>
-        <param name="urlSchemeTask">To be added.</param>
+        <param name="webView">The web view that is making the request.</param>
+        <param name="urlSchemeTask">The task for which to stop loading data.</param>
         <summary>Stops a URL scheme task that processes a URL and loads data for the specified <paramref name="webView" />.</summary>
         <remarks>To be added.</remarks>
       </Docs>

diff --git a/en/MonoTouch.WebKit/IWKUrlSchemeTask.xml b/en/MonoTouch.WebKit/IWKUrlSchemeTask.xml
@@ -67,7 +67,7 @@
         <Parameter Name="error" Type="MonoTouch.Foundation.NSError" />
       </Parameters>
       <Docs>
-        <param name="error">To be added.</param>
+        <param name="error">The error that occurred.</param>
         <summary>Method that is called to indicate failure.</summary>
         <remarks>To be added.</remarks>
       </Docs>
@@ -120,7 +120,7 @@
         <Parameter Name="data" Type="MonoTouch.Foundation.NSData" />
       </Parameters>
       <Docs>
-        <param name="data">To be added.</param>
+        <param name="data">The data that was received.</param>
         <summary>Method that is called to indicate that the task received the data.</summary>
         <remarks>To be added.</remarks>
       </Docs>
@@ -148,7 +148,7 @@
         <Parameter Name="response" Type="MonoTouch.Foundation.NSUrlResponse" />
       </Parameters>
       <Docs>
-        <param name="response">To be added.</param>
+        <param name="response">The response that was received.</param>
         <summary>Method that is called to indicate that the task received a response.</summary>
         <remarks>To be added.</remarks>
       </Docs>

diff --git a/en/MonoTouch.WebKit/WKContentRuleListStore.xml b/en/MonoTouch.WebKit/WKContentRuleListStore.xml
@@ -165,9 +165,9 @@ public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
         </Parameter>
       </Parameters>
       <Docs>
-        <param name="identifier">To be added.</param>
-        <param name="encodedContentRuleList">To be added.</param>
-        <param name="completionHandler">To be added.</param>
+        <param name="identifier">The identifier for the newly compiled list.</param>
+        <param name="encodedContentRuleList">JSON source to compile.</param>
+        <param name="completionHandler">A handler to run after compilation completes or stops with an error.</param>
         <summary>Compiles the provided list of rules, adds the list to the store with the specified <paramref name="identifier" />, and runs a handler that receives the content list and any error that is encountered.</summary>
         <remarks>To be added.</remarks>
       </Docs>
@@ -188,8 +188,8 @@ public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
         <Parameter Name="encodedContentRuleList" Type="System.String" />
       </Parameters>
       <Docs>
-        <param name="identifier">To be added.</param>
-        <param name="encodedContentRuleList">To be added.</param>
+        <param name="identifier">The identifier for the newly compiled list.</param>
+        <param name="encodedContentRuleList">JSON source to compile.</param>
         <summary>Compiles the provided list of rules, adds the list to the store with the specified , and runs a handler that receives the content list and any error that is encountered.</summary>
         <returns>
           <para class="improve-task-t-return-type-description">A task that represents the asynchronous CompileContentRuleList operation.  The value of the TResult parameter is of type MonoTouch.WebKit.WKContentRuleList,MonoTouch.Foundation.NSError.</para>
@@ -239,7 +239,7 @@ public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
         <Parameter Name="url" Type="MonoTouch.Foundation.NSUrl" />
       </Parameters>
       <Docs>
-        <param name="url">To be added.</param>
+        <param name="url">The location of a directory that contains compiled rule lists from which to create the new store.</param>
         <summary>Creates and returns a rule list store object from the provided <paramref name="url" />.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -271,7 +271,7 @@ public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
         </Parameter>
       </Parameters>
       <Docs>
-        <param name="callback">To be added.</param>
+        <param name="callback">A handler to run with the available identifiers.</param>
         <summary>Retrieves the list of identifiers for available content rule lists and passes them to the provided <paramref name="callback" />.</summary>
         <remarks>To be added.</remarks>
       </Docs>
@@ -326,8 +326,8 @@ public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
         </Parameter>
       </Parameters>
       <Docs>
-        <param name="identifier">To be added.</param>
-        <param name="completionHandler">To be added.</param>
+        <param name="identifier">The identifer for the rule list to look up.</param>
+        <param name="completionHandler">A handler to run on the retrieved list.</param>
         <summary>Passes the content rule list that is specified by the provided <paramref name="identifier" /> to the specified <paramref name="completionHandler" />.</summary>
         <remarks>To be added.</remarks>
       </Docs>
@@ -347,7 +347,7 @@ public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
         <Parameter Name="identifier" Type="System.String" />
       </Parameters>
       <Docs>
-        <param name="identifier">To be added.</param>
+        <param name="identifier">The identifer for the rule list to look up.</param>
         <summary>Passes the content rule list that is specified by the provided  to the specified .</summary>
         <returns>
           <para class="improve-task-t-return-type-description">A task that represents the asynchronous LookUpContentRuleList operation.  The value of the TResult parameter is of type MonoTouch.WebKit.WKContentRuleList,MonoTouch.Foundation.NSError.</para>
@@ -382,8 +382,8 @@ public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
         </Parameter>
       </Parameters>
       <Docs>
-        <param name="identifier">To be added.</param>
-        <param name="completionHandler">To be added.</param>
+        <param name="identifier">The identifier for the list to remove.</param>
+        <param name="completionHandler">An error handler to run after the operation completes.</param>
         <summary>Removes the content rule list that is specified by the provided <paramref name="identifier" /> and passes it to the specified <paramref name="completionHandler" />.</summary>
         <remarks>To be added.</remarks>
       </Docs>
@@ -403,7 +403,7 @@ public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
         <Parameter Name="identifier" Type="System.String" />
       </Parameters>
       <Docs>
-        <param name="identifier">To be added.</param>
+        <param name="identifier">The identifier for the list to remove.</param>
         <summary>Removes the content rule list that is specified by the provided  and passes it to the specified .</summary>
         <returns>A task that represents the asynchronous RemoveContentRuleList operation</returns>
         <remarks />

diff --git a/en/MonoTouch.WebKit/WKHttpCookieStore.xml b/en/MonoTouch.WebKit/WKHttpCookieStore.xml
@@ -118,7 +118,7 @@ public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
         <Parameter Name="observer" Type="MonoTouch.WebKit.IWKHttpCookieStoreObserver" />
       </Parameters>
       <Docs>
-        <param name="observer">To be added.</param>
+        <param name="observer">The observer to add.</param>
         <summary>Adds the specified <paramref name="observer" /> to the cookie store.</summary>
         <remarks>To be added.</remarks>
       </Docs>
@@ -167,9 +167,9 @@ public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
         </Parameter>
       </Parameters>
       <Docs>
-        <param name="cookie">To be added.</param>
+        <param name="cookie">The cookie to remove.</param>
         <param name="completionHandler">
-          <para>To be added.</para>
+          <para>An action to run after the operation completes.</para>
           <para tool="nullallowed">This parameter can be <see langword="null" />.</para>
         </param>
         <summary>Deletes the specified <paramref name="cookie" /> from the store and runs a completion handler when the operation is complete.</summary>
@@ -191,7 +191,7 @@ public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
         <Parameter Name="cookie" Type="MonoTouch.Foundation.NSHttpCookie" />
       </Parameters>
       <Docs>
-        <param name="cookie">To be added.</param>
+        <param name="cookie">The cookie to remove.</param>
         <summary>Deletes the specified  from the store and runs a completion handler when the operation is complete.</summary>
         <returns>A task that represents the asynchronous DeleteCookie operation</returns>
         <remarks>
@@ -226,7 +226,7 @@ public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
         </Parameter>
       </Parameters>
       <Docs>
-        <param name="completionHandler">To be added.</param>
+        <param name="completionHandler">A handler to run with all the cookies.</param>
         <summary>Passes all the cookies to the provided <paramref name="completionHandler" />.</summary>
         <remarks>To be added.</remarks>
       </Docs>
@@ -244,7 +244,7 @@ public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
       </ReturnValue>
       <Parameters />
       <Docs>
-        <summary>Passes all the cookies to the provided <paramref name="completionHandler" />.</summary>
+        <summary>Gets all the cookies and returns a task that provides the result.</summary>
         <returns>
           <para class="improve-task-t-return-type-description">A task that represents the asynchronous GetAllCookies operation.  The value of the TResult parameter is of type MonoTouch.Foundation.NSHttpCookie[].</para>
         </returns>
@@ -271,7 +271,7 @@ public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
         <Parameter Name="observer" Type="MonoTouch.WebKit.IWKHttpCookieStoreObserver" />
       </Parameters>
       <Docs>
-        <param name="observer">To be added.</param>
+        <param name="observer">The observer to remove.</param>
         <summary>Removes the specified <paramref name="observer" /> from the cookie store.</summary>
         <remarks>To be added.</remarks>
       </Docs>
@@ -303,9 +303,9 @@ public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
         </Parameter>
       </Parameters>
       <Docs>
-        <param name="cookie">To be added.</param>
+        <param name="cookie">The cookie to set.</param>
         <param name="completionHandler">
-          <para>To be added.</para>
+          <para>A handler to run after the operation completes.</para>
           <para tool="nullallowed">This parameter can be <see langword="null" />.</para>
         </param>
         <summary>Sets the specified <paramref name="cookie" /> and runs a handler when the operation completes.</summary>
@@ -327,7 +327,7 @@ public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
         <Parameter Name="cookie" Type="MonoTouch.Foundation.NSHttpCookie" />
       </Parameters>
       <Docs>
-        <param name="cookie">To be added.</param>
+        <param name="cookie">The cookie to set.</param>
         <summary>Sets the specified  and runs a handler when the operation completes.</summary>
         <returns>A task that represents the asynchronous SetCookie operation</returns>
         <remarks />

diff --git a/en/MonoTouch.WebKit/WKHttpCookieStoreObserver_Extensions.xml b/en/MonoTouch.WebKit/WKHttpCookieStoreObserver_Extensions.xml
@@ -31,7 +31,7 @@
       </Parameters>
       <Docs>
         <param name="This">The instance on which this method operates.</param>
-        <param name="cookieStore">To be added.</param>
+        <param name="cookieStore">The store that changed.</param>
         <summary>Method that is called when a cookie changes in the cookie store.</summary>
         <remarks>To be added.</remarks>
       </Docs>

diff --git a/en/MonoTouch.WebKit/WKUserContentController.xml b/en/MonoTouch.WebKit/WKUserContentController.xml
@@ -207,7 +207,7 @@ public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
         <Parameter Name="contentRuleList" Type="MonoTouch.WebKit.WKContentRuleList" />
       </Parameters>
       <Docs>
-        <param name="contentRuleList">To be added.</param>
+        <param name="contentRuleList">The content rule list to add.</param>
         <summary>Adds the specified list of content rules.</summary>
         <remarks>To be added.</remarks>
       </Docs>
@@ -427,7 +427,7 @@ public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
         <Parameter Name="contentRuleList" Type="MonoTouch.WebKit.WKContentRuleList" />
       </Parameters>
       <Docs>
-        <param name="contentRuleList">To be added.</param>
+        <param name="contentRuleList">The content rule list to remove.</param>
         <summary>Removes the specified content rule list.</summary>
         <remarks>To be added.</remarks>
       </Docs>

diff --git a/en/MonoTouch.WebKit/WKWebView.xml b/en/MonoTouch.WebKit/WKWebView.xml
@@ -1147,7 +1147,7 @@ myTheme.TintColor = UIColor.Red;
         <Parameter Name="urlScheme" Type="System.String" />
       </Parameters>
       <Docs>
-        <param name="urlScheme">To be added.</param>
+        <param name="urlScheme">The URL scheme to check.</param>
         <summary>Returns <see langword="true" /> if the web view has a handler for the specified url scheme.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -1605,10 +1605,10 @@ myTheme.TintColor = UIColor.Red;
       </Parameters>
       <Docs>
         <param name="snapshotConfiguration">
-          <para>To be added.</para>
+          <para>The snapshot configuration to use.</para>
           <para tool="nullallowed">This parameter can be <see langword="null" />.</para>
         </param>
-        <param name="completionHandler">To be added.</param>
+        <param name="completionHandler">A completion handler that receives the image (or <see langword="null" /> if an error occurred) and the error (or <see langword="null" /> if no error occurred).</param>
         <summary>Takes a snapshot of the current viewport and runs a handler that takes the resulting image and any error encountered.</summary>
         <remarks>To be added.</remarks>
       </Docs>
@@ -1633,10 +1633,13 @@ myTheme.TintColor = UIColor.Red;
         <Parameter Name="snapshotConfiguration" Type="MonoTouch.WebKit.WKSnapshotConfiguration" />
       </Parameters>
       <Docs>
-        <param name="snapshotConfiguration">To be added. This parameter can be <see langwor="null" />.</param>
-        <summary>Takes a snapshot of the current viewport and runs a handler that takes the resulting image and any error encountered.</summary>
+        <param name="snapshotConfiguration">
+          <para>The snapshot configuration to use.</para>
+          <para tool="nullallowed">This parameter can be <see langword="null" />.</para>
+        </param>
+        <summary>Takes a snapshot of the current viewport and returns a task that takes the resulting image and any error encountered.</summary>
         <returns>
-          <para class="improve-task-t-return-type-description">A task that represents the asynchronous TakeSnapshot operation.  The value of the TResult parameter is of type MonoTouch.UIKit.UIImage,MonoTouch.Foundation.NSError.</para>
+          <para >A task that receives the resulting image, or <see langword="null" /> if an error occurred</para>
         </returns>
         <remarks>
           <para copied="true">The TakeSnapshotAsync method is suitable to be used with C# async by returning control to the caller with a Task representing the operation.</para>

diff --git a/en/MonoTouch.WebKit/WKWebViewConfiguration.xml b/en/MonoTouch.WebKit/WKWebViewConfiguration.xml
@@ -488,7 +488,7 @@ public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
         <Parameter Name="urlScheme" Type="System.String" />
       </Parameters>
       <Docs>
-        <param name="urlScheme">To be added.</param>
+        <param name="urlScheme">The URL scheme for which to get a handler.</param>
         <summary>Returns the handler for the specified url scheme.</summary>
         <returns>To be added.</returns>
         <remarks>To be added.</remarks>
@@ -835,8 +835,8 @@ public UIView (System.Drawing.RectangleF frame) : base (NSObjectFlag.Empty)
         <Parameter Name="urlScheme" Type="System.String" />
       </Parameters>
       <Docs>
-        <param name="urlSchemeHandler">To be added.</param>
-        <param name="urlScheme">To be added.</param>
+        <param name="urlSchemeHandler">The handler to set.</param>
+        <param name="urlScheme">The URL scheme for which to set a handler.</param>
         <summary>Sets the handler for the specified URL scheme.</summary>
         <remarks>To be added.</remarks>
       </Docs>