Bug 589024 - widget.tooltip is undocumented, and widget.panel should be marked as optional. r=dietrich, a0.7=myk
authorDrew Willcoxon <adw@mozilla.com>
Thu, 19 Aug 2010 21:51:52 -0700
changeset 749 cfee590f9ff3b8a6f3d99a65c2e4d42c942fc9e5
parent 748 a8fde119720e2847a72dfb77738592d75b69b21e
child 750 9d692d9a02b2f526a58a016fa217bf8c6b25b562
push id278
push userdwillcoxon@mozilla.com
push dateFri, 20 Aug 2010 04:53:33 +0000
reviewersdietrich
bugs589024
Bug 589024 - widget.tooltip is undocumented, and widget.panel should be marked as optional. r=dietrich, a0.7=myk
packages/jetpack-core/docs/widget.md
--- a/packages/jetpack-core/docs/widget.md
+++ b/packages/jetpack-core/docs/widget.md
@@ -40,18 +40,18 @@ visibility.
     property.
 
   @prop [image] {string}
     An optional string URL of an image from your package to use as the displayed
     content of the widget.  See the [`self`](#module/jetpack-core/self) module
     for directions on where in your package to store your static data files.
     Widgets must either have a `content` property or an `image` property.
 
-  @prop panel {panel}
-    A `Panel` to open when the user clicks on the widget.  See the
+  @prop [panel] {panel}
+    An optional `Panel` to open when the user clicks on the widget.  See the
     [`panel`](#module/jetpack-core/panel) module for more information about the
     `Panel` objects to which this option can be set and the `reddit-panel`
     example add-on for an example of using this option.  Note: If you also
     specify an `onClick` callback function, it will be called instead of the
     panel being opened.  However, you can then show the panel from the `onClick`
     callback function by calling `panel.show()`.
 
   @prop [width] {integer}
@@ -79,16 +79,20 @@ visibility.
     widget. It is called as `onClick(event)`. `event` is the standard DOM event
     object.
 
   @prop [onReady] {callback}
     An optional function to be called when widget content that is HTML is
     loaded. If the widget's content is an image then use the `onLoad` event
     instead. It is called as `onReady(event)`. `event` is the standard DOM event
     object.
+
+  @prop [tooltip] {string}
+    Optional text to show when the user's mouse hovers over the widget.  If not
+    given, the `label` is used.
 </api>
 
 ## Functions ##
 
 <api name="add">
 @function
   Adds a widget to the bar.