Merge pull request #868 from MarcMil/fix-javadoc

StevenArzt · web-flow · commit 7f7d2120fea8 · 2026-02-19T11:36:05.000+01:00
Fix Javadoc
diff --git a/soot-infoflow-android/src/soot/jimple/infoflow/android/SetupApplication.java b/soot-infoflow-android/src/soot/jimple/infoflow/android/SetupApplication.java
@@ -928,14 +928,13 @@ protected AbstractCallbackAnalyzer createCallbackAnalyzerFromFile(InfoflowAndroi
 	 * out of memory. This method also starts the watchdog thread. Derived classes
 	 * can implement their own timeout handling if necessary.
 	 * 
-	 * @param callbackConfig The configuration for the callback analysis
-	 * @param analyzer       The callback analyzer
+	 * @param analyzer The callback analyzer
 	 * @return The memory watcher that keeps track of the amount of memory spent in
 	 *         the callback analysis
 	 */
-	protected FlowDroidMemoryWatcher createCallbackMemoryWatcher(AbstractCallbackAnalyzer jimpleClass) {
+	protected FlowDroidMemoryWatcher createCallbackMemoryWatcher(AbstractCallbackAnalyzer analyzer) {
 		FlowDroidMemoryWatcher memoryWatcher = new FlowDroidMemoryWatcher(config.getMemoryThreshold());
-		memoryWatcher.addSolver((IMemoryBoundedSolver) jimpleClass);
+		memoryWatcher.addSolver((IMemoryBoundedSolver) analyzer);
 		return memoryWatcher;
 	}
 
diff --git a/soot-infoflow-android/src/soot/jimple/infoflow/android/axml/AXmlElement.java b/soot-infoflow-android/src/soot/jimple/infoflow/android/axml/AXmlElement.java
@@ -1,104 +1,111 @@
 package soot.jimple.infoflow.android.axml;
 
 /**
- * Basic class for all classes which represent elements from an <i>Android XML file</i>.
- * Provides functionality to either include or exclude the element from the XML.
+ * Basic class for all classes which represent elements from an <i>Android XML
+ * file</i>. Provides functionality to either include or exclude the element
+ * from the XML.
  * 
  * @author Stefan Haas, Mario Schlipf
  */
 public abstract class AXmlElement {
 	/**
-	 * The include flag determines whether this element will be written out in the document.
+	 * The include flag determines whether this element will be written out in the
+	 * document.
 	 */
 	protected boolean include = true;
-	
+
 	/**
-	 * The added flag determines wheter this element was part of a parsed xml file or added afterwards.
+	 * The added flag determines wheter this element was part of a parsed xml file
+	 * or added afterwards.
 	 */
 	protected boolean added;
-	
+
 	/**
 	 * The element's namespace.
 	 */
 	String ns;
-	
+
 	/**
 	 * Constructor for a new Android XML Element.
 	 * 
-	 * @param	ns		namespace of this element.
-	 * @param	added	wheter this element was part of a parsed xml file or added afterwards.
+	 * @param ns    namespace of this element.
+	 * @param added wheter this element was part of a parsed xml file or added
+	 *              afterwards.
 	 */
 	public AXmlElement(String ns, boolean added) {
 		this.ns = ns;
 		this.added = added;
 	}
-	
+
 	/**
 	 * Returns the namespace of this element.
 	 * 
-	 * @return	the element's namespace
+	 * @return the element's namespace
 	 */
 	public String getNamespace() {
 		return this.ns;
 	}
-	
+
 	/**
 	 * Sets the namespace of this element.
 	 * 
-	 * @param	ns		the element's namespace
+	 * @param ns the element's namespace
 	 */
 	public void setNamespace(String ns) {
 		this.ns = ns;
 	}
-	
+
 	/**
-	 * The <code>added</code> flag determines wheter this element
-	 * was part of a parsed xml file or added afterwards.
+	 * The <code>added</code> flag determines wheter this element was part of a
+	 * parsed xml file or added afterwards.
 	 * 
-	 * @param	added
+	 * @param added
 	 */
 	public void setAdded(boolean added) {
 		this.added = added;
 	}
-	
+
 	/**
-	 * Returns wheter this element was part of a parsed xml file or added afterwards.
+	 * Returns wheter this element was part of a parsed xml file or added
+	 * afterwards.
 	 * 
-	 * @return	<code>added</code> flag
+	 * @return <code>added</code> flag
 	 */
 	public boolean isAdded() {
 		return this.added;
 	}
-	
+
 	/**
-	 * Returns the current value of the <code>include</code> flag.
-	 * If true the manifest will contain information about this element.
+	 * Returns the current value of the <code>include</code> flag. If true the
+	 * manifest will contain information about this element.
 	 * 
-	 * @return	whether or not the element will be included in the manifest
+	 * @return whether or not the element will be included in the manifest
 	 */
 	public boolean isIncluded() {
 		return this.include;
 	}
-	
+
 	/**
-	 * Sets the <code>include</code> flag to true so that the manifest will contain information about this element.
+	 * Sets the <code>include</code> flag to true so that the manifest will contain
+	 * information about this element.
 	 */
 	public void include() {
 		this.include(true);
 	}
 
 	/**
-	 * Sets the <code>include</code> flag to false so that the manifest will <i>not</i> contain information about this element.
+	 * Sets the <code>include</code> flag to false so that the manifest will
+	 * <i>not</i> contain information about this element.
 	 */
 	public void exclude() {
 		this.include(false);
 	}
-	
+
 	/**
-	 * Sets the <code>include</code> flag to the passed boolean value.
-	 * If given true this element will be included in the manifest.
+	 * Sets the <code>include</code> flag to the passed boolean value. If given true
+	 * this element will be included in the manifest.
 	 * 
-	 * @param	included	value for the <code>include</code> flag
+	 * @param include value for the <code>include</code> flag
 	 */
 	protected void include(boolean include) {
 		this.include = include;
diff --git a/soot-infoflow-android/src/soot/jimple/infoflow/android/axml/AXmlNode.java b/soot-infoflow-android/src/soot/jimple/infoflow/android/axml/AXmlNode.java
@@ -157,8 +157,9 @@ public AXmlNode addChild(AXmlNode child) {
 	 * 
 	 * @param child a new child for this node
 	 * @return this node itself for method chaining
-	 * @throws IndexOutOfBoundsException if the index is out of range (index < 0 ||
-	 *                                   index > children.size())
+	 * @throws IndexOutOfBoundsException if the index is out of range:
+	 *                                   <code>{@literal index < 0 ||
+	 *                                   index > children.size()}</code>)
 	 */
 	public AXmlNode addChild(AXmlNode child, int index) {
 		if (this.children == null)
diff --git a/soot-infoflow-android/src/soot/jimple/infoflow/android/axml/flags/BitwiseFlagSystem.java b/soot-infoflow-android/src/soot/jimple/infoflow/android/axml/flags/BitwiseFlagSystem.java
@@ -14,8 +14,9 @@
  * 01 Option B (cannot be used with option A): 10 Option C (only valid when used
  * with Option A): 11
  * 
- * In this case, we could do checking of B via ((v & 10) == 1) && ((v & 1) != 1)
- * but sometimes there are a lot of options (e.g. inputType)
+ * In this case, we could do checking of B via
+ * <code>{@literal ((v & 10) == 1) && ((v & 1) != 1)}</code> but sometimes there
+ * are a lot of options (e.g. inputType)
  * 
  * @param <T> the keys used to distinguish flags
  */
diff --git a/soot-infoflow-android/src/soot/jimple/infoflow/android/iccta/IccInstrumentDestination.java b/soot-infoflow-android/src/soot/jimple/infoflow/android/iccta/IccInstrumentDestination.java
@@ -55,7 +55,8 @@ public SootClass instrumentDestinationForContentProvider(String destination) {
 	 * take one Intent as their parameter.
 	 * 
 	 * the best way is to use a place holder parameter to avoid exist construct
-	 * method and use exist construct to build the new <init> method.
+	 * method and use exist construct to build the new
+	 * <code>{@literal <init>}</code> method.
 	 * 
 	 * @param compSootClass
 	 * @param intentSootField
diff --git a/soot-infoflow-android/src/soot/jimple/infoflow/android/manifest/BaseProcessManifest.java b/soot-infoflow-android/src/soot/jimple/infoflow/android/manifest/BaseProcessManifest.java
@@ -163,8 +163,7 @@ public BaseProcessManifest(InputStream manifestIS, ARSCFileParser arscParser) th
 	 * by the given {@link InputStream}.
 	 *
 	 * @param manifestIS InputStream for an AppManifest.
-	 * @throws IOException            if an I/O error occurs.
-	 * @throws XmlPullParserException can occur due to a malformed manifest.
+	 * @throws IOException if an I/O error occurs.
 	 */
 	protected void handle(InputStream manifestIS) throws IOException {
 		this.axml = new AXmlHandler(manifestIS);
diff --git a/soot-infoflow-android/src/soot/jimple/infoflow/android/source/parsers/xml/XMLSourceSinkParser.java b/soot-infoflow-android/src/soot/jimple/infoflow/android/source/parsers/xml/XMLSourceSinkParser.java
@@ -106,7 +106,8 @@ public static XMLSourceSinkParser fromStream(InputStream inputStream, ICategoryF
 	/**
 	 * Creates a new instance of the {@link XMLSourceSinkParser} class
 	 * 
-	 * @param filter A filter for excluding certain categories of sources and sinks
+	 * @param categoryFilter A filter for excluding certain categories of sources
+	 *                       and sinks
 	 */
 	protected XMLSourceSinkParser(ICategoryFilter categoryFilter) {
 		this.sourcesAndSinks = new HashMultiMap<>();
@@ -125,8 +126,10 @@ protected void buildSourceSinkLists() {
 					MethodSourceSinkDefinition methodSrc = (MethodSourceSinkDefinition) sourceDef;
 					if (methodSrc.getCallType() == CallType.Return) {
 						String mname = methodSrc.getMethod().getMethodName();
-						logger.error(String.format("Error while building sources for %s: CallType Return is not " +
-								"supported for Source Definitions. The invalid definition is ignored.", mname));
+						logger.error(String.format(
+								"Error while building sources for %s: CallType Return is not "
+										+ "supported for Source Definitions. The invalid definition is ignored.",
+								mname));
 						sourceDef = null;
 					} else if (methodSrc.getMethod() instanceof AndroidMethod) {
 						AndroidMethod am = (AndroidMethod) methodSrc.getMethod();
diff --git a/soot-infoflow-summaries/src/soot/jimple/infoflow/methodSummary/xml/AbstractXMLReader.java b/soot-infoflow-summaries/src/soot/jimple/infoflow/methodSummary/xml/AbstractXMLReader.java
@@ -27,7 +27,8 @@ abstract class AbstractXMLReader {
 	 * Checks whether the given XML is valid against the XSD for the new data
 	 * format.
 	 * 
-	 * @param is The stream from which to read the XML data
+	 * @param reader      The reader from which to read the XML data
+	 * @param xsdFilePath the path to the XSD schema file
 	 * @return true = valid XML false = invalid XML
 	 * @throws IOException
 	 */
diff --git a/soot-infoflow/src/soot/jimple/infoflow/InfoflowConfiguration.java b/soot-infoflow/src/soot/jimple/infoflow/InfoflowConfiguration.java
@@ -961,7 +961,7 @@ public void setResultSerializationTimeout(long timeout) {
 		 * Gets the timeout for the result serialization process in seconds. Writing out
 		 * the results is aborted if it takes longer than the given amount of time.
 		 *
-		 * @result The maximum time for writing out the results in seconds
+		 * @return The maximum time for writing out the results in seconds
 		 */
 		public long getResultSerializationTimeout() {
 			return this.resultSerializationTimeout;
diff --git a/soot-infoflow/src/soot/jimple/infoflow/aliasing/Aliasing.java b/soot-infoflow/src/soot/jimple/infoflow/aliasing/Aliasing.java
@@ -337,9 +337,10 @@ public LocalMustAliasAnalysis getMustAliasAnalysis(Stmt stmt) {
 	/**
 	 * Checks whether the given newly created taint can have an alias at the given
 	 * statement. Assume a statement a.x = source(). This will check whether
-	 * tainting a.<?> can induce new aliases or not.
+	 * tainting <code>{@literal a.<?>}</code> can induce new aliases or not.
 	 * 
 	 * @param val    The value which gets tainted
+	 * 
 	 * @param source The source from which the taints comes from
 	 * @return True if the analysis must look for aliases for the newly constructed
 	 *         taint, otherwise false
diff --git a/soot-infoflow/src/soot/jimple/infoflow/data/accessPaths/IAccessPathReductionStrategy.java b/soot-infoflow/src/soot/jimple/infoflow/data/accessPaths/IAccessPathReductionStrategy.java
@@ -14,9 +14,9 @@
  * Examples for reduction:
  * </p>
  * 
- * <pre>
+ * <code>
  * list.next.prev -> list
- * </pre>
+ * </code>
  * 
  * @author Steven Arzt
  *
diff --git a/soot-infoflow/src/soot/jimple/infoflow/data/accessPaths/SameFieldReductionStrategy.java b/soot-infoflow/src/soot/jimple/infoflow/data/accessPaths/SameFieldReductionStrategy.java
@@ -16,12 +16,12 @@
  * fragments.
  * </p>
  * 
- * <pre>
+ * <code>{@literal
  * <java.lang.Thread: java.lang.ThreadGroup group>
  * <java.lang.ThreadGroup: java.lang.Thread[] threads>
  * <java.lang.Thread: java.lang.ThreadGroup group>
  * <java.lang.ThreadGroup: java.lang.Thread[] threads> *
- * </pre>
+ * }</code>
  * 
  * @author Steven Arzt
  *
diff --git a/soot-infoflow/src/soot/jimple/infoflow/data/accessPaths/This0ReductionStrategy.java b/soot-infoflow/src/soot/jimple/infoflow/data/accessPaths/This0ReductionStrategy.java
@@ -11,9 +11,9 @@
  * its enclosing class to direct accesses.
  * </p>
  * 
- * <pre>
+ * <code>
  * a.inner.this$0.c -> a.c
- * </pre>
+ * </code>
  * 
  * @author Steven Arzt
  *
diff --git a/soot-infoflow/src/soot/jimple/infoflow/entryPointCreators/BaseEntryPointCreator.java b/soot-infoflow/src/soot/jimple/infoflow/entryPointCreators/BaseEntryPointCreator.java
@@ -555,7 +555,7 @@ protected boolean acceptClass(SootClass clazz) {
 
 	/**
 	 * Generates code which creates a new instance of the given class. Note that if
-	 * {@link #allowNonPublicConstructors} is <code>true<code>, private or protected
+	 * {@link #allowNonPublicConstructors} is <code>true</code>, private or protected
 	 * constructors may be used.
 	 * 
 	 * @param createdClass      The class of which to create an instance
@@ -804,7 +804,7 @@ protected boolean isCompatible(SootClass actual, SootClass expected) {
 	}
 
 	/**
-	 * Eliminates all loops of length 0 (if a goto <if a>)
+	 * Eliminates all loops of length 0 like <code>{@literal if a goto <if a>}</code>
 	 */
 	protected void eliminateSelfLoops() {
 		// Get rid of self-loops
diff --git a/soot-infoflow/src/soot/jimple/infoflow/solver/cfg/IInfoflowCFG.java b/soot-infoflow/src/soot/jimple/infoflow/solver/cfg/IInfoflowCFG.java
@@ -215,7 +215,7 @@ public String toString() {
 
 	/**
 	 * Gets all ordinary callees of the call at call site u, i.e., those that are
-	 * not \<clinit\> or a fake edge.
+	 * not <code>{@literal <clinit>}</code> or a fake edge.
 	 * 
 	 * @param u
 	 *            The call site
diff --git a/soot-infoflow/src/soot/jimple/infoflow/solver/fastSolver/flowInsensitive/FlowInsensitiveSolver.java b/soot-infoflow/src/soot/jimple/infoflow/solver/fastSolver/flowInsensitive/FlowInsensitiveSolver.java
@@ -410,7 +410,9 @@ protected Set<D> computeCallToReturnFlowFunction(FlowFunction<D> callToReturnFlo
 	 * Stores callee-side summaries. Also, at the side of the caller, propagates
 	 * intra-procedural flows to return sites using those newly computed summaries.
 	 * 
-	 * @param edge an edge whose target node resembles a method exits
+	 * @param d1 fact at source
+	 * @param n  the exit statement
+	 * @param d2 fact at target
 	 */
 	protected void processExit(D d1, Unit n, D d2) {
 		SootMethod methodThatNeedsSummary = icfg.getMethodOf(n);
@@ -608,9 +610,7 @@ protected void propagate(D sourceVal, SootMethod target, D targetVal,
 	 *                           unbalanced return (this value is not used within
 	 *                           this implementation but may be useful for
 	 *                           subclasses of {@link FlowInsensitiveSolver})
-	 * @param forceRegister      True if the jump function must always be registered
-	 *                           with jumpFn . This can happen when externally
-	 *                           injecting edges that don't come out of this solver.
+	 * @param schedule           True if a new edge should be scheduled.
 	 */
 	@SuppressWarnings("unchecked")
 	protected void propagate(D sourceVal, SootMethod target, D targetVal,
diff --git a/soot-infoflow/src/soot/jimple/infoflow/solver/gcSolver/AbstractReferenceCountingGarbageCollector.java b/soot-infoflow/src/soot/jimple/infoflow/solver/gcSolver/AbstractReferenceCountingGarbageCollector.java
@@ -44,8 +44,7 @@ public abstract class AbstractReferenceCountingGarbageCollector<N, D, A> extends
 	protected int edgeThreshold = 0;
 
 	public AbstractReferenceCountingGarbageCollector(BiDiInterproceduralCFG<N, SootMethod> icfg,
-			ConcurrentHashMultiMap<A, PathEdge<N, D>> jumpFunctions,
-			IGCReferenceProvider<A> referenceProvider) {
+			ConcurrentHashMultiMap<A, PathEdge<N, D>> jumpFunctions, IGCReferenceProvider<A> referenceProvider) {
 		super(icfg, jumpFunctions, referenceProvider);
 	}
 
@@ -131,8 +130,6 @@ protected void onBeforeRemoveEdges() {
 	/**
 	 * Method that is called after the last edge has been removed from the jump
 	 * functions
-	 * 
-	 * @param gcedMethods The number of methods for which edges have been removed
 	 */
 	protected void onAfterRemoveEdges() {
 	}
diff --git a/soot-infoflow/src/soot/jimple/infoflow/solver/gcSolver/fpc/IFDSSolver.java b/soot-infoflow/src/soot/jimple/infoflow/solver/gcSolver/fpc/IFDSSolver.java
@@ -296,8 +296,7 @@ private void runExecutorAndAwaitCompletion() {
 	 * Dispatch the processing of a given edge. It may be executed in a different
 	 * thread.
 	 * 
-	 * @param newSelfLoop indicate that this path edge is a self-loop edge like <s,
-	 *                    d>--><s, d>.
+	 * @param newSelfLoop indicate that this path edge is a self-loop edge like <pre>{@literal<s,d>--><s, d>}</pre>.
 	 * @param edge        the edge to process
 	 * @param orgSrc      used for building abstraction dependency graph.
 	 */
diff --git a/soot-infoflow/src/soot/jimple/infoflow/util/SootMethodRepresentationParser.java b/soot-infoflow/src/soot/jimple/infoflow/util/SootMethodRepresentationParser.java
@@ -45,10 +45,12 @@ public static SootMethodRepresentationParser v() {
 
 	/**
 	 * parses a string in soot representation, for example:
+	 * 
+	 * <pre>{@literal
 	 * <soot.jimple.infoflow.test.TestNoMain: java.lang.String function1()>
 	 * <soot.jimple.infoflow.test.TestNoMain: void functionCallOnObject()>
-	 * <soot.jimple.infoflow.test.TestNoMain: java.lang.String
-	 * function2(java.lang.String,java.lang.String)>
+	 * <soot.jimple.infoflow.test.TestNoMain: java.lang.String function2(java.lang.String,java.lang.String)>
+	 * }</pre>
 	 * 
 	 * @param parseString The method signature to parse
 	 */
@@ -173,6 +175,7 @@ public String[] getParameterTypesFromSubSignature(String subSignature) {
 
 	/**
 	 * Returns the return type of the sub signature
+	 * 
 	 * @param subsig the sub signature
 	 * @return the return type
 	 */

Original file line number	Diff line number	Diff line change
`@@ -14,8 +14,9 @@`
`14`	`14`	`* 01 Option B (cannot be used with option A): 10 Option C (only valid when used`
`15`	`15`	`* with Option A): 11`
`16`	`16`	`*`
`17`		`- * In this case, we could do checking of B via ((v & 10) == 1) && ((v & 1) != 1)`
`18`		`- * but sometimes there are a lot of options (e.g. inputType)`
	`17`	`+ * In this case, we could do checking of B via`
	`18`	`+ * <code>{@literal ((v & 10) == 1) && ((v & 1) != 1)}</code> but sometimes there`
	`19`	`+ * are a lot of options (e.g. inputType)`
`19`	`20`	`*`
`20`	`21`	`* @param <T> the keys used to distinguish flags`
`21`	`22`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -55,7 +55,8 @@ public SootClass instrumentDestinationForContentProvider(String destination) {`
`55`	`55`	`* take one Intent as their parameter.`
`56`	`56`	`*`
`57`	`57`	`* the best way is to use a place holder parameter to avoid exist construct`
`58`		`- * method and use exist construct to build the new <init> method.`
	`58`	`+ * method and use exist construct to build the new`
	`59`	`+ * <code>{@literal <init>}</code> method.`
`59`	`60`	`*`
`60`	`61`	`* @param compSootClass`
`61`	`62`	`* @param intentSootField`
Original file line number	Diff line number	Diff line change
`@@ -961,7 +961,7 @@ public void setResultSerializationTimeout(long timeout) {`
`961`	`961`	`* Gets the timeout for the result serialization process in seconds. Writing out`
`962`	`962`	`* the results is aborted if it takes longer than the given amount of time.`
`963`	`963`	`*`
`964`		`- * @result The maximum time for writing out the results in seconds`
	`964`	`+ * @return The maximum time for writing out the results in seconds`
`965`	`965`	`*/`
`966`	`966`	`public long getResultSerializationTimeout() {`
`967`	`967`	`return this.resultSerializationTimeout;`