Skip to content

Commit 076dcec

Browse files
committed
fix(plugins): fix doc errors
1 parent 2d778a0 commit 076dcec

File tree

3 files changed

+8
-1
lines changed

3 files changed

+8
-1
lines changed

agent-api/src/main/java/com/intergral/deep/agent/api/plugin/IPlugin.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ interface IPluginRegistration extends IRegistration<IPlugin> {
7676
* Indicates if this plugin is currently set to be the auth provider
7777
*
7878
* @return {@code true} if the registered plugin is an {@link com.intergral.deep.agent.api.auth.IAuthProvider} and deep is configured to
79-
* use this provider, else {@link false}
79+
* use this provider, else {@code false}
8080
*/
8181
boolean isAuthProvider();
8282
}

agent-api/src/main/java/com/intergral/deep/agent/api/resource/ConfigurationException.java

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -12,13 +12,18 @@ public final class ConfigurationException extends RuntimeException {
1212

1313
/**
1414
* Create a new configuration exception with specified {@code message} and without a cause.
15+
*
16+
* @param message The exception message
1517
*/
1618
public ConfigurationException(String message) {
1719
super(message);
1820
}
1921

2022
/**
2123
* Create a new configuration exception with specified {@code message} and {@code cause}.
24+
*
25+
* @param message The exception message
26+
* @param cause The root cause of this exception
2227
*/
2328
public ConfigurationException(String message, Throwable cause) {
2429
super(message, cause);

agent-api/src/main/java/com/intergral/deep/agent/api/spi/Ordered.java

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,8 @@ public interface Ordered {
1616
* Returns the order of applying the SPI implementing this interface. Higher values are applied
1717
* later, for example: an SPI with order=1 will run after an SPI with order=0. SPI implementations
1818
* with equal values will be run in a non-deterministic order.
19+
*
20+
* @return the order value
1921
*/
2022
default int order() {
2123
return 0;

0 commit comments

Comments
 (0)