[core] Unify javadoc for InternalApiBridge classes

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

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) {

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);

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);