43 messages in org.apache.mina.devRe: svn commit: r659372 - /mina/branc...
FromSent OnAttachments
Emmanuel LecharnyMay 22, 2008 7:40 pm 
이희승 (Trustin Lee)May 22, 2008 7:46 pm 
Emmanuel LecharnyMay 22, 2008 8:02 pm 
이희승 (Trustin Lee)May 22, 2008 8:14 pm 
Emmanuel LecharnyMay 22, 2008 8:21 pm 
Emmanuel LecharnyMay 22, 2008 8:24 pm 
이희승 (Trustin Lee)May 22, 2008 8:30 pm 
Emmanuel LecharnyMay 22, 2008 8:43 pm 
이희승 (Trustin Lee)May 22, 2008 8:48 pm 
Mike HeathMay 22, 2008 9:52 pm 
이희승 (Trustin Lee)May 22, 2008 9:59 pm 
이희승 (Trustin Lee)May 22, 2008 10:20 pm 
Emmanuel LecharnyMay 22, 2008 10:31 pm 
이희승 (Trustin Lee)May 22, 2008 10:35 pm 
Mike HeathMay 22, 2008 10:44 pm 
Rich DoughertyMay 22, 2008 11:24 pm 
Julien VermillardMay 22, 2008 11:37 pm 
이희승 (Trustin Lee)May 22, 2008 11:44 pm 
Julien VermillardMay 23, 2008 12:13 am 
이희승 (Trustin Lee)May 23, 2008 12:39 am 
Michael QiMay 23, 2008 12:46 am 
Stefano BagnaraMay 23, 2008 1:09 am 
Stefano BagnaraMay 23, 2008 1:17 am 
Julien VermillardMay 23, 2008 1:21 am 
Brad HarveyMay 23, 2008 1:45 am 
Mark WebbMay 23, 2008 6:09 am 
Brad HarveyMay 23, 2008 6:31 am 
Niklas TherningMay 23, 2008 6:54 am 
Alex KarasuluMay 23, 2008 7:30 am 
Emmanuel LecharnyMay 23, 2008 7:50 am 
Emmanuel LecharnyMay 23, 2008 8:07 am 
Julien VermillardMay 23, 2008 8:44 am 
Stefano BagnaraMay 23, 2008 10:03 am 
Alex KarasuluMay 23, 2008 10:14 am 
Mark WebbMay 23, 2008 10:16 am 
Stefano BagnaraMay 23, 2008 10:26 am 
Stefano BagnaraMay 23, 2008 10:28 am 
Emmanuel LecharnyMay 23, 2008 10:40 am 
Mark WebbMay 23, 2008 1:43 pm 
Emmanuel LecharnyMay 23, 2008 2:23 pm 
jver...@archean.frMay 24, 2008 11:07 pm 
Frédéric BrégierMay 24, 2008 11:26 pm 
Emmanuel LecharnyMay 25, 2008 4:00 am 
Actions with this message:
Paste this link in email or IM:
Paste this link in email or IM:
Atom feed for this thread
Paste this URL into your reader:
Subject:Re: svn commit: r659372 - /mina/branches/buffer/core/src/main/java/org/apache/mina/queue/DefaultByteBufferQueue.javaActions...
From:Emmanuel Lecharny (elec@apache.org)
Date:May 22, 2008 10:31:50 pm
List:org.apache.mina.dev

이희승 (Trustin Lee) wrote:

On Fri, 23 May 2008 12:44:00 +0900, Emmanuel Lecharny <elec@apache.org> wrote:

이희승 (Trustin Lee) wrote:

On Fri, 23 May 2008 12:21:43 +0900, Emmanuel Lecharny <elec@apache.org> wrote:

이희승 (Trustin Lee) wrote:

On Fri, 23 May 2008 12:02:45 +0900, Emmanuel Lecharny <elec@apache.org> wrote:

이희승 (Trustin Lee) wrote:

Every public methods except for the constructors are overridden from its supertypes and interfaces. They all got proper JavaDoc comments. Let me know if I am missing something.

Adding a @see Class#method() in the implementation then should help. When you look at a method javadoc it's better to know where too look at : the intheritance scheme can be feilry complex, and it can be a burden to retreive the associated Javadoc.

Something like : /** * @see javax.naming.Context#close() */ public void close() throws NamingException ...

I'd just move the cursor on the method? That shows pretty nicely rendered JavaDoc in modern IDEs.

Sometime, you just have to use vi or emacs. Make it simple for users : add a @see tag. Cost almost nothing, and it helps.

I wouldn't bother with vi or emacs. They pay for what they use. Moreover, it's not 'almost nothing'.

-1.

Please revert the commit.

-1. I have a valid point not to add those @see tags.

If you really want to see them added, add them by yourself. I disagree with what you suggest anyway.

Now you are behaving like a manager, who is a bladder but does no actual action.

Trustin, I'm on the project *management* committee.

I would like to see the code you commit adheres to some standard.

Until this is resolved my right to veto holds so please revert your commit until we figure out the best choice for Javadoc. If you won't revert it, I can do it for you.

Regardless of which we choose something is required to help those using IDE's besides Eclipse. There is no reason why Vi or Emacs users should according to your words, 'pay for what they use'.

I also have to mention that I don't like to go that far. I have to just in order to get this project on rails. You have to understand that you can't break all the rules simply because you think that the rules are bad. I didn't made the rules, and I consider that good practices are also rules we have to follow. If all the implemented classes in the core JVM (ArrayList and List, etc) duplicate the Javadoc, it's for a pretty good reason. You can disagree, but that won't make those good reasons disappear.

PS : for the record, here is the veto definition (http://www.apache.org/foundation/glossary.html) :

*Veto* According to the Apache methodology, a change which has been made or proposed may be made moot through the exercise of a veto by a committer to the codebase <http://www.apache.org/foundation/glossary.html#Codebase> in question. If the R-T-C <http://www.apache.org/foundation/glossary.html#ReviewThenCommit> commit policy is in effect, a veto prevents the change from being made. In either the R-T-C or C-T-R <http://www.apache.org/foundation/glossary.html#CommitThenReview> environments, a veto applied to a change that has already been made forces it to be reverted. Vetos may not be overridden nor voted down, and only cease to apply when the committer who issued the veto withdraws it. All vetos /must/ be accompanied by a valid technical justification; a veto without such a justification is invalid. Vetos only apply to code changes; they do not apply to procedural issues such as software releases.