Merge pull request #1368 from matthiasblaesing/fix_javadoc

Fix javadoc warnings
java-native-access · Aug 11, 2021 · fb76832 · fb76832
2 parents 453c994 + c686646
commit fb76832
Show file tree

Hide file tree

Showing 10 changed files with 22 additions and 22 deletions.
diff --git a/contrib/platform/src/com/sun/jna/platform/mac/CoreFoundation.java b/contrib/platform/src/com/sun/jna/platform/mac/CoreFoundation.java
@@ -303,7 +303,7 @@ public boolean booleanValue() {
      * <p>
      * CFArray is “toll-free bridged” with its Cocoa Foundation counterpart,
      * {@code NSArray}. Therefore, in a method where you see an {@code NSArray *}
-     * parameter, you can pass in a {@link #CFArrayRef}.
+     * parameter, you can pass in a {@code CFArrayRef} .
      */
     class CFArrayRef extends CFTypeRef {
         public CFArrayRef() {

diff --git a/contrib/platform/src/com/sun/jna/platform/mac/IOKit.java b/contrib/platform/src/com/sun/jna/platform/mac/IOKit.java
@@ -763,7 +763,7 @@ CFTypeRef IORegistryEntrySearchCFProperty(IORegistryEntry entry, String plane, C
      * @param connect
      *            An {@code io_connect_t} handle is returned on success, to be used
      *            with the IOConnectXXX APIs. It should be destroyed with
-     *            {@link IOServiceClose}.
+     *            {@link #IOServiceClose}.
      * @return A return code generated by {@code IOService::newUserClient}.
      */
     int IOServiceOpen(IOService service, int owningTask, int type, PointerByReference connect);
@@ -828,7 +828,7 @@ CFTypeRef IORegistryEntrySearchCFProperty(IORegistryEntry entry, String plane, C
      *         <p>
      *         Caller should NOT release the returned CFDictionary - it will be
      *         released as part of the {@link CFTypeRef} returned by
-     *         {@link IOPSCopyPowerSourcesInfo}.
+     *         {@link #IOPSCopyPowerSourcesInfo}.
      */
     CFDictionaryRef IOPSGetPowerSourceDescription(CFTypeRef blob, CFTypeRef ps);
 

diff --git a/contrib/platform/src/com/sun/jna/platform/mac/SystemB.java b/contrib/platform/src/com/sun/jna/platform/mac/SystemB.java
@@ -654,7 +654,7 @@ class Timezone extends Structure {
      * @param oldp
      *            A buffer to hold the information retrieved
      * @param oldlenp
-     *            Size of the buffer, a pointer to a {@link size_t} value
+     *            Size of the buffer, a pointer to a {@link com.sun.jna.platform.unix.LibCAPI.size_t} value
      * @param newp
      *            To set a new value, a buffer of information to be written. May be
      *            null if no value is to be set.
@@ -667,7 +667,7 @@ class Timezone extends Structure {
 
     /**
      * @deprecated Use
-     *             {@link #sysctl(int[], int, Pointer, Pointer, Pointer, com.sun.jna.platform.unix.LibCAPI.size_t)}
+     *             {@link #sysctl(int[], int, Pointer, com.sun.jna.platform.unix.LibCAPI.size_t.ByReference, Pointer, com.sun.jna.platform.unix.LibCAPI.size_t)}
      */
     @Deprecated
     int sysctl(int[] name, int namelen, Pointer oldp, IntByReference oldlenp, Pointer newp, int newlen);
@@ -682,7 +682,7 @@ class Timezone extends Structure {
      * @param oldp
      *            A buffer to hold the information retrieved
      * @param oldlenp
-     *            Size of the buffer, a pointer to a {@link size_t} value
+     *            Size of the buffer, a pointer to a {@link com.sun.jna.platform.unix.LibCAPI.size_t} value
      * @param newp
      *            To set a new value, a buffer of information to be written. May be
      *            null if no value is to be set.
@@ -695,7 +695,7 @@ class Timezone extends Structure {
 
     /**
      * @deprecated Use
-     *             {@link #sysctlbyname(String, Pointer, Pointer, Pointer, com.sun.jna.platform.unix.LibCAPI.size_t)}
+     *             {@link #sysctlbyname(String, Pointer, com.sun.jna.platform.unix.LibCAPI.size_t.ByReference, Pointer, com.sun.jna.platform.unix.LibCAPI.size_t)}
      */
     @Deprecated
     int sysctlbyname(String name, Pointer oldp, IntByReference oldlenp, Pointer newp, int newlen);
@@ -731,7 +731,7 @@ class Timezone extends Structure {
     int sysctlnametomib(String name, Pointer mibp, size_t.ByReference sizep);
 
     /**
-     * @deprecated Use {@link #sysctlnametomib(String, Pointer, Pointer)}
+     * @deprecated Use {@link #sysctlnametomib(String, Pointer, com.sun.jna.platform.unix.LibCAPI.size_t.ByReference)}
      */
     @Deprecated
     int sysctlnametomib(String name, Pointer mibp, IntByReference sizep);

diff --git a/contrib/platform/src/com/sun/jna/platform/win32/Advapi32Util.java b/contrib/platform/src/com/sun/jna/platform/win32/Advapi32Util.java
@@ -966,7 +966,7 @@ public static String[] registryGetStringArray(HKEY hKey, String value) {
 
     /**
      * Convert the null-delimited buffer of strings returned from registry values of
-     * type {@link WinNT.REG_MULTI_SZ} to an array of strings.
+     * type {@link WinNT#REG_MULTI_SZ} to an array of strings.
      *
      * @param data
      *            A buffer containing strings delimited by a null character, ending

diff --git a/contrib/platform/src/com/sun/jna/platform/win32/Cfgmgr32Util.java b/contrib/platform/src/com/sun/jna/platform/win32/Cfgmgr32Util.java
@@ -111,22 +111,22 @@ public static String CM_Get_Device_ID(int devInst) throws Cfgmgr32Exception {
      * @return An {@link Object} containing the specified registry property for the
      *         device.
      *         <p>
-     *         If the property is of type {@link WinNT.REG_SZ}, a
+     *         If the property is of type {@link WinNT#REG_SZ}, a
      *         {@link java.lang.String} is returned.
      *         <p>
-     *         If the property is of type {@link WinNT.REG_MULTI_SZ}, an array of
+     *         If the property is of type {@link WinNT#REG_MULTI_SZ}, an array of
      *         {@link java.lang.String} is returned.
      *         <p>
-     *         If the property is of type {@link WinNT.REG_DWORD}, an
+     *         If the property is of type {@link WinNT#REG_DWORD}, an
      *         {@link java.lang.Integer} is returned.
      *         <p>
-     *         If the property is of type {@link WinNT.REG_BINARY}, an array of
+     *         If the property is of type {@link WinNT#REG_BINARY}, an array of
      *         {@link java.lang.Byte} is returned.
      *         <p>
      *         If no value exists for this property (error
-     *         {@link Cfgmgr32.CR_NO_SUCH_VALUE}), returns {@code null}.
+     *         {@link Cfgmgr32#CR_NO_SUCH_VALUE}), returns {@code null}.
      * @throws Cfgmgr32Exception
-     *             on any errors other than {@link Cfgmgr32.CR_NO_SUCH_VALUE}
+     *             on any errors other than {@link Cfgmgr32#CR_NO_SUCH_VALUE}
      */
     public static Object CM_Get_DevNode_Registry_Property(int devInst, int ulProperty) throws Cfgmgr32Exception {
 

diff --git a/contrib/platform/src/com/sun/jna/platform/win32/Kernel32.java b/contrib/platform/src/com/sun/jna/platform/win32/Kernel32.java
@@ -2787,7 +2787,7 @@ boolean SystemTimeToTzSpecificLocalTime(TIME_ZONE_INFORMATION lpTimeZone,
 
     /**
      * @deprecated Use
-     *             {@link #CreateRemoteThread(com.sun.jna.platform.win32.WinNT.HANDLE, com.sun.jna.platform.win32.WinBase.SECURITY_ATTRIBUTES, int, com.sun.jna.Pointer, com.sun.jna.Pointer, int, com.sun.jna.platform.win32.WinDef.DWORDByReference)
+     *             {@link #CreateRemoteThread(com.sun.jna.platform.win32.WinNT.HANDLE, com.sun.jna.platform.win32.WinBase.SECURITY_ATTRIBUTES, int, com.sun.jna.Pointer, com.sun.jna.Pointer, int, com.sun.jna.platform.win32.WinDef.DWORDByReference)}
      */
     @Deprecated
     HANDLE CreateRemoteThread(HANDLE hProcess, WinBase.SECURITY_ATTRIBUTES lpThreadAttributes, int dwStackSize, FOREIGN_THREAD_START_ROUTINE lpStartAddress, Pointer lpParameter, DWORD dwCreationFlags, Pointer lpThreadId);

diff --git a/contrib/platform/src/com/sun/jna/platform/win32/PsapiUtil.java b/contrib/platform/src/com/sun/jna/platform/win32/PsapiUtil.java
@@ -71,11 +71,11 @@ public static int[] enumProcesses() {
      * @throws Win32Exception in case an error occurs
      * @see <a href="http://msdn.microsoft.com/en-us/library/ms683217(VS.85).aspx">MSDN</a>
      */
-    public static String GetProcessImageFileName(HANDLE process) {
+    public static String GetProcessImageFileName(HANDLE hProcess) {
         int size = 2048;
         while (true) {
             final char[] filePath = new char[size];
-            int length = Psapi.INSTANCE.GetProcessImageFileName(process,
+            int length = Psapi.INSTANCE.GetProcessImageFileName(hProcess,
                 filePath, filePath.length);
             if(length == 0) {
                 if(Native.getLastError() != WinError.ERROR_INSUFFICIENT_BUFFER) {

diff --git a/contrib/platform/src/com/sun/jna/platform/win32/WTypes.java b/contrib/platform/src/com/sun/jna/platform/win32/WTypes.java
@@ -108,7 +108,7 @@ public BSTR() {
          * Instantiate a BSTR from a pointer. The user is responsible for allocating and
          * releasing memory for the {@link BSTR}, most commonly using
          * {@link OleAuto#SysAllocString(String)} and
-         * {@link OleAuto#SysFreeString(BSTR)}
+         * {@link OleAuto#SysFreeString(com.sun.jna.platform.win32.WTypes.BSTR)}
          *
          * @param pointer
          *            A pointer to the string
@@ -119,7 +119,7 @@ public BSTR(Pointer pointer) {
 
         /**
          * @deprecated Use {@link OleAuto#SysAllocString(String)} and
-         *             {@link OleAuto#SysFreeString(BSTR)}
+         *             {@link OleAuto#SysFreeString(com.sun.jna.platform.win32.WTypes.BSTR)}
          */
         @Deprecated
         public BSTR(String value) {

diff --git a/contrib/platform/src/com/sun/jna/platform/win32/WinNT.java b/contrib/platform/src/com/sun/jna/platform/win32/WinNT.java
@@ -2994,7 +2994,7 @@ protected SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX(Pointer memory) {
          * Create a new instance of the appropriate subclass of
          * {@link SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX} from the provided
          * {@link Pointer} to native memory. Use this method rather than
-         * {@link #SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX(Pointer)} to properly
+         * {@code SYSTEM_LOGICAL_PROCESSOR_INFORMATION_EX(Pointer)} to properly
          * cast the Pointer to the appropriate subclass and populate variable
          * length arrays.
          *

diff --git a/contrib/platform/src/com/sun/jna/platform/win32/Wtsapi32.java b/contrib/platform/src/com/sun/jna/platform/win32/Wtsapi32.java
@@ -149,7 +149,7 @@ public interface WTS_CONNECTSTATE_CLASS {
 
     /**
      * Contains values that indicate the type of session information to retrieve in
-     * a call to the {@link #WTSQuerySessionInformation()} function.
+     * a call to the {@link #WTSQuerySessionInformation(com.sun.jna.platform.win32.WinNT.HANDLE, int, int, com.sun.jna.ptr.PointerByReference, com.sun.jna.ptr.IntByReference)} function.
      */
     public interface WTS_INFO_CLASS {
         int WTSInitialProgram = 0;