Improve javadoc for some addons (#15701)

Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>

bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/InputWithNavigationControl.java

@@ -37,49 +37,56 @@ public interface InputWithNavigationControl extends IStateUpdatable {
     /**
      * Navigate back
      *
-     * @throws ReceivedMessageParseException, IOException
+     * @throws ReceivedMessageParseException
+     * @throws IOException
      */
     void goBack() throws ReceivedMessageParseException, IOException;
 
     /**
      * Navigate up
      *
-     * @throws ReceivedMessageParseException, IOException
+     * @throws ReceivedMessageParseException
+     * @throws IOException
      */
     void goUp() throws IOException, ReceivedMessageParseException;
 
     /**
      * Navigate down
      *
-     * @throws ReceivedMessageParseException, IOException
+     * @throws ReceivedMessageParseException
+     * @throws IOException
      */
     void goDown() throws IOException, ReceivedMessageParseException;
 
     /**
      * Navigate left. Not for all zones or functions available.
      *
-     * @throws ReceivedMessageParseException, IOException
+     * @throws ReceivedMessageParseException
+     * @throws IOException
      */
     void goLeft() throws IOException, ReceivedMessageParseException;
 
     /**
      * Navigate right. Not for all zones or functions available.
      *
-     * @throws ReceivedMessageParseException, IOException
+     * @throws ReceivedMessageParseException
+     * @throws IOException
      */
     void goRight() throws IOException, ReceivedMessageParseException;
 
     /**
      * Select current item. Not for all zones or functions available.
      *
-     * @throws ReceivedMessageParseException, IOException
+     * @throws ReceivedMessageParseException
+     * @throws IOException
      */
     void selectCurrentItem() throws IOException, ReceivedMessageParseException;
 
     /**
      * Navigate to root menu
      *
-     * @throws ReceivedMessageParseException, IOException
+     * @throws ReceivedMessageParseException
+     * @throws IOException
      */
     boolean goToRoot() throws IOException, ReceivedMessageParseException;
 

bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/AbstractInputControlXML.java

@@ -65,7 +65,9 @@ public abstract class AbstractInputControlXML {
 
     /**
      * Wraps the XML message with the inputID tags. Example with inputID=NET_RADIO:
-     * <NET_RADIO>message</NET_RADIO>.
+     * {@code
+     * <NET_RADIO>message</NET_RADIO>
+     * }.
      *
      * @param message XML message
      * @return

bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/DeviceInformationXML.java

@@ -55,6 +55,9 @@ public class DeviceInformationXML implements DeviceInformation {
      * We need that called only once. Will give us name, id, version and zone information.
      *
      * Example:
+     * 
+     * <pre>
+     * {@code
      * <Feature_Existence>
      * <Main_Zone>1</Main_Zone>
      * <Zone_2>1</Zone_2>
@@ -77,6 +80,8 @@ public class DeviceInformationXML implements DeviceInformation {
      * <iPod_USB>1</iPod_USB>
      * <AirPlay>1</AirPlay>
      * </Feature_Existence>
+     * }
+     * </pre>
      *
      * @throws IOException
      */

bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/InputWithNavigationControlXML.java

@@ -31,7 +31,7 @@ import org.w3c.dom.Node;
  * other inputs are using the same way of navigating through menus. A menu on Yamaha AVRs
  * is hierarchically organised. Entries are divided into pages with 8 elements per page.
  *
- * The XML nodes <List_Control> and <List_Info> are used.
+ * The XML nodes {@code <List_Control>} and {@code <List_Info>} are used.
  *
  * In contrast to other protocol classes an object of this type will store state information,
  * because it caches the received XML information of the updateNavigationState(). This may change

bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/InputWithPlayControlXML.java

@@ -34,7 +34,7 @@ import org.w3c.dom.Node;
  * This class implements the Yamaha Receiver protocol related to navigation functionally. USB, NET_RADIO, IPOD and
  * other inputs are using the same way of playback control.
  * <p>
- * The XML nodes <Play_Info> and <Play_Control> are used.
+ * The XML nodes {@code <Play_Info>} and {@code <Play_Control>} are used.
  * <p>
  * Example:
  * <p>

bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/InputWithPresetControlXML.java

@@ -32,7 +32,7 @@ import org.w3c.dom.Node;
  * This class implements the Yamaha Receiver protocol related to navigation functionally. USB, NET_RADIO, IPOD and
  * other inputs are using the same way of playback control.
  *
- * The XML nodes <Play_Info> and <Play_Control> are used.
+ * The XML nodes {@code <Play_Info>} and {@code <Play_Control>} are used.
  *
  * Example:
  *

bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/InputWithTunerDABControlXML.java

@@ -36,7 +36,7 @@ import org.w3c.dom.Node;
  *
  * Note that yamaha maintains separate presets for each band.
  *
- * The XML nodes <DAB><Play_Control><Band>FM</Band></Play_Control></DAB> are used.
+ * The XML nodes {@code <DAB><Play_Control><Band>FM</Band></Play_Control></DAB>} are used.
  *
  * No state will be saved in here, but in {@link DabBandState}, {@link PresetInfoState} and {@link PlayInfoState}
  * instead.

bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/XMLConnection.java

@@ -104,7 +104,7 @@ public class XMLConnection extends AbstractConnection {
     /**
      * Post the given xml message
      *
-     * @param message XML formatted message excluding < ?xml > or <YAMAHA_AV> tags.
+     * @param message XML formatted message excluding {@code <?xml>} or {@code <YAMAHA_AV>} tags.
      * @throws IOException
      */
     @Override
@@ -115,7 +115,7 @@ public class XMLConnection extends AbstractConnection {
     /**
      * Post the given xml message and return the response as string.
      *
-     * @param message XML formatted message excluding <?xml> or <YAMAHA_AV> tags.
+     * @param message XML formatted message excluding {@code <?xml>} or {@code <YAMAHA_AV>} tags.
      * @return Return the response as text or throws an exception if the connection failed.
      * @throws IOException
      */

bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/protocol/xml/XMLUtils.java

@@ -187,7 +187,9 @@ public class XMLUtils {
 
     /**
      * Wraps the XML message with the zone tags. Example with zone=Main_Zone:
-     * <Main_Zone>message</Main_Zone>.
+     * {@code
+     * <Main_Zone>message</Main_Zone>
+     * }.
      *
      * @param message XML message
      * @return

bundles/org.openhab.binding.yamahareceiver/src/main/java/org/openhab/binding/yamahareceiver/internal/state/AvailableInputState.java

@@ -16,7 +16,7 @@ import java.util.Map;
 import java.util.TreeMap;
 
 /**
- * List of AVR input channel names with <Input ID, Input Name>
+ * List of AVR input channel names with {@code <Input ID, Input Name>}
  *
  * @author David Graeff - Initial contribution
  */