Some Eclipse Foundation services are deprecated, or will be soon. Please ensure you've read this important communication.
Bug 272021 - [preferences] Javadoc the PDEPreferencesManager
Summary: [preferences] Javadoc the PDEPreferencesManager
Status: VERIFIED FIXED
Alias: None
Product: PDE
Classification: Eclipse Project
Component: UI (show other bugs)
Version: 3.5   Edit
Hardware: PC Linux
: P3 normal (vote)
Target Milestone: 3.5 RC1   Edit
Assignee: Ankur Sharma CLA
QA Contact:
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2009-04-13 11:06 EDT by Curtis Windatt CLA
Modified: 2009-06-01 11:40 EDT (History)
1 user (show)

See Also:

Attachments
Patch (12.14 KB, patch)
2009-05-06 06:25 EDT, Ankur Sharma CLA 		john.arthorne: iplog+
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 Curtis Windatt CLA 2009-04-13 11:06:15 EDT 
The new preferences manager in PDE aims to streamline the usage of preferences in PDE (bug 264394).  Unfortunately, even though it is now used throughout the platform it is not documented properly.  New classes, especially those used throughout the component, should have javadoc to ensure they are used correctly.
Comment 1 Curtis Windatt CLA 2009-04-13 11:10:48 EDT 
Ankur, please find some time during 3.5 to fix this (it can wait until RC1).  The javadoc should specify any inputs/return values that can be null, or must not be null.  The overall class description should explain its purpose and have '@see' entries linking it to the tests.
Comment 2 Chris Aniszczyk CLA 2009-05-05 08:17:41 EDT 
ping Ankur ;)
Comment 3 Ankur Sharma CLA 2009-05-06 06:25:30 EDT 
Created attachment 134601 [details]
Patch

Javadoc added
Comment 4 Darin Wright CLA 2009-05-06 11:19:41 EDT 
Applied. Only javadoc changes to internal code.
Comment 5 Darin Wright CLA 2009-05-06 11:20:24 EDT 
Don't need additional review for comment changes in internal code.
Comment 6 John Arthorne CLA 2009-06-01 11:40:38 EDT 
Moved iplog+ flag from bug to patch.