Fix javadoc issues
parent
e5d886f4f8
commit
262b9d2469
|
@ -275,7 +275,7 @@ $ java -jar build/libs/portmapper-*.jar
|
|||
$ ./gradlew licenseFormat
|
||||
```
|
||||
|
||||
### Publish to jcenter
|
||||
### Publish to Maven Central
|
||||
|
||||
1. Add the following to your `~/.gradle/gradle.properties`:
|
||||
|
||||
|
|
|
@ -309,7 +309,6 @@ public class PortMapperApp extends SingleFrameApplication {
|
|||
* Get the IP address of the local host.
|
||||
*
|
||||
* @return IP address of the local host or <code>null</code>, if the address could not be determined.
|
||||
* @throws RouterException
|
||||
*/
|
||||
public String getLocalHostAddress() {
|
||||
|
||||
|
|
|
@ -17,12 +17,9 @@
|
|||
*/
|
||||
package org.chris.portmapper.logging;
|
||||
|
||||
import javax.swing.JTextArea;
|
||||
|
||||
/**
|
||||
* The {@link LogMessageWriter} copies every written string to a {@link LogMessageListener}. All written strings are
|
||||
* buffered, so no string is missed. A {@link LogMessageListener} can be registered using method
|
||||
* {@link #registerListener(JTextArea)}.
|
||||
* buffered, so no string is missed.
|
||||
*/
|
||||
public interface LogMessageListener {
|
||||
|
||||
|
|
|
@ -25,8 +25,7 @@ import javax.swing.JTextArea;
|
|||
|
||||
/**
|
||||
* The {@link LogMessageWriter} copies every written string to a {@link LogMessageListener}. All written strings are
|
||||
* buffered, so no string is missed. A {@link LogMessageListener} can be registered using method
|
||||
* {@link #registerListener(JTextArea)}.
|
||||
* buffered, so no string is missed.
|
||||
*/
|
||||
public class LogMessageWriter extends Writer {
|
||||
|
||||
|
|
|
@ -59,6 +59,10 @@ public class PortMappingPreset implements Serializable {
|
|||
|
||||
/**
|
||||
* Creates a new preset with the given default values.
|
||||
*
|
||||
* @param remoteHost the remote host name.
|
||||
* @param internalClient the IP address of the internal host.
|
||||
* @param description the description of the port mapping.
|
||||
*/
|
||||
public PortMappingPreset(final String remoteHost, final String internalClient, final String description) {
|
||||
this.remoteHost = remoteHost;
|
||||
|
|
|
@ -33,7 +33,7 @@ public interface IRouter extends AutoCloseable {
|
|||
* Get the IP address of the local host.
|
||||
*
|
||||
* @return IP address of the local host or <code>null</code>, if the address could not be determined.
|
||||
* @throws RouterException
|
||||
* @throws RouterException in case an unexpected error occurs.
|
||||
*/
|
||||
public String getLocalHostAddress() throws RouterException;
|
||||
|
||||
|
@ -41,6 +41,7 @@ public interface IRouter extends AutoCloseable {
|
|||
* Get the external IP of the router.
|
||||
*
|
||||
* @return the external IP of the router.
|
||||
* @throws RouterException in case an unexpected error occurs.
|
||||
*/
|
||||
public abstract String getExternalIPAddress() throws RouterException;
|
||||
|
||||
|
@ -48,7 +49,6 @@ public interface IRouter extends AutoCloseable {
|
|||
* Get the internal host name or IP of the router.
|
||||
*
|
||||
* @return the internal host name or IP of the router.
|
||||
* @throws RouterException
|
||||
*/
|
||||
public abstract String getInternalHostName();
|
||||
|
||||
|
@ -56,7 +56,7 @@ public interface IRouter extends AutoCloseable {
|
|||
* Get the internal port of the router.
|
||||
*
|
||||
* @return the internal port of the router.
|
||||
* @throws RouterException
|
||||
* @throws RouterException in case an unexpected error occurs.
|
||||
*/
|
||||
public abstract int getInternalPort() throws RouterException;
|
||||
|
||||
|
@ -72,7 +72,7 @@ public interface IRouter extends AutoCloseable {
|
|||
/**
|
||||
* Write information about the router to the log.
|
||||
*
|
||||
* @throws RouterException
|
||||
* @throws RouterException in case an unexpected error occurs.
|
||||
*/
|
||||
public abstract void logRouterInfo() throws RouterException;
|
||||
|
||||
|
@ -81,7 +81,7 @@ public interface IRouter extends AutoCloseable {
|
|||
*
|
||||
* @param mappings
|
||||
* the port mappings to add.
|
||||
* @throws RouterException
|
||||
* @throws RouterException in case an unexpected error occurs.
|
||||
*/
|
||||
public abstract void addPortMappings(Collection<PortMapping> mappings) throws RouterException;
|
||||
|
||||
|
@ -90,7 +90,7 @@ public interface IRouter extends AutoCloseable {
|
|||
*
|
||||
* @param mapping
|
||||
* the port mapping to add.
|
||||
* @throws RouterException
|
||||
* @throws RouterException in case an unexpected error occurs.
|
||||
*/
|
||||
public abstract void addPortMapping(PortMapping mapping) throws RouterException;
|
||||
|
||||
|
@ -99,17 +99,17 @@ public interface IRouter extends AutoCloseable {
|
|||
*
|
||||
* @param mapping
|
||||
* the port mapping to remove.
|
||||
* @throws RouterException
|
||||
* @throws RouterException in case an unexpected error occurs.
|
||||
*/
|
||||
public abstract void removeMapping(PortMapping mapping) throws RouterException;
|
||||
|
||||
/**
|
||||
* Remove the port mapping with the given data from the router.
|
||||
*
|
||||
* @param protocol
|
||||
* @param remoteHost
|
||||
* @param externalPort
|
||||
* @throws RouterException
|
||||
* @param protocol the port mapping's network protocol (TCP or UDP).
|
||||
* @param remoteHost the port mapping's remote host name.
|
||||
* @param externalPort the port mapping's external port number.
|
||||
* @throws RouterException in case an unexpected error occurs.
|
||||
*/
|
||||
public abstract void removePortMapping(Protocol protocol, String remoteHost, int externalPort)
|
||||
throws RouterException;
|
||||
|
|
Loading…
Reference in New Issue