add doc

soot-oss · Jan 21, 2025 · 6ca33ad · 6ca33ad
1 parent 7bd9e7d
commit 6ca33ad
Show file tree

Hide file tree

Showing 3 changed files with 3 additions and 2 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,
-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 @@