From 1657f9f605886027b82873e5778bda40f4f882fe Mon Sep 17 00:00:00 2001
From: Hardy Ferentschik <hardy@hibernate.org>
Date: Mon, 5 Mar 2012 17:03:57 +0100
Subject: [PATCH] HHH-7037 formatting, javadocs

---
 .../java/org/hibernate/annotations/Cache.java | 21 ++++++++----
 .../java/org/hibernate/annotations/Check.java |  3 +-
 .../source/annotations/attribute/package.html | 34 +++++++++++++++++++
 .../source/annotations/entity/package.html    | 33 ++++++++++++++++++
 ...anyToManyPluralAttributeElementSource.java |  3 +-
 ...OneToManyPluralAttributeElementSource.java |  4 +--
 6 files changed, 86 insertions(+), 12 deletions(-)
 create mode 100755 hibernate-core/src/main/java/org/hibernate/metamodel/internal/source/annotations/attribute/package.html
 create mode 100755 hibernate-core/src/main/java/org/hibernate/metamodel/internal/source/annotations/entity/package.html

diff --git a/hibernate-core/src/main/java/org/hibernate/annotations/Cache.java b/hibernate-core/src/main/java/org/hibernate/annotations/Cache.java
index 8fd717be64..d388c68548 100644
--- a/hibernate-core/src/main/java/org/hibernate/annotations/Cache.java
+++ b/hibernate-core/src/main/java/org/hibernate/annotations/Cache.java
@@ -22,6 +22,7 @@
  * Boston, MA  02110-1301  USA
  */
 package org.hibernate.annotations;
+
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
@@ -35,16 +36,22 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
  *
  * @author Emmanuel Bernard
  */
-@Target({TYPE, METHOD, FIELD})
+@Target({ TYPE, METHOD, FIELD })
 @Retention(RUNTIME)
 public @interface Cache {
-	/** concurrency strategy chosen */
-	CacheConcurrencyStrategy usage();
-	/** cache region name */
-	String region() default "";
 	/**
-	 * whether or not lazy-properties are included in the second level cache
-	 * default all, other value: non-lazy
+	 * @return Returns the concurrency strategy chosen
+	 */
+	CacheConcurrencyStrategy usage();
+
+	/**
+	 * @return Returns the cache region name
+	 */
+	String region() default "";
+
+	/**
+	 * @return Returns whether or not lazy-properties are included in the second level cache.
+	 *         Default is <i>all</i>, other value: <i>non-lazy</i>.
 	 */
 	String include() default "all";
 }
diff --git a/hibernate-core/src/main/java/org/hibernate/annotations/Check.java b/hibernate-core/src/main/java/org/hibernate/annotations/Check.java
index ee14d715df..068722cada 100644
--- a/hibernate-core/src/main/java/org/hibernate/annotations/Check.java
+++ b/hibernate-core/src/main/java/org/hibernate/annotations/Check.java
@@ -22,6 +22,7 @@
  * Boston, MA  02110-1301  USA
  */
 package org.hibernate.annotations;
+
 import java.lang.annotation.Retention;
 import java.lang.annotation.Target;
 
@@ -36,7 +37,7 @@ import static java.lang.annotation.RetentionPolicy.RUNTIME;
  *
  * @author Emmanuel Bernard
  */
