<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[169490] trunk/Source/WebKit2</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta">
<dt>Revision</dt> <dd><a href="http://trac.webkit.org/projects/webkit/changeset/169490">169490</a></dd>
<dt>Author</dt> <dd>ggaren@apple.com</dd>
<dt>Date</dt> <dd>2014-05-30 12:11:46 -0700 (Fri, 30 May 2014)</dd>
</dl>
<h3>Log Message</h3>
<pre>Some more copy-editing of the Modern WebKit headerdoc
https://bugs.webkit.org/show_bug.cgi?id=133408
Reviewed by Beth Dakin.
A copy-editor suggested some edits to the headerdoc for clarity,
style, and formatting.
I reviewed the edits and accepted about 80% of them.
* UIProcess/API/Cocoa/WKBackForwardList.h:
* UIProcess/API/Cocoa/WKBackForwardListItem.h:
* UIProcess/API/Cocoa/WKFrameInfo.h:
* UIProcess/API/Cocoa/WKNavigation.h:
* UIProcess/API/Cocoa/WKNavigationAction.h:
(NS_ENUM):
* UIProcess/API/Cocoa/WKNavigationDelegate.h:
(NS_ENUM):
* UIProcess/API/Cocoa/WKNavigationResponse.h:
* UIProcess/API/Cocoa/WKPreferences.h:
* UIProcess/API/Cocoa/WKProcessPool.h:
* UIProcess/API/Cocoa/WKScriptMessage.h:
* UIProcess/API/Cocoa/WKScriptMessageHandler.h:
* UIProcess/API/Cocoa/WKUIDelegate.h:
* UIProcess/API/Cocoa/WKUserContentController.h:
* UIProcess/API/Cocoa/WKWebView.h:
* UIProcess/API/Cocoa/WKWebViewConfiguration.h:</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkSourceWebKit2ChangeLog">trunk/Source/WebKit2/ChangeLog</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKBackForwardListh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardList.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKBackForwardListItemh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardListItem.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKFrameInfoh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKFrameInfo.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKNavigationh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigation.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKNavigationActionh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigationAction.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKNavigationDelegateh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigationDelegate.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKNavigationResponseh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigationResponse.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKPreferencesh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKPreferences.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKProcessPoolh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKProcessPool.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKScriptMessageh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKScriptMessage.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKScriptMessageHandlerh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKScriptMessageHandler.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKUIDelegateh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKUIDelegate.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKUserContentControllerh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKUserContentController.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKWebViewh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.h</a></li>
<li><a href="#trunkSourceWebKit2UIProcessAPICocoaWKWebViewConfigurationh">trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebViewConfiguration.h</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkSourceWebKit2ChangeLog"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/ChangeLog (169489 => 169490)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/ChangeLog 2014-05-30 18:19:21 UTC (rev 169489)
+++ trunk/Source/WebKit2/ChangeLog 2014-05-30 19:11:46 UTC (rev 169490)
</span><span class="lines">@@ -1,3 +1,33 @@
</span><ins>+2014-05-30 Geoffrey Garen <ggaren@apple.com>
+
+ Some more copy-editing of the Modern WebKit headerdoc
+ https://bugs.webkit.org/show_bug.cgi?id=133408
+
+ Reviewed by Beth Dakin.
+
+ A copy-editor suggested some edits to the headerdoc for clarity,
+ style, and formatting.
+
+ I reviewed the edits and accepted about 80% of them.
+
+ * UIProcess/API/Cocoa/WKBackForwardList.h:
+ * UIProcess/API/Cocoa/WKBackForwardListItem.h:
+ * UIProcess/API/Cocoa/WKFrameInfo.h:
+ * UIProcess/API/Cocoa/WKNavigation.h:
+ * UIProcess/API/Cocoa/WKNavigationAction.h:
+ (NS_ENUM):
+ * UIProcess/API/Cocoa/WKNavigationDelegate.h:
+ (NS_ENUM):
+ * UIProcess/API/Cocoa/WKNavigationResponse.h:
+ * UIProcess/API/Cocoa/WKPreferences.h:
+ * UIProcess/API/Cocoa/WKProcessPool.h:
+ * UIProcess/API/Cocoa/WKScriptMessage.h:
+ * UIProcess/API/Cocoa/WKScriptMessageHandler.h:
+ * UIProcess/API/Cocoa/WKUIDelegate.h:
+ * UIProcess/API/Cocoa/WKUserContentController.h:
+ * UIProcess/API/Cocoa/WKWebView.h:
+ * UIProcess/API/Cocoa/WKWebViewConfiguration.h:
+
</ins><span class="cx"> 2014-05-30 Timothy Horton <timothy_horton@apple.com>
</span><span class="cx">
</span><span class="cx"> Crash loading skydrive.com (assertion under RemoteLayerTreeDisplayRefreshMonitor)
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKBackForwardListh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardList.h (169489 => 169490)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardList.h 2014-05-30 18:19:21 UTC (rev 169489)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardList.h 2014-05-30 19:11:46 UTC (rev 169490)
</span><span class="lines">@@ -29,8 +29,8 @@
</span><span class="cx">
</span><span class="cx"> #import <WebKit/WKBackForwardListItem.h>
</span><span class="cx">
</span><del>-/*! @abstract A @link WKWebView @/link's list of previously-visited webpages that can be reached by
- going back or forward.
</del><ins>+/*! @abstract A WKBackForwardList object is a list of webpages previously
+ visited in a web view that can be reached by going back or forward.
</ins><span class="cx"> */
</span><span class="cx"> WK_CLASS_AVAILABLE(10_10, 8_0)
</span><span class="cx"> @interface WKBackForwardList : NSObject
</span><span class="lines">@@ -39,27 +39,35 @@
</span><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) WKBackForwardListItem *currentItem;
</span><span class="cx">
</span><del>-/*! @abstract The item right before the current item, or nil if there isn't one.
</del><ins>+/*! @abstract The item immediately preceding the current item, or nil
+if there isn't one.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) WKBackForwardListItem *backItem;
</span><span class="cx">
</span><del>-/*! @abstract The item right after the current item, or nil if there isn't one.
</del><ins>+/*! @abstract The item immediately following the current item, or nil
+if there isn't one.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) WKBackForwardListItem *forwardItem;
</span><span class="cx">
</span><del>-/*! @abstract Returns an item the given distance from the current item.
- @param index Index of the desired list item relative to the current item; 0 is current item, -1 is back item, 1 is forward item, etc.
- @result The item the given distance from the current item. If index exceeds the limits of the list, nil is returned.
</del><ins>+/*! @abstract Returns the item at a specified distance from the current
+ item.
+ @param index Index of the desired list item relative to the current item:
+ 0 for the current item, -1 for the immediately preceding item, 1 for the
+ immediately following item, and so on.
+ @result The item at the specified distance from the current item, or nil
+ if the index parameter exceeds the limits of the list.
</ins><span class="cx"> */
</span><span class="cx"> - (WKBackForwardListItem *)itemAtIndex:(NSInteger)index;
</span><span class="cx">
</span><del>-/*! @abstract Returns the portion of the list before the current item.
- @discussion The entries are in the order that they were originally visited.
</del><ins>+/*! @abstract The portion of the list preceding the current item.
+ @discussion The items are in the order in which they were originally
+ visited.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) NSArray *backList;
</span><span class="cx">
</span><del>-/*! @abstract Returns the portion of the list after the current item.
- @discussion The entries are in the order that they were originally visited.
</del><ins>+/*! @abstract The portion of the list following the current item.
+ @discussion The items are in the order in which they were originally
+ visited.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) NSArray *forwardList;
</span><span class="cx">
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKBackForwardListItemh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardListItem.h (169489 => 169490)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardListItem.h 2014-05-30 18:19:21 UTC (rev 169489)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKBackForwardListItem.h 2014-05-30 19:11:46 UTC (rev 169490)
</span><span class="lines">@@ -29,7 +29,7 @@
</span><span class="cx">
</span><span class="cx"> #import <Foundation/Foundation.h>
</span><span class="cx">
</span><del>-/*! A @link WKBackForwardListItem @/link represents a visited webpage in a WKWebView's back-forward list.
</del><ins>+/*! A WKBackForwardListItem object represents a previously visited webpage in the back-forward list of a web view.
</ins><span class="cx"> */
</span><span class="cx"> WK_CLASS_AVAILABLE(10_10, 8_0)
</span><span class="cx"> @interface WKBackForwardListItem : NSObject
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKFrameInfoh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKFrameInfo.h (169489 => 169490)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKFrameInfo.h 2014-05-30 18:19:21 UTC (rev 169489)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKFrameInfo.h 2014-05-30 19:11:46 UTC (rev 169490)
</span><span class="lines">@@ -29,18 +29,20 @@
</span><span class="cx">
</span><span class="cx"> #import <Foundation/Foundation.h>
</span><span class="cx">
</span><del>-/*! A @link WKFrameInfo @/link object contains information about a frame on a webpage.
- @discussion WKFrameInfo objects are transient, data-only objects. A WKFrameInfo object
- does not uniquely identify a frame across multiple delegate method calls.
</del><ins>+/*! A WKFrameInfo object contains information about a frame on a webpage.
+ @discussion An instance of this class is a transient, data-only object;
+ it does not uniquely identify a frame across multiple delegate method
+ calls.
</ins><span class="cx"> */
</span><span class="cx"> WK_CLASS_AVAILABLE(10_10, 8_0)
</span><span class="cx"> @interface WKFrameInfo : NSObject
</span><span class="cx">
</span><del>-/*! @abstract Whether the frame is the main frame or a subframe.
</del><ins>+/*! @abstract A Boolean value indicating whether the frame is the main frame
+ or a subframe.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly, getter=isMainFrame) BOOL mainFrame;
</span><span class="cx">
</span><del>-/*! @abstract The current NSURLRequest of this frame.
</del><ins>+/*! @abstract The frame's current request.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) NSURLRequest *request;
</span><span class="cx">
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKNavigationh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigation.h (169489 => 169490)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigation.h 2014-05-30 18:19:21 UTC (rev 169489)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigation.h 2014-05-30 19:11:46 UTC (rev 169490)
</span><span class="lines">@@ -29,25 +29,31 @@
</span><span class="cx">
</span><span class="cx"> #import <Foundation/Foundation.h>
</span><span class="cx">
</span><del>-/*! WKNavigation objects are returned from the @link WKWebView @/link load methods and are passed to the
- @link WKNavigationDelegate @/link methods. A WKNavigation object uniquely identifies a webpage load from start to finish.
</del><ins>+/*! A WKNavigation object contains information for tracking the loading
+ progress of a webpage.
+ @discussion A navigation is returned from the web view load methods, and is
+ also passed to the navigation delegate methods, to uniquely identify a webpage
+ load from start to finish.
</ins><span class="cx"> */
</span><span class="cx"> WK_CLASS_AVAILABLE(10_10, 8_0)
</span><span class="cx"> @interface WKNavigation : NSObject
</span><span class="cx">
</span><del>-/*! @abstract The initial NSURLRequest used to perform the navigation.
</del><ins>+/*! @abstract The initial request used to perform the navigation.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) NSURLRequest *initialRequest;
</span><span class="cx">
</span><del>-/*! @abstract The current request of the navigation. This request may be different from the request returned by initialRequest if server side redirects have happened.
</del><ins>+/*! @abstract The navigation's current request.
+ @discussion This request may be different from the one returned by
+ initialRequest if server-side redirects have occurred.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) NSURLRequest *request;
</span><span class="cx">
</span><del>-/* @abstract The NSURLResponse for the navigation or nil if no response has been received yet.
</del><ins>+/* @abstract The response to the navigation, or nil if no response has yet
+ been received.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) NSURLResponse *response;
</span><span class="cx">
</span><del>-/* @abstract The error for the navigation if it failed or nil if it did not fail.
</del><ins>+/* @abstract The error if the navigation failed, or nil if it did not fail.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) NSError *error;
</span><span class="cx">
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKNavigationActionh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigationAction.h (169489 => 169490)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigationAction.h 2014-05-30 18:19:21 UTC (rev 169489)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigationAction.h 2014-05-30 19:11:46 UTC (rev 169490)
</span><span class="lines">@@ -36,12 +36,12 @@
</span><span class="cx"> @class WKFrameInfo;
</span><span class="cx">
</span><span class="cx"> /*! @enum WKNavigationType
</span><del>- @abstract the type of action that triggered a possible navigation.
- @constant WKNavigationTypeLinkActivated A link with an href activated by the user.
</del><ins>+ @abstract The type of action triggering a navigation.
+ @constant WKNavigationTypeLinkActivated A link with an href attribute was activated by the user.
</ins><span class="cx"> @constant WKNavigationTypeFormSubmitted A form was submitted.
</span><span class="cx"> @constant WKNavigationTypeBackForward An item from the back-forward list was requested.
</span><span class="cx"> @constant WKNavigationTypeReload The webpage was reloaded.
</span><del>- @constant WKNavigationTypeFormResubmitted A form was resubmitted (for example by going back or forward, or reloading).
</del><ins>+ @constant WKNavigationTypeFormResubmitted A form was resubmitted (for example by going back, going forward, or reloading).
</ins><span class="cx"> @constant WKNavigationTypeOther Navigation is taking place for some other reason.
</span><span class="cx"> */
</span><span class="cx"> typedef NS_ENUM(NSInteger, WKNavigationType) {
</span><span class="lines">@@ -53,24 +53,26 @@
</span><span class="cx"> WKNavigationTypeOther = -1,
</span><span class="cx"> } WK_ENUM_AVAILABLE(10_10, 8_0);
</span><span class="cx">
</span><del>-/*! Contains information about an action that may cause a navigation. Used for making policy decisions.
</del><ins>+/*!
+A WKNavigationAction object contains information about an action that may cause a navigation, used for making policy decisions.
</ins><span class="cx"> */
</span><span class="cx"> WK_CLASS_AVAILABLE(10_10, 8_0)
</span><span class="cx"> @interface WKNavigationAction : NSObject
</span><span class="cx">
</span><del>-/*! @abstract Describes the frame that requested the navigation.
</del><ins>+/*! @abstract The frame requesting the navigation.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) WKFrameInfo *sourceFrame;
</span><span class="cx">
</span><del>-/*! @abstract Describes the target frame of the navigation. If this is a new window navigation, targetFrame will be nil.
</del><ins>+/*! @abstract The target frame, or nil if this is a new window navigation.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) WKFrameInfo *targetFrame;
</span><span class="cx">
</span><del>-/*! @abstract The type of the navigation.
</del><ins>+/*! @abstract The type of action that triggered the navigation.
+ @discussion The value is one of the constants of the enumerated type WKNavigationType.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) WKNavigationType navigationType;
</span><span class="cx">
</span><del>-/*! @abstract The NSURLRequest of the navigation.
</del><ins>+/*! @abstract The navigation's request.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) NSURLRequest *request;
</span><span class="cx">
</span><span class="lines">@@ -80,7 +82,7 @@
</span><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) NSEventModifierFlags modifierFlags;
</span><span class="cx">
</span><del>-/*! @abstract The mouse button number that caused the navigation to be requested.
</del><ins>+/*! @abstract The number of the mouse button causing the navigation to be requested.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) NSInteger buttonNumber;
</span><span class="cx">
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKNavigationDelegateh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigationDelegate.h (169489 => 169490)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigationDelegate.h 2014-05-30 18:19:21 UTC (rev 169489)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigationDelegate.h 2014-05-30 19:11:46 UTC (rev 169490)
</span><span class="lines">@@ -35,7 +35,8 @@
</span><span class="cx"> @class WKWebView;
</span><span class="cx">
</span><span class="cx"> /*! @enum WKNavigationActionPolicy
</span><del>- @abstract the policy to pass back to the decision handler in webView:decidePolicyForNavigationAction:decisionHandler:.
</del><ins>+ @abstract The policy to pass back to the decision handler from the
+ webView:decidePolicyForNavigationAction:decisionHandler: method.
</ins><span class="cx"> @constant WKNavigationActionPolicyCancel Cancel the navigation.
</span><span class="cx"> @constant WKNavigationActionPolicyAllow Allow the navigation to continue.
</span><span class="cx"> */
</span><span class="lines">@@ -45,7 +46,7 @@
</span><span class="cx"> } WK_ENUM_AVAILABLE(10_10, 8_0);
</span><span class="cx">
</span><span class="cx"> /*! @enum WKNavigationResponsePolicy
</span><del>- @abstract the policy to pass back to the decision handler in webView:decidePolicyForNavigationResponse:decisionHandler:.
</del><ins>+ @abstract The policy to pass back to the decision handler from the webView:decidePolicyForNavigationResponse:decisionHandler: method.
</ins><span class="cx"> @constant WKNavigationResponsePolicyCancel Cancel the navigation.
</span><span class="cx"> @constant WKNavigationResponsePolicyAllow Allow the navigation to continue.
</span><span class="cx"> */
</span><span class="lines">@@ -54,62 +55,71 @@
</span><span class="cx"> WKNavigationResponsePolicyAllow,
</span><span class="cx"> } WK_ENUM_AVAILABLE(10_10, 8_0);
</span><span class="cx">
</span><del>-/*! A class that conforms to WKNavigationDelegate can decide policy for main frame and subframe navigations,
- and track progress for main frame navigations.
</del><ins>+/*! A class conforming to the WKNavigationDelegate protocol can provide
+ methods for tracking progress for main frame navigations and for deciding
+ policy for main frame and subframe navigations.
</ins><span class="cx"> */
</span><span class="cx"> @protocol WKNavigationDelegate <NSObject>
</span><span class="cx">
</span><span class="cx"> @optional
</span><span class="cx">
</span><del>-/*! @abstract Decides whether a navigation should be allowed or not.
- @param webView The WKWebView invoking the delegate method.
- @param navigationAction A description of the action that triggered the navigation request.
- @param decisionHandler The decision handler that should be called to allow or cancel the navigation.
</del><ins>+/*! @abstract Decides whether to allow or cancel a navigation.
+ @param webView The web view invoking the delegate method.
+ @param navigationAction Descriptive information about the action
+ triggering the navigation request.
+ @param decisionHandler The decision handler to call to allow or cancel the
+ navigation. The argument is one of the constants of the enumerated type WKNavigationActionPolicy.
</ins><span class="cx"> */
</span><span class="cx"> - (void)webView:(WKWebView *)webView decidePolicyForNavigationAction:(WKNavigationAction *)navigationAction decisionHandler:(void (^)(WKNavigationActionPolicy))decisionHandler;
</span><span class="cx">
</span><del>-/*! @abstract Decides whether a navigation should be allowed or cancelled once its response is known.
- @param webView The WKWebView invoking the delegate method.
- @param navigationResponse A description of the navigation response.
- @param decisionHandler The decision handler that should be called to allow or cancel the navigation.
</del><ins>+/*! @abstract Decides whether to allow or cancel a navigation after its
+ response is known.
+ @param webView The web view invoking the delegate method.
+ @param navigationResponse Descriptive information about the navigation
+ response.
+ @param decisionHandler The decision handler to call to allow or cancel the
+ navigation. The argument is one of the constants of the enumerated type WKNavigationResponsePolicy.
</ins><span class="cx"> */
</span><span class="cx"> - (void)webView:(WKWebView *)webView decidePolicyForNavigationResponse:(WKNavigationResponse *)navigationResponse decisionHandler:(void (^)(WKNavigationResponsePolicy))decisionHandler;
</span><span class="cx">
</span><span class="cx"> /*! @abstract Invoked when a main frame navigation starts.
</span><del>- @param webView The WKWebView invoking the delegate method.
</del><ins>+ @param webView The web view invoking the delegate method.
</ins><span class="cx"> @param navigation The navigation.
</span><span class="cx"> */
</span><span class="cx"> - (void)webView:(WKWebView *)webView didStartProvisionalNavigation:(WKNavigation *)navigation;
</span><span class="cx">
</span><del>-/*! @abstract Invoked when a server redirect is received for the main frame.
- @param webView The WKWebView invoking the delegate method.
</del><ins>+/*! @abstract Invoked when a server redirect is received for the main
+ frame.
+ @param webView The web view invoking the delegate method.
</ins><span class="cx"> @param navigation The navigation.
</span><span class="cx"> */
</span><span class="cx"> - (void)webView:(WKWebView *)webView didReceiveServerRedirectForProvisionalNavigation:(WKNavigation *)navigation;
</span><span class="cx">
</span><del>-/*! @abstract Invoked if an error occurs when starting to load data for the main frame.
- @param webView The WKWebView invoking the delegate method.
</del><ins>+/*! @abstract Invoked when an error occurs while starting to load data for
+ the main frame.
+ @param webView The web view invoking the delegate method.
</ins><span class="cx"> @param navigation The navigation.
</span><del>- @param error Specifies the type of error that occurred during the navigation.
</del><ins>+ @param error The error that occurred.
</ins><span class="cx"> */
</span><span class="cx"> - (void)webView:(WKWebView *)webView didFailProvisionalNavigation:(WKNavigation *)navigation withError:(NSError *)error;
</span><span class="cx">
</span><span class="cx"> /*! @abstract Invoked when content starts arriving for the main frame.
</span><del>- @param webView The WKWebView invoking the delegate method.
</del><ins>+ @param webView The web view invoking the delegate method.
</ins><span class="cx"> @param navigation The navigation.
</span><span class="cx"> */
</span><span class="cx"> - (void)webView:(WKWebView *)webView didCommitNavigation:(WKNavigation *)navigation;
</span><span class="cx">
</span><span class="cx"> /*! @abstract Invoked when a main frame navigation completes.
</span><del>- @param webView The WKWebView invoking the delegate method.
</del><ins>+ @param webView The web view invoking the delegate method.
</ins><span class="cx"> @param navigation The navigation.
</span><span class="cx"> */
</span><span class="cx"> - (void)webView:(WKWebView *)webView didFinishNavigation:(WKNavigation *)navigation;
</span><span class="cx">
</span><del>-/*! @abstract Invoked if an error occurs while loading a committed main frame navigation.
- @param webView The WKWebView invoking the delegate method.
</del><ins>+/*! @abstract Invoked when an error occurs during a committed main frame
+ navigation.
+ @param webView The web view invoking the delegate method.
</ins><span class="cx"> @param navigation The navigation.
</span><del>- @param error Specifies the type of error that occurred during the navigation.
</del><ins>+ @param error The error that occurred.
</ins><span class="cx"> */
</span><span class="cx"> - (void)webView:(WKWebView *)webView didFailNavigation:(WKNavigation *)navigation withError:(NSError *)error;
</span><span class="cx">
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKNavigationResponseh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigationResponse.h (169489 => 169490)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigationResponse.h 2014-05-30 18:19:21 UTC (rev 169489)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKNavigationResponse.h 2014-05-30 19:11:46 UTC (rev 169490)
</span><span class="lines">@@ -36,15 +36,16 @@
</span><span class="cx"> WK_CLASS_AVAILABLE(10_10, 8_0)
</span><span class="cx"> @interface WKNavigationResponse : NSObject
</span><span class="cx">
</span><del>-/*! @abstract Whether the frame that is being navigated is the main frame or not.
</del><ins>+/*! @abstract A Boolean value indicating whether the frame being navigated is the main frame.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly, getter=isForMainFrame) BOOL forMainFrame;
</span><span class="cx">
</span><del>-/*! @abstract The NSURLResponse of the frame.
</del><ins>+/*! @abstract The frame's response.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) NSURLResponse *response;
</span><span class="cx">
</span><del>-/*! @abstract Whether WebKit can show the MIME type natively or not.
</del><ins>+/*! @abstract A Boolean value indicating whether WebKit can display the response's MIME type natively.
+ @discussion Allowing a navigation response with a MIME type that can’t be shown will cause the navigation to fail.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) BOOL canShowMIMEType;
</span><span class="cx">
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKPreferencesh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKPreferences.h (169489 => 169490)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKPreferences.h 2014-05-30 18:19:21 UTC (rev 169489)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKPreferences.h 2014-05-30 19:11:46 UTC (rev 169490)
</span><span class="lines">@@ -30,17 +30,20 @@
</span><span class="cx"> #import <CoreGraphics/CoreGraphics.h>
</span><span class="cx"> #import <Foundation/Foundation.h>
</span><span class="cx">
</span><del>-/*! WKPreferences encapsulates the preferences you can change for one or more WKWebViews.
- A @link WKWebView @/link can specify which WKPreferences object it uses through its @link WKWebViewConfiguration @/link.
</del><ins>+/*! A WKPreferences object encapsulates the preference settings for a web
+ view. The preferences object associated with a web view is specified by
+ its web view configuration.
</ins><span class="cx"> */
</span><span class="cx"> WK_CLASS_AVAILABLE(10_10, 8_0)
</span><span class="cx"> @interface WKPreferences : NSObject
</span><span class="cx">
</span><del>-/*! @abstract Returns an initialized WKPreferences object.
</del><ins>+/*! @abstract Returns an initialized preferences object.
</ins><span class="cx"> @param userDefaultsKeyPrefix The user defaults key prefix.
</span><del>- @result An initialized WKPreferences object, or nil if the object could not be initialized.
- @discussion If the userDefaultsKeyPrefix argument is non-nil, it is prepended to the keys used to store preferences
- in the user defaults database. If the argument is nil, the preferences object won't save anything to the user defaults database.
</del><ins>+ @result An initialized preferences object.
+ @discussion If the userDefaultsKeyPrefix parameter is not nil, it is
+ prepended to the keys used to store preferences in the user defaults
+ database. If the parameter is nil, the preferences object will not save
+ anything to the user defaults database.
</ins><span class="cx"> */
</span><span class="cx"> - (instancetype)initWithUserDefaultsKeyPrefix:(NSString *)userDefaultsKeyPrefix WK_DESIGNATED_INITIALIZER;
</span><span class="cx">
</span><span class="lines">@@ -48,43 +51,56 @@
</span><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) NSString *userDefaultsKeyPrefix;
</span><span class="cx">
</span><del>-/*! @abstract The minimum font size in points. Defaults to 0.
</del><ins>+/*! @abstract The minimum font size in points.
+ @discussion The default value is 0.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic) CGFloat minimumFontSize;
</span><span class="cx">
</span><del>-/*! @abstract Whether JavaScript is enabled. Defaults to YES.
</del><ins>+/*! @abstract A Boolean value indicating whether JavaScript is enabled.
+ @discussion The default value is YES.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, getter=isJavaScriptEnabled) BOOL javaScriptEnabled;
</span><span class="cx">
</span><del>-/*! @abstract Whether JavaScript can open windows without user interaction. Defaults to NO on iOS and YES on OS X.
</del><ins>+/*! @abstract A Boolean value indicating whether JavaScript can open
+ windows without user interaction.
+ @discussion The default value is NO in iOS and YES in OS X.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic) BOOL javaScriptCanOpenWindowsAutomatically;
</span><span class="cx">
</span><del>-/*! @abstract Whether the WKWebView suppresses content rendering until it is fully loaded into memory. Defaults to NO.
</del><ins>+/*! @abstract A Boolean value indicating whether the web view suppresses
+ content rendering until it is fully loaded into memory.
+ @discussion The default value is NO.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic) BOOL suppressesIncrementalRendering;
</span><span class="cx">
</span><span class="cx"> #if TARGET_OS_IPHONE
</span><del>-/*! @abstract Whether HTML5 videos play inline or use the native full-screen controller. Defaults to NO.
</del><ins>+/*! @abstract A Boolean value indicating whether HTML5 videos play inline
+ (YES) or use the native full-screen controller (NO).
+ @discussion The default value is NO.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic) BOOL allowsInlineMediaPlayback;
</span><span class="cx">
</span><del>-/*! @abstract Whether HTML5 videos can play automatically or require the user to start playing them. Defaults to YES.
</del><ins>+/*! @abstract A Boolean value indicating whether HTML5 videos require the
+ user to start playing them (YES) or can play automatically (NO).
+ @discussion The default value is YES.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic) BOOL mediaPlaybackRequiresUserAction;
</span><span class="cx">
</span><del>-/*! @abstract Whether AirPlay is allowed. Defaults to YES.
</del><ins>+/*! @abstract A Boolean value indicating whether AirPlay is allowed.
+ @discussion The default value is YES.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic) BOOL mediaPlaybackAllowsAirPlay;
</span><span class="cx">
</span><span class="cx"> #endif
</span><span class="cx">
</span><span class="cx"> #if !TARGET_OS_IPHONE
</span><del>-/*! @abstract Whether Java is enabled. Defaults to NO.
</del><ins>+/*! @abstract A Boolean value indicating whether Java is enabled.
+ @discussion The default value is YES.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, getter=isJavaEnabled) BOOL javaEnabled;
</span><span class="cx">
</span><del>-/*! abstract Whether plug-ins are enabled. Defaults to NO.
</del><ins>+/*! @abstract A Boolean value indicating whether plug-ins are enabled.
+ @discussion The default value is YES.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, getter=arePlugInsEnabled) BOOL plugInsEnabled;
</span><span class="cx"> #endif
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKProcessPoolh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKProcessPool.h (169489 => 169490)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKProcessPool.h 2014-05-30 18:19:21 UTC (rev 169489)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKProcessPool.h 2014-05-30 19:11:46 UTC (rev 169490)
</span><span class="lines">@@ -29,10 +29,11 @@
</span><span class="cx">
</span><span class="cx"> #import <Foundation/Foundation.h>
</span><span class="cx">
</span><del>-/*! A pool of Web Content processes.
- A @link WKWebView @/link specifies its process pool through its @link WKWebViewConfiguration @/link.
- Each WKWebView will get its own Web Content process until an implementation-defined process limit is reached; after that,
- web views with the same process pool end up sharing Web Content processes.
</del><ins>+/*! A WKProcessPool object represents a pool of web content processes.
+ The process pool associated with a web view is specified by its web view
+ configuration. Each web view is given its own web content process until an
+ implementation-defined process limit is reached; after that, web views
+ with the same process pool end up sharing web content processes.
</ins><span class="cx"> */
</span><span class="cx"> WK_CLASS_AVAILABLE(10_10, 8_0)
</span><span class="cx"> @interface WKProcessPool : NSObject
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKScriptMessageh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKScriptMessage.h (169489 => 169490)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKScriptMessage.h 2014-05-30 18:19:21 UTC (rev 169489)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKScriptMessage.h 2014-05-30 19:11:46 UTC (rev 169490)
</span><span class="lines">@@ -31,18 +31,23 @@
</span><span class="cx">
</span><span class="cx"> @class WKWebView;
</span><span class="cx">
</span><del>-/*! A @link WKScriptMessage @/link object contains information about a message being sent from a webpage.
</del><ins>+/*! A WKScriptMessage object contains information about a message sent from
+ a webpage.
</ins><span class="cx"> */
</span><span class="cx"> WK_CLASS_AVAILABLE(10_10, 8_0)
</span><span class="cx"> @interface WKScriptMessage : NSObject
</span><span class="cx">
</span><del>-/*! @abstract The body of the message. Allowed types are NSDictionary, NSArray, NSNumber, NSNull, NSString, and NSDate. */
</del><ins>+/*! @abstract The body of the message.
+ @discussion Allowed types are NSNumber, NSString, NSDate, NSArray,
+ NSDictionary, and NSNull.
+ */
</ins><span class="cx"> @property (nonatomic, readonly) id body;
</span><span class="cx">
</span><del>-/*! @abstract The web view the message is coming from. */
</del><ins>+/*! @abstract The web view sending the message. */
</ins><span class="cx"> @property (nonatomic, readonly, weak) WKWebView *webView;
</span><span class="cx">
</span><del>-/*! @abstract The name of the message handler this message is being sent to. */
</del><ins>+/*! @abstract The name of the message handler to which the message is sent.
+ */
</ins><span class="cx"> @property (nonatomic, readonly) NSString *name;
</span><span class="cx">
</span><span class="cx"> @end
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKScriptMessageHandlerh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKScriptMessageHandler.h (169489 => 169490)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKScriptMessageHandler.h 2014-05-30 18:19:21 UTC (rev 169489)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKScriptMessageHandler.h 2014-05-30 19:11:46 UTC (rev 169490)
</span><span class="lines">@@ -32,15 +32,17 @@
</span><span class="cx"> @class WKScriptMessage;
</span><span class="cx"> @class WKUserContentController;
</span><span class="cx">
</span><del>-/*! A class that conforms to WKScriptMessageHandler provides a method for recieving messages from JavaScript running in a webpage.
</del><ins>+/*! A class conforming to the WKScriptMessageHandler protocol provides a
+ method for receiving messages from JavaScript running in a webpage.
</ins><span class="cx"> */
</span><span class="cx"> @protocol WKScriptMessageHandler <NSObject>
</span><span class="cx">
</span><span class="cx"> @required
</span><span class="cx">
</span><del>-/*! @abstract Invoked when a script message is recieved from a webpage.
- @param userContentController The WKUserContentController invoking the delegate method.
- @param message The script message being received.
</del><ins>+/*! @abstract Invoked when a script message is received from a webpage.
+ @param userContentController The user content controller invoking the
+ delegate method.
+ @param message The script message received.
</ins><span class="cx"> */
</span><span class="cx"> - (void)userContentController:(WKUserContentController *)userContentController didReceiveScriptMessage:(WKScriptMessage *)message;
</span><span class="cx">
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKUIDelegateh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKUIDelegate.h (169489 => 169490)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKUIDelegate.h 2014-05-30 18:19:21 UTC (rev 169489)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKUIDelegate.h 2014-05-30 19:11:46 UTC (rev 169490)
</span><span class="lines">@@ -33,51 +33,63 @@
</span><span class="cx"> @class WKWebViewConfiguration;
</span><span class="cx"> @class WKWindowFeatures;
</span><span class="cx">
</span><del>-/*! A class that conforms to WKUIDelegate provides methods for presenting native UI on behalf of the webpage.
</del><ins>+/*! A class conforming to the WKUIDelegate protocol provides methods for
+ presenting native UI on behalf of a webpage.
</ins><span class="cx"> */
</span><span class="cx"> @protocol WKUIDelegate <NSObject>
</span><span class="cx">
</span><span class="cx"> @optional
</span><span class="cx">
</span><del>-/*! @abstract Create a new WKWebView.
- @param webView The WKWebView invoking the delegate method.
- @param configuration The configuration that must be used when creating the new WKWebView.
- @param navigationAction The navigation action that is causing the new WKWebView to be created.
</del><ins>+/*! @abstract Creates a new web view.
+ @param webView The web view invoking the delegate method.
+ @param configuration The configuration to use when creating the new web
+ view.
+ @param navigationAction The navigation action causing the new web view to
+ be created.
</ins><span class="cx"> @param windowFeatures Window features requested by the webpage.
</span><del>- @result A new WKWebView or nil.
- @discussion The WKWebView returned must be created with the specified configuration. WebKit will load the request in the returned WKWebView.
</del><ins>+ @result A new web view or nil.
+ @discussion The web view returned must be created with the specified configuration. WebKit will load the request in the returned web view.
</ins><span class="cx"> */
</span><span class="cx"> - (WKWebView *)webView:(WKWebView *)webView createWebViewWithConfiguration:(WKWebViewConfiguration *)configuration forNavigationAction:(WKNavigationAction *)navigationAction windowFeatures:(WKWindowFeatures *)windowFeatures;
</span><span class="cx">
</span><del>-/*! @abstract Display a JavaScript alert panel.
- @param webView The WKWebView invoking the delegate method.
</del><ins>+/*! @abstract Displays a JavaScript alert panel.
+ @param webView The web view invoking the delegate method.
</ins><span class="cx"> @param message The message to display.
</span><del>- @param frame Information about the frame whose JavaScript initiated this call.
- @param completionHandler The completion handler that should get called after the alert panel has been dismissed.
- @discussion Clients should visually indicate that this panel comes from JavaScript initiated by the specified frame.
- The panel should have a single "OK" button.
</del><ins>+ @param frame Information about the frame whose JavaScript initiated this
+ call.
+ @param completionHandler The completion handler to call after the alert
+ panel has been dismissed.
+ @discussion Clients should visually indicate that this panel comes from
+ JavaScript initiated by the specified frame.
+ The panel should have a single OK button.
</ins><span class="cx"> */
</span><span class="cx"> - (void)webView:(WKWebView *)webView runJavaScriptAlertPanelWithMessage:(NSString *)message initiatedByFrame:(WKFrameInfo *)frame completionHandler:(void (^)())completionHandler;
</span><span class="cx">
</span><del>-/*! @abstract Display a JavaScript confirm panel.
- @param webView The WKWebView invoking the delegate method.
</del><ins>+/*! @abstract Displays a JavaScript confirm panel.
+ @param webView The web view invoking the delegate method.
</ins><span class="cx"> @param message The message to display.
</span><span class="cx"> @param frame Information about the frame whose JavaScript initiated this call.
</span><del>- @param completionHandler The completion handler that should get called after the confirm panel has been dismissed.
- Pass YES if the user chose OK, NO if the user chose Cancel.
- @discussion Clients should visually indicate that this panel comes from JavaScript initiated by the specified frame.
- The panel should have two buttons, e.g. "OK" and "Cancel".
</del><ins>+ @param completionHandler The completion handler to call after the confirm
+ panel has been dismissed. Pass YES if the user chose OK, NO if the user
+ chose Cancel.
+ @discussion Clients should visually indicate that this panel comes from
+ JavaScript initiated by the specified frame.
+ The panel should have two buttons, such as OK and Cancel.
</ins><span class="cx"> */
</span><span class="cx"> - (void)webView:(WKWebView *)webView runJavaScriptConfirmPanelWithMessage:(NSString *)message initiatedByFrame:(WKFrameInfo *)frame completionHandler:(void (^)(BOOL result))completionHandler;
</span><span class="cx">
</span><del>-/*! @abstract Display a JavaScript text input panel.
- @param webView The WKWebView invoking the delegate method.
</del><ins>+/*! @abstract Displays a JavaScript text input panel.
+ @param webView The web view invoking the delegate method.
</ins><span class="cx"> @param message The message to display.
</span><del>- @param defaultText The initial text for the text entry area.
</del><ins>+ @param defaultText The initial text to display in the text entry field.
</ins><span class="cx"> @param frame Information about the frame whose JavaScript initiated this call.
</span><del>- @param completionHandler The completion handler that should get called after the text input panel has been dismissed. Pass the typed text if the user chose OK, otherwise nil.
- @discussion Clients should visually indicate that this panel comes from JavaScript initiated by the specified frame.
- The panel should have two buttons, e.g. "OK" and "Cancel", and an area to type text.
</del><ins>+ @param completionHandler The completion handler to call after the text
+ input panel has been dismissed. Pass the entered text if the user chose
+ OK, otherwise nil.
+ @discussion Clients should visually indicate that this panel comes from
+ JavaScript initiated by the specified frame.
+ The panel should have two buttons, such as OK and Cancel, and a field in
+ which to enter text.
</ins><span class="cx"> */
</span><span class="cx"> - (void)webView:(WKWebView *)webView runJavaScriptTextInputPanelWithPrompt:(NSString *)prompt defaultText:(NSString *)defaultText initiatedByFrame:(WKFrameInfo *)frame completionHandler:(void (^)(NSString *result))completionHandler;
</span><span class="cx">
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKUserContentControllerh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKUserContentController.h (169489 => 169490)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKUserContentController.h 2014-05-30 18:19:21 UTC (rev 169489)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKUserContentController.h 2014-05-30 19:11:46 UTC (rev 169490)
</span><span class="lines">@@ -32,13 +32,16 @@
</span><span class="cx"> @class WKUserScript;
</span><span class="cx"> @protocol WKScriptMessageHandler;
</span><span class="cx">
</span><del>-/*! WKUserContentController provides a way for JavaScript to post messages to the @link WKWebView @/link.
- A @link WKWebView @/link can specify which WKUserContentController object it uses through its @link WKWebViewConfiguration @/link.
</del><ins>+/*! A WKUserContentController object provides a way for JavaScript to post
+ messages to a web view.
+ The user content controller associated with a web view is specified by its
+ web view configuration.
</ins><span class="cx"> */
</span><span class="cx"> WK_CLASS_AVAILABLE(10_10, 8_0)
</span><span class="cx"> @interface WKUserContentController : NSObject
</span><span class="cx">
</span><del>-/*! @abstract The user scripts associated with this user content controller.
</del><ins>+/*! @abstract The user scripts associated with this user content
+ controller.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) NSArray *userScripts;
</span><span class="cx">
</span><span class="lines">@@ -52,9 +55,11 @@
</span><span class="cx"> - (void)removeAllUserScripts;
</span><span class="cx">
</span><span class="cx"> /*! @abstract Adds a script message handler.
</span><del>- @param scriptMessageHandler The message handler where the messages should be delivered.
</del><ins>+ @param scriptMessageHandler The message handler to add.
</ins><span class="cx"> @param name The name of the message handler.
</span><del>- @discussion Adding a scriptMessageHandler adds a function window.webkit.messageHandlers.<name>.postMessage(<messageBody>) for all frames.
</del><ins>+ @discussion Adding a scriptMessageHandler adds a function
+ window.webkit.messageHandlers.<name>.postMessage(<messageBody>) for all
+ frames.
</ins><span class="cx"> */
</span><span class="cx"> - (void)addScriptMessageHandler:(id <WKScriptMessageHandler>)scriptMessageHandler name:(NSString *)name;
</span><span class="cx">
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKWebViewh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.h (169489 => 169490)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.h 2014-05-30 18:19:21 UTC (rev 169489)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebView.h 2014-05-30 19:11:46 UTC (rev 169490)
</span><span class="lines">@@ -42,7 +42,7 @@
</span><span class="cx"> @protocol WKUIDelegate;
</span><span class="cx">
</span><span class="cx"> /*!
</span><del>- A @link WKWebView @/link displays interactive Web content.
</del><ins>+ A WKWebView object displays interactive Web content.
</ins><span class="cx"> @helperclass @link WKWebViewConfiguration @/link
</span><span class="cx"> Used to configure @link WKWebView @/link instances.
</span><span class="cx"> */
</span><span class="lines">@@ -54,90 +54,108 @@
</span><span class="cx"> @interface WKWebView : NSView
</span><span class="cx"> #endif
</span><span class="cx">
</span><del>-/*! @abstract A copy of the configuration with which the @link WKWebView @/link was initialized. */
</del><ins>+/*! @abstract A copy of the configuration with which the web view was
+ initialized. */
</ins><span class="cx"> @property (nonatomic, readonly) WKWebViewConfiguration *configuration;
</span><span class="cx">
</span><del>-/*! @abstract The view's navigation delegate. */
</del><ins>+/*! @abstract The web view's navigation delegate. */
</ins><span class="cx"> @property (nonatomic, weak) id <WKNavigationDelegate> navigationDelegate;
</span><span class="cx">
</span><del>-/*! @abstract The view's user interface delegate. */
</del><ins>+/*! @abstract The web view's user interface delegate. */
</ins><span class="cx"> @property (nonatomic, weak) id <WKUIDelegate> UIDelegate;
</span><span class="cx">
</span><del>-/*! @abstract The view's back-forward list. */
</del><ins>+/*! @abstract The web view's back-forward list. */
</ins><span class="cx"> @property (nonatomic, readonly) WKBackForwardList *backForwardList;
</span><span class="cx">
</span><del>-/*! @abstract Returns a view initialized with the specified frame and configuration.
- @param frame The frame for the new view.
- @param configuration The configuration for the new view.
- @result An initialized view, or nil if the object could not be initialized.
- @discussion This is a designated initializer. You can use @link -initWithFrame: @/link to
- initialize an instance with the default configuration.
- The initializer copies
- @link //apple_ref/doc/methodparam/WKWebView/initWithFrame:configuration:/configuration
- configuration@/link, so mutating it after initialization has no effect on the
- @link WKWebView @/link instance.
</del><ins>+/*! @abstract Returns a web view initialized with a specified frame and
+ configuration.
+ @param frame The frame for the new web view.
+ @param configuration The configuration for the new web view.
+ @result An initialized web view, or nil if the object could not be
+ initialized.
+ @discussion This is a designated initializer. You can use
+ @link -initWithFrame: @/link to initialize an instance with the default
+ configuration. The initializer copies the specified configuration, so
+ mutating the configuration after invoking the initializer has no effect
+ on the web view.
</ins><span class="cx"> */
</span><span class="cx"> - (instancetype)initWithFrame:(CGRect)frame configuration:(WKWebViewConfiguration *)configuration WK_DESIGNATED_INITIALIZER;
</span><span class="cx">
</span><del>-- (instancetype)initWithCoder:(NSCoder *)coder WK_UNAVAILABLE;
-
-/*! @abstract Navigates to the given NSURLRequest.
- @param request The NSURLRequest to navigate to.
</del><ins>+/*! @abstract Navigates to a requested URL.
+ @param request The request specifying the URL to which to navigate.
</ins><span class="cx"> @result A new navigation for the given request.
</span><span class="cx"> */
</span><span class="cx"> - (WKNavigation *)loadRequest:(NSURLRequest *)request;
</span><span class="cx">
</span><del>-/*! @abstract Navigates to an item from the back-forward list and sets it as the current item.
- @param item The item to navigate to. Must be one of the items in the receiver's back-forward list.
- @result A new navigation to the requested item, or nil if it is the current item or the item is not part of the view's back-forward list.
</del><ins>+/*! @abstract Navigates to an item from the back-forward list and sets it
+ as the current item.
+ @param item The item to which to navigate. Must be one of the items in the
+ web view's back-forward list.
+ @result A new navigation to the requested item, or nil if it is already
+ the current item or is not part of the web view's back-forward list.
</ins><span class="cx"> @seealso backForwardList
</span><span class="cx"> */
</span><span class="cx"> - (WKNavigation *)goToBackForwardListItem:(WKBackForwardListItem *)item;
</span><span class="cx">
</span><del>-/*! @abstract The webpage title. @link WKWebView @/link is KVO-compliant for this property.
</del><ins>+/*! @abstract The page title.
+ @discussion @link WKWebView @/link is key-value observing (KVO) compliant
+ for this property.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) NSString *title;
</span><span class="cx">
</span><del>-/*! @abstract The active URL. @link WKWebView @/link is KVO-compliant for this property.
- @discussion This is the URL that should be reflected in the user interface.
</del><ins>+/*! @abstract The active URL.
+ @discussion This is the URL that should be reflected in the user
+ interface.
+ @link WKWebView @/link is key-value observing (KVO) compliant for this
+ property.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) NSURL *URL;
</span><span class="cx">
</span><del>-/*! @abstract Whether the view is loading content. @link WKWebView @/link is KVO-compliant for this
- property. */
</del><ins>+/*! @abstract A Boolean value indicating whether the view is currently
+ loading content.
+ @discussion @link WKWebView @/link is key-value observing (KVO) compliant
+ for this property.
+ */
</ins><span class="cx"> @property (nonatomic, readonly, getter=isLoading) BOOL loading;
</span><span class="cx">
</span><del>-/*! @abstract An estimate of the fraction complete for a document load. @link WKWebView @/link is
- KVO-compliant for this property.
- @discussion This value will range from 0 to 1 and, once a load completes, will remain at 1.0
- until a new load starts, at which point it will be reset to 0. The value is an estimate based
- on the total number of bytes expected to be received for a document,
- including all its possible subresources.
</del><ins>+/*! @abstract An estimate of what fraction of the current navigation has been completed.
+ @discussion This value ranges from 0.0 to 1.0 based on the total number of
+ bytes expected to be received, including the main document and all of its
+ potential subresources. After a navigation completes, the value remains at 1.0
+ until a new navigation starts, at which point it is reset to 0.0.
+ @link WKWebView @/link is key-value observing (KVO) compliant for this
+ property.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) double estimatedProgress;
</span><span class="cx">
</span><del>-/*! @abstract Whether all of the resources on the webpage have been loaded over securely encrypted connections.
- @link WKWebView @/link is KVO-compliant for this property.
</del><ins>+/*! @abstract A Boolean value indicating whether all resources on the page
+ have been loaded over securely encrypted connections.
+ @discussion @link WKWebView @/link is key-value observing (KVO) compliant
+ for this property.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) BOOL hasOnlySecureContent;
</span><span class="cx">
</span><del>-/*! @abstract Whether there's a back item in the back-forward list that can be navigated to.
</del><ins>+/*! @abstract A Boolean value indicating whether there is a back item in
+ the back-forward list that can be navigated to.
</ins><span class="cx"> @seealso backForwardList.
</span><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) BOOL canGoBack;
</span><span class="cx">
</span><del>-/*! @abstract Whether there's a forward item in the back-forward list that can be navigated to.
</del><ins>+/*! @abstract A Boolean value indicating whether there is a forward item in
+ the back-forward list that can be navigated to.
</ins><span class="cx"> @seealso backForwardList.
</span><span class="cx"> */
</span><span class="cx"> @property (nonatomic, readonly) BOOL canGoForward;
</span><span class="cx">
</span><span class="cx"> /*! @abstract Navigates to the back item in the back-forward list.
</span><del>- @result A new navigation to the requested item, or nil if there is no back item in the back-forward list.
</del><ins>+ @result A new navigation to the requested item, or nil if there is no back
+ item in the back-forward list.
</ins><span class="cx"> */
</span><span class="cx"> - (WKNavigation *)goBack;
</span><span class="cx">
</span><span class="cx"> /*! @abstract Navigates to the forward item in the back-forward list.
</span><del>- @result A new navigation to the requested item, or nil if there is no forward item in the back-forward list.
</del><ins>+ @result A new navigation to the requested item, or nil if there is no
+ forward item in the back-forward list.
</ins><span class="cx"> */
</span><span class="cx"> - (WKNavigation *)goForward;
</span><span class="cx">
</span><span class="lines">@@ -146,7 +164,8 @@
</span><span class="cx"> */
</span><span class="cx"> - (WKNavigation *)reload;
</span><span class="cx">
</span><del>-/*! @abstract Reloads the current page, performing end-to-end revalidation using cache-validating conditionals if possible.
</del><ins>+/*! @abstract Reloads the current page, performing end-to-end revalidation
+ using cache-validating conditionals if possible.
</ins><span class="cx"> @result A new navigation representing the reload.
</span><span class="cx"> */
</span><span class="cx"> - (WKNavigation *)reloadFromOrigin;
</span><span class="lines">@@ -155,7 +174,9 @@
</span><span class="cx"> */
</span><span class="cx"> - (void)stopLoading;
</span><span class="cx">
</span><del>-/*! @abstract Whether horizontal swipe gestures will trigger back-forward list navigations. Defaults to NO.
</del><ins>+/*! @abstract A Boolean value indicating whether horizontal swipe gestures
+ will trigger back-forward list navigations.
+ @discussion The default value is NO.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic) BOOL allowsBackForwardNavigationGestures;
</span><span class="cx">
</span><span class="lines">@@ -166,17 +187,22 @@
</span><span class="cx"> #endif
</span><span class="cx">
</span><span class="cx"> #if !TARGET_OS_IPHONE
</span><del>-/* @abstract Whether magnify gestures will change the WKWebView magnification. Defaults to NO.
- @discussion It is possible to set the magnification property even if allowsMagnify is set to NO.
</del><ins>+/* @abstract A Boolean value indicating whether magnify gestures will
+ change the web view's magnification.
+ @discussion It is possible to set the magnification property even if
+ allowsMagnification is set to NO.
+ The default value is NO.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic) BOOL allowsMagnification;
</span><span class="cx">
</span><del>-/* @abstract The amount by which the webpage content is currently scaled. Defaults to 1.0.
</del><ins>+/* @abstract The factor by which the page content is currently scaled.
+ @discussion The default value is 1.0.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic) CGFloat magnification;
</span><span class="cx">
</span><del>-/* @abstract Magnify the webpage content by the given amount and center the result on the given point.
- * @param magnification The amount by which to magnify the content.
</del><ins>+/* @abstract Scales the page content by a specified factor and centers the
+ result on a specified point.
+ * @param magnification The factor by which to scale the content.
</ins><span class="cx"> * @param point The point (in view space) on which to center magnification.
</span><span class="cx"> */
</span><span class="cx"> - (void)setMagnification:(CGFloat)magnification centeredAtPoint:(CGPoint)point;
</span><span class="lines">@@ -189,12 +215,14 @@
</span><span class="cx">
</span><span class="cx"> @interface WKWebView (WKIBActions) <NSUserInterfaceValidations>
</span><span class="cx">
</span><del>-/*! @abstract Action method that navigates to the back item in the back-forward list.
</del><ins>+/*! @abstract Action method that navigates to the back item in the
+ back-forward list.
</ins><span class="cx"> @param sender The object that sent this message.
</span><span class="cx"> */
</span><span class="cx"> - (IBAction)goBack:(id)sender;
</span><span class="cx">
</span><del>-/*! @abstract Action method that navigates to the forward item in the back-forward list.
</del><ins>+/*! @abstract Action method that navigates to the forward item in the
+ back-forward list.
</ins><span class="cx"> @param sender The object that sent this message.
</span><span class="cx"> */
</span><span class="cx"> - (IBAction)goForward:(id)sender;
</span><span class="lines">@@ -204,13 +232,14 @@
</span><span class="cx"> */
</span><span class="cx"> - (IBAction)reload:(id)sender;
</span><span class="cx">
</span><del>-/*! @abstract Action method that reloads the current page, performing end-to-end revalidation using
- cache-validating conditionals if possible.
</del><ins>+/*! @abstract Action method that reloads the current page, performing
+ end-to-end revalidation using cache-validating conditionals if possible.
</ins><span class="cx"> @param sender The object that sent this message.
</span><span class="cx"> */
</span><span class="cx"> - (IBAction)reloadFromOrigin:(id)sender;
</span><span class="cx">
</span><del>-/*! @abstract Action method that stops loading all resources on the current page.
</del><ins>+/*! @abstract Action method that stops loading all resources on the current
+ page.
</ins><span class="cx"> @param sender The object that sent this message.
</span><span class="cx"> */
</span><span class="cx"> - (IBAction)stopLoading:(id)sender;
</span></span></pre></div>
<a id="trunkSourceWebKit2UIProcessAPICocoaWKWebViewConfigurationh"></a>
<div class="modfile"><h4>Modified: trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebViewConfiguration.h (169489 => 169490)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebViewConfiguration.h 2014-05-30 18:19:21 UTC (rev 169489)
+++ trunk/Source/WebKit2/UIProcess/API/Cocoa/WKWebViewConfiguration.h 2014-05-30 19:11:46 UTC (rev 169490)
</span><span class="lines">@@ -33,25 +33,26 @@
</span><span class="cx"> @class WKProcessPool;
</span><span class="cx"> @class WKUserContentController;
</span><span class="cx">
</span><del>-/*! A @link WKWebViewConfiguration @/link is a collection of properties used to initialize a web
- view.
</del><ins>+/*! A WKWebViewConfiguration object is a collection of properties with
+ which to initialize a web view.
</ins><span class="cx"> @helps Contains properties used to configure a @link WKWebView @/link.
</span><span class="cx"> */
</span><span class="cx"> WK_CLASS_AVAILABLE(10_10, 8_0)
</span><span class="cx"> @interface WKWebViewConfiguration : NSObject <NSCopying>
</span><span class="cx">
</span><del>-/*! @abstract The process pool from which the Web Content process for the view should come.
- @discussion When the @link WKWebView @/link is initialized with the configuration, a new Web
- Content process from the specified pool will be created for it, or an existing process in
</del><ins>+/*! @abstract The process pool from which to obtain the view's web content
+ process.
+ @discussion When a web view is initialized, a new web content process
+ will be created for it from the specified pool, or an existing process in
</ins><span class="cx"> that pool will be used.
</span><span class="cx"> */
</span><span class="cx"> @property (nonatomic, strong) WKProcessPool *processPool;
</span><span class="cx">
</span><del>-/*! @abstract The preferences that should be used by web views created with this configuration.
</del><ins>+/*! @abstract The preference settings to be used by the web view.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, strong) WKPreferences *preferences;
</span><span class="cx">
</span><del>-/*! @abstract The user content controller that should be used by web views created with this configuration.
</del><ins>+/*! @abstract The user content controller to associate with the web view.
</ins><span class="cx"> */
</span><span class="cx"> @property (nonatomic, strong) WKUserContentController *userContentController;
</span><span class="cx">
</span></span></pre>
</div>
</div>
</body>
</html>