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

@@ -87,9 +87,10 @@ public interface HomematicGateway {
* @param dpConfig The configuration of the datapoint
* @param newValue The new value for the datapoint
* @param rxMode The rxMode with which the value should be sent to the device
* ({@link HomematicBindingConstants#RX_BURST_MODE "BURST"} for burst mode,
* {@link HomematicBindingConstants#RX_WAKEUP_MODE "WAKEUP"} for wakeup mode, or null for the default
* mode)
* ({@link org.openhab.binding.homematic.internal.HomematicBindingConstants#RX_BURST_MODE "BURST"}
* for burst mode,
* {@link org.openhab.binding.homematic.internal.HomematicBindingConstants#RX_WAKEUP_MODE "WAKEUP"}
* for wakeup mode, or null for the default mode)
*/
void sendDatapoint(HmDatapoint dp, HmDatapointConfig dpConfig, Object newValue, String rxMode)
throws IOException, HomematicClientException;

View File

@@ -25,7 +25,7 @@ import org.openhab.core.library.unit.Units;
import org.openhab.core.types.Type;
/**
* Converts between a Homematic datapoint value and a {@link DecimalType}.
* Converts between a Homematic datapoint value and a {@link org.openhab.core.library.types.DecimalType}.
*
* @author Michael Reitler - Initial contribution
*/

View File

@@ -32,7 +32,7 @@ public interface HomematicChannelGroupTypeProvider extends ChannelGroupTypeProvi
* Use this method to lookup a ChannelGroupType which was generated by the
* homematic binding. Other than {@link #getChannelGroupType(ChannelGroupTypeUID, Locale)}
* of this provider, it will return also those {@link ChannelGroupType}s
* which are excluded by {@link HomematicThingTypeExcluder}
* which are excluded by {@link org.openhab.binding.homematic.type.HomematicThingTypeExcluder}
*
* @param channelGroupTypeUID
* e.g. <i>homematic:HM-WDS40-TH-I-2_0</i>

View File

@@ -32,7 +32,8 @@ public interface HomematicChannelTypeProvider extends ChannelTypeProvider {
* Use this method to lookup a ChannelType which was generated by the
* homematic binding. Other than {@link #getChannelType(ChannelTypeUID, Locale)}
* of this provider, it will return also those {@link ChannelType}s
* which are excluded by {@link HomematicThingTypeExcluder}
* which are excluded by
* {@link org.openhab.binding.homematic.type.HomematicThingTypeExcluder}
*
* @param channelTypeUID
* e.g. <i>homematic:HM-WDS40-TH-I-2_0_RSSI_DEVICE</i>

View File

@@ -46,8 +46,10 @@ public interface HomematicConfigDescriptionProvider extends ConfigDescriptionPro
/**
* Use this method to lookup a ConfigDescription which was generated by the
* homematic binding. Other than {@link #getConfigDescription(URI, Locale)}
* of this provider, it will return also those {@link ConfigDescription}s
* which are excluded by {@link HomematicThingTypeExcluder}
* of this provider, it will return also those
* {@link org.openhab.core.config.core.ConfigDescription}s
* which are excluded by
* {@link org.openhab.binding.homematic.type.HomematicThingTypeExcluder}
*
* @param URI config-description-uri
* e.g. <i>thing-type:homematic:HM-WDS40-TH-I-2</i>

View File

@@ -32,6 +32,7 @@ public interface HomematicThingTypeExcluder {
/**
* Returns list of ThingTypes to be excluded. Clients which implement this
* are henceforth responsible to ...
* <ul>
* <li>provide any excluded ThingType on their own - e.g. in a custom
* {@link org.openhab.core.thing.binding.ThingTypeProvider} or by
* defining those {@link org.openhab.core.thing.type.ThingType}s in XML.</li>
@@ -43,6 +44,7 @@ public interface HomematicThingTypeExcluder {
* {@link org.openhab.core.thing.Channel}) which can be handled by
* the binding (see
* {@link org.openhab.binding.homematic.internal.handler.HomematicThingHandler})</li>
* </ul>
*
* @return {@link ThingTypeUID}s of ThingTypes that are supposed to be
* excluded from the binding's thing-type generation