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 202106 - JavaDoc for "supersedes" in ServiceProvider annotation
Summary: JavaDoc for "supersedes" in ServiceProvider annotation
Status: VERIFIED FIXED
Alias: None
Product: platform
Classification: Unclassified
Component: Lookup (show other bugs)
Version: 7.1
Hardware: PC Other
: P4 normal (vote)
Assignee: Jaroslav Havlin
URL:
Keywords:
Depends on:
Blocks:
 
Reported: 2011-09-14 09:24 UTC by Jaroslav Havlin
Modified: 2011-09-16 07:16 UTC (History)
1 user (show)

See Also:
Issue Type: ENHANCEMENT
Exception Reporter:

Attachments
Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Jaroslav Havlin 2011-09-14 09:24:00 UTC 
Please, add a hint to JavaDoc for ServiceProvider annotation.

Mention that "fully-qualified class name" for "supersedes" element should contain dollar signs ($) before inner class names.

For example:

"org.netbeans.modules.openfile.FileChooser.JavaFilesFilter" - wrong
"org.netbeans.modules.openfile.FileChooser$JavaFilesFilter" - correct

See bug 201373.
Comment 1 Jaroslav Tulach 2011-09-15 08:41:50 UTC 
Would not it be easier to integrate the change directly into Hg than report a bug?
Comment 2 Jaroslav Havlin 2011-09-15 08:46:19 UTC 
Sure, it would be easier.
Sorry, I didn't want to change component that does not belong to me.
So, can I change it?
Comment 3 Jaroslav Tulach 2011-09-15 09:56:24 UTC 
Yes, you can. Thanks.
Comment 4 Jaroslav Havlin 2011-09-15 13:44:47 UTC 
core-main/rev/55cb4c3b2b4b

Thank you. Fixed.
Comment 5 Jaroslav Tulach 2011-09-16 07:16:19 UTC 
If you have clarifications or observations how certain API works, feel free to adjust the javadoc without much asking. Javadoc is the first place developers using a method/class can access from the IDE and having notes from someone who suffered with the API may help them in their own suffering.

If you are in doubt you can use <div class="nonnormative">text</div> which is rendered with blue background to signal that this is not the specification, but rather description of current implementation.

In the case of 55cb4c3b2b4b you changed the "normative" javadoc correctly.