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

wince/org.eclipse.tm.rapi/src/org/eclipse/tm/rapi/IRapiDesktop.java

@@ -14,8 +14,9 @@ import org.eclipse.tm.internal.rapi.RapiDesktop;
 
 /**
  * This class is used to find connected WinCE-based remote devices. 
- * <p> Use <code>IRapiDesktop.getInstance()</code> to obtain an instance.  
+ * <p> Use {@link IRapiDesktop#getInstance()} to obtain an instance.  
  * 
+ * @noextend This class is not intended to be subclassed by clients.
  * @author Radoslav Gerganov
  */
 public abstract class IRapiDesktop extends IUnknown {

wince/org.eclipse.tm.rapi/src/org/eclipse/tm/rapi/IRapiDevice.java

@@ -13,6 +13,7 @@ package org.eclipse.tm.rapi;
 /**
  * This class represents a connected WinCE-based remote device.
  * 
+ * @noextend This class is not intended to be subclassed by clients.
  * @author Radoslav Gerganov
  */
 public abstract class IRapiDevice extends IUnknown {

wince/org.eclipse.tm.rapi/src/org/eclipse/tm/rapi/IRapiEnumDevices.java

@@ -15,6 +15,7 @@ package org.eclipse.tm.rapi;
  * remote devices which are represented by <code>IRapiDevice</code>
  * objects. 
  * 
+ * @noextend This class is not intended to be subclassed by clients.
  * @author Radoslav Gerganov
  */
 public abstract class IRapiEnumDevices extends IUnknown {

wince/org.eclipse.tm.rapi/src/org/eclipse/tm/rapi/IRapiSession.java

@@ -14,6 +14,7 @@ package org.eclipse.tm.rapi;
  * This class is used to perform Remote API 2 operations on a connected
  * WinCE-based remote device.
  * 
+ * @noextend This class is not intended to be subclassed by clients.
  * @author Radoslav Gerganov
  */
 public abstract class IRapiSession extends IUnknown {

wince/org.eclipse.tm.rapi/src/org/eclipse/tm/rapi/IUnknown.java

@@ -13,6 +13,7 @@ package org.eclipse.tm.rapi;
 /**
  * Java wrapper for the native IUnknown interface.
  * 
+ * @noextend This class is not intended to be subclassed by clients.
  * @author Radoslav Gerganov
  */
 public abstract class IUnknown {

wince/org.eclipse.tm.rapi/src/org/eclipse/tm/rapi/Rapi.java

@@ -14,6 +14,7 @@ package org.eclipse.tm.rapi;
  * This class provides access to some native Win32 APIs and constants.
  *
  * @noextend This class is not intended to be subclassed by clients.
+ * @noinstantiate This class is not intended to be instantiated by clients.
  * @author Radoslav Gerganov
  */
 public final class Rapi {
@@ -79,6 +80,29 @@ public final class Rapi {
   public static final int COINIT_DISABLE_OLE1DDE   = 0x4;
   public static final int COINIT_SPEED_OVER_MEMORY = 0x8;
 
+  /**
+	 * Initializes the library, the clients must call this method before any
+	 * other. The meaning of the <code>init</code> parameter and the returned
+	 * value is platform dependent. On Win32 platforms this method is directly
+	 * mapped to <code>CoInitializeEx</code>.
+	 *
+	 * @param init on Win32 it is either {@link Rapi#COINIT_APARTMENTTHREADED}
+	 *            or {@link Rapi#COINIT_MULTITHREADED}
+	 * @return on Win32 this is the returned value from
+	 *         <code>CoInitializeEx</code>
+	 */
+  public static final int initialize(int init) {
+  	return CoInitializeEx(0, init);
+  }
+
+  /**
+   * Uninitializes the library, the clients must call this method last to free any allocated resources.
+   * This method is platform dependent, on Win32 it is directly mapped to <code>CoUninitialize</code>.
+   */
+  public static final void uninitialize() {
+  	CoUninitialize();
+  }
+
   /**
    * Initializes the COM library.
    */
@@ -89,6 +113,19 @@ public final class Rapi {
    */
   public static final native void CoUninitialize();
 
+  /**
+   * Sets the first element of the specified array with the address of a newly
+   * instantiated <code>IRAPIDesktop</code> native interface.
+   * @param pIRAPIDesktop an array with one element
+   * @return {@link Rapi#NOERROR} if the function succeeds; otherwise an error code
+   */
   final static native int CreateRapiDesktop(int[] pIRAPIDesktop);
+
+
+  /**
+   * Invokes the <code>Release</code> method of the <code>IUnkonwn</code> object
+   * having the specified address.
+   * @param addr the address of the <code>IUnknown</code> object
+   */
   final static native void ReleaseIUnknown(int addr);
 }