From 9ae783e59246eff7a48026163cf596b94ca4fff9 Mon Sep 17 00:00:00 2001
From: lukaseder <lukas.eder@gmail.com>
Date: Mon, 24 Apr 2017 13:03:36 +0200
Subject: [PATCH] [#6128] Add more Javadoc to JPADatabase

---
 .../main/java/org/jooq/util/jpa/JPADatabase.java  | 15 ++++++++++++++-
 1 file changed, 14 insertions(+), 1 deletion(-)

diff --git a/jOOQ-meta-extensions/src/main/java/org/jooq/util/jpa/JPADatabase.java b/jOOQ-meta-extensions/src/main/java/org/jooq/util/jpa/JPADatabase.java
index 4f6a377524..523f0570a1 100644
--- a/jOOQ-meta-extensions/src/main/java/org/jooq/util/jpa/JPADatabase.java
+++ b/jOOQ-meta-extensions/src/main/java/org/jooq/util/jpa/JPADatabase.java
@@ -65,7 +65,20 @@ import org.springframework.context.annotation.ClassPathScanningCandidateComponen
 import org.springframework.core.type.filter.AnnotationTypeFilter;
 
 /**
- * The JPA database
+ * The JPA database.
+ * <p>
+ * This jOOQ-meta schema source works on an undisclosed in-memory
+ * {@link H2Database}, which is constructed from a set of JPA-annotated entities
+ * using Spring and Hibernate:
+ * <p>
+ * <ul>
+ * <li>Spring discovers all the JPA-annotated entities in the comma-separated
+ * list of <code>packages</code> (configured in the code generator)</li>
+ * <li>Those entities are passed to Hibernate's {@link SchemaExport} to generate
+ * an empty database schema in the in-memory H2 database</li>
+ * <li>A jOOQ {@link H2Database} is used to reverse-engineer this schema
+ * again</li>
+ * </ul>
  *
  * @author Lukas Eder
  */