Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Issue #417: Fix wrong Javadoc references #429

Merged
merged 2 commits into from
Sep 27, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -128,7 +128,7 @@ public void stop() {
/**
* Close the closable and avoid any null pointer exception if the argument is <code>null</code>
*
* @param closable
* @param closeable
* @throws IOException
*/
private void close(Closeable closeable) throws IOException {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -59,7 +59,7 @@ public List<SqlTable> 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.
*/
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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.
*
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -325,7 +325,7 @@ private List<String> 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) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -182,7 +182,7 @@ public List<List<String>> 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.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down Expand Up @@ -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,
Expand Down Expand Up @@ -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,
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -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(
Expand Down