-@Target({TYPE, METHOD, FIELD})
+@Target({ TYPE, METHOD, FIELD })
 @Retention(RUNTIME)
 public @interface Check {
 	String constraints();
diff --git a/hibernate-core/src/main/java/org/hibernate/metamodel/internal/source/annotations/attribute/package.html b/hibernate-core/src/main/java/org/hibernate/metamodel/internal/source/annotations/attribute/package.html
new file mode 100755
index 0000000000..6f41661c51
--- /dev/null
+++ b/hibernate-core/src/main/java/org/hibernate/metamodel/internal/source/annotations/attribute/package.html
@@ -0,0 +1,34 @@
+<!--
+  ~ Hibernate, Relational Persistence for Idiomatic Java
+  ~
+  ~ Copyright (c) 2008, Red Hat Middleware LLC or third-party contributors as
+  ~ indicated by the @author tags or express copyright attribution
+  ~ statements applied by the authors.  All third-party contributions are
+  ~ distributed under license by Red Hat Middleware LLC.
+  ~
+  ~ This copyrighted material is made available to anyone wishing to use, modify,
+  ~ copy, or redistribute it subject to the terms and conditions of the GNU
+  ~ Lesser General Public License, as published by the Free Software Foundation.
+  ~
+  ~ This program is distributed in the hope that it will be useful,
+  ~ but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+  ~ or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
+  ~ for more details.
+  ~
+  ~ You should have received a copy of the GNU Lesser General Public License
+  ~ along with this distribution; if not, write to:
+  ~ Free Software Foundation, Inc.
+  ~ 51 Franklin Street, Fifth Floor
+  ~ Boston, MA  02110-1301  USA
+  ~
+  -->
+
+<html>
+<head></head>
+<body>
+<p>
+    This package contains classes related to mapped attributes and associations of a mapped entity. It also contains the
+    attribute related source implementations.
+</p>
+</body>
+</html>
diff --git a/hibernate-core/src/main/java/org/hibernate/metamodel/internal/source/annotations/entity/package.html b/hibernate-core/src/main/java/org/hibernate/metamodel/internal/source/annotations/entity/package.html
new file mode 100755
index 0000000000..2d0629a274
--- /dev/null
+++ b/hibernate-core/src/main/java/org/hibernate/metamodel/internal/source/annotations/entity/package.html
@@ -0,0 +1,33 @@
+<!--
+  ~ Hibernate, Relational Persistence for Idiomatic Java
+  ~
+  ~ Copyright (c) 2008, Red Hat Middleware LLC or third-party contributors as
+  ~ indicated by the @author tags or express copyright attribution
+  ~ statements applied by the authors.  All third-party contributions are
+  ~ distributed under license by Red Hat Middleware LLC.
+  ~
+  ~ This copyrighted material is made available to anyone wishing to use, modify,
+  ~ copy, or redistribute it subject to the terms and conditions of the GNU
+  ~ Lesser General Public License, as published by the Free Software Foundation.
+  ~
+  ~ This program is distributed in the hope that it will be useful,
+  ~ but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
+  ~ or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public License
+  ~ for more details.
+  ~
+  ~ You should have received a copy of the GNU Lesser General Public License
+  ~ along with this distribution; if not, write to:
+  ~ Free Software Foundation, Inc.
+  ~ 51 Franklin Street, Fifth Floor
+  ~ Boston, MA  02110-1301  USA
+  ~
+  -->
+
+<html>
+<head></head>
+<body>
+<p>
+    This package contains classes related to mapped entities and their hierarchy structure.
+</p>
+</body>
+</html>
diff --git a/hibernate-core/src/main/java/org/hibernate/metamodel/spi/source/ManyToManyPluralAttributeElementSource.java b/hibernate-core/src/main/java/org/hibernate/metamodel/spi/source/ManyToManyPluralAttributeElementSource.java
index 0f117e709a..5deb199238 100644
--- a/hibernate-core/src/main/java/org/hibernate/metamodel/spi/source/ManyToManyPluralAttributeElementSource.java
+++ b/hibernate-core/src/main/java/org/hibernate/metamodel/spi/source/ManyToManyPluralAttributeElementSource.java
@@ -29,8 +29,7 @@ import java.util.List;
 /**
  * @author Steve Ebersole
  */
-public interface ManyToManyPluralAttributeElementSource
-		extends PluralAttributeElementSource, CascadeStyleSource {
+public interface ManyToManyPluralAttributeElementSource extends PluralAttributeElementSource, CascadeStyleSource {
 	public String getReferencedEntityName();
 
 	public String getReferencedEntityAttributeName();
diff --git a/hibernate-core/src/main/java/org/hibernate/metamodel/spi/source/OneToManyPluralAttributeElementSource.java b/hibernate-core/src/main/java/org/hibernate/metamodel/spi/source/OneToManyPluralAttributeElementSource.java
index e9ad3fc7b2..705ab02cc9 100644
--- a/hibernate-core/src/main/java/org/hibernate/metamodel/spi/source/OneToManyPluralAttributeElementSource.java
+++ b/hibernate-core/src/main/java/org/hibernate/metamodel/spi/source/OneToManyPluralAttributeElementSource.java
@@ -26,8 +26,8 @@ package org.hibernate.metamodel.spi.source;
 /**
  * @author Steve Ebersole
  */
-public interface OneToManyPluralAttributeElementSource
-		extends PluralAttributeElementSource, CascadeStyleSource {
+public interface OneToManyPluralAttributeElementSource extends PluralAttributeElementSource, CascadeStyleSource {
 	public String getReferencedEntityName();
+
 	public boolean isNotFoundAnException();
 }