Update Javadocs

testcontainers · Oct 20, 2020 · 082fcbb · 082fcbb
1 parent f5498d5
commit 082fcbb
Showing 1 changed file with 3 additions and 1 deletion.
diff --git a/core/src/main/java/org/testcontainers/utility/ImageNameSubstitutor.java b/core/src/main/java/org/testcontainers/utility/ImageNameSubstitutor.java
@@ -10,7 +10,9 @@
 import static java.util.Comparator.comparingInt;
 
 /**
- * TODO: Javadocs
+ * An image name substitutor converts a Docker image name, as may be specified in code, to an alternative name.
+ * This is intended to provide a way to override image names, for example to enforce pulling of images from a private
+ * registry.
  */
 @Slf4j
 public abstract class ImageNameSubstitutor implements Function<DockerImageName, DockerImageName> {