From 9f270c2253160b8307bc5c4403ccb053665e666e Mon Sep 17 00:00:00 2001
From: Mark Rotteveel <mark@lawinegevaar.nl>
Date: Tue, 2 Jan 2024 13:02:23 +0100
Subject: [PATCH] Add javadoc on (main) classes similar to testcontainers-java

---
 CHANGES.md                                                 | 1 +
 .../org/firebirdsql/testcontainers/FirebirdContainer.java  | 7 +++++++
 .../testcontainers/FirebirdContainerProvider.java          | 3 +++
 3 files changed, 11 insertions(+)

diff --git a/CHANGES.md b/CHANGES.md
index fcfa6e2..945a13e 100644
--- a/CHANGES.md
+++ b/CHANGES.md
@@ -6,6 +6,7 @@ Version History
 - Updated org.testcontainers:jdbc to 1.19.3
 - Updated various test-dependencies
 - Updated Maven build plugins
+- Add javadoc on (main) classes similar to testcontainers-java
 
 1.3.0
 -----
diff --git a/src/main/java/org/firebirdsql/testcontainers/FirebirdContainer.java b/src/main/java/org/firebirdsql/testcontainers/FirebirdContainer.java
index 4823885..45ad22e 100644
--- a/src/main/java/org/firebirdsql/testcontainers/FirebirdContainer.java
+++ b/src/main/java/org/firebirdsql/testcontainers/FirebirdContainer.java
@@ -9,6 +9,13 @@
 import java.security.NoSuchAlgorithmException;
 import java.time.ZoneId;
 
+/**
+ * Testcontainers implementation for Firebird.
+ * <p>
+ * Supported image: {@code jacobalberty/firebird}
+ * <p>
+ * Exposed ports: 3050
+ */
 public class FirebirdContainer<SELF extends FirebirdContainer<SELF>> extends JdbcDatabaseContainer<SELF> {
 
     private static final Logger log = LoggerFactory.getLogger(FirebirdContainer.class);
diff --git a/src/main/java/org/firebirdsql/testcontainers/FirebirdContainerProvider.java b/src/main/java/org/firebirdsql/testcontainers/FirebirdContainerProvider.java
index 30ccbf7..7e1a56e 100644
--- a/src/main/java/org/firebirdsql/testcontainers/FirebirdContainerProvider.java
+++ b/src/main/java/org/firebirdsql/testcontainers/FirebirdContainerProvider.java
@@ -5,6 +5,9 @@
 import org.testcontainers.jdbc.ConnectionUrl;
 import org.testcontainers.utility.DockerImageName;
 
+/**
+ * Factory for Firebird containers.
+ */
 public class FirebirdContainerProvider extends JdbcDatabaseContainerProvider {
 
     public static final String USER_PARAM = "user";