From 082fcbb01e2f29d0999a5b1808fb90ea941701a3 Mon Sep 17 00:00:00 2001
From: Richard North <rich.north@gmail.com>
Date: Tue, 20 Oct 2020 21:33:55 +0100
Subject: [PATCH] Update Javadocs

---
 .../java/org/testcontainers/utility/ImageNameSubstitutor.java | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

diff --git a/core/src/main/java/org/testcontainers/utility/ImageNameSubstitutor.java b/core/src/main/java/org/testcontainers/utility/ImageNameSubstitutor.java
index 61bea321e0a..6f9516f695f 100644
--- 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> {