

![]() | 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: | Stefano Bagnara (apa...@bago.org) | |
| Date: | May 23, 2008 10:26:24 am | |
| List: | org.apache.mina.dev | |
Emmanuel Lecharny ha scritto:
I withdraw my veto, as the missing @inheritDoc have been added to the file.
It would have been so much easier, and less noisy to simply do it without arguing, the only discussion would have been about which tag to use (I don't really like the @inheritdoc tag - and I may be wrong about that -, but at least expose to the user that the javadoc is available in an interface or upper class. We may discuss it beside this thread, and inject the result of this discussion into the MINA code best practice).
Sure. If Trustin simply did what you asked with your veto we would have a lot of @see or copy&paste comments and it would be a lot worse. I personally think that @inheritdoc is clutter when you don't need to add anything to the doc, but anyway this would have been much easier if it didn't start with a veto ;-)
IMHO a similar scenario is better solved with the committers involvement and not with a veto from a single PMC member. the community idea about the style should be collected and then followed. There could be people out there with deep knowledge of javadocs and why a given style is good or bad and it is better to discuss new solutions instead of closing in your opinions with an early veto.
In my environment the javadoc generation for a class with no javadocs implementing an interface with javadocs simply generate this:
----- Description copied from interface: #InterfaceName#
#InterfaceMethodJavadoc#
------
This also happen for extensions.
The {@inheritdoc} (at least in my environment) simply "hide" the fact that the doc is identical to the superclass/interface doc so it reduce the available informations. Furthermore if you use {@inheritdoc} you don't have the link to the superclass/interface that you would have with a @see and that is automatically added if you don't have a javadoc at all.
That said, is your complaint about the generated javadoc or the code itself?
Stefano







