Opened 12 years ago

Closed 10 years ago

Last modified 10 years ago

#4778 closed defect (fixed)

TooltipDialog documentation incorrect — at Version 5

Reported by: davidb Owned by: bill
Priority: high Milestone: 1.0
Component: Documentation Version: 0.9
Keywords: Cc:
Blocked By: Blocking:

Description (last modified by bill)

See comments on http://dojotoolkit.org/book/dojo-book-0-9/part-2-dijit/layout/dialog regarding show and hide.

There is confusion as to how to invoke TooltipDialog.
Note dijit/tests/test_Dialog.html uses a DropDownButton to invoke.

Change History (5)

comment:1 Changed 12 years ago by davidb

Description: modified (diff)

comment:2 Changed 12 years ago by Neil Roberts

Owner: changed from Neil Roberts to bill

comment:3 Changed 12 years ago by bill

Resolution: fixed
Status: newclosed
Summary: TooltipDialog documentation incorrect?TooltipDialog documentation incorrect

OK, I just updated that page.

comment:4 Changed 10 years ago by Stefan Bird

Resolution: fixed
Status: closedreopened

That page still says TooltipDialog? has a hide() method, when in fact it doesn't.

As mentioned by http://dojotoolkit.org/book/dojo-book-0-9/part-2-dijit/layout/dialog#comment-16063, to programmatically hide a TooltipDialog? you need to call its onCancel() method instead, which is a little odd.

Either the documentation should be updated to state that TooltipDialog? doesn't have a hide() method and to call onCancel() instead, or a hide() method should be added (which possibly calls onCancel() internally).

comment:5 Changed 10 years ago by bill

Component: Doc parserDocumentation
Description: modified (diff)
Resolution: fixed
Status: reopenedclosed

The current documentation for TooltipDialog is http://docs.dojocampus.org/dijit/TooltipDialog and http://api.dojotoolkit.org/jsdoc/1.3/dijit.TooltipDialog. The former doesn't mention any methods and the latter just has the correct list.

The dojo-book-0-9 is notorious for problems like this; it was just too hard to keep it updated so now we use the auto-generated api.dojotoolkit.org. But we haven't been maintaining it for years, you should really use the new documentation.

Note: See TracTickets for help on using tickets.