Bug 286608 - [Doc] Polishing ModelProvider javadoc
Summary: [Doc] Polishing ModelProvider javadoc
Status: RESOLVED FIXED
Alias: None
Product: Platform
Classification: Eclipse Project
Component: Resources (show other bugs)
Version: 3.6   Edit
Hardware: PC Windows XP
: P3 trivial (vote)
Target Milestone: 3.6 M2   Edit
Assignee: Tomasz Zarna CLA
QA Contact:
URL:
Whiteboard: hasPatch
Keywords: Documentation
Depends on:
Blocks:
 
Reported: 2009-08-14 05:27 EDT by Tomasz Zarna CLA
Modified: 2009-08-17 03:41 EDT (History)
2 users (show)

See Also:


Attachments
Fix v01 (1.81 KB, patch)
2009-08-14 05:28 EDT, Tomasz Zarna CLA
no flags Details | Diff

Note You need to log in before you can comment on or make changes to this bug.
Description Tomasz Zarna CLA 2009-08-14 05:27:50 EDT
While I was reading javadoc for ModelProvider.java I found a few places that can be polished.
Comment 1 Tomasz Zarna CLA 2009-08-14 05:28:52 EDT
Created attachment 144515 [details]
Fix v01

Szymon could you take a look at the patch and let me know if the changes make sense to you?
Comment 2 Szymon Brandys CLA 2009-08-14 05:38:22 EDT
Makes sense :-)
Comment 3 John Arthorne CLA 2009-08-14 10:50:04 EDT
Looks good, I released to HEAD. The addition of @noreference to ModelProvider.init will be flagged as an API change. Olivier, do we need to do anything other than adding an API filter in our plugin? In this case the javadoc of the method already had this text:

  "This method should not be called by clients and cannot be overridden by   
  subclasses."

However, when we switched over to API tooling we missed this and never added the @noreference tag.
Comment 4 Szymon Brandys CLA 2009-08-17 03:41:58 EDT
(In reply to comment #3)
> Looks good, I released to HEAD. The addition of @noreference to
> ModelProvider.init will be flagged as an API change. Olivier, do we need to do
> anything other than adding an API filter in our plugin? In this case the
> javadoc of the method already had this text:

We had similar issues earlier in the compare. API filter was enough and no more actions were required.