Improve documentation for AbstractDiscoveryService (#6342)

Signed-off-by: David Graeff <david.graeff@web.de>
eclipse-archived · Oct 10, 2018 · 53e19ba · 53e19ba
1 parent 87e20cc
commit 53e19ba
Showing 1 changed file with 4 additions and 2 deletions.
diff --git a/...covery/src/main/java/org/eclipse/smarthome/config/discovery/AbstractDiscoveryService.java b/...covery/src/main/java/org/eclipse/smarthome/config/discovery/AbstractDiscoveryService.java
@@ -106,11 +106,12 @@ public AbstractDiscoveryService(@Nullable Set<ThingTypeUID> supportedThingTypes,
     }
 
     /**
-     * Creates a new instance of this class with the specified parameters.
+     * Creates a new instance of this class with the specified parameters and background discovery enabled.
      *
      * @param supportedThingTypes the list of Thing types which are supported (can be null)
      * @param timeout the discovery timeout in seconds after which the discovery service
      *            automatically stops its forced discovery process (>= 0).
+     *            If set to 0, disables the automatic stop.
      * @throws IllegalArgumentException if the timeout < 0
      */
     public AbstractDiscoveryService(@Nullable Set<ThingTypeUID> supportedThingTypes, int timeout)
@@ -119,10 +120,11 @@ public AbstractDiscoveryService(@Nullable Set<ThingTypeUID> supportedThingTypes,
     }
 
     /**
-     * Creates a new instance of this class with the specified parameters.
+     * Creates a new instance of this class with the specified parameters and background discovery enabled.
      *
      * @param timeout the discovery timeout in seconds after which the discovery service
      *            automatically stops its forced discovery process (>= 0).
+     *            If set to 0, disables the automatic stop.
      * @throws IllegalArgumentException if the timeout < 0
      */
     public AbstractDiscoveryService(int timeout) throws IllegalArgumentException {