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

@@ -62,7 +62,7 @@ public class AsuswrtHttpClient {
/**
* Sends a synchronous HTTP request.
*
* The result will be handled in {@link #handleHttpSuccessResponse(String, String) or
* The result will be handled in {@link #handleHttpSuccessResponse(String, String)} or
* {@link #handleHttpResultError(Throwable)}.
*
* If the response should be returned use {@link #getSyncRequest(String, String)} instead.
@@ -106,7 +106,7 @@ public class AsuswrtHttpClient {
/**
* Sends an asynchronous HTTP request so it does not wait for an answer.
*
* The result will be handled in {@link #handleHttpSuccessResponse(String, String) or
* The result will be handled in {@link #handleHttpSuccessResponse(String, String)} or
* {@link #handleHttpResultError(Throwable)}.
*
* @param url the URL to which the request is sent to

View File

@@ -39,7 +39,7 @@ public class AsuswrtErrorHandler {
/**
* Raises a new error.
*
* @param exception the exception
* @param ex the exception
*/
public void raiseError(Exception ex) {
raiseError(ex, "");
@@ -48,7 +48,7 @@ public class AsuswrtErrorHandler {
/**
* Raises a new error.
*
* @param exception the exception
* @param ex the exception
* @param infoMessage optional info message
*/
public void raiseError(Exception ex, @Nullable String infoMessage) {

View File

@@ -46,7 +46,7 @@ public class AsuswrtIpInfo {
/**
* Constructor.
*
* @param interfaceName name of interface
* @param ifName name of interface
* @param jsonObject with ipInfo
*/
public AsuswrtIpInfo(String ifName, JsonObject jsonObject) {

View File

@@ -393,7 +393,7 @@ public class AsuswrtRouter extends BaseBridgeHandler {
/**
* Fire Event
*
* @param channelUID chanelUID event belongs to
* @param channel chanelUID event belongs to
* @param event event-name is fired
*/
protected void fireEvent(String channel, String event) {