[upnpcontrol] Fix javadoc links (openhab#14471)

Signed-off-by: Mark Herwege <mark.herwege@telenet.be>
FordPrfkt · Apr 19, 2023 · 1e9b0f8 · 1e9b0f8
1 parent 2f1f06f
commit 1e9b0f8
Show file tree

Hide file tree

Showing 5 changed files with 34 additions and 29 deletions.
diff --git a/...ol/src/main/java/org/openhab/binding/upnpcontrol/internal/audiosink/UpnpAudioSinkReg.java b/...ol/src/main/java/org/openhab/binding/upnpcontrol/internal/audiosink/UpnpAudioSinkReg.java
@@ -16,9 +16,9 @@
 import org.openhab.binding.upnpcontrol.internal.handler.UpnpRendererHandler;
 
 /**
- * Interface class to be implemented in {@link UpnpControlHandlerFactory}, allows a {UpnpRendererHandler} to register
- * itself as an audio sink when it supports audio. If it supports audio is only known after the communication with the
- * renderer is established.
+ * Interface class to be implemented in {@link org.openhab.binding.upnpcontrol.internal.UpnpControlHandlerFactory
+ * UpnpControlHandlerFactory}, allows a {@link UpnpRendererHandler} to register itself as an audio sink when it supports
+ * audio. If it supports audio is only known after the communication with the renderer is established.
  *
  * @author Mark Herwege - Initial contribution
  */

diff --git a/...npcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpHandler.java b/...npcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpHandler.java
@@ -228,7 +228,8 @@ protected void updateStatus(ThingStatus status) {
 
     /**
      * Method called when a the remote device represented by the thing for this handler is added to the jupnp
-     * {@link RegistryListener} or is updated. Configuration info can be retrieved from the {@link RemoteDevice}.
+     * {@link org.jupnp.registry.RegistryListener RegistryListener} or is updated. Configuration info can be retrieved
+     * from the {@link RemoteDevice}.
      *
      * @param device
      */
@@ -292,7 +293,7 @@ protected void updateChannels() {
 
     /**
      * Invoke PrepareForConnection on the UPnP Connection Manager.
-     * Result is received in {@link onValueReceived}.
+     * Result is received in {@link #onValueReceived}.
      *
      * @param remoteProtocolInfo
      * @param peerConnectionManager
@@ -339,7 +340,7 @@ protected void connectionComplete() {
 
     /**
      * Invoke GetCurrentConnectionIDs on the UPnP Connection Manager.
-     * Result is received in {@link onValueReceived}.
+     * Result is received in {@link #onValueReceived}.
      */
     protected void getCurrentConnectionIDs() {
         Map<String, String> inputs = Collections.emptyMap();
@@ -349,7 +350,7 @@ protected void getCurrentConnectionIDs() {
 
     /**
      * Invoke GetCurrentConnectionInfo on the UPnP Connection Manager.
-     * Result is received in {@link onValueReceived}.
+     * Result is received in {@link #onValueReceived}.
      */
     protected void getCurrentConnectionInfo() {
         CompletableFuture<Boolean> settingAVTransport = isAvTransportIdSet;
@@ -373,7 +374,7 @@ protected void getCurrentConnectionInfo() {
 
     /**
      * Invoke GetFeatureList on the UPnP Connection Manager.
-     * Result is received in {@link onValueReceived}.
+     * Result is received in {@link #onValueReceived}.
      */
     protected void getFeatureList() {
         Map<String, String> inputs = Collections.emptyMap();
@@ -383,7 +384,7 @@ protected void getFeatureList() {
 
     /**
      * Invoke GetProtocolInfo on UPnP Connection Manager.
-     * Result is received in {@link onValueReceived}.
+     * Result is received in {@link #onValueReceived}.
      */
     protected void getProtocolInfo() {
         Map<String, String> inputs = Collections.emptyMap();
@@ -415,10 +416,10 @@ public void onStatusChanged(boolean status) {
     }
 
     /**
-     * This method wraps {@link org.openhab.core.io.transport.upnp.UpnpIOService.invokeAction}. It schedules and
-     * submits the call and calls {@link onValueReceived} upon completion. All state updates or other actions depending
-     * on the results should be triggered from {@link onValueReceived} because the class fields with results will be
-     * filled asynchronously.
+     * This method wraps {@link org.openhab.core.io.transport.upnp.UpnpIOService#invokeAction invokeAction}. It
+     * schedules and submits the call and calls {@link #onValueReceived} upon completion. All state updates or other
+     * actions depending on the results should be triggered from {@link #onValueReceived} because the class fields with
+     * results will be filled asynchronously.
      *
      * @param serviceId
      * @param actionId

diff --git a/...l/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpRendererHandler.java b/...l/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpRendererHandler.java
@@ -453,7 +453,7 @@ protected void setNextURI(String nextURI, String nextURIMetaData) {
 
     /**
      * Invoke GetTransportState on UPnP AV Transport.
-     * Result is received in {@link onValueReceived}.
+     * Result is received in {@link #onValueReceived}.
      */
     protected void getTransportState() {
         Map<String, String> inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId));
@@ -463,7 +463,7 @@ protected void getTransportState() {
 
     /**
      * Invoke getPositionInfo on UPnP AV Transport.
-     * Result is received in {@link onValueReceived}.
+     * Result is received in {@link #onValueReceived}.
      */
     protected void getPositionInfo() {
         Map<String, String> inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId));
@@ -473,7 +473,7 @@ protected void getPositionInfo() {
 
     /**
      * Invoke GetMediaInfo on UPnP AV Transport.
-     * Result is received in {@link onValueReceived}.
+     * Result is received in {@link #onValueReceived}.
      */
     protected void getMediaInfo() {
         Map<String, String> inputs = Collections.singletonMap(INSTANCE_ID, Integer.toString(avTransportId));
@@ -483,7 +483,9 @@ protected void getMediaInfo() {
 
     /**
      * Retrieves the current volume known to the control point, gets updated by GENA events or after UPnP Rendering
-     * Control GetVolume call. This method is used to retrieve volume by {@link UpnpAudioSink.getVolume}.
+     * Control GetVolume call. This method is used to retrieve volume with the
+     * {@link org.openhab.binding.upnpcontrol.internal.audiosink.UpnpAudioSink#getVolume UpnpAudioSink.getVolume}
+     * method.
      *
      * @return current volume
      */
@@ -493,7 +495,7 @@ public PercentType getCurrentVolume() {
 
     /**
      * Invoke GetVolume on UPnP Rendering Control.
-     * Result is received in {@link onValueReceived}.
+     * Result is received in {@link #onValueReceived}.
      *
      * @param channel
      */
@@ -534,7 +536,7 @@ public void setVolume(PercentType volume) {
 
     /**
      * Invoke getMute on UPnP Rendering Control.
-     * Result is received in {@link onValueReceived}.
+     * Result is received in {@link #onValueReceived}.
      *
      * @param channel
      */
@@ -563,7 +565,7 @@ protected void setMute(String channel, OnOffType mute) {
 
     /**
      * Invoke getMute on UPnP Rendering Control.
-     * Result is received in {@link onValueReceived}.
+     * Result is received in {@link #onValueReceived}.
      *
      * @param channel
      */

diff --git a/...rol/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpServerHandler.java b/...rol/src/main/java/org/openhab/binding/upnpcontrol/internal/handler/UpnpServerHandler.java
@@ -191,7 +191,7 @@ protected void initJob() {
     }
 
     /**
-     * Method that does a UPnP browse on a content directory. Results will be retrieved in the {@link onValueReceived}
+     * Method that does a UPnP browse on a content directory. Results will be retrieved in the {@link #onValueReceived}
      * method.
      *
      * @param objectID content directory object
@@ -233,7 +233,7 @@ protected void browse(String objectID, String browseFlag, String filter, String
     }
 
     /**
-     * Method that does a UPnP search on a content directory. Results will be retrieved in the {@link onValueReceived}
+     * Method that does a UPnP search on a content directory. Results will be retrieved in the {@link #onValueReceived}
      * method.
      *
      * @param containerID content directory container
@@ -543,7 +543,8 @@ private void handleCommandInRenderer(ChannelUID channelUID, Command command) {
 
     /**
      * Add a renderer to the renderer channel state option list.
-     * This method is called from the {@link UpnpControlHandlerFactory} class when creating a renderer handler.
+     * This method is called from the {@link org.openhab.binding.upnpcontrol.internal.UpnpControlHandlerFactory
+     * UpnpControlHandlerFactory} class when creating a renderer handler.
      *
      * @param key
      */
@@ -560,7 +561,8 @@ public void addRendererOption(String key) {
 
     /**
      * Remove a renderer from the renderer channel state option list.
-     * This method is called from the {@link UpnpControlHandlerFactory} class when removing a renderer handler.
+     * This method is called from the {@link org.openhab.binding.upnpcontrol.internal.UpnpControlHandlerFactory
+     * UpnpControlHandlerFactory} class when removing a renderer handler.
      *
      * @param key
      */

diff --git a/...pcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/queue/UpnpEntryQueue.java b/...pcontrol/src/main/java/org/openhab/binding/upnpcontrol/internal/queue/UpnpEntryQueue.java
@@ -40,7 +40,7 @@
  * of a current index in the queue. It has convenience methods to play previous/next entries, whereby the queue can be
  * organized to play from first to last (with no repetition), to restart at the start when the end is reached (in a
  * continuous loop), or to random shuffle the entries. Repeat and shuffle are off by default, but can be set using the
- * {@link setRepeat} and {@link setShuffle} methods.
+ * {@link #setRepeat} and {@link #setShuffle} methods.
  *
  * @author Mark Herwege - Initial contribution
  *
@@ -186,7 +186,7 @@ public int index() {
     }
 
     /**
-     * @return the index of the next element in the queue that will be served if {@link next} is called, or -1 if
+     * @return the index of the next element in the queue that will be served if {@link #next} is called, or -1 if
      *         nothing to serve for next.
      */
     public synchronized int nextIndex() {
@@ -198,7 +198,7 @@ public synchronized int nextIndex() {
     }
 
     /**
-     * @return the index of the previous element in the queue that will be served if {@link previous} is called, or -1
+     * @return the index of the previous element in the queue that will be served if {@link #previous} is called, or -1
      *         if nothing to serve for next.
      */
     public synchronized int previousIndex() {
@@ -210,7 +210,7 @@ public synchronized int previousIndex() {
     }
 
     /**
-     * @return true if there is an element to server when calling {@link next}.
+     * @return true if there is an element to server when calling {@link #next}.
      */
     public synchronized boolean hasNext() {
         int size = currentQueue.size();
@@ -221,7 +221,7 @@ public synchronized boolean hasNext() {
     }
 
     /**
-     * @return true if there is an element to server when calling {@link previous}.
+     * @return true if there is an element to server when calling {@link #previous}.
      */
     public synchronized boolean hasPrevious() {
         int size = currentQueue.size();