Skip to content

Commit 840a29f

Browse files
committed
chore: update javadoc internal API tags (#6391)
2 parents 75fb5eb + 7dcfeea commit 840a29f

41 files changed

Lines changed: 61 additions & 50 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.

pmd-ant/src/main/java/net/sourceforge/pmd/ant/InternalApiBridge.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@
2020
* <p><b>None of this is published API, and compatibility can be broken anytime!</b>
2121
* Use this only at your own risk.
2222
*
23-
* @apiNote Internal API
23+
* @internalApi None of this is published API, and compatibility can be broken anytime! Use this only at your own risk.
2424
*/
2525
@InternalApi
2626
public final class InternalApiBridge {

pmd-ant/src/main/java/net/sourceforge/pmd/ant/ReportException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
/**
88
* @author Philippe T'Seyen
9-
* @apiNote Internal API
9+
* @internalApi None of this is published API, and compatibility can be broken anytime! Use this only at your own risk.
1010
*/
1111
class ReportException extends RuntimeException {
1212
private static final long serialVersionUID = 6043174086675858209L;

pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/ast/ApexCommentBuilder.java

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,6 @@
1919
import org.antlr.v4.runtime.Recognizer;
2020
import org.antlr.v4.runtime.Token;
2121

22-
import net.sourceforge.pmd.annotation.InternalApi;
2322
import net.sourceforge.pmd.lang.ast.LexException;
2423
import net.sourceforge.pmd.lang.ast.impl.SuppressionCommentImpl;
2524
import net.sourceforge.pmd.lang.document.FileLocation;
@@ -30,7 +29,6 @@
3029
import io.github.apexdevtools.apexparser.ApexLexer;
3130
import io.github.apexdevtools.apexparser.CaseInsensitiveInputStream;
3231

33-
@InternalApi
3432
final class ApexCommentBuilder {
3533
private final TextDocument sourceCode;
3634
private final CommentInformation commentInfo;

pmd-apex/src/main/java/net/sourceforge/pmd/lang/apex/multifile/InternalApiBridge.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@
1616
* <p><b>None of this is published API, and compatibility can be broken anytime!</b>
1717
* Use this only at your own risk.
1818
*
19-
* @apiNote Internal API
19+
* @internalApi None of this is published API, and compatibility can be broken anytime! Use this only at your own risk.
2020
*/
2121
@InternalApi
2222
public final class InternalApiBridge {

pmd-core/src/main/java/net/sourceforge/pmd/PMDConfiguration.java

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -365,7 +365,7 @@ public void setReportProperties(Properties reportProperties) {
365365
*
366366
* @return The currently used analysis cache. Never null.
367367
*
368-
* @apiNote This is internal API.
368+
* @internalApi None of this is published API, and compatibility can be broken anytime! Use this only at your own risk.
369369
*/
370370
AnalysisCache getAnalysisCache() {
371371
// Make sure we are not null
@@ -385,7 +385,8 @@ AnalysisCache getAnalysisCache() {
385385
*
386386
* @param cache The analysis cache to be used.
387387
*
388-
* @apiNote This is internal API. Use {@link #setAnalysisCacheLocation(String)} to configure a cache.
388+
* @internalApi None of this is published API, and compatibility can be broken anytime! Use this only at your own risk.
389+
* Use {@link #setAnalysisCacheLocation(String)} to configure a cache.
389390
*/
390391
void setAnalysisCache(final AnalysisCache cache) {
391392
// the doc says it's a noop if incremental analysis was disabled,

pmd-core/src/main/java/net/sourceforge/pmd/cpd/Tokens.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ public class Tokens {
3232
/**
3333
* Create a new instance.
3434
*
35-
* @apiNote Internal API
35+
* @internalApi None of this is published API, and compatibility can be broken anytime! Use this only at your own risk.
3636
*/
3737
Tokens() {
3838
// constructor is package private

pmd-core/src/main/java/net/sourceforge/pmd/lang/InternalApiBridge.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -22,7 +22,7 @@
2222
* <p><b>None of this is published API, and compatibility can be broken anytime!</b>
2323
* Use this only at your own risk.
2424
*
25-
* @apiNote Internal API
25+
* @internalApi None of this is published API, and compatibility can be broken anytime! Use this only at your own risk.
2626
*/
2727
@InternalApi
2828
public final class InternalApiBridge {

pmd-core/src/main/java/net/sourceforge/pmd/lang/LanguageProcessor.java

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -72,7 +72,7 @@ class AnalysisTask {
7272
* Create a new task. This constructor is internal and will be
7373
* called by PMD.
7474
*
75-
* @apiNote Internal API
75+
* @internalApi None of this is published API, and compatibility can be broken anytime! Use this only at your own risk.
7676
*/
7777
AnalysisTask(RuleSets rulesets,
7878
List<TextFile> files,
@@ -121,7 +121,7 @@ public LanguageProcessorRegistry getLpRegistry() {
121121
/**
122122
* Produce a new analysis task with just different files.
123123
*
124-
* @apiNote Internal API
124+
* @internalApi None of this is published API, and compatibility can be broken anytime! Use this only at your own risk.
125125
*/
126126
AnalysisTask withFiles(List<TextFile> newFiles) {
127127
return new AnalysisTask(

pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/InternalApiBridge.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
* <p><b>None of this is published API, and compatibility can be broken anytime!</b>
1616
* Use this only at your own risk.
1717
*
18-
* @apiNote Internal API
18+
* @internalApi None of this is published API, and compatibility can be broken anytime! Use this only at your own risk.
1919
*/
2020
@InternalApi
2121
public final class InternalApiBridge {

pmd-core/src/main/java/net/sourceforge/pmd/lang/ast/LexException.java

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ public LexException(int line, int column, @Nullable FileId filename, String mess
4444
/**
4545
* Constructor called by JavaCC.
4646
*
47-
* @apiNote Internal API.
47+
* @internalApi None of this is published API, and compatibility can be broken anytime! Use this only at your own risk.
4848
*/
4949
LexException(boolean eofSeen, String lexStateName, int errorLine, int errorColumn, String errorAfter, char curChar) {
5050
super(makeReason(eofSeen, lexStateName, errorAfter, curChar));

0 commit comments

Comments
 (0)