From d6427894730c219b09040b733156b562d967110c Mon Sep 17 00:00:00 2001 From: maalej Date: Fri, 27 Sep 2024 08:38:56 +0200 Subject: [PATCH] Issue #417: Fix wrong Javadoc references * Fix errors related to wrong javadoc references --- .../metricshub/agent/process/config/ProcessOutput.java | 2 +- .../metricshub/agent/process/runtime/ProcessControl.java | 2 +- .../connector/deserializer/custom/SqlTableDeserializer.java | 2 +- .../metricshub/engine/strategy/source/SourceProcessor.java | 2 +- .../extension/jawk/MetricsHubExtensionForJawk.java | 2 +- .../extension/snmp/AbstractSnmpRequestExecutor.java | 2 +- .../snmp/detection/SnmpGetNextCriterionProcessor.java | 6 +++--- .../extension/win/detection/WmiCriterionProcessor.java | 2 +- 8 files changed, 10 insertions(+), 10 deletions(-) diff --git a/metricshub-agent/src/main/java/org/sentrysoftware/metricshub/agent/process/config/ProcessOutput.java b/metricshub-agent/src/main/java/org/sentrysoftware/metricshub/agent/process/config/ProcessOutput.java index 1f83e729b..c9e358ce0 100644 --- a/metricshub-agent/src/main/java/org/sentrysoftware/metricshub/agent/process/config/ProcessOutput.java +++ b/metricshub-agent/src/main/java/org/sentrysoftware/metricshub/agent/process/config/ProcessOutput.java @@ -33,7 +33,7 @@ * {@link StreamProcessor} of the STDOUT is mandatory, if you don't define the * {@link StreamProcessor} of the STDERR, a redirection will take place and * the standard error and standard output will be merged. You can change this behavior by overriding - * the {@link AbstractProcess#onBeforeProcessStart(ProcessBuilder)}. + * the onBeforeProcessStart method in the {@link AbstractProcess}. */ @Data @Builder diff --git a/metricshub-agent/src/main/java/org/sentrysoftware/metricshub/agent/process/runtime/ProcessControl.java b/metricshub-agent/src/main/java/org/sentrysoftware/metricshub/agent/process/runtime/ProcessControl.java index 3f82668ba..c0fef8084 100644 --- a/metricshub-agent/src/main/java/org/sentrysoftware/metricshub/agent/process/runtime/ProcessControl.java +++ b/metricshub-agent/src/main/java/org/sentrysoftware/metricshub/agent/process/runtime/ProcessControl.java @@ -128,7 +128,7 @@ public void stop() { /** * Close the closable and avoid any null pointer exception if the argument is null * - * @param closable + * @param closeable * @throws IOException */ private void close(Closeable closeable) throws IOException { diff --git a/metricshub-engine/src/main/java/org/sentrysoftware/metricshub/engine/connector/deserializer/custom/SqlTableDeserializer.java b/metricshub-engine/src/main/java/org/sentrysoftware/metricshub/engine/connector/deserializer/custom/SqlTableDeserializer.java index 6eb21ceaf..8ac17d8b0 100644 --- a/metricshub-engine/src/main/java/org/sentrysoftware/metricshub/engine/connector/deserializer/custom/SqlTableDeserializer.java +++ b/metricshub-engine/src/main/java/org/sentrysoftware/metricshub/engine/connector/deserializer/custom/SqlTableDeserializer.java @@ -59,7 +59,7 @@ public List deserialize(JsonParser parser, DeserializationContext ctxt } /** - * Parse a {@link JsonNode} and try to create a {@link Sqltable} object from it and add it to the sqlTables list. + * Parse a {@link JsonNode} and try to create a {@link SqlTable} object from it and add it to the sqlTables list. * @param tableNode The JSON node to parse. * @param sqlTables The list where to add the SQL tables. */ diff --git a/metricshub-engine/src/main/java/org/sentrysoftware/metricshub/engine/strategy/source/SourceProcessor.java b/metricshub-engine/src/main/java/org/sentrysoftware/metricshub/engine/strategy/source/SourceProcessor.java index ce8c45a6d..ce34bde2f 100644 --- a/metricshub-engine/src/main/java/org/sentrysoftware/metricshub/engine/strategy/source/SourceProcessor.java +++ b/metricshub-engine/src/main/java/org/sentrysoftware/metricshub/engine/strategy/source/SourceProcessor.java @@ -152,7 +152,7 @@ private SourceTable processSourceThroughExtension(final Source source) { } /** - * Processes a given {@link Source} by using an appropriate {@link ISourceComputation} found through + * Processes a given {@link Source} by using an appropriate {@link ISourceComputationExtension} found through * an {@link ExtensionManager}. This method delegates the processing of the source to the extension * if available, or returns an empty {@link SourceTable} if no suitable extension is found. * diff --git a/metricshub-jawk-extension/src/main/java/org/sentrysoftware/metricshub/extension/jawk/MetricsHubExtensionForJawk.java b/metricshub-jawk-extension/src/main/java/org/sentrysoftware/metricshub/extension/jawk/MetricsHubExtensionForJawk.java index e02682790..103849470 100644 --- a/metricshub-jawk-extension/src/main/java/org/sentrysoftware/metricshub/extension/jawk/MetricsHubExtensionForJawk.java +++ b/metricshub-jawk-extension/src/main/java/org/sentrysoftware/metricshub/extension/jawk/MetricsHubExtensionForJawk.java @@ -325,7 +325,7 @@ private List toAwkListString(final Object arg) { /** * Return the value of the variable in parameter if it exists. - * @param arg The name of the variable to retrieve. + * @param args The name of the variable to retrieve. * @return The value of the variable. */ private String getVariable(final Object[] args) { diff --git a/metricshub-snmp-extension-common/src/main/java/org/sentrysoftware/metricshub/extension/snmp/AbstractSnmpRequestExecutor.java b/metricshub-snmp-extension-common/src/main/java/org/sentrysoftware/metricshub/extension/snmp/AbstractSnmpRequestExecutor.java index e81c9572c..29b8e42e6 100644 --- a/metricshub-snmp-extension-common/src/main/java/org/sentrysoftware/metricshub/extension/snmp/AbstractSnmpRequestExecutor.java +++ b/metricshub-snmp-extension-common/src/main/java/org/sentrysoftware/metricshub/extension/snmp/AbstractSnmpRequestExecutor.java @@ -182,7 +182,7 @@ public List> executeSNMPTable( * * @param request The type of SNMP request (GET, GETNEXT, TABLE). * @param oid The SNMP Object Identifier (OID) for the request. - * @param configuration The SNMP configuration containing connection details. + * @param protocol The SNMP configuration containing connection details. * @param hostname The hostname or IP address of the SNMP-enabled device. * @param selectColumnArray An array of column names for TABLE requests. * @param logMode Flag indicating whether to log warnings in case of errors. diff --git a/metricshub-snmp-extension-common/src/main/java/org/sentrysoftware/metricshub/extension/snmp/detection/SnmpGetNextCriterionProcessor.java b/metricshub-snmp-extension-common/src/main/java/org/sentrysoftware/metricshub/extension/snmp/detection/SnmpGetNextCriterionProcessor.java index 5325890e0..0f16d1e4c 100644 --- a/metricshub-snmp-extension-common/src/main/java/org/sentrysoftware/metricshub/extension/snmp/detection/SnmpGetNextCriterionProcessor.java +++ b/metricshub-snmp-extension-common/src/main/java/org/sentrysoftware/metricshub/extension/snmp/detection/SnmpGetNextCriterionProcessor.java @@ -135,7 +135,7 @@ public CriterionTestResult process( * @param hostname The hostname. * @param oid The SNMP OID. * @param result The result of the SNMP GetNext operation. - * @return {@link TestResult} wrapping the message and the success status. + * @return {@link CriterionTestResult} wrapping the message and the success status. */ static CriterionTestResult checkSNMPGetNextValue(final String hostname, final String oid, final String result) { String message; @@ -181,7 +181,7 @@ static CriterionTestResult checkSNMPGetNextValue(final String hostname, final St * @param oid The SNMP OID. * @param expected The expected value. * @param result The result of the SNMP GetNext operation. - * @return {@link TestResult} wrapping the message and the success status. + * @return {@link CriterionTestResult} wrapping the message and the success status. */ static CriterionTestResult checkSNMPGetNextExpectedValue( final String hostname, @@ -247,7 +247,7 @@ static CriterionTestResult checkSNMPGetNextExpectedValue( * @param oid The SNMP OID. * @param expected The expected value. * @param result The result of the SNMP GetNext operation. - * @return {@link TestResult} wrapping the success status and the message + * @return {@link CriterionTestResult} wrapping the success status and the message */ static CriterionTestResult checkSNMPGetNextResult( final String hostname, diff --git a/metricshub-win-extension-common/src/main/java/org/sentrysoftware/metricshub/extension/win/detection/WmiCriterionProcessor.java b/metricshub-win-extension-common/src/main/java/org/sentrysoftware/metricshub/extension/win/detection/WmiCriterionProcessor.java index 24739011f..f87aebd2f 100644 --- a/metricshub-win-extension-common/src/main/java/org/sentrysoftware/metricshub/extension/win/detection/WmiCriterionProcessor.java +++ b/metricshub-win-extension-common/src/main/java/org/sentrysoftware/metricshub/extension/win/detection/WmiCriterionProcessor.java @@ -241,7 +241,7 @@ public NamespaceResult detectNamespace( * @param telemetryManager The telemetry manager providing access to host configuration and WMI credentials. * @param hostname The hostname of the device * @param winConfiguration The WMI protocol configuration (credentials, etc.) - * @param wmiCriterion The WMI criterion with an "Automatic" namespace + * @param wqlCriterion The WMI criterion with an "Automatic" namespace * @return A {@link CriterionTestResult} telling whether we found the proper namespace for the specified WQL */ CriterionTestResult findNamespace(