Improve javadoc for all addons (#15667)

Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
This commit is contained in:
Holger Friedrich
2023-09-30 21:49:12 +02:00
committed by GitHub
parent 0039e391cd
commit cbf4411034
618 changed files with 1106 additions and 1110 deletions

View File

@@ -108,15 +108,6 @@ public class MagentaTVHandlerFactory extends BaseThingHandlerFactory {
return null;
}
/**
* Add a device to the device table
*
* @param udn UDN for the device
* @param deviceId A unique device id
* @param ipAddress IP address of the receiver
* @param handler The corresponding thing handler
*/
public void setNotifyServletStatus(boolean newStatus) {
logger.debug("NotifyServlet started");
servletInitialized = newStatus;

View File

@@ -219,7 +219,7 @@ public class MagentaTVControl {
* <friendlyName>$friendlyName</friendlyName>\n <userID>$userID</userID>\n
* </u:X-pairingRequest>\n </s:Body> </s:Envelope>
*
* @returns true: pairing successful
* @return true: pairing successful
* @throws MagentaTVException
*/
public boolean sendPairingRequest() throws MagentaTVException {

View File

@@ -101,8 +101,10 @@ public class MagentaTVHandler extends BaseThingHandler implements MagentaTVListe
/**
* Constructor, save bindingConfig (services as default for thingConfig)
*
* @param manager
* @param thing
* @param bindingConfig
* @param network
* @param httpClient
*/
public MagentaTVHandler(MagentaTVDeviceManager manager, Thing thing, MagentaTVNetwork network,
HttpClient httpClient) {
@@ -376,8 +378,8 @@ public class MagentaTVHandler extends BaseThingHandler implements MagentaTVListe
/**
* Update thing status
*
* @param mode new thing status
* @return ON = power on, OFF=power off
* @param newStatus new thing status
* @param errorMessage
*/
public void setOnlineStatus(ThingStatus newStatus, String errorMessage) {
ThingStatus status = this.getThing().getStatus();

View File

@@ -66,8 +66,9 @@ public class MagentaTVHttp {
* Given a URL and a set parameters, send a HTTP POST request to the URL
* location created by the URL and parameters.
*
* @param host
* @param url The URL to send a POST request to.
* @param urlParameters List of parameters to use in the URL for the POST
* @param postData List of parameters to use in the URL for the POST
* request. Null if no parameters.
* @param soapAction Header attribute for SOAP ACTION: xxx
* @param connection Header attribut for CONNECTION: xxx
@@ -107,7 +108,7 @@ public class MagentaTVHttp {
* @param remotePort destination port
* @param data data to send
* @return received response
* @throws IOException
* @throws MagentaTVException
*/
public String sendData(String remoteIp, String remotePort, String data) throws MagentaTVException {
String errorMessage = "";

View File

@@ -43,8 +43,8 @@ public class MagentaTVNetwork {
/**
* Init local network interface, determine local IP and MAC address
*
* @param networkAddressService
* @return
* @param localIP
* @param localPort
*/
public void initLocalNet(String localIP, String localPort) throws MagentaTVException {
try {

View File

@@ -82,7 +82,7 @@ public class MagentaTVNotifyServlet extends HttpServlet {
* STB_playContent> </e:property> </e:propertyset>
*
* @param request
* @param resp
* @param response
*
* @throws ServletException, IOException
*/