This Bugzilla instance is a read-only archive of historic NetBeans bug reports. To report a bug in NetBeans please follow the project's instructions for reporting issues.

Bug 124043 - Class generic type parameter hint doesn't create proper javadoc
Summary: Class generic type parameter hint doesn't create proper javadoc
Status: RESOLVED FIXED
Alias: None
Product: java
Classification: Unclassified
Component: Javadoc (show other bugs)
Version: 6.x
Hardware: All All
: P3 blocker with 3 votes (vote)
Assignee: Jan Pokorsky
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-12-14 17:05 UTC by krdixon
Modified: 2008-03-25 19:10 UTC (History)
0 users

See Also:
Issue Type: DEFECT
Exception Reporter:


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description krdixon 2007-12-14 17:05:14 UTC
If you have a class with generic type parameters, the hint doesn't create proper javadoc.  For example,

/**
* This is a description
*/
class MyClass<GenericParameter>
{
}

The hint will create javadoc that reads:

/**
* This is a description
* @param GenericParameter This won't show up in the javadoc
*/

Whereas, the correct javadoc has angle brackets <> around the parameter name:

/**
* This is a description
* @param <GenericParameter> This is proper
*/

This has the unfortunate effect of not having the documentation show up in javadoc.  Javadoc does not throw a warning
(and neither does netbeans) about it, and rather unfortunately leaves the documentation out of the pages without so much
as a wimper of protest.

You can check out the specification here:
http://java.sun.com/j2se/1.5.0/docs/guide/javadoc/doclet/transition-1.5docletapi.html
Comment 1 Jan Pokorsky 2008-01-19 19:11:04 UTC
You are right. Thanks for pointing this out.
Comment 2 Jan Pokorsky 2008-03-25 19:10:58 UTC
fixed as http://hg.netbeans.org/main/rev/fb83ea1136d9