Opened 13 years ago

Closed 13 years ago

Last modified 12 years ago

#1781 closed defect (fixed)

Add API docs for Clock, GoogleMap, YahooMap, Chart, FilteringTable widgets

Reported by: bill Owned by: Tom Trenka
Priority: high Milestone:
Component: General Version: 0.4
Keywords: Cc:
Blocked By: Blocking:

Description (last modified by bill)

Clock, GoogleMap?, YahooMap?, Chart, FilteringTable? widgets need summary for the widget itself (ex: "interface to yahoo maps that ..."), and comment for each parameter to the widget.

Change History (8)

comment:1 Changed 13 years ago by Tom Trenka

Description: modified (diff)
Resolution: fixed
Status: newclosed

comment:2 Changed 13 years ago by bill

Resolution: fixed
Status: closedreopened

OK, I'm looking. YahooMaps?, GoogleMaps?, and FilteringTable? need comments for the widgets themselves, and comments on the all the parameters to the widgets. Actually, the parameters need to be declared in the property list, not in the constrctor. I think this is the part you don't like but that's the standard so you have to do it.

comment:3 Changed 13 years ago by Tom Trenka

Resolution: fixed
Status: reopenedclosed

comment:4 Changed 13 years ago by bill

Resolution: fixed
Status: closedreopened

I think you're probably misunderstanding about the documentation format we're using (for the rest of the widgets). If you look at FilteringTable?, for instance:

	<table dojoType="filteringTable" id="parsedFromHtml" 
		multiple="true" alternateRows="true" maxSortable="2"
		cellpadding="0" cellspacing="0" border="0">

It has parameters like "multiple", "alternateRows", etc. Each of those parameters needs to be documented. And also you need a comment right above the dojo.widget.defineWidget() call. Compare to something like

http://trac.dojotoolkit.org/browser/trunk/src/widget/DatePicker.js

comment:5 Changed 13 years ago by Tom Trenka

I can do that at some point.

It would have been nice to know that there was a fairly extensive set of documentation changes that only affected widgets, though.

comment:6 Changed 13 years ago by bill

Description: modified (diff)
Summary: Add API docs for GoogleMap, YahooMap, Chart, FilteringTable widgetsAdd API docs for Clock, GoogleMap, YahooMap, Chart, FilteringTable widgets

comment:7 Changed 13 years ago by Tom Trenka

Resolution: fixed
Status: reopenedclosed

(In [6502]) Fixes #1781.

comment:8 Changed 12 years ago by (none)

Milestone: 0.4.1

Milestone 0.4.1 deleted

Note: See TracTickets for help on using tickets.