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

4
bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/IndegoController.java
View File

@@ -261,8 +261,8 @@ public class IndegoController {
/**
* Sends a PUT/POST request to the server.
*
* @param method the type of request ({@link org.eclipse.jetty.http.HttpMethod.PUT} or
* {@link org.eclipse.jetty.http.HttpMethod.POST})
* @param method the type of request ({@link org.eclipse.jetty.http.HttpMethod#PUT} or
* {@link org.eclipse.jetty.http.HttpMethod#POST})
* @param path the relative path to which the request should be sent
* @param requestDto the DTO which should be sent to the server as JSON
* @throws IndegoAuthenticationException if request was rejected as unauthorized

2
bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/IndegoDeviceController.java
View File

@@ -281,7 +281,7 @@ public class IndegoDeviceController extends IndegoController {
}
/**
* Request map position updates for the next ({@link count} * {@link interval}) number of seconds.
* Request map position updates for the next ({@code count} * {@code interval}) number of seconds.
*
* @param count number of updates
* @param interval number of seconds between updates

4
bundles/org.openhab.binding.boschindego/src/main/java/org/openhab/binding/boschindego/internal/IndegoTypeDatabase.java
View File

@@ -25,7 +25,9 @@ public class IndegoTypeDatabase {
/**
* Return tool name from tool type number.
*
* @see https://www.boschtoolservice.com/gb/en/boschdiy/spareparts/search-results?q=Indego
* @see <a href=
* "https://www.boschtoolservice.com/gb/en/boschdiy/spareparts/search-results?q=Indego">
* https://www.boschtoolservice.com/gb/en/boschdiy/spareparts/search-results?q=Indego</a>
*
* @param toolTypeNumber condensed tool type number, e.g. "3600HA2200" rather than "3 600 HA2 200".
* @return tool type name