From 1179f84611b4809559a660d2166bdfa342717e46 Mon Sep 17 00:00:00 2001
From: Robin Bygrave <robin.bygrave@gmail.com>
Date: Fri, 25 Mar 2016 10:51:41 +1300
Subject: [PATCH] Javadoc only update #619

---
 pom.xml                                       |   3 +-
 src/main/java/com/avaje/ebean/package.html    | 115 +++++++++---------
 .../com/avaje/ebean/search/package-info.java  |   4 +
 .../docstore/api/mapping/package-info.java    |   4 +
 .../docstore/api/package-info.java            |   4 +
 .../docstore/api/support/package-info.java    |   4 +
 .../docstore/none/package-info.java           |   8 ++
 7 files changed, 82 insertions(+), 60 deletions(-)
 create mode 100644 src/main/java/com/avaje/ebean/search/package-info.java
 create mode 100644 src/main/java/com/avaje/ebeanservice/docstore/api/mapping/package-info.java
 create mode 100644 src/main/java/com/avaje/ebeanservice/docstore/api/package-info.java
 create mode 100644 src/main/java/com/avaje/ebeanservice/docstore/api/support/package-info.java
 create mode 100644 src/main/java/com/avaje/ebeanservice/docstore/none/package-info.java

diff --git a/pom.xml b/pom.xml
index f647f3ae8..839b135df 100644
--- a/pom.xml
+++ b/pom.xml
@@ -291,7 +291,7 @@
         <artifactId>maven-javadoc-plugin</artifactId>
         <version>2.9.1</version>
         <configuration>
-          <doctitle>Ebean 6</doctitle>
+          <doctitle>Ebean 7</doctitle>
           <overview>src/main/java/com/avaje/ebean/overview.html</overview>
           <source>1.8</source>
           <doclet>org.avaje.doclet.PygmentsDoclet</doclet>
@@ -310,7 +310,6 @@
           </additionalparam>
           <linksource>true</linksource>
           <overview>src/main/java/com/avaje/ebean/overview.html</overview>
-
         </configuration>
 
         <executions>
diff --git a/src/main/java/com/avaje/ebean/package.html b/src/main/java/com/avaje/ebean/package.html
index f0ffd4c74..3f1155af5 100644
--- a/src/main/java/com/avaje/ebean/package.html
+++ b/src/main/java/com/avaje/ebean/package.html
@@ -3,85 +3,84 @@
 	<TITLE>Ebean core API</TITLE>
 </HEAD>
 <Body BGCOLOR="#ffffff">
-Core API (see <a href="Ebean.html">Ebean</a> and <a href="EbeanServer.html">EbeanServer</a>).
+Core API (see <a href="EbeanServer.html">EbeanServer</a> and <a href="Ebean.html">Ebean</a>).
 
 <h3>Ebean</h3>
 <p>
 Provides the main API for fetching and persisting beans with eBean.
 </p>
 
