 | Start a set with this search |
 | Include this search in one of my sets |
 | Exclude this search from one of my sets |
 | Permalink to these results Paste this link in email or IM: |
 | Atom feed for tracking future search results Paste this URL into your reader: |
43 messages in org.apache.mina.devRe: svn commit: r659372 - /mina/branc...| From | Sent On | Attachments |
|---|---|---|
| Emmanuel Lecharny | May 22, 2008 7:40 pm | |
| 이희승 (Trustin Lee) | May 22, 2008 7:46 pm | |
| Emmanuel Lecharny | May 22, 2008 8:02 pm | |
| 이희승 (Trustin Lee) | May 22, 2008 8:14 pm | |
| Emmanuel Lecharny | May 22, 2008 8:21 pm | |
| Emmanuel Lecharny | May 22, 2008 8:24 pm | |
| 이희승 (Trustin Lee) | May 22, 2008 8:30 pm | |
| Emmanuel Lecharny | May 22, 2008 8:43 pm | |
| 이희승 (Trustin Lee) | May 22, 2008 8:48 pm | |
| Mike Heath | May 22, 2008 9:52 pm | |
| 이희승 (Trustin Lee) | May 22, 2008 9:59 pm | |
| 이희승 (Trustin Lee) | May 22, 2008 10:20 pm | |
| Emmanuel Lecharny | May 22, 2008 10:31 pm | |
| 이희승 (Trustin Lee) | May 22, 2008 10:35 pm | |
| Mike Heath | May 22, 2008 10:44 pm | |
| Rich Dougherty | May 22, 2008 11:24 pm | |
| Julien Vermillard | May 22, 2008 11:37 pm | |
| 이희승 (Trustin Lee) | May 22, 2008 11:44 pm | |
| Julien Vermillard | May 23, 2008 12:13 am | |
| 이희승 (Trustin Lee) | May 23, 2008 12:39 am | |
| Michael Qi | May 23, 2008 12:46 am | |
| Stefano Bagnara | May 23, 2008 1:09 am | |
| Stefano Bagnara | May 23, 2008 1:17 am | |
| Julien Vermillard | May 23, 2008 1:21 am | |
| Brad Harvey | May 23, 2008 1:45 am | |
| Mark Webb | May 23, 2008 6:09 am | |
| Brad Harvey | May 23, 2008 6:31 am | |
| Niklas Therning | May 23, 2008 6:54 am | |
| Alex Karasulu | May 23, 2008 7:30 am | |
| Emmanuel Lecharny | May 23, 2008 7:50 am | |
| Emmanuel Lecharny | May 23, 2008 8:07 am | |
| Julien Vermillard | May 23, 2008 8:44 am | |
| Stefano Bagnara | May 23, 2008 10:03 am | |
| Alex Karasulu | May 23, 2008 10:14 am | |
| Mark Webb | May 23, 2008 10:16 am | |
| Stefano Bagnara | May 23, 2008 10:26 am | |
| Stefano Bagnara | May 23, 2008 10:28 am | |
| Emmanuel Lecharny | May 23, 2008 10:40 am | |
| Mark Webb | May 23, 2008 1:43 pm | |
| Emmanuel Lecharny | May 23, 2008 2:23 pm | |
| jver...@archean.fr | May 24, 2008 11:07 pm | |
| Frédéric Brégier | May 24, 2008 11:26 pm | |
| Emmanuel Lecharny | May 25, 2008 4:00 am |
| Permalink for this message Paste this link in email or IM: |
| Permalink for this thread 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.java | Actions... |
|---|---|---|
| From: | Mike Heath (mhe...@apache.org) | |
| Date: | May 22, 2008 9:52:26 pm | |
| List: | org.apache.mina.dev | |
Emmanuel Lecharny 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 think @see is the wrong approach for this situation. We should use @inheritedDoc instead of @see. With @see you get no useful information if your IDE supports in-editor popup docs. You also have to make an extra click to get to useful information when browsing the JavaDocs which is almost as annoying as empty docs.
Also with @inheritedDoc you can see immediately in the code that there are JavaDocs for the method.
IMO using @inheritedDoc instead of empty JavaDocs should be the standard practice in any Java project.
-Mike