Hi Chris,

We have a few ideas on how to better show the inherited items. One idea
is to show all inherited items, for example methods, in a single summary
table rather than as a collection of tables that list each inherited
item. The summary table would look like the summary table for the
methods defined in the class itself; they would contain the method
signature and the one line summary of the method. 

Since the table of inherited items can be quite long, we might make it
collapsible so you first see the methods defined in the class, then
expand the table to see inherited methods.

The idea of a single table that shows all the class elements, both
defined in the class and inherited, is a bit daunting. For example, the
table for the DataGrid would contain over 200 rows, probably closer to
250 rows. 

Stephen



-----Original Message-----
From: flexcoders@yahoogroups.com [mailto:[EMAIL PROTECTED] On
Behalf Of Chris Velevitch
Sent: Monday, February 06, 2006 6:28 PM
To: flexcoders@yahoogroups.com
Subject: Re: [flexcoders] Flex 2 - Looking for feedback on Flex API doc

On 2/7/06, Stephen Gilson <[EMAIL PROTECTED]> wrote:
> For your comment on issue #4, we are planning on adding the "Use" and

I'm interested in knowing what your thoughts are on my comments on issue
#1.
> On 2/3/06, Stephen Gilson <[EMAIL PROTECTED]> wrote:
> > 1. ... We have a
> > request to split the public and protected methods into separate 
> > tables, so that you do not see the protected methods if you are 
> > using the class, but view them only when you are creating a
subclass.
>
> The distinction between using a class and subclassing a class is very 
> important.
>
> When using a class however, a single alphabetic list of all public 
> properties, methods, styles, effects, etc is more usable than lots of 
> little boxes all over the place because:-
>
> a. we're using THIS class and more interested seeing the behaviour and

> attributes of THIS class as a whole, not the individual components 
> that make up the class.
>
> b. useful for people new to the class to help them understand what the

> class can do before moving on the how the class is constructed (ie 
> inheritance hierarchy) or how to subclass it.
>
> c. show the name of the class in which it is defined next to it.
>
> > 3. Is it styled well? Is it easy to read and does the use of color, 
> > font, and layout make sense?
>
> No, see above.
>
> > 4. Are the inheritance tables usable? These are the tables that list

> > the inherited items from the superclasses.
>
> How about a graphical inheritance hierarchy of all classes? It would 
> be a great way to visually see where a class fits in the whole scheme 
> of things.


Chris
--
Chris Velevitch
Manager - Sydney Flash Platform Developers Group www.flashdev.org.au


--
Flexcoders Mailing List
FAQ: http://groups.yahoo.com/group/flexcoders/files/flexcodersFAQ.txt
Search Archives:
http://www.mail-archive.com/flexcoders%40yahoogroups.com
Yahoo! Groups Links



 





--
Flexcoders Mailing List
FAQ: http://groups.yahoo.com/group/flexcoders/files/flexcodersFAQ.txt
Search Archives: http://www.mail-archive.com/flexcoders%40yahoogroups.com 
Yahoo! Groups Links

<*> To visit your group on the web, go to:
    http://groups.yahoo.com/group/flexcoders/

<*> To unsubscribe from this group, send an email to:
    [EMAIL PROTECTED]

<*> Your use of Yahoo! Groups is subject to:
    http://docs.yahoo.com/info/terms/
 



Reply via email to