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.
| Summary: | Class generic type parameter hint doesn't create proper javadoc | ||
|---|---|---|---|
| Product: | java | Reporter: | krdixon <krdixon> |
| Component: | Javadoc | Assignee: | Jan Pokorsky <jpokorsky> |
| Status: | RESOLVED FIXED | ||
| Severity: | blocker | ||
| Priority: | P3 | ||
| Version: | 6.x | ||
| Hardware: | All | ||
| OS: | All | ||
| Issue Type: | DEFECT | Exception Reporter: | |
You are right. Thanks for pointing this out. |
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