DASCA/WALA
2
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Remove useless "@return" tags with no descriptive text

Browse Source
This commit is contained in:
Ben Liblit 2017-12-19 16:05:34 -06:00
parent 85ca6424b1
commit 0d6d9f2b2e
27 changed files with 3 additions and 60 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
com.ibm.wala.cast.java.ecj/src/com/ibm/wala/cast/java/translator/jdt/JDT2CAstUtils.java
View File

@ -174,7 +174,6 @@ public class JDT2CAstUtils {
* Returns true if type is char, byte, short, int, or long. Return false otherwise (including boolean!)
*
* @param type
* @return
*/
public static boolean isLongOrLess(ITypeBinding type) {
String t = type.getBinaryName();
@ -186,7 +185,6 @@ public class JDT2CAstUtils {
* CAstSymbol.NULL_DEFAULT_VALUE.
*
* @param type
* @return
*/
public static Object defaultValueForType(ITypeBinding type) {
if (isLongOrLess(type))
@ -237,7 +235,6 @@ public class JDT2CAstUtils {
*
* @param returnType
* @param ast
* @return
*/
public static ITypeBinding getErasedType(ITypeBinding returnType, AST ast) {
if (returnType.isTypeVariable() || returnType.isCapture())

13
com.ibm.wala.cast.java.ecj/src/com/ibm/wala/cast/java/translator/jdt/JDTJava2CAstTranslator.java
View File

@ -411,7 +411,6 @@ public abstract class JDTJava2CAstTranslator<T extends Position> {
* @param typeBinding
* @param name Used in creating default constructor, and passed into new ClassEntity()
* @param context
* @return
*/
private CAstEntity createClassDeclaration(ASTNode n, List<BodyDeclaration> bodyDecls,
List<EnumConstantDeclaration> enumConstants, ITypeBinding typeBinding, String name, int modifiers,
@ -649,7 +648,6 @@ public abstract class JDTJava2CAstTranslator<T extends Position> {
* constructor.
* @param context
* @param inits
* @return
*/
private CAstNode createConstructorBody(MethodDeclaration n, ITypeBinding classBinding, WalkContext context,
ArrayList<ASTNode> inits) {
@ -721,7 +719,6 @@ public abstract class JDTJava2CAstTranslator<T extends Position> {
* @param overriding Declaration of the overriding method.
* @param overridden Binding of the overridden method, in a a superclass or implemented interface.
* @param oldContext
* @return
*/
private CAstEntity makeSyntheticCovariantRedirect(MethodDeclaration overriding, IMethodBinding overridingBinding,
IMethodBinding overridden, WalkContext oldContext) {
@ -1665,7 +1662,6 @@ public abstract class JDTJava2CAstTranslator<T extends Position> {
* the code into an assignment and binary operation.
*
* @param context
* @return
*/
private CAstNode doFunkyGenericAssignPreOpHack(Assignment assign, WalkContext context) {
Expression left = assign.getLeftHandSide();
@ -1751,7 +1747,6 @@ public abstract class JDTJava2CAstTranslator<T extends Position> {
*
* @param n
* @param context
* @return
*/
private CAstNode visit(SimpleName n, WalkContext context) {
// class name, handled above in either method invocation, qualified name, or qualified this
@ -1818,7 +1813,6 @@ public abstract class JDTJava2CAstTranslator<T extends Position> {
*
* @param typeOfThis
* @param isPrivate
* @return
*/
private static ITypeBinding findClosestEnclosingClassSubclassOf(ITypeBinding typeOfThis, ITypeBinding owningType, boolean isPrivate) {
// GENERICS
@ -1866,7 +1860,6 @@ public abstract class JDTJava2CAstTranslator<T extends Position> {
*
* @param n
* @param context
* @return
*/
private CAstNode visit(FieldAccess n, WalkContext context) {
CAstNode targetNode = visitNode(n.getExpression(), context);
@ -1883,7 +1876,6 @@ public abstract class JDTJava2CAstTranslator<T extends Position> {
* @param fieldName Name of the field.
* @param positioningNode Used only for making a JdtPosition.
* @param context
* @return
*/
private CAstNode createFieldAccess(CAstNode targetNode, String fieldName, IVariableBinding possiblyParameterizedBinding,
ASTNode positioningNode, WalkContext context) {
@ -1978,7 +1970,6 @@ public abstract class JDTJava2CAstTranslator<T extends Position> {
*
* @param n
* @param context
* @return
*/
private CAstNode visit(QualifiedName n, WalkContext context) {
// "package.Class" is a QualifiedName, but also is "Class.staticField"
@ -2443,7 +2434,6 @@ public abstract class JDTJava2CAstTranslator<T extends Position> {
*
* @param n
* @param context
* @return
*/
private CAstNode visit(EnhancedForStatement n, WalkContext context) {
if (n.getExpression().resolveTypeBinding().isArray())
@ -2791,7 +2781,6 @@ public abstract class JDTJava2CAstTranslator<T extends Position> {
* Giant switch statement.
*
* @param n
* @return
*/
private CAstEntity visit(AbstractTypeDeclaration n, WalkContext context) {
// handling of compilationunit in translate()
@ -2811,7 +2800,6 @@ public abstract class JDTJava2CAstTranslator<T extends Position> {
* Giant switch statement, part deux
*
* @param context
* @return
*/
private CAstNode visitNode(ASTNode n, WalkContext context) {
if (n == null)
@ -3320,7 +3308,6 @@ public abstract class JDTJava2CAstTranslator<T extends Position> {
*
* @param decl
* @param context
* @return
*/
private CAstEntity visit(EnumConstantDeclaration decl, WalkContext context) {
return new FieldEntity(decl.getName().getIdentifier(), decl.resolveVariable().getType(), enumQuals, makePosition(decl

11
com.ibm.wala.cast.js.nodejs/src/com/ibm/wala/cast/js/nodejs/NodejsRequireTargetSelector.java
View File

@ -185,7 +185,6 @@ public class NodejsRequireTargetSelector implements MethodTargetSelector {
*
* @param dir Y in the pseudo algorithm
* @param target X in the pseudo algorithm
* @return
* @throws IOException
*/
public static SourceFileModule resolve(File rootDir, File dir, String target) throws IOException {
@ -214,8 +213,7 @@ public class NodejsRequireTargetSelector implements MethodTargetSelector {
* 4. If X.node is a file, load X.node as binary addon. STOP
*
* @param f
* @return
* @throws IOException
* @throws IOException
*/
private static SourceFileModule loadAsFile(File rootDir, File f) throws IOException {
// 1.
@ -248,7 +246,6 @@ public class NodejsRequireTargetSelector implements MethodTargetSelector {
* 4. If X/index.node is a file, load X/index.node as binary addon. STOP
*
* @param d
* @return
* @throws IOException
*/
private static SourceFileModule loadAsDirectory(File rootDir, File d) throws IOException {
@ -293,8 +290,7 @@ public class NodejsRequireTargetSelector implements MethodTargetSelector {
*
* @param dir
* @param target
* @return
* @throws IOException
* @throws IOException
*/
private static SourceFileModule loadNodeModules(File rootDir, File d, String target) throws IOException {
List<File> dirs = nodeModulePaths(rootDir, d);
@ -322,8 +318,7 @@ public class NodejsRequireTargetSelector implements MethodTargetSelector {
* 5. return DIRS
*
* @param d
* @return
* @throws IOException
* @throws IOException
*/
private static List<File> nodeModulePaths(File rootDir, File d) throws IOException {
LinkedList<File> dirs = new LinkedList<>();

1
com.ibm.wala.cast.js.nodejs/src/com/ibm/wala/cast/js/nodejs/NodejsRequiredSourceModule.java
View File

@ -125,7 +125,6 @@ public class NodejsRequiredSourceModule extends SourceFileModule {
*
* @param rootDir
* @param file
* @return
*/
public static String convertFileToClassName(File rootDir, File file) {
URI normalizedWorkingDirURI = rootDir.getAbsoluteFile().toURI().normalize();

2
com.ibm.wala.cast.js/source/com/ibm/wala/cast/js/html/IUrlResolver.java
View File

@ -22,14 +22,12 @@ public interface IUrlResolver {
/**
* From Internet to local
* @param input
* @return
*/
public URL resolve(URL input);
/**
* From local to Internet
* @param input
* @return
*/
public URL deResolve(URL input);

1
com.ibm.wala.cast.js/source/com/ibm/wala/cast/js/html/UrlManipulator.java
View File

@ -19,7 +19,6 @@ public class UrlManipulator {
/**
* @param urlFound the link as appear
* @param context the URL in which the link appeared
* @return
* @throws MalformedURLException
*/
public static URL relativeToAbsoluteUrl(String urlFound, URL context) throws MalformedURLException {

1
com.ibm.wala.cast.js/source/com/ibm/wala/cast/js/ipa/callgraph/JSCallGraphUtil.java
View File

@ -107,7 +107,6 @@ public class JSCallGraphUtil extends com.ibm.wala.cast.ipa.callgraph.CAstCallGra
/**
* @param preprocessor CAst rewriter to use for preprocessing JavaScript source files; may be null
* @return
*/
public static JavaScriptLoaderFactory makeLoaders(CAstRewriterFactory<?, ?> preprocessor) {
if (translatorFactory == null) {

1
com.ibm.wala.cast.js/source/com/ibm/wala/cast/js/ipa/callgraph/JavaScriptFunctionDotCallTargetSelector.java
View File

@ -124,7 +124,6 @@ public class JavaScriptFunctionDotCallTargetSelector implements MethodTargetSele
* @param caller
* @param site
* @param receiver
* @return
*/
private IMethod getFunctionCallTarget(CGNode caller, CallSiteReference site, IClass receiver) {
int nargs = getNumberOfArgsPassed(caller, site);

1
com.ibm.wala.cast.js/source/com/ibm/wala/cast/js/ipa/callgraph/RecursionCheckContextSelector.java
View File

@ -130,7 +130,6 @@ public class RecursionCheckContextSelector implements ContextSelector {
/**
* is it possible for m to be involved in a recursive cycle?
* @param m
* @return
*/
private static boolean recursionPossible(IMethod m) {
// object or array constructors cannot be involved

1
com.ibm.wala.cast.js/source/com/ibm/wala/cast/js/translator/PropertyReadExpander.java
View File

@ -145,7 +145,6 @@ public class PropertyReadExpander extends CAstRewriter<PropertyReadExpander.Rewr
* @param element
* @param context
* @param nodeMap
* @return
*/
private CAstNode makeConstRead(CAstNode root, CAstNode receiver, CAstNode element, RewriteContext context,
Map<Pair<CAstNode, ExpanderKey>, CAstNode> nodeMap) {

2
com.ibm.wala.cast/source/java/com/ibm/wala/cast/ipa/callgraph/DelegatingAstPointerKeys.java
View File

@ -94,7 +94,6 @@ public class DelegatingAstPointerKeys implements AstPointerKeyFactory {
* get type for F appropriate for use in a field name.
*
* @param F
* @return
*/
protected IClass getFieldNameType(InstanceKey F) {
return F.getConcreteType();
@ -103,7 +102,6 @@ public class DelegatingAstPointerKeys implements AstPointerKeyFactory {
/**
* if F is a supported constant representing a field, return the corresponding {@link InstanceFieldKey} for I. Otherwise, return <code>null</code>.
* @param F
* @return
*/
protected PointerKey getInstanceFieldPointerKeyForConstant(InstanceKey I, ConstantKey<?> F) {
Object v = F.getValue();

1
com.ibm.wala.cast/source/java/com/ibm/wala/cast/ipa/callgraph/ScopeMappingInstanceKeys.java
View File

@ -88,7 +88,6 @@ abstract public class ScopeMappingInstanceKeys implements InstanceKeyFactory {
* get the CGNode representing the lexical parent of {@link #creator} with
* name definer
*
* @return
*/
public Iterator<CGNode> getFunargNodes(Pair<String, String> name) {
Collection<CGNode> constructorCallers = getConstructorCallers(this, name);

3
com.ibm.wala.cast/source/java/com/ibm/wala/cast/ir/ssa/AssignInstruction.java
View File

@ -62,9 +62,6 @@ public class AssignInstruction extends SSAUnaryOpInstruction {
((AstPreInstructionVisitor) v).visitAssign(this);
}
/**
* @return
*/
public int getVal() {
return getUse(0);
}

1
com.ibm.wala.cast/source/java/com/ibm/wala/cast/ir/translator/AstTranslator.java
View File

@ -323,7 +323,6 @@ public abstract class AstTranslator extends CAstVisitor<AstTranslator.WalkContex
* the AST node representing the read
* @param context
* @param name
* @return
*/
protected int doLexicallyScopedRead(CAstNode node, WalkContext context, final String name, TypeReference type) {
return doLexReadHelper(context, name, type);

2
com.ibm.wala.core.tests/src/com/ibm/wala/core/tests/demandpa/AbstractPtrTest.java
View File

@ -249,7 +249,6 @@ public abstract class AbstractPtrTest {
/**
* @param scope
* @return
* @throws ClassHierarchyException
*/
private static IClassHierarchy findOrCreateCHA(AnalysisScope scope) throws ClassHierarchyException {
@ -261,7 +260,6 @@ public abstract class AbstractPtrTest {
/**
* @param scopeFile
* @return
* @throws IOException
*/
private AnalysisScope findOrCreateAnalysisScope() throws IOException {

1
com.ibm.wala.core.tests/src/com/ibm/wala/core/tests/slicer/SlicerTest.java
View File

@ -1068,7 +1068,6 @@ public class SlicerTest {
* @param cg
* @param d
* @param name
* @return
*/
private static CGNode findMethod(CallGraph cg, Descriptor d, Atom name) {
for (CGNode n : Iterator2Iterable.make(cg.getSuccNodes(cg.getFakeRootNode()))) {

3
com.ibm.wala.core/src/com/ibm/wala/demandpa/alg/DemandRefinementPointsTo.java
View File

@ -259,7 +259,6 @@ public class DemandRefinementPointsTo extends AbstractDemandPointsTo {
/**
* @param pk
* @param ikeyPred
* @return
*/
private Pair<PointsToResult, Collection<InstanceKeyAndState>> getPointsToWithStates(PointerKey pk, Predicate<InstanceKey> ikeyPred) {
if (!(pk instanceof com.ibm.wala.ipa.callgraph.propagation.LocalPointerKey)) {
@ -539,7 +538,6 @@ public class DemandRefinementPointsTo extends AbstractDemandPointsTo {
/**
* @param ik
* @return
*/
private Pair<PointsToResult, Collection<PointerKey>> getFlowsToInternal(InstanceKeyAndState ikAndState) {
InstanceKey ik = ikAndState.getInstanceKey();
@ -1666,7 +1664,6 @@ public class DemandRefinementPointsTo extends AbstractDemandPointsTo {
* @param addGraphs whether graphs should always be added
* @param callee
* @param pkAndState
* @return
*/
protected boolean calleeSubGraphMissingAndShouldNotBeAdded(boolean addGraphs, CGNode callee, PointerKeyAndState pkAndState) {
return !addGraphs && !g.hasSubgraphForNode(callee);

2
com.ibm.wala.core/src/com/ibm/wala/util/strings/Atom.java
View File

@ -468,8 +468,6 @@ public final class Atom implements Serializable {
/**
* Special method that is called by Java deserialization process. Any HashCons'ed object should implement it, in order to make
* sure that all equal objects are consolidated.
*
* @return
*/
private Object readResolve() {
return findOrCreate(this.val);

3
com.ibm.wala.core/src/com/ibm/wala/viz/viewer/PaPanel.java
View File

@ -194,7 +194,6 @@ public class PaPanel extends JSplitPane {
/**
* Override if you want different roots for your heap tree.
* @return
*/
protected List<Object> getRootNodes(){
List<Object> ret = new ArrayList<>();
@ -230,7 +229,6 @@ public class PaPanel extends JSplitPane {
/**
* Used for filling the tree dynamically. Override and handle your own nodes / different links.
* @param node
* @return
*/
protected List<Object> getChildrenFor(Object node) {
List<Object> ret = new ArrayList<>();
@ -255,7 +253,6 @@ public class PaPanel extends JSplitPane {
* pointer keys (not just for fields)
*
* @param ik
* @return
*/
protected List<? extends PointerKey> getPointerKeysUnderInstanceKey(InstanceKey ik) {
int ikIndex = pa.getInstanceKeyMapping().getMappedIndex(ik);

1
com.ibm.wala.ide.jdt.test/source/com/ibm/wala/demandpa/driver/DemandCastChecker.java
View File

@ -177,7 +177,6 @@ public class DemandCastChecker {
* @param scope
* @param cha
* @param options
* @return
* @throws CancelException
* @throws IllegalArgumentException
*/

1
com.ibm.wala.scandroid/source/org/scandroid/flow/types/FlowType.java
View File

@ -124,7 +124,6 @@ public abstract class FlowType<E extends ISSABasicBlock> {
*
* @param a
* @param b
* @return
*/
@SuppressWarnings("unused")
private boolean compareBlocks(BasicBlockInContext<E> a,

1
com.ibm.wala.scandroid/source/org/scandroid/spec/MethodNamePattern.java
View File

@ -98,7 +98,6 @@ public class MethodNamePattern {
* Returns a Collection of IMethods which are found in the following
* ClassLoaders: Application, Primordial, Extension
* @param cha
* @return
*/
public Collection<IMethod> getPossibleTargets(IClassHierarchy cha) {
Collection<IMethod> matching = new LinkedList<>();

1
com.ibm.wala.scandroid/source/org/scandroid/spec/SpecUtils.java
View File

@ -58,7 +58,6 @@ public class SpecUtils {
*
* @param s1
* @param s2
* @return
*/
public static ISpecs combine(final ISpecs s1, final ISpecs s2) {
return new ISpecs() {

3
com.ibm.wala.scandroid/source/org/scandroid/spec/StaticSpecs.java
View File

@ -99,9 +99,6 @@ public class StaticSpecs implements ISpecs {
return new SourceSpec[] {};
}
/**
* @return
*/
private List<IField> collectFields() {
List<IField> fields = new ArrayList<>();
Iterator<IClass> itr = cha.iterator();

1
com.ibm.wala.scandroid/source/org/scandroid/synthmethod/SSAtoXMLVisitor.java
View File

@ -465,7 +465,6 @@ public class SSAtoXMLVisitor implements SSAInstruction.IVisitor {
*
* @param defNum
*
* @return
* @throws IllegalStateException
*/
private String getLocalName(int defNum) throws IllegalStateException {

1
com.ibm.wala.scandroid/source/org/scandroid/synthmethod/XMLSummaryWriter.java
View File

@ -267,7 +267,6 @@ public class XMLSummaryWriter {
* (I[Ljava/lang/String;)[Ljava/lang/String;
*
* @param summary
* @return
*/
private static String getMethodDescriptor(MethodSummary summary) {
StringBuilder typeSigs = new StringBuilder("(");

1
com.ibm.wala.scandroid/source/org/scandroid/util/AndroidAnalysisContext.java
View File

@ -299,7 +299,6 @@ public class AndroidAnalysisContext {
/**
* Returns all concrete classes implementing the given interface or any subinterfaces
* @param iRoot
* @return
*/
public Collection<IClass> concreteClassesForInterface(IClass iRoot) {
Set<IClass> clazzes = HashSetFactory.make();