Improve javadoc for some addons (#15701)

Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
This commit is contained in:
Holger Friedrich
2023-10-08 00:25:04 +02:00
committed by GitHub
parent f8bcfb0c7e
commit f24a4305b8
275 changed files with 547 additions and 406 deletions

View File

@@ -25,11 +25,16 @@ public class StringUtils {
/**
* Simple method to escape XML special characters in String.
* There are five XML Special characters which needs to be escaped :
*
* <pre>
* {@code
* & - &amp;
* < - &lt;
* > - &gt;
* " - &quot;
* ' - &apos;
* }
* </pre>
*/
public static String escapeXml(String xml) {
xml = xml.replace("&", "&amp;");
@@ -43,11 +48,16 @@ public class StringUtils {
/**
* Simple method to un escape XML special characters in String.
* There are five XML Special characters which needs to be escaped :
*
* <pre>
* {@code
* & - &amp;
* < - &lt;
* > - &gt;
* " - &quot;
* ' - &apos;
* }
* </pre>
*/
public static String unEscapeXml(String xml) {
xml = xml.replace("&amp;", "&");

View File

@@ -36,7 +36,7 @@ public final class UpnpProtocolMatcher {
* Test if an UPnP protocol matches the object class. This method is used to filter resources for the primary
* resource.
*
* @param protocol format: <protocol>:<network>:<contentFormat>:<additionalInfo>
* @param protocol format: {@code <protocol>:<network>:<contentFormat>:<additionalInfo>}
* e.g. http-get:*:audio/mpeg:*
* @param objectClass e.g. object.item.audioItem.musicTrack
* @return true if protocol matches objectClass
@@ -71,7 +71,7 @@ public final class UpnpProtocolMatcher {
* Ignore vendor specific additionalInfo part in UPnP protocol string.
* Do all comparisons in lower case.
*
* @param protocol format: <protocol>:<network>:<contentFormat>:<additionalInfo>
* @param protocol format: {@code <protocol>:<network>:<contentFormat>:<additionalInfo>}
* @param protocolSet
* @return true if protocol in protocolSet
*/