add irrigation system, clean up javadocs

Signed-off-by: Eugen Freiter <freiter@gmx.de>

Author: Eugen Freiter

README.md

@@ -24,7 +24,7 @@ Supported HomeKit Accessories
 =========
 
 Current implementation is based on HAP specification Release R2 (published 2019-07-26) and
-fully supports 36 out of 45 HomeKit accessory services defined there.
+fully supports 37 out of 45 HomeKit accessory services defined there.
 
 | HomeKit Accessory & Service type | Supported by Java-HAP |
 |--------------------|--------------------|
@@ -48,7 +48,7 @@ fully supports 36 out of 45 HomeKit accessory services defined there.
 |  Heater Cooler                    |     :white_check_mark:    |
 |  Humidifier Dehumidifier          |     :white_check_mark:    |
 |  Humidity Sensor                  |     :white_check_mark:    |
-|  Irrigation System                |     :x:                   |
+|  Irrigation System                |     :white_check_mark:    |
 |  Leak Sensor                      |     :white_check_mark:    |
 |  Light Bulb                       |     :white_check_mark:    |
 |  Light Sensor                     |     :white_check_mark:    |

src/main/java/io/github/hapjava/accessories/AirPurifierAccessory.java

@@ -9,11 +9,7 @@
 import java.util.Collections;
 import java.util.concurrent.CompletableFuture;
 
-/**
- * An air purifier.
- *
- * @author Eugen Freiter
- */
+/** An air purifier. */
 public interface AirPurifierAccessory extends HomekitAccessory {
   /**
    * Mandatory: Retrieves the current active state of the fan'.

src/main/java/io/github/hapjava/accessories/AirQualityAccessory.java

@@ -8,11 +8,7 @@
 import java.util.Collections;
 import java.util.concurrent.CompletableFuture;
 
-/**
- * An air quality accessory which can include several sensors.
- *
- * @author Eugen Freiter
- */
+/** An air quality accessory which can include several sensors. */
 public interface AirQualityAccessory extends HomekitAccessory {
 
   /**

src/main/java/io/github/hapjava/accessories/Bridge.java

@@ -1,5 +1,6 @@
 package io.github.hapjava.accessories;
 
+/** HomeKit bridge service. */
 public interface Bridge extends HomekitAccessory {
 
   @Override

src/main/java/io/github/hapjava/accessories/CarbonDioxideSensorAccessory.java

@@ -8,14 +8,7 @@
 import java.util.Collections;
 import java.util.concurrent.CompletableFuture;
 
-/**
- * A carbon dioxide sensor reports whether carbon dioxide has been detected or not.
- *
- * <p>Carbon dioxide sensors that run on batteries will need to implement this interface and also
- * implement {@link BatteryAccessory}.
- *
- * @author Eugen Freiter
- */
+/** A carbon dioxide sensor reports carbon dioxide level. */
 public interface CarbonDioxideSensorAccessory extends HomekitAccessory {
 
   /**

src/main/java/io/github/hapjava/accessories/CarbonMonoxideSensorAccessory.java

@@ -11,9 +11,6 @@
 /**
  * A carbon monoxide sensor reports whether carbon monoxide has been detected or not.
  *
- * <p>Carbon monoxide sensors that run on batteries will need to implement this interface and also
- * implement {@link BatteryAccessory}.
- *
  * @author Gaston Dombiak
  */
 public interface CarbonMonoxideSensorAccessory extends HomekitAccessory {

src/main/java/io/github/hapjava/accessories/ContactSensorAccessory.java

@@ -12,9 +12,6 @@
  * A contact sensor that reports whether contact is detected or not. Typical contact sensors are
  * window/door sensors. When contact is detected it means that the door/window is closed.
  *
- * <p>Contact sensors that run on batteries will need to implement this interface and also implement
- * {@link BatteryAccessory}.
- *
  * @author Gaston Dombiak
  */
 public interface ContactSensorAccessory extends HomekitAccessory {

src/main/java/io/github/hapjava/accessories/DoorAccessory.java

@@ -8,11 +8,7 @@
 import java.util.Collections;
 import java.util.concurrent.CompletableFuture;
 
-/**
- * A door with status
- *
- * @author Eugen Freiter
- */
+/** A motorized door with current and target position. */
 public interface DoorAccessory extends HomekitAccessory {
 
   /**

src/main/java/io/github/hapjava/accessories/DoorbellAccessory.java

@@ -8,11 +8,7 @@
 import java.util.Collections;
 import java.util.concurrent.CompletableFuture;
 
-/**
- * The Doorbell accessory describes a doorbell.
- *
- * @author Eugen Freiter
- */
+/** doorbell accessory with a switch (button push) event. */
 public interface DoorbellAccessory extends HomekitAccessory {
 
   /**

src/main/java/io/github/hapjava/accessories/FanAccessory.java

@@ -1,6 +1,5 @@
 package io.github.hapjava.accessories;
 
-import io.github.hapjava.accessories.optionalcharacteristic.AccessoryWithFanState;
 import io.github.hapjava.characteristics.HomekitCharacteristicChangeCallback;
 import io.github.hapjava.services.Service;
 import io.github.hapjava.services.impl.FanService;
@@ -9,8 +8,7 @@
 import java.util.concurrent.CompletableFuture;
 
 /**
- * A fan with basic characteristics. User {@link AccessoryWithFanState} for Fan with more
- * characteristics.
+ * A fan with mandatory characteristics.
  *
  * @author Andy Lintner
  */