Skip to content

Commit d99f675

Browse files
committed
Doc fixes.
1 parent fd7382a commit d99f675

File tree

2 files changed

+19
-6
lines changed

2 files changed

+19
-6
lines changed

src/java/org/jnativehook/GlobalScreen.java

+14-5
Original file line numberDiff line numberDiff line change
@@ -224,48 +224,55 @@ public static void removeNativeMouseWheelListener(NativeMouseWheelListener liste
224224
/**
225225
* Get information about the native monitor configuration and layout.
226226
*
227+
* @return an array of <code>NativeMonitorInfo</code> objects.
227228
* @since 2.1
228229
*/
229230
public static native NativeMonitorInfo[] getNativeMonitors();
230231

231232
/**
232233
* Retrieves the keyboard auto repeat rate.
233234
*
235+
* @return <code>Integer</code> or null.
234236
* @since 2.1
235237
*/
236238
public static native Integer getAutoRepeatRate();
237239

238240
/**
239241
* Retrieves the keyboard auto repeat delay.
240242
*
243+
* @return <code>Integer</code> or null.
241244
* @since 2.1
242245
*/
243246
public static native Integer getAutoRepeatDelay();
244247

245248
/**
246249
* Retrieves the mouse acceleration multiplier.
247250
*
251+
* @return <code>Integer</code> or null.
248252
* @since 2.1
249253
*/
250254
public static native Integer getPointerAccelerationMultiplier();
251255

252256
/**
253257
* Retrieves the mouse acceleration threshold.
254258
*
259+
* @return <code>Integer</code> or null.
255260
* @since 2.1
256261
*/
257262
public static native Integer getPointerAccelerationThreshold();
258263

259264
/**
260265
* Retrieves the mouse sensitivity.
261266
*
267+
* @return <code>Integer</code> or null.
262268
* @since 2.1
263269
*/
264270
public static native Integer getPointerSensitivity();
265271

266272
/**
267273
* Retrieves the double/triple click interval in milliseconds.
268274
*
275+
* @return <code>Integer</code> or null.
269276
* @since 2.1
270277
*/
271278
public static native Integer getMultiClickIterval();
@@ -277,7 +284,7 @@ protected static class NativeHookThread extends Thread {
277284
/**
278285
* Exception thrown by this thread.
279286
*/
280-
private NativeHookException exception;
287+
protected NativeHookException exception;
281288

282289
/**
283290
* Default constructor.
@@ -318,11 +325,15 @@ public NativeHookException getException() {
318325
* Native implementation to start the input hook. This method blocks and should only be called by this
319326
* specialized thread implementation. This method will notifyAll() after passing any exception exception
320327
* throwing code.
328+
*
329+
* @throws NativeHookException problem registering the native hook with the underlying operating system.
321330
*/
322-
private native void enable() throws NativeHookException;
331+
protected native void enable() throws NativeHookException;
323332

324333
/**
325334
* Native implementation to stop the input hook. There is no other way to stop the hook.
335+
*
336+
* @throws NativeHookException problem un-registering the native hook with the underlying operating system.
326337
*/
327338
public native void disable() throws NativeHookException;
328339

@@ -359,8 +370,7 @@ protected static void dispatchEvent(NativeInputEvent event) {
359370
* <code>Load "record"</code> is missing for the xorg.conf file on
360371
* Unix/Linux/Solaris platforms.
361372
*
362-
* @throws NativeHookException problem registering the native hook with
363-
* the underlying operating system.
373+
* @throws NativeHookException problem registering the native hook with the underlying operating system.
364374
* @since 1.1
365375
*/
366376
public static void registerNativeHook() throws NativeHookException {
@@ -389,7 +399,6 @@ public static void registerNativeHook() throws NativeHookException {
389399
* hook it is not registered the function has no effect.
390400
*
391401
* @throws NativeHookException hook interrupted by Java.
392-
*
393402
* @since 1.1
394403
*/
395404
public static void unregisterNativeHook() throws NativeHookException {

src/java/org/jnativehook/NativeMonitorInfo.java

+5-1
Original file line numberDiff line numberDiff line change
@@ -77,14 +77,18 @@ public NativeMonitorInfo(short number, int x, int y, short width, short height)
7777
}
7878

7979
/**
80-
* Get the logical number for this display. The primary display will always be zero.
80+
* Get the logical number of this display. The primary display will always be zero.
81+
*
82+
* @return the logical number of this display.
8183
*/
8284
public short getNumber() {
8385
return number;
8486
}
8587

8688
/**
8789
* Set the logical number for this display.
90+
*
91+
* @param number the logical number of this display.
8892
*/
8993
public void setNumber(short number) {
9094
this.number = number;

0 commit comments

Comments
 (0)