Menu

#142 Lost class comment

closed-fixed
None
1
2002-11-13
2002-08-30
No

Here is a simple test class to demonstrate the problem:

/**
* A valid, handwritten class comment
*/
// @see thie comment will cause Jalopy to replace the
one above
public class JalopyTest{

}

When Jalopy is run with comment generation turned on,
the comments will be replaced, resulting in this:

/**
* DOCUMENT ME!
*
* @version $Revision: 1.1 $
* @author $author$
*/
public class JalopyTest {
}

It's the line beginning with "// @see" that causes the
problem. Remove that & the handwritten comment will be
left alone.

I found this after running Jalopy on an EJB that had
XDoclet tags in it. I wanted to temporarily remove an
XDoclet tag so I moved it into a // comment. XDoclet &
javadoc both correctly ignored it after that.

-Steve

Discussion

  • Marco Hunsicker

    Marco Hunsicker - 2002-09-03

    Logged In: YES
    user_id=44430

    Fix will appear with the next release (Working CVS repository
    should be online in a week or so).

    Thanks.

     
  • Marco Hunsicker

    Marco Hunsicker - 2002-09-03
    • priority: 5 --> 1
    • assigned_to: nobody --> marcohu
    • status: open --> open-fixed
     
  • Yanker

    Yanker - 2002-11-01

    Logged In: YES
    user_id=495393

    Please note, that a JavaDoc comment must immediately precede
    the class that it describes. Blank lines (and // comments)
    between the class declaration and the JavaDoc comment are
    not allowed. This also applies to methods and variables of
    course.

    Odi

     
  • Marco Hunsicker

    Marco Hunsicker - 2002-11-13
    • status: open-fixed --> closed-fixed
     

Log in to post a comment.