add doc

soot-oss · Jan 22, 2025 · 1cc83f0 · 1cc83f0
1 parent e0f0eb4
commit 1cc83f0
Show file tree

Hide file tree

Showing 5 changed files with 5 additions and 4 deletions.
diff --git a/sootup.core/src/main/java/sootup/core/inputlocation/AnalysisInputLocation.java b/sootup.core/src/main/java/sootup/core/inputlocation/AnalysisInputLocation.java
@@ -58,7 +58,7 @@ public interface AnalysisInputLocation {
   /**
    * Scan the input location and create ClassSources for every compilation / interpretation unit.
    *
-   * @return The source entries.
+   * @return an Autocloseable resource that must be closed!
    */
   @Nonnull
   Stream<? extends SootClassSource> getClassSources(@Nonnull View view);

diff --git a/...n/java/sootup/java/bytecode/frontend/inputlocation/ArchiveBasedAnalysisInputLocation.java b/...n/java/sootup/java/bytecode/frontend/inputlocation/ArchiveBasedAnalysisInputLocation.java
@@ -108,6 +108,7 @@ public Optional<JavaSootClassSource> getClassSource(@Nonnull ClassType type, @No
     }
   }
 
+  /** returns a Autocloseable resource that must be closed! */
   @Override
   @Nonnull
   public Stream<JavaSootClassSource> getClassSources(@Nonnull View view) {

diff --git a/...main/java/sootup/java/bytecode/frontend/inputlocation/PathBasedAnalysisInputLocation.java b/...main/java/sootup/java/bytecode/frontend/inputlocation/PathBasedAnalysisInputLocation.java
@@ -141,7 +141,7 @@ public static PathBasedAnalysisInputLocation create(
             + "' has to be pointing to the root of a class container, e.g. directory, jar, zip, apk, war etc.");
   }
 
-  /** returns a resource that must be closed! */
+  /** returns a Autocloseable resource that must be closed! */
   @Nonnull
   protected Stream<JavaSootClassSource> walkDirectory(
       @Nonnull Path dirPath,

diff --git a/...de.frontend/src/test/java/sootup/java/bytecode/frontend/TryWithResourcesFinallyTests.java b/...de.frontend/src/test/java/sootup/java/bytecode/frontend/TryWithResourcesFinallyTests.java
@@ -9,8 +9,8 @@
 import sootup.core.inputlocation.AnalysisInputLocation;
 import sootup.core.model.SourceType;
 import sootup.core.signatures.MethodSignature;
-import sootup.java.bytecode.frontend.inputlocation.ClassFileBasedAnalysisInputLocation;
 import sootup.core.util.printer.BriefStmtPrinter;
+import sootup.java.bytecode.frontend.inputlocation.ClassFileBasedAnalysisInputLocation;
 import sootup.java.core.views.JavaView;
 
 @Tag(TestCategories.JAVA_8_CATEGORY)

diff --git a/...a/sootup/java/bytecode/frontend/inputlocation/JrtFileSystemAnalysisInputLocationTest.java b/...a/sootup/java/bytecode/frontend/inputlocation/JrtFileSystemAnalysisInputLocationTest.java
@@ -53,7 +53,7 @@ public void getClassSources() {
     assertTrue(
         classSources.size()
             > 20000); // "a lot" not precise as this amount can differ depending on the included
-                      // runtime
+    // runtime
     // library
     assertTrue(classSources.stream().anyMatch(cs -> cs.getClassType().equals(sig1)));
     assertTrue(view.getClass(sig1).isPresent());
-Original file line number
+Diff line change
@@ Expand Up @@
         }
       }
+      /** returns a Autocloseable resource that must be closed! */
       @Override
       @Nonnull
       public Stream<JavaSootClassSource> getClassSources(@Nonnull View view) {
@@ Expand Down @@