Bug 226280

Summary:

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

Product:

[Tools] Target Management

Reporter:

Radoslav Gerganov <rgerganov>

Component:

Core

Assignee:

Radoslav Gerganov <rgerganov>

Status:

RESOLVED FIXED

QA Contact:

Martin Oberhuber <mober.at+eclipse>

Severity:

enhancement

Priority:

Keywords:

api, contributed, Documentation, helpwanted

Version:

3.0

Target Milestone:

3.0 M7

Hardware:

OS:

Windows CE

Whiteboard:

Attachments:

Description	Flags
javadoc enhanced, api tooling used	mober.at+eclipse: iplog+

Description Radoslav Gerganov

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

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

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

2008-05-07 06:36:38 EDT

The new initialize() and uninitialize() methods are used now, native CoInit/CoUninit are private. Marking as fixed.