Fix docs for Window.close() and Window.location=

srawlins · commit-bot@chromium.org · commit bb293ef8cf1d · 2019-08-08T15:20:41.000Z
* `closed` is not a method. * `location` is not a method. * `location=` does _not_ take a String; only a Location object. Fixes #16893 Change-Id: Ia5389ae80c39c5c7d9eebdd0cd04cb994a27fd7d Reviewed-on: https://dart-review.googlesource.com/c/sdk/+/111965 Reviewed-by: Terry Lucas <terry@google.com> Commit-Queue: Samuel Rawlins <srawlins@google.com>
diff --git a/sdk/lib/html/dart2js/html_dart2js.dart b/sdk/lib/html/dart2js/html_dart2js.dart
@@ -30564,7 +30564,7 @@ class Window extends EventTarget
   // TODO: consider forcing users to do: window.location.assign('string').
   /**
    * Sets the window's location, which causes the browser to navigate to the new
-   * location. [value] may be a Location object or a String.
+   * location.
    */
   set location(value) {
     _location = value;
@@ -34587,12 +34587,14 @@ abstract class WindowBase implements EventTarget {
    *     var other = window.open('http://www.example.com', 'foo');
    *     // Closes other window, as it is script-closeable.
    *     other.close();
-   *     print(other.closed()); // 'true'
+   *     print(other.closed); // 'true'
    *
-   *     window.location('http://www.mysite.com', 'foo');
+   *     var newLocation = window.location
+   *         ..href = 'http://www.mysite.com';
+   *     window.location = newLocation;
    *     // Does not close this window, as the history has changed.
    *     window.close();
-   *     print(window.closed()); // 'false'
+   *     print(window.closed); // 'false'
    *
    * See also:
    *
diff --git a/tools/dom/src/CrossFrameTypes.dart b/tools/dom/src/CrossFrameTypes.dart
@@ -116,12 +116,14 @@ abstract class WindowBase implements EventTarget {
    *     var other = window.open('http://www.example.com', 'foo');
    *     // Closes other window, as it is script-closeable.
    *     other.close();
-   *     print(other.closed()); // 'true'
+   *     print(other.closed); // 'true'
    *
-   *     window.location('http://www.mysite.com', 'foo');
+   *     var newLocation = window.location
+   *         ..href = 'http://www.mysite.com';
+   *     window.location = newLocation;
    *     // Does not close this window, as the history has changed.
    *     window.close();
-   *     print(window.closed()); // 'false'
+   *     print(window.closed); // 'false'
    *
    * See also:
    *
diff --git a/tools/dom/templates/html/impl/impl_Window.darttemplate b/tools/dom/templates/html/impl/impl_Window.darttemplate
@@ -76,7 +76,7 @@ $(CLASS_MODIFIERS)class $CLASSNAME$EXTENDS$IMPLEMENTS {
   // TODO: consider forcing users to do: window.location.assign('string').
   /**
    * Sets the window's location, which causes the browser to navigate to the new
-   * location. [value] may be a Location object or a String.
+   * location.
    */
   set location(value) {
     _location = value;

Original file line number	Diff line number	Diff line change
`@@ -116,12 +116,14 @@ abstract class WindowBase implements EventTarget {`
`116`	`116`	`* var other = window.open('http://www.example.com', 'foo');`
`117`	`117`	`* // Closes other window, as it is script-closeable.`
`118`	`118`	`* other.close();`
`119`		`- * print(other.closed()); // 'true'`
	`119`	`+ * print(other.closed); // 'true'`
`120`	`120`	`*`
`121`		`- * window.location('http://www.mysite.com', 'foo');`
	`121`	`+ * var newLocation = window.location`
	`122`	`+ * ..href = 'http://www.mysite.com';`
	`123`	`+ * window.location = newLocation;`
`122`	`124`	`* // Does not close this window, as the history has changed.`
`123`	`125`	`* window.close();`
`124`		`- * print(window.closed()); // 'false'`
	`126`	`+ * print(window.closed); // 'false'`
`125`	`127`	`*`
`126`	`128`	`* See also:`
`127`	`129`	`*`