Opened 7 years ago

Closed 7 years ago

#15462 closed defect (fixed)

missing reference doc for dojox/mobile

Reported by: bill Owned by: Eric Durocher
Priority: undecided Milestone: 1.8
Component: Documentation Version: 1.7.2
Keywords: Cc:
Blocked By: Blocking:

Description (last modified by bill)

Add doc for

  • dojox/mobile/scrollable.
  • dojox/mobile/searchbox
  • dojox/mobile/datepicker
  • dojox/mobile/menuitem

Change History (5)

comment:1 Changed 7 years ago by bill

Owner: set to Eric Durocher
Status: newassigned

comment:2 Changed 7 years ago by bill

Description: modified (diff)
Summary: missing reference doc for dojox/mobile/scrollablemissing reference doc for dojox/mobile

comment:3 Changed 7 years ago by Eric Durocher

  • dojox/mobile/scrollable: this is an internal mixin that is not meant to be used directly, I don't think it should be in the reference doc (unless there are links to it somewhere? I did not see any)
  • dojox/mobile/searchbox: yes this one is missing.
  • dojox/mobile/datepicker: http://livedocs.dojotoolkit.org/dojox/mobile/DatePicker is there.
  • dojox/mobile/menuitem: this does not exist, are there links to that somewhere?

comment:4 in reply to:  3 Changed 7 years ago by bill

Replying to edurocher:

  • dojox/mobile/scrollable: this is an internal mixin that is not meant to be used directly, I don't think it should be in the reference doc (unless there are links to it somewhere? I did not see any)

You can find links using grep or the search dialog in any IDE. This one is referenced from:

./dojo/has.rst::ref:dojox/mobile/scrollable <dojox/mobile/scrollable> translate3d

Also, there's no indication that scrollable is private/internal in the API doc for that file, and until recently that file had specific code in it for people to use it directly (the code to use it without dojo).

OK, so livedocs is stuck again. It would really be better if you updated documents by checking into github directly, as documented in http://livedocs.dojotoolkit.org/developer/metadoc#editing-documentation-locally.

  • dojox/mobile/menuitem: this does not exist, are there links to that somewhere?

Yes:

./dojox/mobile/IconMenuItem.rst:IconMenuItem represents a menu item of :ref:dojox.mobile.MenuItem <dojox/mobile/MenuItem>. This widget inherits from dojox.mobile._ItemBase. Basic usage is same as the other subclasses such as :ref:dojox.mobile.ListItem <dojox/mobile/ListItem>.

comment:5 Changed 7 years ago by Eric Durocher

Milestone: tbd1.8
Resolution: fixed
Status: assignedclosed
  • dojox/mobile/scrollable: page created
  • dojox/mobile/SearchBox: page created with help from doughays
  • dojox/mobile/DatePicker: ok
  • fixed wrong ref in dojox/mobile/IconMenuItem (MenuItem -> IconMenu).
Note: See TracTickets for help on using tickets.