RE: [flexcoders] Flex 2 - Looking for feedback on Flex API doc

[Stephen Gilson]

Thanks for the feedback,
 

For 
#4, we would not remove the inheritance tables, but make them look like the 
summary tables for the elements defined within the class. 

 
Right now, the inheritance tables are just a list of the 
inherited elements with no description. Instead, we could replace 
the lists with actual summary tables, like the list of methods defined in the 
class. These tables show the method signature, and contain a one-line 
description of the method. It would make each page much longer, so we would also 
need a way to show/hide the inheritance tables if we implement 
it.
 
Stephen


From: flexcoders@yahoogroups.com 
[mailto:[EMAIL PROTECTED] On Behalf Of Teoti 
GraphixSent: Thursday, February 02, 2006 6:14 PMTo: 
flexcoders@yahoogroups.comSubject: Re: [flexcoders] Flex 2 - Looking 
for feedback on Flex API doc
1. Would there be a way to toggle them? I develop components, so 
having everything is nice. But when you are making an application, yes, you 
definitly don't need protected stuff.2.I think it's nice, for me it's 
likle seeing flash cards over and over, you memorize things quicker seeing 
compact groups. Let's remember howmany learning styles there are out there 
to.3.I love it, but my opinion again. I really think for as serious of 
documentaion this is, it is just drab enough to catch your attention every time 
you read them. The style lends well to 'surfing' the classes.4. Please 
keep them or at least create toggles for them. They are invaluable as methioned 
above about memorization.I think you could ditch them if they did not serve 
a pratical purpose. But hey, they put the whole picture together, over and 
over.Great job on the docs, for me they are a pleasure to allow my self 
to see how kewl this stuff really is. Gets the inventive mid 
going!Peace, Mike
On 2/2/06, Stephen 
Gilson <[EMAIL PROTECTED]> 
wrote:
All,We 
  are looking for feedback on the Flex API documentation. Thisdocumentation 
  is titled "Macromedia Flex 2 ActionScript and MXMLLanguage Reference" and 
  is available from Flex Builder Help, or in astandalone form. We 
  modeled this documentation on JavaDocs. So, if you are familiar 
  withJavaDocs, it should look pretty familiar. You can see it 
  here:http://livedocs.macromedia.com/labs/1/flex/langref/index.htmlAfter 
  the Alpha release, we made several changes to it based on userfeedback. 
  One change was to move static properties and methods to theirown area of 
  the output. Topics for discussion now are:1. For each class, 
  we mix both public and protected methods in the samesummary table. This is 
  the way JavaDocs handles methods. We have arequest 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.Is this a change you would like to 
  see?2. We include a summary of the MXML syntax for the Flex 
  components atthe top of each class description. The syntax lists the MXML 
  tagattributes and default values for each component.Is this 
  helpful, or should we just remove it? Without it, you would haveto look at 
  the tables of properties, events, effects, and styles todetermine the MXML 
  syntax.3. Is it styled well? Is it easy to read and does the use 
  of color,font, and layout make sense?4. Are the inheritance 
  tables usable? These are the tables that list theinherited items from the 
  superclasses.One possibility is to replace these inheritance lists 
  with actualsummary tables, like you see for the properties and methods 
  defined inthe class. The summary table shows the item, and includes a 
  one-linesummary.Thanks,Stephen Flex Doc 
  Team--Flexcoders Mailing ListFAQ: http://groups.yahoo.com/group/flexcoders/files/flexcodersFAQ.txtSearch 
  Archives: http://www.mail-archive.com/flexcoders%40yahoogroups.com 
  
  
  
  YAHOO! GROUPS LINKS 
  
     Visit your group "flexcoders" on the web.  
     To unsubscribe from this group, send an email 
    to:  [EMAIL PROTECTED]  

     Your use of Yahoo! Groups is subject to the Yahoo! Terms of 
    Service. 
  
  
  





--
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



   Visit your group "flexcoders" on the web. 
   To unsubscribe from this group, send an email to: [EMAIL PROTECTED] 
   Your use of Yahoo! Groups is subject to the Yahoo! Terms of Service.