Skip to content

Commit

Permalink
Doc fixes.
Browse files Browse the repository at this point in the history
  • Loading branch information
kwhat committed Oct 31, 2016
1 parent fd7382a commit d99f675
Show file tree
Hide file tree
Showing 2 changed files with 19 additions and 6 deletions.
19 changes: 14 additions & 5 deletions src/java/org/jnativehook/GlobalScreen.java
Original file line number Diff line number Diff line change
Expand Up @@ -224,48 +224,55 @@ public static void removeNativeMouseWheelListener(NativeMouseWheelListener liste
/**
* Get information about the native monitor configuration and layout.
*
* @return an array of <code>NativeMonitorInfo</code> objects.
* @since 2.1
*/
public static native NativeMonitorInfo[] getNativeMonitors();

/**
* Retrieves the keyboard auto repeat rate.
*
* @return <code>Integer</code> or null.
* @since 2.1
*/
public static native Integer getAutoRepeatRate();

/**
* Retrieves the keyboard auto repeat delay.
*
* @return <code>Integer</code> or null.
* @since 2.1
*/
public static native Integer getAutoRepeatDelay();

/**
* Retrieves the mouse acceleration multiplier.
*
* @return <code>Integer</code> or null.
* @since 2.1
*/
public static native Integer getPointerAccelerationMultiplier();

/**
* Retrieves the mouse acceleration threshold.
*
* @return <code>Integer</code> or null.
* @since 2.1
*/
public static native Integer getPointerAccelerationThreshold();

/**
* Retrieves the mouse sensitivity.
*
* @return <code>Integer</code> or null.
* @since 2.1
*/
public static native Integer getPointerSensitivity();

/**
* Retrieves the double/triple click interval in milliseconds.
*
* @return <code>Integer</code> or null.
* @since 2.1
*/
public static native Integer getMultiClickIterval();
Expand All @@ -277,7 +284,7 @@ protected static class NativeHookThread extends Thread {
/**
* Exception thrown by this thread.
*/
private NativeHookException exception;
protected NativeHookException exception;

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

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

Expand Down Expand Up @@ -359,8 +370,7 @@ protected static void dispatchEvent(NativeInputEvent event) {
* <code>Load "record"</code> is missing for the xorg.conf file on
* Unix/Linux/Solaris platforms.
*
* @throws NativeHookException problem registering the native hook with
* the underlying operating system.
* @throws NativeHookException problem registering the native hook with the underlying operating system.
* @since 1.1
*/
public static void registerNativeHook() throws NativeHookException {
Expand Down Expand Up @@ -389,7 +399,6 @@ public static void registerNativeHook() throws NativeHookException {
* hook it is not registered the function has no effect.
*
* @throws NativeHookException hook interrupted by Java.
*
* @since 1.1
*/
public static void unregisterNativeHook() throws NativeHookException {
Expand Down
6 changes: 5 additions & 1 deletion src/java/org/jnativehook/NativeMonitorInfo.java
Original file line number Diff line number Diff line change
Expand Up @@ -77,14 +77,18 @@ public NativeMonitorInfo(short number, int x, int y, short width, short height)
}

/**
* Get the logical number for this display. The primary display will always be zero.
* Get the logical number of this display. The primary display will always be zero.
*
* @return the logical number of this display.
*/
public short getNumber() {
return number;
}

/**
* Set the logical number for this display.
*
* @param number the logical number of this display.
*/
public void setNumber(short number) {
this.number = number;
Expand Down

0 comments on commit d99f675

Please sign in to comment.