Bug 332451 - Javadoc cleanup in SearchEngine#createJavaSearchScope(IJavaElement[], int)
Summary: Javadoc cleanup in SearchEngine#createJavaSearchScope(IJavaElement[], int)
Status: VERIFIED FIXED
Alias: None
Product: JDT
Classification: Eclipse Project
Component: Core (show other bugs)
Version: 3.7   Edit
Hardware: PC Windows 7
: P3 trivial (vote)
Target Milestone: 3.7 M5   Edit
Assignee: Olivier Thomann CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2010-12-13 11:31 EST by Markus Keller CLA
Modified: 2011-01-25 08:21 EST (History)
2 users (show)

See Also:

Attachments
Proposed fix (5.44 KB, patch)
2010-12-16 09:25 EST, Olivier Thomann CLA 		no flags Details | Diff
Fix 2 (1.07 KB, patch)
2010-12-16 10:47 EST, Markus Keller CLA 		no flags Details | Diff
View All 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 2010-12-13 11:31:38 EST 
HEAD

Javadoc of SearchEngine#createJavaSearchScope(IJavaElement[], int) needs some cleanup:
- formatting needs to be HTML
- should reference {@link IJavaSearchScope#SYSTEM_LIBRARIES} here:
	 * - its system libraries (internal and external jars, class folders that are coming from an
	 *   IClasspathContainer with the K_SYSTEM kind)
	 *   if IJavaSearchScope.APPLICATION_LIBRARIES is specified

The other createJavaSearchScope(..) methods would also be easier to read with a few more <p>s or <br>s.
Comment 1 Olivier Thomann CLA 2010-12-16 09:25:07 EST 
Created attachment 185321 [details]
Proposed fix
Comment 2 Olivier Thomann CLA 2010-12-16 09:25:45 EST 
Released for 3.7M5.
Markus, let me know if this is what you wanted. It looks at least much better now.
Comment 3 Markus Keller CLA 2010-12-16 10:47:28 EST 
Created attachment 185331 [details]
Fix 2

Formatting looks good, but the wrong reference to APPLICATION_LIBRARIES is still there.
Comment 4 Markus Keller CLA 2010-12-16 10:47:45 EST 
.
Comment 5 Olivier Thomann CLA 2010-12-16 10:52:38 EST 
Released. Thx. I misunderstood your comment 0.
Comment 6 Ayushman Jain CLA 2011-01-25 08:21:41 EST 
Verified for 3.7M5 using code inspection.