Added a lot more documentation to Window.

Added a lot more documentation to Window.

It'll take one more CL to finish Window off.

Committed: https://code.google.com/p/dart/source/detail?r=15132

[blois, 2012-11-19 23:58:20]

On 2012/11/19 23:39:08, Andrei Mouravski wrote:

Code changes look good.

[Kathy Walrath, 2012-11-20 00:04:20]

A few quibbles, but basically looks good.

I'm not sure how we should format code samples, but something is always better
than nothing!

http://codereview.chromium.org/11416081/diff/1/sdk/lib/html/src/CrossFrameTyp...
File sdk/lib/html/src/CrossFrameTypes.dart (right):

http://codereview.chromium.org/11416081/diff/1/sdk/lib/html/src/CrossFrameTyp...
sdk/lib/html/src/CrossFrameTypes.dart:27: * The [Location] object representing
the current location of this window.
I think we can just say:

* The current location of this window.

(Location is already in the signature, and shorter is better.)

http://codereview.chromium.org/11416081/diff/1/sdk/lib/html/src/CrossFrameTyp...
sdk/lib/html/src/CrossFrameTypes.dart:36: * Indicates whether the window is
closed.
the -> this

http://codereview.chromium.org/11416081/diff/1/sdk/lib/html/src/CrossFrameTyp...
sdk/lib/html/src/CrossFrameTypes.dart:45: * A reference to the [Window] that
opened this [Window].
change to:

A reference to the window that opened this one.

http://codereview.chromium.org/11416081/diff/1/sdk/lib/html/src/CrossFrameTyp...
sdk/lib/html/src/CrossFrameTypes.dart:54: * A reference to the parent of this
[Window].
[Window] -> window

http://codereview.chromium.org/11416081/diff/1/sdk/lib/html/src/CrossFrameTyp...
sdk/lib/html/src/CrossFrameTypes.dart:68: * A reference to the topmost [Window]
in the [Window] heirarchy.
again, [Window] -> window

[Andrei Mouravski, 2012-11-20 00:15:37]

PTAL.

http://codereview.chromium.org/11416081/diff/1/sdk/lib/html/src/CrossFrameTyp...
File sdk/lib/html/src/CrossFrameTypes.dart (right):

http://codereview.chromium.org/11416081/diff/1/sdk/lib/html/src/CrossFrameTyp...
sdk/lib/html/src/CrossFrameTypes.dart:27: * The [Location] object representing
the current location of this window.
On 2012/11/20 00:04:21, Kathy Walrath wrote:
> I think we can just say:
> 
> * The current location of this window.
> 
> (Location is already in the signature, and shorter is better.)

Done.

http://codereview.chromium.org/11416081/diff/1/sdk/lib/html/src/CrossFrameTyp...
sdk/lib/html/src/CrossFrameTypes.dart:36: * Indicates whether the window is
closed.
On 2012/11/20 00:04:21, Kathy Walrath wrote:
> the -> this

Done.

http://codereview.chromium.org/11416081/diff/1/sdk/lib/html/src/CrossFrameTyp...
sdk/lib/html/src/CrossFrameTypes.dart:45: * A reference to the [Window] that
opened this [Window].
On 2012/11/20 00:04:21, Kathy Walrath wrote:
> change to:
> 
> A reference to the window that opened this one.

Done.

http://codereview.chromium.org/11416081/diff/1/sdk/lib/html/src/CrossFrameTyp...
sdk/lib/html/src/CrossFrameTypes.dart:54: * A reference to the parent of this
[Window].
On 2012/11/20 00:04:21, Kathy Walrath wrote:
> [Window] -> window

Done.

http://codereview.chromium.org/11416081/diff/1/sdk/lib/html/src/CrossFrameTyp...
sdk/lib/html/src/CrossFrameTypes.dart:68: * A reference to the topmost [Window]
in the [Window] heirarchy.
On 2012/11/20 00:04:21, Kathy Walrath wrote:
> again, [Window] -> window

Done.

[Kathy Walrath, 2012-11-20 01:51:24]

2 nits, and then lgtm

http://codereview.chromium.org/11416081/diff/6001/sdk/lib/html/src/CrossFrame...
File sdk/lib/html/src/CrossFrameTypes.dart (right):

http://codereview.chromium.org/11416081/diff/6001/sdk/lib/html/src/CrossFrame...
sdk/lib/html/src/CrossFrameTypes.dart:45: * A reference to the [Window] that
opened this one.
Again, [Window] -> window. (I'm not sure whether x-refs in summaries will be
supported, and they seem questionable in general -- better to make the summary
as simple as possible.)

http://codereview.chromium.org/11416081/diff/6001/sdk/lib/html/src/CrossFrame...
sdk/lib/html/src/CrossFrameTypes.dart:68: * A reference to the topmost window in
the window heirarchy.
heirarchy -> hierarchy 

(Tough word to spell. I had to look it up to be sure!)

[Andrei Mouravski, 2012-11-20 06:28:47]

Thanks! Submitting.

https://codereview.chromium.org/11416081/diff/6001/sdk/lib/html/src/CrossFram...
File sdk/lib/html/src/CrossFrameTypes.dart (right):

https://codereview.chromium.org/11416081/diff/6001/sdk/lib/html/src/CrossFram...
sdk/lib/html/src/CrossFrameTypes.dart:45: * A reference to the [Window] that
opened this one.
On 2012/11/20 01:51:24, Kathy Walrath wrote:
> Again, [Window] -> window. (I'm not sure whether x-refs in summaries will be
> supported, and they seem questionable in general -- better to make the summary
> as simple as possible.)

Done.