Re: [MINA 3] IoBuffer
On Sat, Nov 26, 2011 at 1:39 AM, Emmanuel Lecharny elecha...@gmail.comwrote: Hi guys, Hi Emmanuel, Feel free to comment... ...here we go! Using the 2 MINA IoBuffer is difficult for us because the documentation of it is too hard to reach. JavaDoc's like @see # xy ByteBuffer (..) only makes sense if the IDE displays the linked API docu immediately, otherwise it's far from fun. I think the most of us don't like to lookup the ByteBuffer docu, we want it first hand! We look into the JavaDoc because we need it, just in this moment. So what is more expressive: /** * @see Buffer#hasRemaining() */ vs. /** * Tells whether there are any elements between the current position and the limit. * * @returns true if, and only if, there is at least one element remaining in this buffer */ WDYT? Best regards Christian
Re: [MINA 3] IoBuffer
...one more thing, the sun.reflect.generics.reflectiveObjects.NotImplementedException's should be replaced by java.lang.UnsupportedOperationException's. My IDE refuse the compilation because the NotImplementedException is not public API (access restriction). On Sun, Nov 27, 2011 at 10:05 PM, Christian Schwarz chriss@googlemail.com wrote: On Sat, Nov 26, 2011 at 1:39 AM, Emmanuel Lecharny elecha...@gmail.comwrote: Hi guys, Hi Emmanuel, Feel free to comment... ...here we go! Using the 2 MINA IoBuffer is difficult for us because the documentation of it is too hard to reach. JavaDoc's like @see # xy ByteBuffer (..) only makes sense if the IDE displays the linked API docu immediately, otherwise it's far from fun. I think the most of us don't like to lookup the ByteBuffer docu, we want it first hand! We look into the JavaDoc because we need it, just in this moment. So what is more expressive: /** * @see Buffer#hasRemaining() */ vs. /** * Tells whether there are any elements between the current position and the limit. * * @returns true if, and only if, there is at least one element remaining in this buffer */ WDYT? Best regards Christian
Re: [MINA 3] IoBuffer
On 11/27/11 10:05 PM, Christian Schwarz wrote: On Sat, Nov 26, 2011 at 1:39 AM, Emmanuel Lecharnyelecha...@gmail.comwrote: Hi guys, Hi Emmanuel, Feel free to comment... ...here we go! Using the 2 MINA IoBuffer is difficult for us because the documentation of it is too hard to reach. JavaDoc's like @see # xy ByteBuffer (..) only makes sense if the IDE displays the linked API docu immediately, otherwise it's far from fun. I think the most of us don't like to lookup the ByteBuffer docu, we want it first hand! We look into the JavaDoc because we need it, just in this moment. So what is more expressive: /** * @see Buffer#hasRemaining() */ vs. /** * Tells whether there are any elements between the current position and the limit. * * @returns true if, and only if, there is at least one element remaining in this buffer */ WDYT? I agree. What made me use the @see tag is that it was fast and easy. I do think that it would be better to include some documentation associated to this @see tag. The main issue is that we *must* not copy the original doco (which is copyaighted). -- Regards, Cordialement, Emmanuel Lécharny www.iktek.com
Re: [MINA 3] IoBuffer
On 11/27/11 10:18 PM, Christian Schwarz wrote: ...one more thing, the sun.reflect.generics.reflectiveObjects.NotImplementedException's should be replaced by java.lang.UnsupportedOperationException's. My IDE refuse the compilation because the NotImplementedException is not public API (access restriction). Right ! Btw, I will implement the missing code soon, so it's just a placeholder atm. -- Regards, Cordialement, Emmanuel Lécharny www.iktek.com
