Attachment 95377 Details for Bug 226280 – javadoc enhanced, api tooling used

[patch] javadoc enhanced, api tooling used

RapiJavadoc.txt (text/plain), 5.85 KB, created by Radoslav Gerganov

on 2008-04-09 11:13:36 EDT

(hide)

Description:

Filename:

MIME Type:

Creator: Radoslav Gerganov

Created: 2008-04-09 11:13:36 EDT

Size: 5.85 KB

patch

obsolete

>### Eclipse Workspace Patch 1.0
>#P org.eclipse.tm.rapi
>Index: src/org/eclipse/tm/rapi/IRapiSession.java
>===================================================================
>RCS file: /cvsroot/dsdp/org.eclipse.tm.core/wince/org.eclipse.tm.rapi/src/org/eclipse/tm/rapi/IRapiSession.java,v
>retrieving revision 1.4
>diff -u -r1.4 IRapiSession.java
>--- src/org/eclipse/tm/rapi/IRapiSession.java	9 Apr 2008 12:55:27 -0000	1.4
>+++ src/org/eclipse/tm/rapi/IRapiSession.java	9 Apr 2008 15:02:10 -0000
>@@ -14,6 +14,7 @@
>  * 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 {
>Index: src/org/eclipse/tm/rapi/IUnknown.java
>===================================================================
>RCS file: /cvsroot/dsdp/org.eclipse.tm.core/wince/org.eclipse.tm.rapi/src/org/eclipse/tm/rapi/IUnknown.java,v
>retrieving revision 1.2
>diff -u -r1.2 IUnknown.java
>--- src/org/eclipse/tm/rapi/IUnknown.java	9 Apr 2008 12:55:27 -0000	1.2
>+++ src/org/eclipse/tm/rapi/IUnknown.java	9 Apr 2008 15:02:10 -0000
>@@ -13,6 +13,7 @@
> /**
>  * 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 {
>Index: src/org/eclipse/tm/rapi/IRapiDevice.java
>===================================================================
>RCS file: /cvsroot/dsdp/org.eclipse.tm.core/wince/org.eclipse.tm.rapi/src/org/eclipse/tm/rapi/IRapiDevice.java,v
>retrieving revision 1.1
>diff -u -r1.1 IRapiDevice.java
>--- src/org/eclipse/tm/rapi/IRapiDevice.java	27 Mar 2008 19:50:25 -0000	1.1
>+++ src/org/eclipse/tm/rapi/IRapiDevice.java	9 Apr 2008 15:02:10 -0000
>@@ -13,6 +13,7 @@
> /**
>  * 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 {
>Index: src/org/eclipse/tm/rapi/IRapiDesktop.java
>===================================================================
>RCS file: /cvsroot/dsdp/org.eclipse.tm.core/wince/org.eclipse.tm.rapi/src/org/eclipse/tm/rapi/IRapiDesktop.java,v
>retrieving revision 1.3
>diff -u -r1.3 IRapiDesktop.java
>--- src/org/eclipse/tm/rapi/IRapiDesktop.java	9 Apr 2008 12:55:27 -0000	1.3
>+++ src/org/eclipse/tm/rapi/IRapiDesktop.java	9 Apr 2008 15:02:10 -0000
>@@ -14,8 +14,9 @@
> 
> /**
>  * 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 {
>Index: src/org/eclipse/tm/rapi/IRapiEnumDevices.java
>===================================================================
>RCS file: /cvsroot/dsdp/org.eclipse.tm.core/wince/org.eclipse.tm.rapi/src/org/eclipse/tm/rapi/IRapiEnumDevices.java,v
>retrieving revision 1.1
>diff -u -r1.1 IRapiEnumDevices.java
>--- src/org/eclipse/tm/rapi/IRapiEnumDevices.java	27 Mar 2008 19:50:25 -0000	1.1
>+++ src/org/eclipse/tm/rapi/IRapiEnumDevices.java	9 Apr 2008 15:02:10 -0000
>@@ -15,6 +15,7 @@
>  * 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 {
>Index: src/org/eclipse/tm/rapi/Rapi.java
>===================================================================
>RCS file: /cvsroot/dsdp/org.eclipse.tm.core/wince/org.eclipse.tm.rapi/src/org/eclipse/tm/rapi/Rapi.java,v
>retrieving revision 1.1
>diff -u -r1.1 Rapi.java
>--- src/org/eclipse/tm/rapi/Rapi.java	9 Apr 2008 12:55:27 -0000	1.1
>+++ src/org/eclipse/tm/rapi/Rapi.java	9 Apr 2008 15:02:10 -0000
>@@ -80,6 +80,26 @@
>   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.
>    */
>   public static final native int CoInitializeEx(int pvReserved, int dwCoInit);
>@@ -89,6 +109,19 @@
>    */
>   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);
> }

Flags:

mober.at+eclipse: iplog+

Actions: View | Diff

Attachments on bug 226280: 95377