Skip to content

Enforce Javadoc doclint via inherited property and failOnWarnings #166

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.

Sign up for GitHub

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

Merged
vharseko merged 1 commit into from
Jul 16, 2026
Merged

Enforce Javadoc doclint via inherited property and failOnWarnings #166

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
7 changes: 3 additions & 4 deletions contrib-http-framework/src/main/java/org/forgerock/http/filter/ConditionalFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* information: "Portions copyright [year] [name of copyright owner]".
*
* Copyright 2016 ForgeRock AS.
* Portions Copyrighted 2026 3A Systems, LLC.
*/

package org.forgerock.http.filter;
Expand Down Expand Up @@ -48,18 +49,16 @@ public class ConditionalFilter implements Filter {
* This constructor is provided as an ease to write some code : since you have access to the boolean,
* you may optimise the code like this :
* <pre>
* {@code
* if (condition) {
* return delegate;
* } else {
* return new Filter() {
* @Override
* public Promise<Response, NeverThrowsException> filter(Context context, Request request, Handler handler) {
* &#64;Override
* public Promise&lt;Response, NeverThrowsException&gt; filter(Context context, Request request, Handler handler) {
* return handler.handle(context, request);
* }
* };
* }
* }
* </pre>
*
* @param delegate
Expand Down
4 changes: 2 additions & 2 deletions ...g-ai/src/main/java/org/openidentityplatform/openig/ai/filter/MCPServerFeaturesFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -46,8 +46,8 @@

/**
* MCPServerFeaturesFilter
* <br/>
* This filter enforces allow/deny policies for MCP (Management & Control Protocol)
* <br>
* This filter enforces allow/deny policies for MCP (Management &amp; Control Protocol)
* features exchanged as JSON-RPC payloads with an MCP server. It inspects both
* incoming requests and outgoing responses and removes or rejects features
* according to the configured rules.
Expand Down
3 changes: 2 additions & 1 deletion openig-core/src/main/java/org/forgerock/openig/el/ExpressionRequestAsyncFunction.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* information: "Portions copyright [year] [name of copyright owner]".
*
* Copyright 2016 ForgeRock AS.
* Portions Copyrighted 2026 3A Systems, LLC.
*/

package org.forgerock.openig.el;
Expand All @@ -25,7 +26,7 @@

/**
* This is an implementation of the {@link AsyncFunction} based on the evaluation of an {@link Expression}.
* @param <V>
* @param <V> the type of the value returned by the evaluated expression
*/
public class ExpressionRequestAsyncFunction<V> implements AsyncFunction<ContextAndRequest, V, Exception> {

Expand Down
1 change: 0 additions & 1 deletion openig-core/src/main/java/org/forgerock/openig/filter/OpenApiValidationFilter.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -64,7 +64,6 @@
* {@code 503 Service Unavailable}</li>
* <li>{@code false} (default) – log a warning and pass the original response through.</li>
* </ul>
* </p>
*
* <h2>Heap configuration</h2>
* <pre>{@code
Expand Down
7 changes: 4 additions & 3 deletions openig-core/src/main/java/org/forgerock/openig/filter/PasswordReplayFilterHeaplet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* information: "Portions Copyright [year] [name of copyright owner]".
*
* Copyright 2015-2016 ForgeRock AS.
* Portions Copyrighted 2026 3A Systems, LLC.
*/

package org.forgerock.openig.filter;
Expand Down Expand Up @@ -76,9 +77,9 @@
* <li>Extracted patterns need to have at least a single regex group, the first one is always used</li>
* </ul>
*
* <h3>Usage examples:</h3>
* <h2>Usage examples:</h2>
*
* <h4>Authenticate on behalf of the user when a login page is GET</h4>
* <h3>Authenticate on behalf of the user when a login page is GET</h3>
*
* <p>When a {@literal GET} request to the login page is intercepted, OpenIG will generate an alternative
* authentication request and send it in place of the original request. The response is forwarded as-is to the caller.
Expand All @@ -99,7 +100,7 @@
* }
* </pre>
*
* <h4>Authenticate on behalf of the user when a login page is returned</h4>
* <h3>Authenticate on behalf of the user when a login page is returned</h3>
*
* <p>When a response that is identified to be a login page is intercepted, OpenIG will generate an authentication
* request and send it. The authentication response is ignored ATM. Then OpenIG replays the original incoming request.
Expand Down
2 changes: 1 addition & 1 deletion openig-core/src/main/java/org/forgerock/openig/handler/router/RouterHandler.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -104,7 +104,7 @@
* synchronously.</li>
* </ul>
* In both cases, the default value is 10 seconds.
* <br/>
* <br>
* <p>In addition to regular route JSON files, this handler now also recognises OpenAPI spec files
* ({@code .json}, {@code .yaml}, {@code .yml}) dropped into the same routes directory.
* When {@code openApiValidation.mockMode} is {@code true}, auto-generated routes use an
Expand Down
3 changes: 2 additions & 1 deletion openig-core/src/main/java/org/forgerock/openig/heap/GenericHeaplet.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
*
* Copyright 2010-2011 ApexIdentity Inc.
* Portions Copyright 2011-2016 ForgeRock AS.
* Portions Copyrighted 2026 3A Systems, LLC.
*/

package org.forgerock.openig.heap;
Expand All @@ -39,7 +40,7 @@
/**
* A generic base class for heaplets with automatically injected fields.
* <p>
* If the object created is an instance of {@link GenericHeapObject}, it is then
* If the object created is an instance of {@code GenericHeapObject}, it is then
* automatically injected with {@code logger} and {@code storage} objects.
*/
public abstract class GenericHeaplet implements Heaplet {
Expand Down
3 changes: 2 additions & 1 deletion openig-core/src/main/java/org/forgerock/openig/heap/Keys.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,7 @@
* information: "Portions copyright [year] [name of copyright owner]".
*
* Copyright 2015-2016 ForgeRock AS.
* Portions Copyrighted 2026 3A Systems, LLC.
*/
package org.forgerock.openig.heap;

Expand Down Expand Up @@ -99,7 +100,7 @@ public final class Keys {
public static final String SESSION_FACTORY_HEAP_KEY = "Session";

/**
* Key to retrieve an implementation of a {@link org.forgerock.util.Factory<org.forgerock.http.io.Buffer>} instance
* Key to retrieve an implementation of a {@link org.forgerock.util.Factory}&lt;{@link org.forgerock.http.io.Buffer}&gt; instance
* from the {@link org.forgerock.openig.heap.Heap}.
*/
public static final String TEMPORARY_STORAGE_HEAP_KEY = "TemporaryStorage";
Expand Down
4 changes: 2 additions & 2 deletions openig-core/src/main/java/org/forgerock/openig/util/JsonValues.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -212,7 +212,7 @@ public static Function<JsonValue, String, JsonValueException> heapObjectNameOrPo

/**
* Returns a function that will evaluate all String nodes. Transformation is applied
* recursively. <p>Malformed expressions are ignored e.g: <tt>"$$$${{"</tt>
* recursively. <p>Malformed expressions are ignored e.g: <code>"$$$${{"</code>
* and their values are not changed. <p>When an error occurs during the
* evaluation of an expression, the value is set to {@code null} because we
* cannot differentiate successful evaluations or failed ones.
Expand All @@ -225,7 +225,7 @@ public static Function<JsonValue, JsonValue, JsonValueException> evaluated() {

/**
* Returns a function that will evaluate all String nodes. Transformation is applied
* recursively. <p>Malformed expressions are ignored e.g: <tt>"$$$${{"</tt>
* recursively. <p>Malformed expressions are ignored e.g: <code>"$$$${{"</code>
* and their values are not changed. <p>When an error occurs during the
* evaluation of an expression, the value is set to {@code null} because we
* cannot differentiate successful evaluations or failed ones.
Expand Down
10 changes: 7 additions & 3 deletions pom.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,7 +38,10 @@
<maven.min.version>3.1.0</maven.min.version>
<maven.compiler.target>11</maven.compiler.target>
<maven.compiler.source>11</maven.compiler.source>


<!-- Javadoc doclint level, inherited by all modules. -->
<doclint>all,-missing</doclint>

<!-- ForgeRock build tools and Checkstyle versions (to avoid many checkstyle errors with ForgeRock Parent 2.0.10) -->
<forgerockBuildToolsVersion>1.0.3</forgerockBuildToolsVersion>
<checkstylePluginVersion>2.9.1</checkstylePluginVersion>
Expand Down Expand Up @@ -859,7 +862,8 @@
</execution>
</executions>
<configuration>
<doclint>none</doclint>
<doclint>${doclint}</doclint>
<failOnWarnings>true</failOnWarnings>
<notimestamp>true</notimestamp>
</configuration>
</plugin>
Expand Down Expand Up @@ -956,7 +960,7 @@
<plugin>
<groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-javadoc-plugin</artifactId>
<version>3.10.1</version>
<version>3.12.0</version>
<configuration>
</configuration>
</plugin>
Expand Down