Bug 195945 - [spec] Javadoc of ICompilationUnit should explain working copies
Summary: [spec] Javadoc of ICompilationUnit should explain working copies
Status: NEW
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.3   Edit
Hardware: PC Windows XP
: P3 enhancement (vote)
Target Milestone: ---   Edit
Assignee: JDT-Core-Inbox CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2007-07-10 03:06 EDT by Markus Keller CLA
Modified: 2009-11-12 08:52 EST (History)
1 user (show)

See Also:

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 Markus Keller CLA 2007-07-10 03:06:30 EDT 
HEAD

Bug 195361 revealed that the Javadoc of ICompilationUnit.getOwner() does not explain that "no owner" means the primary owner.

Furthermore, I think the explanation of working copies in the Javadoc of IWorkingCopy should be copied to ICompilationUnit. This is still valuable information, but is easy to miss since IWorkingCopy is deprecated.
Comment 1 Mik Kersten CLA 2007-07-10 12:11:15 EDT 
This would indeed be helpful.  Just fyi, when fixing bug 195361 I was also wondering if it would make more sense to never have it null and in stead to have a static/singleton/immutable working copy that always answered true to isPrimary() since that would make the API and client code more explicit.  But I assume that this would be too big a change.
Comment 2 Markus Keller CLA 2009-11-12 08:52:44 EST 
> ... Javadoc of ICompilationUnit.getOwner() does not
> explain that "no owner" means the primary owner.

This has been fixed with bug 293711.

> Furthermore, I think the explanation of working copies in the Javadoc of
> IWorkingCopy should be copied to ICompilationUnit. This is still valuable
> information, but is easy to miss since IWorkingCopy is deprecated.

Still holds.