Re: [flexcoders] Flex API Docs - Feature request
Did you add that comment to the LiveDocs as well (about the Tree)? - Original Message - From: Simon Fifield To: [EMAIL PROTECTED] Com Sent: Saturday, May 14, 2005 11:12 AM Subject: [flexcoders] Flex API Docs - Feature request I've just requested the following improvement of the Flex API docs because I think they are lacking some very useful and basic information: The API documentation lacks a lot of information that would save a considerable amount of time looking and testing for the answers - for example, you can find which node is currently selected in a Tree component by using the Tree.selectedNode property. The API docs explains that the item returned is dependent on the type of item selected - fair enough, but what if the user deselects a node so that no node is selected? I know that its probably going to be undefined, but why doesn't the API say that, I have to check it before I can carry on with other coding. This is not the first item that I've had this with, in fact the only reason I'm asking for this feature request is because there are so many times that I've thought that the API doc doesn't really cover what I need to know about the Class. The Java docs are very thorough although not perfect - I'm not asking for perfection because its not achievable, but the API docs can be massively improved. Thinking about it, if the code was being written "test first" surely a lot of the information would be there ready. Kind Regards, Simon Fifield Mango Solutions 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 the Yahoo! Terms of Service.
RE: [flexcoders] Flex API Docs - Feature request
Hi Jess, To be honest I'd completely forgotten about the comments on the LiveDocs. 99% of the time I use the API docs that came as part of FlexBuilder. But I've added the livedocs to my favourites now just to see if anyone's added some useful extra info. Thanks, Simon -Original Message-From: flexcoders@yahoogroups.com [mailto:[EMAIL PROTECTED]On Behalf Of JesterXLSent: 14 May 2005 16:18To: flexcoders@yahoogroups.comSubject: Re: [flexcoders] Flex API Docs - Feature request Did you add that comment to the LiveDocs as well (about the Tree)? - Original Message - From: Simon Fifield To: [EMAIL PROTECTED] Com Sent: Saturday, May 14, 2005 11:12 AM Subject: [flexcoders] Flex API Docs - Feature request I've just requested the following improvement of the Flex API docs because I think they are lacking some very useful and basic information: The API documentation lacks a lot of information that would save a considerable amount of time looking and testing for the answers - for example, you can find which node is currently selected in a Tree component by using the Tree.selectedNode property. The API docs explains that the item returned is dependent on the type of item selected - fair enough, but what if the user deselects a node so that no node is selected? I know that its probably going to be undefined, but why doesn't the API say that, I have to check it before I can carry on with other coding. This is not the first item that I've had this with, in fact the only reason I'm asking for this feature request is because there are so many times that I've thought that the API doc doesn't really cover what I need to know about the Class. The Java docs are very thorough although not perfect - I'm not asking for perfection because its not achievable, but the API docs can be massively improved. Thinking about it, if the code was being written "test first" surely a lot of the information would be there ready. Kind Regards, Simon Fifield Mango Solutions 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 the Yahoo! Terms of Service.
RE: [flexcoders] Flex API Docs - Feature request
LiveDocs is a great way to make a request to the Flex doc group, but we also participate in this group as well. The advantage to using LiveDocs is that your comment appears on the Tree API doc page for all other Flex users to see if they encounter the same issue. Stephen Flex Doc From: flexcoders@yahoogroups.com [mailto:[EMAIL PROTECTED] On Behalf Of Simon FifieldSent: Saturday, May 14, 2005 12:53 PMTo: flexcoders@yahoogroups.comSubject: RE: [flexcoders] Flex API Docs - Feature request Hi Jess, To be honest I'd completely forgotten about the comments on the LiveDocs. 99% of the time I use the API docs that came as part of FlexBuilder. But I've added the livedocs to my favourites now just to see if anyone's added some useful extra info. Thanks, Simon -Original Message-From: flexcoders@yahoogroups.com [mailto:[EMAIL PROTECTED]On Behalf Of JesterXLSent: 14 May 2005 16:18To: flexcoders@yahoogroups.comSubject: Re: [flexcoders] Flex API Docs - Feature request Did you add that comment to the LiveDocs as well (about the Tree)? - Original Message - From: Simon Fifield To: [EMAIL PROTECTED] Com Sent: Saturday, May 14, 2005 11:12 AM Subject: [flexcoders] Flex API Docs - Feature request I've just requested the following improvement of the Flex API docs because I think they are lacking some very useful and basic information: The API documentation lacks a lot of information that would save a considerable amount of time looking and testing for the answers - for example, you can find which node is currently selected in a Tree component by using the Tree.selectedNode property. The API docs explains that the item returned is dependent on the type of item selected - fair enough, but what if the user deselects a node so that no node is selected? I know that its probably going to be undefined, but why doesn't the API say that, I have to check it before I can carry on with other coding. This is not the first item that I've had this with, in fact the only reason I'm asking for this feature request is because there are so many times that I've thought that the API doc doesn't really cover what I need to know about the Class. The Java docs are very thorough although not perfect - I'm not asking for perfection because its not achievable, but the API docs can be massively improved. Thinking about it, if the code was being written "test first" surely a lot of the information would be there ready. Kind Regards, Simon Fifield Mango Solutions 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 the Yahoo! Terms of Service.