bug 599437: correct docs on Tabs objects so they describe tab.location as Location object; r=adw 0.9rc2
authorMyk Melez <myk@mozilla.org>
Tue, 19 Oct 2010 16:59:03 -0700
changeset 888 173d56fa8cc1c5622eae70f1ae88ef789de4722b
parent 887 bb651f9b6f092dca29f79ae223ee67a31d2e3951
child 889 cde12eefd178d7a0ee7d5e9ae77f3089bcbdc6ec
push id392
push usermyk@mozilla.com
push dateTue, 19 Oct 2010 23:59:10 +0000
reviewersadw
bugs599437
bug 599437: correct docs on Tabs objects so they describe tab.location as Location object; r=adw
packages/addon-kit/docs/tabs.md
--- a/packages/addon-kit/docs/tabs.md
+++ b/packages/addon-kit/docs/tabs.md
@@ -177,19 +177,24 @@ registration.
 
 <api name="title">
 @property {string}
 The title of the page currently loaded in the tab.
 This property is read-only.
 </api>
 
 <api name="location">
-@property {string}
+@property {Location}
 The URL of the page currently loaded in the tab.
-This property can be set, to load a different URL in the tab.
+This property can be set to load a different URL in the tab.
+The value is a Location object, just like window.location in web pages.
+Its toString() method returns a string representation of the URL.
+For more information about Location objects, see their [Mozilla Developer
+Network documentation][MDN].
+[MDN]: https://developer.mozilla.org/en/DOM/window.location#Location_object
 </api>
 
 <api name="contentWindow">
 @property {object}
 The window object for the page currently loaded in the tab.
 This property is read-only, meaning you cannot set it to different window.
 The window itself can be modified.
 </api>