public/openhab-addons
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Improve javadoc for some addons (#15701)

Browse Source 
Signed-off-by: Holger Friedrich <mail@holger-friedrich.de>
This commit is contained in:
Holger Friedrich
2023-10-08 00:25:04 +02:00
committed by GitHub
parent f8bcfb0c7e
commit f24a4305b8
275 changed files with 547 additions and 406 deletions
Download Patch File Download Diff File Expand all files Collapse all files

8
bundles/org.openhab.binding.opensprinkler/src/main/java/org/openhab/binding/opensprinkler/internal/api/OpenSprinklerApi.java
View File

@@ -190,14 +190,14 @@ public interface OpenSprinklerApi {
/**
* Returns a list of all internal programs as a list of StateOptions.
*
* @return List<StateOption>
* @return {@code List<StateOption>}
*/
List<StateOption> getPrograms();
/**
* Return a list of all the stations the device has as List of StateOptions
*
* @return List<StateOption>
* @return {@code List<StateOption>}
*/
List<StateOption> getStations();
@@ -212,7 +212,7 @@ public interface OpenSprinklerApi {
void runProgram(Command command) throws CommunicationApiException, UnauthorizedApiException;
/**
* Fetch the station names and place them in a list of List<StateOption>.
* Fetch the station names and place them in a list of {@code List<StateOption>}.
* Use getStations() to retrieve this list.
*
* @throws CommunicationApiException
@@ -250,7 +250,7 @@ public interface OpenSprinklerApi {
/**
* Gets the rain delay in hours from the OpenSprinkler device.
*
* @return QuantityType<Time>
* @return {@code QuantityType<Time>}
*/
QuantityType<Time> getRainDelay();
}