[jira] Commented: (DIRMINA-575) Add the missing Javadoc, add some comments
[ https://issues.apache.org/jira/browse/DIRMINA-575?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12598168#action_12598168 ] Emmanuel Lecharny commented on DIRMINA-575: --- For a 2.0, it will be a blocker. If we have to have a 2.0.0-M3, this is not a blocker. The thing is that we can't say a JIRA issue is a blocker for a future version. About what has to be added, a complete code review should be done, or at least, using a tool like Enerjy on eclipse of any other tool can tell you where the Javadoc is missing. This is actually what we are doing on Directory : using such a tool to add missing javadoc. I know this is painfull, but it's a no brainer, and a good thing to do when tired, as it does not need to be very efficient. I usually do that when it's late at night or when commuting, as it needs no brain power. > Add the missing Javadoc, add some comments > -- > > Key: DIRMINA-575 > URL: https://issues.apache.org/jira/browse/DIRMINA-575 > Project: MINA > Issue Type: Task > Components: Web Site / Documentation >Reporter: Emmanuel Lecharny > > If we except the interfaces, the code lacks of javadoc and comments, which > make it complicated for new committers to get into it. > We need to add those missing javadocs, and comments where it's necessary. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online.
[jira] Commented: (DIRMINA-575) Add the missing Javadoc, add some comments
[ https://issues.apache.org/jira/browse/DIRMINA-575?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12598169#action_12598169 ] Trustin Lee commented on DIRMINA-575: - Yeah, I concur with you that we need to improve our documentation before the RC (or GA), but not in milestones which is prone to change. > Add the missing Javadoc, add some comments > -- > > Key: DIRMINA-575 > URL: https://issues.apache.org/jira/browse/DIRMINA-575 > Project: MINA > Issue Type: Task > Components: Web Site / Documentation >Reporter: Emmanuel Lecharny > > If we except the interfaces, the code lacks of javadoc and comments, which > make it complicated for new committers to get into it. > We need to add those missing javadocs, and comments where it's necessary. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online.
[jira] Commented: (DIRMINA-575) Add the missing Javadoc, add some comments
[ https://issues.apache.org/jira/browse/DIRMINA-575?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12598260#action_12598260 ] Emmanuel Lecharny commented on DIRMINA-575: --- Yeah, exactly : it's a blocker for a RC or even a GA. Milestones are just work in progress, and documentation has to follow. However, it's way better to write doco while writing ocde for two reasons : - it's fresh in your mind - doco is a part of the code To be very clear : it's all about progress. We may not have a complete documentation, or a perfect one for 2.0, but at least, it should be enough for our users. > Add the missing Javadoc, add some comments > -- > > Key: DIRMINA-575 > URL: https://issues.apache.org/jira/browse/DIRMINA-575 > Project: MINA > Issue Type: Task > Components: Web Site / Documentation >Reporter: Emmanuel Lecharny >Priority: Blocker > Fix For: 2.0.0-RC1 > > > If we except the interfaces, the code lacks of javadoc and comments, which > make it complicated for new committers to get into it. > We need to add those missing javadocs, and comments where it's necessary. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online.
[jira] Commented: (DIRMINA-575) Add the missing Javadoc, add some comments
[ https://issues.apache.org/jira/browse/DIRMINA-575?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel&focusedCommentId=12741312#action_12741312 ] Ashish Paliwal commented on DIRMINA-575: This JIRA issue is very generic and we may not be able to close it. We may choose to create specific JIRA issues for places where we want to add documentation and close this issue. wdyt? > Add the missing Javadoc, add some comments > -- > > Key: DIRMINA-575 > URL: https://issues.apache.org/jira/browse/DIRMINA-575 > Project: MINA > Issue Type: Task > Components: Web Site / Documentation >Reporter: Emmanuel Lecharny >Priority: Blocker > Fix For: 2.0.0-RC1 > > > If we except the interfaces, the code lacks of javadoc and comments, which > make it complicated for new committers to get into it. > We need to add those missing javadocs, and comments where it's necessary. -- This message is automatically generated by JIRA. - You can reply to this email to add a comment to the issue online.