-<pre class="code">
-	// EXAMPLE 1: Simple fetch
-	//========================
+<pre>{@code
+// EXAMPLE 1: Simple fetch
+//========================
 
-	// fetch order 10
-	Order order = Ebean.find(Order.class, 10);
+// fetch order 10
+Order order = Ebean.find(Order.class, 10);
 
 
 
-	// EXAMPLE 2: Fetch an Object with associations
-	//=============================================
-	
-	// fetch Customer 7 including their billing and shipping addresses
-	Customer customer = 
-		Ebean.find(Customer.class)
-			.setId(7)
-			.fetch("billingAddress")
-			.fetch("shippingAddress")
-			.findUnique();	
-	
-	Address billAddr = customer.getBillingAddress();
-	Address shipAddr = customer.getShippingAddress();
+// EXAMPLE 2: Fetch an Object with associations
+//=============================================
+
+// fetch Customer 7 including their billing and shipping addresses
+Customer customer =
+	Ebean.find(Customer.class)
+		.setId(7)
+		.fetch("billingAddress")
+		.fetch("shippingAddress")
+		.findUnique();
+
+Address billAddr = customer.getBillingAddress();
+Address shipAddr = customer.getShippingAddress();
 
 
 
 
-	// EXAMPLE 3: Create and save an Order
-	//=====================================
-	
-	// get a Customer reference so we don't hit the database
-	Customer custRef = Ebean.getReference(Customer.class, 7);
+// EXAMPLE 3: Create and save an Order
+//=====================================
 
-	// create a new Order object
-	Order newOrder = new Order();
-	newOrder.setStatus(Order.Status.NEW);
-	newOrder.setCustomer(custRef);
-	
-	ArrayList orderLines = new ArrayList();
-	newOrder.setLines(orderLines);
-	...
+// get a Customer reference so we don't hit the database
+Customer custRef = Ebean.getReference(Customer.class, 7);
 
-	// add a line to the order
-	Product prodRef = Ebean.getReference(Product.class, 41);
-	OrderLine line = new OrderLine();
-	line.setProduct(prodRef);
-	line.setQuantity(10);
-	orderLines.add(line);
-	...
+// create a new Order object
+Order newOrder = new Order();
+newOrder.setStatus(Order.Status.NEW);
+newOrder.setCustomer(custRef);
 
-	// save the order and its lines in a single transaction
-	// NB: assumes CascadeType.PERSIST is set on the order lines association
-	Ebean.save(newOrder);
+ArrayList orderLines = new ArrayList();
+newOrder.setLines(orderLines);
+...
+
+// add a line to the order
+Product prodRef = Ebean.getReference(Product.class, 41);
+OrderLine line = new OrderLine();
+line.setProduct(prodRef);
+line.setQuantity(10);
+orderLines.add(line);
+...
+
+// save the order and its lines in a single transaction
+// NB: assumes CascadeType.PERSIST is set on the order lines association
+Ebean.save(newOrder);
 
 
 
-	// EXAMPLE 4: Use another database
-	//=================================
+// EXAMPLE 4: Use another database
+//=================================
 
-	// Get access to the Human Resources EbeanServer/Database
-	EbeanServer hrServer = Ebean.getServer(&quot;HR&quot;);
-                                        
-                                  
-	// fetch contact 3 from the HR database
-	Contact contact = hrServer.find(Contact.class, 3);
-                                        
-	contact.setStatus(Contact.Status.INACTIVE);
-	...
-                                        
-	// save the contact back to the HR database
-	hrServer.save(contact); 
-	
-</pre>
+// Get access to the Human Resources EbeanServer/Database
+EbeanServer hrServer = Ebean.getServer(&quot;HR&quot;);
+
+
+// fetch contact 3 from the HR database
+Contact contact = hrServer.find(Contact.class, 3);
+
+contact.setStatus(Contact.Status.INACTIVE);
+...
+
+// save the contact back to the HR database
+hrServer.save(contact);
+}</pre>
 
 </Body>
 </HTML>
\ No newline at end of file
diff --git a/src/main/java/com/avaje/ebean/search/package-info.java b/src/main/java/com/avaje/ebean/search/package-info.java
new file mode 100644
index 000000000..b97ec16d6
--- /dev/null
+++ b/src/main/java/com/avaje/ebean/search/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Provides text search expressions like Match, TextQueryString etc.
+ */
+package com.avaje.ebean.search;
\ No newline at end of file
diff --git a/src/main/java/com/avaje/ebeanservice/docstore/api/mapping/package-info.java b/src/main/java/com/avaje/ebeanservice/docstore/api/mapping/package-info.java
new file mode 100644
index 000000000..65eaf21f6
--- /dev/null
+++ b/src/main/java/com/avaje/ebeanservice/docstore/api/mapping/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Mapping for document store integration.
+ */
+package com.avaje.ebeanservice.docstore.api.mapping;
\ No newline at end of file
diff --git a/src/main/java/com/avaje/ebeanservice/docstore/api/package-info.java b/src/main/java/com/avaje/ebeanservice/docstore/api/package-info.java
new file mode 100644
index 000000000..75b533f11
--- /dev/null
+++ b/src/main/java/com/avaje/ebeanservice/docstore/api/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * The service API for document store integration.
+ */
+package com.avaje.ebeanservice.docstore.api;
\ No newline at end of file
diff --git a/src/main/java/com/avaje/ebeanservice/docstore/api/support/package-info.java b/src/main/java/com/avaje/ebeanservice/docstore/api/support/package-info.java
new file mode 100644
index 000000000..0c0a8c6d1
--- /dev/null
+++ b/src/main/java/com/avaje/ebeanservice/docstore/api/support/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Support objects for implementing integration.
+ */
+package com.avaje.ebeanservice.docstore.api.support;
\ No newline at end of file
diff --git a/src/main/java/com/avaje/ebeanservice/docstore/none/package-info.java b/src/main/java/com/avaje/ebeanservice/docstore/none/package-info.java
new file mode 100644
index 000000000..2b6a86465
--- /dev/null
+++ b/src/main/java/com/avaje/ebeanservice/docstore/none/package-info.java
@@ -0,0 +1,8 @@
+/**
+ * "No op" implementation of document store.
+ * <p>
+ * This is 'placeholder' implementation used if there is no document store service found
+ * and if there is an attempt to use the document store features an error will be thrown.
+ * </p>
+ */
+package com.avaje.ebeanservice.docstore.none;
\ No newline at end of file