Skip to content

Commit 91d14b8

Browse files
authored
Enable strict Javadoc doclint (all,-missing) and fix all doclint issues (#197)
1 parent 6c2985d commit 91d14b8

93 files changed

Lines changed: 232 additions & 357 deletions

File tree

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

custom-scripted-connector-bundler/src/main/java/org/forgerock/openidm/tools/scriptedbundler/CustomObjectType.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
33
*
44
* Copyright (c) 2015 ForgeRock AS. All Rights Reserved
5+
* Portions Copyrighted 2026 3A Systems, LLC.
56
*
67
* The contents of this file are subject to the terms
78
* of the Common Development and Distribution License
@@ -32,7 +33,7 @@
3233
* A single connector configuration objectType, contained in {@link CustomConfiguration}.
3334
*
3435
* Given a JSON configuration such as:
35-
* <pre><blockquote>
36+
* <pre>
3637
* "objectTypes" : [
3738
* {
3839
* "name" : "group",
@@ -66,7 +67,7 @@
6667
* ]
6768
* }
6869
* ]
69-
* </blockquote></pre>
70+
* </pre>
7071
* this object represents a single objectType array element.
7172
*/
7273
public class CustomObjectType extends CustomBaseObject {

custom-scripted-connector-bundler/src/main/java/org/forgerock/openidm/tools/scriptedbundler/CustomObjectTypeProperty.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
33
*
44
* Copyright (c) 2015 ForgeRock AS. All Rights Reserved
5+
* Portions Copyrighted 2026 3A Systems, LLC.
56
*
67
* The contents of this file are subject to the terms
78
* of the Common Development and Distribution License
@@ -32,7 +33,7 @@
3233
* A single connector objectType property, contained in {@link CustomObjectType}.
3334
*
3435
* Given a JSON configuration such as:
35-
* <pre><blockquote>
36+
* <pre>
3637
* "properties" : [
3738
* {
3839
* "name" : "name",
@@ -57,7 +58,7 @@
5758
* ...
5859
* }
5960
* ]
60-
* </blockquote></pre>
61+
* </pre>
6162
* this object represents a single properties array element.
6263
*/
6364
public class CustomObjectTypeProperty extends CustomBaseObject {

custom-scripted-connector-bundler/src/main/java/org/forgerock/openidm/tools/scriptedbundler/CustomObjectTypePropertyFlag.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
33
*
44
* Copyright (c) 2015 ForgeRock AS. All Rights Reserved
5+
* Portions Copyrighted 2026 3A Systems, LLC.
56
*
67
* The contents of this file are subject to the terms
78
* of the Common Development and Distribution License
@@ -31,12 +32,12 @@
3132
* A single objectType property flag, contained in {@link CustomObjectTypeProperty}.
3233
*
3334
* Represented in a JSON configuration list as:
34-
* <pre><blockquote>
35+
* <pre>
3536
* "flags" : [
3637
* "NOT_READABLE",
3738
* "NOT_RETURNED_BY_DEFAULT"
3839
* ],
39-
* </blockquote></pre>
40+
* </pre>
4041
*/
4142
public class CustomObjectTypePropertyFlag extends CustomBaseObject {
4243
/**

custom-scripted-connector-bundler/src/main/java/org/forgerock/openidm/tools/scriptedbundler/CustomObjectTypePropertyItemProperty.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
33
*
44
* Copyright (c) 2015 ForgeRock AS. All Rights Reserved
5+
* Portions Copyrighted 2026 3A Systems, LLC.
56
*
67
* The contents of this file are subject to the terms
78
* of the Common Development and Distribution License
@@ -31,12 +32,12 @@
3132
* A single property of an objectType item, contained in {@link CustomObjectTypePropertyItems}.
3233
*
3334
* Represented in JSON as:
34-
* <pre><blockquote>
35+
* <pre>
3536
* {
3637
* "name" : "uid",
3738
* "type" : "string"
3839
* }
39-
* </blockquote></pre>
40+
* </pre>
4041
*/
4142
public class CustomObjectTypePropertyItemProperty extends CustomBaseObject {
4243
/**

custom-scripted-connector-bundler/src/main/java/org/forgerock/openidm/tools/scriptedbundler/CustomObjectTypePropertyItems.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
33
*
44
* Copyright (c) 2015 ForgeRock AS. All Rights Reserved
5+
* Portions Copyrighted 2026 3A Systems, LLC.
56
*
67
* The contents of this file are subject to the terms
78
* of the Common Development and Distribution License
@@ -33,7 +34,7 @@
3334
* A single connector configuration objectType, contained in {@link CustomObjectTypeProperty}.
3435
*
3536
* Represented in a JSON configuration as:
36-
* <pre><blockquote>
37+
* <pre>
3738
* {
3839
* "type" : "object",
3940
* "nativeType" : "object",
@@ -42,7 +43,7 @@
4243
* "type" : "string"
4344
* }]
4445
* }
45-
* </blockquote></pre>
46+
* </pre>
4647
*/
4748
public class CustomObjectTypePropertyItems extends CustomBaseObject {
4849

custom-scripted-connector-bundler/src/main/java/org/forgerock/openidm/tools/scriptedbundler/CustomProperty.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
33
*
44
* Copyright (c) 2015 ForgeRock AS. All Rights Reserved
5+
* Portions Copyrighted 2026 3A Systems, LLC.
56
*
67
* The contents of this file are subject to the terms
78
* of the Common Development and Distribution License
@@ -34,7 +35,7 @@
3435
* A single connector configuration property, contained in {@link CustomConfiguration}.
3536
*
3637
* The JSON configuration might contain something like the following:
37-
* <pre><blockquote>
38+
* <pre>
3839
* "properties" : [
3940
* {
4041
* "order" : 0,
@@ -58,7 +59,7 @@
5859
* "group" : "default"
5960
* }
6061
* ]
61-
* </blockquote></pre>
62+
* </pre>
6263
*
6364
* This object represents a single property in the list above. These properties define the connector's
6465
* configuration properties and are the data source for generating the code to support connector metadata

custom-scripted-connector-bundler/src/main/java/org/forgerock/openidm/tools/scriptedbundler/ProvidedProperty.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
33
*
44
* Copyright (c) 2015 ForgeRock AS. All Rights Reserved
5+
* Portions Copyrighted 2026 3A Systems, LLC.
56
*
67
* The contents of this file are subject to the terms
78
* of the Common Development and Distribution License
@@ -34,7 +35,7 @@
3435
* A single connector configuration property, contained in {@link org.forgerock.openidm.tools.scriptedbundler.CustomConfiguration}.
3536
*
3637
* The JSON configuration might contain something like the following:
37-
* <pre><blockquote>
38+
* <pre>
3839
* "providedProperties" : [
3940
* {
4041
* "name" : "FirstProperty",
@@ -46,7 +47,7 @@
4647
* "type" : "Float"
4748
* }
4849
* ]
49-
* </blockquote></pre>
50+
* </pre>
5051
*
5152
* This object represents a single property in the list above. These properties populate values for the properties
5253
* defined by default in the connector's base configuration class. For example, the ScriptedSQLConfiguration class

openidm-audit/src/main/java/org/forgerock/openidm/audit/impl/AuditLogger.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,7 @@
22
* DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS HEADER.
33
*
44
* Copyright 2011-2015 ForgeRock AS.
5+
* Portions Copyrighted 2026 3A Systems, LLC.
56
*
67
* The contents of this file are subject to the terms
78
* of the Common Development and Distribution License
@@ -109,7 +110,6 @@ public interface AuditLogger {
109110
* @param handler the {@link QueryResourceHandler} object.
110111
* @param type the type of audit log entries to query
111112
* @param formatted whether to format the results.
112-
* @return the query result object.
113113
* @throws NotFoundException if the specified object could not be found.
114114
* @throws ForbiddenException if access to the object or the specified query is forbidden.
115115
*/

openidm-authnfilter/src/main/java/org/forgerock/openidm/auth/modules/oauth/OAuthModule.java

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
* information: "Portions copyright [year] [name of copyright owner]".
1313
*
1414
* Copyright 2016 ForgeRock AS.
15+
* Portions Copyrighted 2026 3A Systems, LLC.
1516
*/
1617
package org.forgerock.openidm.auth.modules.oauth;
1718

@@ -190,7 +191,6 @@ public Promise<AuthStatus, AuthenticationException> validateRequest(MessageInfoC
190191
* @param messageInfo {@inheritDoc}
191192
* @param subject {@inheritDoc}
192193
* @return {@inheritDoc}
193-
* @throws AuthException {@inheritDoc}
194194
*/
195195
@Override
196196
public Promise<AuthStatus, AuthenticationException> secureResponse(MessageInfoContext messageInfo,
@@ -203,7 +203,6 @@ public Promise<AuthStatus, AuthenticationException> secureResponse(MessageInfoCo
203203
*
204204
* @param messageInfo {@inheritDoc}
205205
* @param subject {@inheritDoc}
206-
* @throws AuthException {@inheritDoc}
207206
*/
208207
@Override
209208
public Promise<Void, AuthenticationException> cleanSubject(MessageInfoContext messageInfo, Subject subject) {

openidm-config/src/main/java/org/forgerock/openidm/config/manage/ConfigObjectService.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@
1212
* information: "Portions copyright [year] [name of copyright owner]".
1313
*
1414
* Copyright 2011-2016 ForgeRock AS.
15-
* Portions Copyrighted 2024 3A Systems LLC.
15+
* Portions Copyrighted 2024-2026 3A Systems LLC.
1616
*/
1717

1818

@@ -313,7 +313,7 @@ public Promise<ResourceResponse, ResourceException> apply(
313313

314314
/**
315315
* Creates a new object in the object set.
316-
* <p/>
316+
* <p>
317317
* This method sets the {@code _id} property to the assigned identifier for the object,
318318
* and the {@code _rev} property to the revised object version (For optimistic concurrency)
319319
*

0 commit comments

Comments
 (0)