Hi SS, OK by me. IMO Javadoc comments should be short statements of purpose. They shouldn't talk about algorithms, but should document anything unusual about parameters. For example, Object parameters are used in RenderManager methods, but it isn't documented what Objects are acceptable.
regards, Larry On 6/25/07, Sunburned Surveyor <[EMAIL PROTECTED]> wrote: > I'm currently adding Javadoc comments and anylizing methods for unit > testing in my code for OpenJUMP's pluggable rendering system. I have a > question about commits to the OpenJUMP SVN that I wanted to run by you > guys: > > Does anyone have a problem with me adding Javadoc comments to public > methods currently without javadoc comments in existing JUMP classes > that I work with? For example, the RenderingManager class has several > public methods with no Javadoc comments. > > I know I can get a little comment happy, so I thought I would ask hear > before I submit anything. I promise I will keep any new Javadoc > comments as terse as possible. :] > > The Sunburned Surveyor > > ------------------------------------------------------------------------- > This SF.net email is sponsored by DB2 Express > Download DB2 Express C - the FREE version of DB2 express and take > control of your XML. No limits. Just data. Click to get it now. > http://sourceforge.net/powerbar/db2/ > _______________________________________________ > Jump-pilot-devel mailing list > Jump-pilot-devel@lists.sourceforge.net > https://lists.sourceforge.net/lists/listinfo/jump-pilot-devel > -- http://amusingprogrammer.blogspot.com/ ------------------------------------------------------------------------- This SF.net email is sponsored by DB2 Express Download DB2 Express C - the FREE version of DB2 express and take control of your XML. No limits. Just data. Click to get it now. http://sourceforge.net/powerbar/db2/ _______________________________________________ Jump-pilot-devel mailing list Jump-pilot-devel@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/jump-pilot-devel
