phoedos/pmd
1
1
Fork 1
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

[core] Unify javadoc for InternalApiBridge classes

Browse Source 
Refs #4348
This commit is contained in:
Andreas Dangel
2024-02-01 12:09:12 +01:00
parent 83879dc420
commit fae522a002
12 changed files with 107 additions and 38 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

12
pmd-ant/src/main/java/net/sourceforge/pmd/ant/InternalApiBridge.java
View File

@ -12,15 +12,19 @@ import net.sourceforge.pmd.annotation.InternalApi;
import net.sourceforge.pmd.reporting.GlobalAnalysisListener;
/**
* Gives access to package private methods.
* Internal API.
*
* <p>Acts as a bridge between outer parts of PMD and the restricted access
* internal API of this package.
*
* <p><b>None of this is published API, and compatibility can be broken anytime!</b>
* Use this only at your own risk.
*
* @apiNote Internal API
*/
@InternalApi
public final class InternalApiBridge {
private InternalApiBridge() {
// utility class
}
private InternalApiBridge() {}
public static GlobalAnalysisListener newListener(Formatter formatter, Project project) throws IOException {
return formatter.newListener(project);

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

@ -8,13 +8,19 @@ import net.sourceforge.pmd.annotation.InternalApi;
import net.sourceforge.pmd.lang.apex.ApexLanguageProperties;
/**
* Internal API.
*
* <p>Acts as a bridge between outer parts of PMD and the restricted access
* internal API of this package.
*
* <p><b>None of this is published API, and compatibility can be broken anytime!</b>
* Use this only at your own risk.
*
* @apiNote Internal API
*/
@InternalApi
public final class InternalApiBridge {
private InternalApiBridge() {
// utility class
}
private InternalApiBridge() {}
public static ApexMultifileAnalysis createApexMultiFileAnalysis(ApexLanguageProperties properties) {
return new ApexMultifileAnalysis(properties);

12
pmd-core/src/main/java/net/sourceforge/pmd/InternalApiBridge.java
View File

@ -8,15 +8,19 @@ import net.sourceforge.pmd.annotation.InternalApi;
import net.sourceforge.pmd.reporting.FileAnalysisListener;
/**
* Makes package private methods available for other packages. This is only internal.
* Internal API.
*
* <p>Acts as a bridge between outer parts of PMD and the restricted access
* internal API of this package.
*
* <p><b>None of this is published API, and compatibility can be broken anytime!</b>
* Use this only at your own risk.
*
* @apiNote Internal API
*/
@InternalApi
public final class InternalApiBridge {
private InternalApiBridge() {
// utility class
}
private InternalApiBridge() {}
public static Rule getRule(RuleContext ruleContext) {
return ruleContext.getRule();

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

@ -15,6 +15,14 @@ import net.sourceforge.pmd.util.log.PmdReporter;
/**
* Internal API.
*
* <p>Acts as a bridge between outer parts of PMD and the restricted access
* internal API of this package.
*
* <p><b>None of this is published API, and compatibility can be broken anytime!</b>
* Use this only at your own risk.
*
* @apiNote Internal API
*/
@InternalApi
public final class InternalApiBridge {

11
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/ast/InternalApiBridge.java
View File

@ -35,7 +35,9 @@ import net.sourceforge.pmd.lang.java.types.internal.infer.TypeInferenceLogger;
import net.sourceforge.pmd.util.AssertionUtil;
/**
* Acts as a bridge between outer parts of PMD and the restricted access
* Internal API.
*
* <p>Acts as a bridge between outer parts of PMD and the restricted access
* internal API of this package.
*
* <p><b>None of this is published API, and compatibility can be broken anytime!</b>
@ -43,14 +45,11 @@ import net.sourceforge.pmd.util.AssertionUtil;
*
* @author Clément Fournier
* @since 7.0.0
* @apiNote Internal API
*/
@InternalApi
public final class InternalApiBridge {
private InternalApiBridge() {
}
private InternalApiBridge() {}
@Deprecated
public static ASTVariableId newVarId(String image) {

12
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/types/InternalApiBridge.java
View File

@ -7,13 +7,19 @@ package net.sourceforge.pmd.lang.java.types;
import net.sourceforge.pmd.annotation.InternalApi;
/**
* Internal API.
*
* <p>Acts as a bridge between outer parts of PMD and the restricted access
* internal API of this package.
*
* <p><b>None of this is published API, and compatibility can be broken anytime!</b>
* Use this only at your own risk.
*
* @apiNote Internal API
*/
@InternalApi
public final class InternalApiBridge {
private InternalApiBridge() {
// internal api
}
private InternalApiBridge() {}
public static boolean isSameTypeInInference(JTypeMirror t, JTypeMirror s) {
return TypeOps.isSameTypeInInference(t, s);

12
pmd-java/src/main/java/net/sourceforge/pmd/lang/java/types/ast/InternalApiBridge.java
View File

@ -14,13 +14,19 @@ import net.sourceforge.pmd.lang.java.types.ast.internal.RegularCtx;
import net.sourceforge.pmd.util.AssertionUtil;
/**
* Internal API.
*
* <p>Acts as a bridge between outer parts of PMD and the restricted access
* internal API of this package.
*
* <p><b>None of this is published API, and compatibility can be broken anytime!</b>
* Use this only at your own risk.
*
* @apiNote Internal API
*/
@InternalApi
public final class InternalApiBridge {
private InternalApiBridge() {
// utility
}
private InternalApiBridge() {}
public static boolean canGiveContextToPoly(ExprContext exprContext, boolean lambdaOrMethodRef) {
return exprContext.canGiveContextToPoly(lambdaOrMethodRef);

12
pmd-jsp/src/main/java/net/sourceforge/pmd/lang/jsp/ast/InternalApiBridge.java
View File

@ -8,13 +8,19 @@ import net.sourceforge.pmd.annotation.InternalApi;
import net.sourceforge.pmd.lang.ast.impl.javacc.JavaccTokenDocument;
/**
* Internal API.
*
* <p>Acts as a bridge between outer parts of PMD and the restricted access
* internal API of this package.
*
* <p><b>None of this is published API, and compatibility can be broken anytime!</b>
* Use this only at your own risk.
*
* @apiNote Internal API
*/
@InternalApi
public final class InternalApiBridge {
private InternalApiBridge() {
// internal
}
private InternalApiBridge() {}
public static JavaccTokenDocument.TokenDocumentBehavior getJspTokenBehavior() {
return JspParser.TOKEN_BEHAVIOR;

11
pmd-modelica/src/main/java/net/sourceforge/pmd/lang/modelica/ast/InternalApiBridge.java
View File

@ -10,6 +10,17 @@ import net.sourceforge.pmd.lang.modelica.resolver.ModelicaScope;
import net.sourceforge.pmd.lang.modelica.resolver.internal.ResolutionContext;
import net.sourceforge.pmd.lang.modelica.resolver.internal.Watchdog;
/**
* Internal API.
*
* <p>Acts as a bridge between outer parts of PMD and the restricted access
* internal API of this package.
*
* <p><b>None of this is published API, and compatibility can be broken anytime!</b>
* Use this only at your own risk.
*
* @apiNote Internal API
*/
@InternalApi
public final class InternalApiBridge {
private InternalApiBridge() {}

11
pmd-modelica/src/main/java/net/sourceforge/pmd/lang/modelica/resolver/InternalApiBridge.java
View File

@ -11,6 +11,17 @@ import net.sourceforge.pmd.lang.modelica.ast.Visibility;
import net.sourceforge.pmd.lang.modelica.resolver.internal.ResolutionContext;
import net.sourceforge.pmd.lang.modelica.resolver.internal.Watchdog;
/**
* Internal API.
*
* <p>Acts as a bridge between outer parts of PMD and the restricted access
* internal API of this package.
*
* <p><b>None of this is published API, and compatibility can be broken anytime!</b>
* Use this only at your own risk.
*
* @apiNote Internal API
*/
@InternalApi
public final class InternalApiBridge {
private InternalApiBridge() {}

15
pmd-plsql/src/main/java/net/sourceforge/pmd/lang/plsql/ast/InternalApiBridge.java
View File

@ -10,17 +10,20 @@ import net.sourceforge.pmd.lang.symboltable.NameDeclaration;
import net.sourceforge.pmd.lang.symboltable.Scope;
/**
* Acts as a bridge between outer parts (e.g. symbol table) and the restricted
* access internal API of this package.
* Internal API.
*
* @apiNote This is internal API.
* <p>Acts as a bridge between outer parts of PMD and the restricted access
* internal API of this package.
*
* <p><b>None of this is published API, and compatibility can be broken anytime!</b>
* Use this only at your own risk.
*
* @apiNote Internal API
*/
@InternalApi
public final class InternalApiBridge {
private InternalApiBridge() {
}
private InternalApiBridge() {}
public static void setScope(PLSQLNode node, Scope decl) {
((AbstractPLSQLNode) node).setScope(decl);

15
pmd-visualforce/src/main/java/net/sourceforge/pmd/lang/vf/ast/InternalApiBridge.java
View File

@ -8,14 +8,19 @@ import net.sourceforge.pmd.annotation.InternalApi;
import net.sourceforge.pmd.lang.vf.DataType;
/**
* This is internal API, and can be changed at any time.
* Internal API.
*
* <p>Acts as a bridge between outer parts of PMD and the restricted access
* internal API of this package.
*
* <p><b>None of this is published API, and compatibility can be broken anytime!</b>
* Use this only at your own risk.
*
* @apiNote Internal API
*/
@InternalApi
public final class InternalApiBridge {
private InternalApiBridge() {
// utility class
}
private InternalApiBridge() {}
public static void setDataType(VfTypedNode node, DataType dataType) {
((AbstractVFDataNode) node).setDataType(dataType);