From c9b5434d75aebbe44b965c645214b98141126c37 Mon Sep 17 00:00:00 2001
From: "honfika@gmail.com" <honfika@gmail.com>
Date: Tue, 7 Apr 2015 14:04:11 +0200
Subject: [PATCH] javadoc comment fixes

---
 src/com/sun/jna/platform/win32/Advapi32.java  | 22 ++++++------
 src/com/sun/jna/platform/win32/Gdi32.java     |  2 +-
 src/com/sun/jna/platform/win32/Shell32.java   |  2 +-
 src/com/sun/jna/platform/win32/User32.java    | 34 ++++++-------------
 src/com/sun/jna/platform/win32/W32Errors.java |  2 +-
 src/com/sun/jna/platform/win32/WinNT.java     | 10 +++---
 src/com/sun/jna/platform/win32/WinUser.java   |  6 ++--
 7 files changed, 32 insertions(+), 46 deletions(-)

diff --git a/src/com/sun/jna/platform/win32/Advapi32.java b/src/com/sun/jna/platform/win32/Advapi32.java
index 9d6681537..09497c2db 100644
--- a/src/com/sun/jna/platform/win32/Advapi32.java
+++ b/src/com/sun/jna/platform/win32/Advapi32.java
@@ -396,15 +396,15 @@ public interface Advapi32 extends StdCallLibrary {
 
     /**
      *
-     * @param hKey
-     * @param lpSubKey
-     * @param Reserved
-     * @param lpClass
-     * @param dwOptions
-     * @param samDesired
-     * @param lpSecurityAttributes
-     * @param phkResult
-     * @param lpdwDisposition
+     * @param hKey hKey
+     * @param lpSubKey lpSubKey
+     * @param Reserved Reserved
+     * @param lpClass lpClass
+     * @param dwOptions dwOptions
+     * @param samDesired samDesired
+     * @param lpSecurityAttributes lpSecurityAttributes
+     * @param phkResult phkResult
+     * @param lpdwDisposition lpdwDisposition
      * @return If the function succeeds, the return value is ERROR_SUCCESS. If
      * the function fails, the return value is a nonzero error code defined in
      * Winerror.h.
@@ -415,8 +415,8 @@ public interface Advapi32 extends StdCallLibrary {
 
     /**
      *
-     * @param hKey
-     * @param name
+     * @param hKey hKey
+     * @param name name
      * @return If the function succeeds, the return value is ERROR_SUCCESS. If
      * the function fails, the return value is a nonzero error code defined in
      * Winerror.h.
diff --git a/src/com/sun/jna/platform/win32/Gdi32.java b/src/com/sun/jna/platform/win32/Gdi32.java
index 88756dfc2..eed0925ba 100644
--- a/src/com/sun/jna/platform/win32/Gdi32.java
+++ b/src/com/sun/jna/platform/win32/Gdi32.java
@@ -320,7 +320,7 @@ public interface Gdi32 extends StdCallLibrary {
      * the desired format for the DIB data.
      * @param uUsage The format of the bmiColors member of the {@link
      * BITMAPINFO} structure.
-     * @return
+     * @return the number of scan lines copied from the bitmap
      */
     int GetDIBits(HDC hdc, HBITMAP hbmp, int uStartScan, int cScanLines, Pointer lpvBits, BITMAPINFO lpbi, int uUsage);
 
diff --git a/src/com/sun/jna/platform/win32/Shell32.java b/src/com/sun/jna/platform/win32/Shell32.java
index 227449f7b..b818b8790 100644
--- a/src/com/sun/jna/platform/win32/Shell32.java
+++ b/src/com/sun/jna/platform/win32/Shell32.java
@@ -28,7 +28,7 @@ public interface Shell32 extends StdCallLibrary {
             W32APIOptions.UNICODE_OPTIONS);
 
     /**
-     * @param lpExecInfo
+     * @param lpExecInfo lpExecInfo
      * @return true if successful. Otherwise false.
      */
     boolean ShellExecuteEx(SHELLEXECUTEINFO lpExecInfo);
diff --git a/src/com/sun/jna/platform/win32/User32.java b/src/com/sun/jna/platform/win32/User32.java
index 0efe231d4..b929d6e7e 100644
--- a/src/com/sun/jna/platform/win32/User32.java
+++ b/src/com/sun/jna/platform/win32/User32.java
@@ -967,24 +967,10 @@ public interface User32 extends StdCallLibrary, WinUser {
      *
      * @return The following table shows the possible return values for this
      * function.
-     * <table>
-     * <tr>
-     * <th>Return code/value</th>
-     * <th>Description</th>
-     * </tr>
-     * <tr>
-     * <td>0</td>
-     * <td>The wait was satisfied successfully.</td>
-     * </tr>
-     * <tr>
-     * <td>WAIT_TIMEOUT</td>
-     * <td>The wait was terminated because the time-out interval elapsed.</td>
-     * </tr>
-     * <tr>
-     * <td>WAIT_FAILED</td>
-     * <td>An error occurred.</td>
-     * </tr>
-     * </table>
+     * Return code: Description
+     * 0: The wait was satisfied successfully.
+     * WAIT_TIMEOUT: The wait was terminated because the time-out interval elapsed.
+     * WAIT_FAILED: An error occurred.
      */
     DWORD WaitForInputIdle(HANDLE hProcess, DWORD dwMilliseconds);
 
@@ -1112,14 +1098,14 @@ public interface User32 extends StdCallLibrary, WinUser {
      * If the function fails, the return value is zero. To get extended error
      * information, call {@link Kernel32#GetLastError}.
      * {@link WinUser#WM_HOTKEY} messages generated by the hot key
-     * {@link WinUser#WM_HOTKEY} message.<br/>
+     * {@link WinUser#WM_HOTKEY} message.
      * A combination of the following values
      * <ul>
      * <li>{@link WinUser#MOD_ALT} Either ALT key must be held down.</li>
      * <li>{@link WinUser#MOD_CONTROL} Either CTRL key must be held down.</li>
      * <li>{@link WinUser#MOD_NOREPEAT} Changes the hotkey behavior so that the
      * keyboard auto-repeat does not yield multiple hotkey notifications.
-     * <b><br/>
+     * <b>
      * Windows Vista and Windows XP/2000: This flag is not supported.</b></li>
      * <li>{@link WinUser#MOD_SHIFT} Either SHIFT key must be held down.
      * </li>
@@ -1329,10 +1315,10 @@ public interface User32 extends StdCallLibrary, WinUser {
      * information, call GetLastError.
      *
      * This function typically fails for one of the following reasons:
-     * <p/>
-     * - an invalid parameter value<p/>
-     * - the system class was registered by a different module<p/>
-     * - The WH_CBT hook is installed and returns a failure code<p/>
+     * 
+     * - an invalid parameter value
+     * - the system class was registered by a different module
+     * - The WH_CBT hook is installed and returns a failure code
      * - if one of the controls in the dialog template is not registered, or its
      * window window procedure fails WM_CREATE or WM_NCCREATE
      */
diff --git a/src/com/sun/jna/platform/win32/W32Errors.java b/src/com/sun/jna/platform/win32/W32Errors.java
index be77b5d6b..d3716152e 100644
--- a/src/com/sun/jna/platform/win32/W32Errors.java
+++ b/src/com/sun/jna/platform/win32/W32Errors.java
@@ -169,7 +169,7 @@ public abstract class W32Errors implements WinError {
     /**
      * FACILITY_USERMODE_FILTER_MANAGER
      *
-     * Translation macro for converting: NTSTATUS --> HRESULT.
+     * Translation macro for converting: NTSTATUS --&gt; HRESULT.
      *
      * @param x the x
      * @return the int
diff --git a/src/com/sun/jna/platform/win32/WinNT.java b/src/com/sun/jna/platform/win32/WinNT.java
index 0b1079914..fa7e888be 100644
--- a/src/com/sun/jna/platform/win32/WinNT.java
+++ b/src/com/sun/jna/platform/win32/WinNT.java
@@ -349,7 +349,7 @@ public interface WinNT extends WinError, WinDef, WinBase, BaseTSD {
         /**
          * Initialize a TOKEN_PRIVILEGES instance from initialized memory.
          *
-         * @param p
+         * @param p p
          */
         public TOKEN_PRIVILEGES(Pointer p) {
             super(p);
@@ -675,7 +675,7 @@ public interface WinNT extends WinError, WinDef, WinBase, BaseTSD {
          * WARNING: this filename may be either the short or long form of the
          * filename.
          *
-         * @return
+         * @return result
          */
         public String getFilename() {
             return new String(FileName, 0, FileNameLength / 2);
@@ -1033,9 +1033,9 @@ public interface WinNT extends WinError, WinDef, WinBase, BaseTSD {
         /**
          * Override to the appropriate object for INVALID_HANDLE_VALUE.
          *
-         * @param nativeValue
-         * @param context
-         * @return
+         * @param nativeValue nativeValue
+         * @param context context
+         * @return result
          */
         @Override
         public Object fromNative(Object nativeValue, FromNativeContext context) {
diff --git a/src/com/sun/jna/platform/win32/WinUser.java b/src/com/sun/jna/platform/win32/WinUser.java
index 5344d9c45..36b22ed2c 100644
--- a/src/com/sun/jna/platform/win32/WinUser.java
+++ b/src/com/sun/jna/platform/win32/WinUser.java
@@ -268,9 +268,9 @@ public interface WinUser extends StdCallLibrary, WinDef {
         /**
          * Return whether to continue enumeration.
          *
-         * @param hWnd
-         * @param data
-         * @return
+         * @param hWnd hWnd
+         * @param data data
+         * @return result
          */
         boolean callback(HWND hWnd, Pointer data);
     }