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

@@ -55,7 +55,7 @@ public abstract class NhcAction {
}
/**
* This method should be called when an object implementing the {@NhcActionEvent} interface is initialized.
* This method should be called when an object implementing the {@link NhcActionEvent} interface is initialized.
* It keeps a record of the event handler in that object so it can be updated when the action receives an update
* from the Niko Home Control IP-interface.
*
@@ -66,7 +66,7 @@ public abstract class NhcAction {
}
/**
* This method should be called when an object implementing the {@NhcActionEvent} interface is disposed.
* This method should be called when an object implementing the {@link NhcActionEvent} interface is disposed.
* It resets the reference, so no updates go to the handler anymore.
*
*/

View File

@@ -95,7 +95,7 @@ public interface NhcControllerEvent {
/**
* This method is called when a notice event is received from the Niko Home Control controller.
*
* @param alarmText
* @param noticeText
*/
void noticeEvent(String noticeText);

View File

@@ -74,7 +74,8 @@ public abstract class NhcEnergyMeter {
}
/**
* This method should be called when an object implementing the {@NhcEnergyMeterEvent} interface is initialized.
* This method should be called when an object implementing the {@link NhcEnergyMeterEvent} interface is
* initialized.
* It keeps a record of the event handler in that object so it can be updated when the action receives an update
* from the Niko Home Control IP-interface.
*
@@ -85,7 +86,7 @@ public abstract class NhcEnergyMeter {
}
/**
* This method should be called when an object implementing the {@NhcEnergyMeterEvent} interface is disposed.
* This method should be called when an object implementing the {@link NhcEnergyMeterEvent} interface is disposed.
* It resets the reference, so no updates go to the handler anymore.
*
*/

View File

@@ -109,7 +109,7 @@ public abstract class NhcThermostat {
}
/**
* This method should be called when an object implementing the {@NhcThermostatEvent} interface is initialized.
* This method should be called when an object implementing the {@link NhcThermostatEvent} interface is initialized.
* It keeps a record of the event handler in that object so it can be updated when the action receives an update
* from the Niko Home Control IP-interface.
*
@@ -120,7 +120,7 @@ public abstract class NhcThermostat {
}
/**
* This method should be called when an object implementing the {@NhcThermostatEvent} interface is disposed.
* This method should be called when an object implementing the {@link NhcThermostatEvent} interface is disposed.
* It resets the reference, so no updates go to the handler anymore.
*
*/
@@ -311,7 +311,7 @@ public abstract class NhcThermostat {
* {@link NhcThermostat2}.
*
* @param overrule temperature to overrule the setpoint in 0.1°C multiples
* @param time time duration in min for overrule
* @param overruletime time duration in min for overrule
*/
public abstract void executeOverrule(int overrule, int overruletime);

View File

@@ -150,7 +150,7 @@ public abstract class NikoHomeControlCommunication {
/**
* Return all actions in the Niko Home Control Controller.
*
* @return <code>Map&ltString, {@link NhcAction}></code>
* @return <code>Map&lt;String, {@link NhcAction}></code>
*/
public Map<String, NhcAction> getActions() {
return actions;
@@ -159,7 +159,7 @@ public abstract class NikoHomeControlCommunication {
/**
* Return all thermostats in the Niko Home Control Controller.
*
* @return <code>Map&ltString, {@link NhcThermostat}></code>
* @return <code>Map&lt;String, {@link NhcThermostat}></code>
*/
public Map<String, NhcThermostat> getThermostats() {
return thermostats;
@@ -168,7 +168,7 @@ public abstract class NikoHomeControlCommunication {
/**
* Return all energyMeters meters in the Niko Home Control Controller.
*
* @return <code>Map&ltString, {@link NhcEnergyMeter}></code>
* @return <code>Map&lt;String, {@link NhcEnergyMeter}></code>
*/
public Map<String, NhcEnergyMeter> getEnergyMeters() {
return energyMeters;

View File

@@ -51,7 +51,7 @@ public class NhcThermostat1 extends NhcThermostat {
* Sends thermostat setpoint to Niko Home Control.
*
* @param overrule temperature to overrule the setpoint in 0.1°C multiples
* @param time time duration in min for overrule
* @param overruletime time duration in min for overrule
*/
@Override
public void executeOverrule(int overrule, int overruletime) {

View File

@@ -92,7 +92,7 @@ public class NikoHomeControlCommunication2 extends NikoHomeControlCommunication
* Niko Home Control II Connected Controller.
*
* @throws CertificateException when the SSL context for MQTT communication cannot be created
* @throws UnknownHostException when the IP address is not provided
* @throws java.net.UnknownHostException when the IP address is not provided
*
*/
public NikoHomeControlCommunication2(NhcControllerEvent handler, String clientId,