Bug 226280 - [apidoc][WinCE] Provide better javadoc for org.eclipse.tm.rapi.*
Summary: [apidoc][WinCE] Provide better javadoc for org.eclipse.tm.rapi.*
Status: RESOLVED FIXED
Alias: None
Product: Target Management
Classification: Tools
Component: Core (show other bugs)
Version: 3.0   Edit
Hardware: PC Windows CE
: P3 enhancement (vote)
Target Milestone: 3.0 M7   Edit
Assignee: Radoslav Gerganov CLA
QA Contact: Martin Oberhuber CLA
URL:
Whiteboard:
Keywords: api, contributed, Documentation, helpwanted
Depends on:
Blocks:
 
Reported: 2008-04-09 09:32 EDT by Radoslav Gerganov CLA
Modified: 2011-05-25 07:24 EDT (History)
0 users

See Also:

Attachments
javadoc enhanced, api tooling used (5.85 KB, patch)
2008-04-09 11:13 EDT, Radoslav Gerganov CLA 		mober.at+eclipse: 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 Radoslav Gerganov CLA 2008-04-09 09:32:25 EDT 
Provide better javadocs for the public APIs in org.eclipse.tm.rapi and take advantage of the new API tooling (@noextend, @noimplement, etc.)
Comment 1 Radoslav Gerganov CLA 2008-04-09 11:13:36 EDT 
Created attachment 95377 [details]
javadoc enhanced, api tooling used

* @noextend annotations added where is appropriate
* Rapi#CreateRapiDesktop and Rapi#ReleaseIUnknown documented
* Rapi#initialize() and Rapi#uninitialize() added to encapsulate CoInitialize/CoUnitialize. We should think about the signature of these functions, on other platforms we may need more arguments.

(I will make CoInit/CoUnit private once we agree how to wrap them)
Comment 2 Martin Oberhuber CLA 2008-04-09 21:30:59 EDT 
Patch applied (25 LOC) with following modifications:

* Add @noinstantiate to final class Rapi
* Replace <code> by </code> in Javadoc of (un)initialize()

[226280][apidoc][wince] Provide better javadoc for org.eclipse.tm.rapi.*

This bug is not yet fixed with this contribution, since the new init() / uninit() methods are not yet used by the exemplary tools, and the CoInitializeEx is not yet private.
Comment 3 Radoslav Gerganov CLA 2008-05-07 06:36:38 EDT 
The new initialize() and uninitialize() methods are used now, native CoInit/CoUninit are private. Marking as fixed.