I definitely don't agree with Gunnar's remark that:
"The MXML examples at the end, however, should be removed and replaced with AS-examples."
Cheers
-michael
On 2/3/06, gunnar a reinseth <[EMAIL PROTECTED]> wrote:
1. The docs should definately display both protected and public methods/properties - just the way it is! (and it's nice to see that the 'override' keyword is used as well)
2. The MXML syntax summary is helpful to get a quick overview of the component - e.g. if i'm only looking for a style name. The MXML examples at the end, however, should be removed and replaced with AS-examples.
3. No problems with the styling...
4. I use the inheritance tables all the time - so, yes.
--
gunnarOn 2/2/06, Stephen Gilson < [EMAIL PROTECTED]> wrote:All,
We are looking for feedback on the Flex API documentation. This
documentation is titled "Macromedia Flex 2 ActionScript and MXML
Language Reference" and is available from Flex Builder Help, or in a
standalone form.
We modeled this documentation on JavaDocs. So, if you are familiar with
JavaDocs, it should look pretty familiar. You can see it here:
http://livedocs.macromedia.com/labs/1/flex/langref/index.html
After the Alpha release, we made several changes to it based on user
feedback. One change was to move static properties and methods to their
own area of the output.
Topics for discussion now are:
1. For each class, we mix both public and protected methods in the same
summary table. This is the way JavaDocs handles methods. 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.
Is this a change you would like to see?
2. We include a summary of the MXML syntax for the Flex components at
the top of each class description. The syntax lists the MXML tag
attributes and default values for each component.
Is this helpful, or should we just remove it? Without it, you would have
to look at the tables of properties, events, effects, and styles to
determine 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 the
inherited items from the superclasses.
One possibility is to replace these inheritance lists with actual
summary tables, like you see for the properties and methods defined in
the class. The summary table shows the item, and includes a one-line
summary.
Thanks,
Stephen
Flex Doc Team
--
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 .
--
Flexcoders Mailing List
FAQ: http://groups.yahoo.com/group/flexcoders/files/flexcodersFAQ.txt
Search Archives: http://www.mail-archive.com/flexcoders%40yahoogroups.com
SPONSORED LINKS
Web site design development Computer software development Software design and development Macromedia flex Software development best practice
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.
