diff --git a/core/src/main/javadoc/images/bkg_blkheader.png b/core/src/main/javadoc/images/bkg_blkheader.png
new file mode 100644
index 0000000000..499e912008
Binary files /dev/null and b/core/src/main/javadoc/images/bkg_blkheader.png differ
diff --git a/core/src/main/javadoc/images/bkg_gradient.gif b/core/src/main/javadoc/images/bkg_gradient.gif
new file mode 100644
index 0000000000..077fa157ed
Binary files /dev/null and b/core/src/main/javadoc/images/bkg_gradient.gif differ
diff --git a/core/src/main/javadoc/images/bkgheader.png b/core/src/main/javadoc/images/bkgheader.png
new file mode 100644
index 0000000000..ec13b78bad
Binary files /dev/null and b/core/src/main/javadoc/images/bkgheader.png differ
diff --git a/core/src/main/javadoc/images/h1_hdr.png b/core/src/main/javadoc/images/h1_hdr.png
new file mode 100644
index 0000000000..31caf5efb5
Binary files /dev/null and b/core/src/main/javadoc/images/h1_hdr.png differ
diff --git a/core/src/main/javadoc/package.html b/core/src/main/javadoc/package.html
index 7c2c428ad4..521ff379a9 100644
--- a/core/src/main/javadoc/package.html
+++ b/core/src/main/javadoc/package.html
@@ -1,31 +1,54 @@
-Hibernate JavaDoc documentation.
-
+Hibernate Core (native API) JavaDocs
-The following are considered to define the "core API" of Hibernate, meaning it is fully intended that they
-be exposed to application code:
-
+In addition to {@link org.hibernate.SessionFactory} and {@link org.hibernate.Session}, applications using the
+Hibernate native API will often need to utilize the following interfaces:
+ - {@link org.hibernate.cfg.Configuration}
- {@link org.hibernate.Hibernate}
- - {@link org.hibernate.Session}
- - {@link org.hibernate.SessionFactory}
- {@link org.hibernate.Transaction}
- {@link org.hibernate.Query}
- {@link org.hibernate.Criteria}
- - {@link org.hibernate.ScrollableResults}
- - {@link org.hibernate.cfg.Configuration}
+ - {@link org.hibernate.criterion.Projection}
+ - {@link org.hibernate.criterion.Projections}
+ - {@link org.hibernate.criterion.Criterion}
- {@link org.hibernate.criterion.Restrictions}
- {@link org.hibernate.criterion.Order}
- {@link org.hibernate.criterion.Example}
-
+These interfaces are fully intended to be exposed to application code.
+
-The Extension SPIs are intended to be used by application programmers
-to extend Hibernate functionality. None of these interfaces are intended
-to be called by the application - they are called internally by Hibernate.
-These contracts are less stable than the Core API. The safest way to extend
-functionality is to contribute extensions back to the project.
-
+Extensions
+Hibernate defines a number of interfaces that are completely intended to be extendable by application programmers and/or
+integrators. Listed below is a (not necessarily exhaustive) list of the most commonly utilized extension points:
+ - {@link org.hibernate.EntityNameResolver}
+ - {@link org.hibernate.Interceptor} / {@link org.hibernate.EmptyInterceptor}
+ - {@link org.hibernate.Transaction} / {@link org.hibernate.transaction.TransactionFactory}
+ - {@link org.hibernate.context.CurrentSessionContext}
+ - {@link org.hibernate.dialect.Dialect}
+ - {@link org.hibernate.dialect.resolver.DialectResolver}
+ - {@link org.hibernate.event event listener} interfaces
+ - {@link org.hibernate.id.IdentifierGenerator}
+ - {@link org.hibernate.tuple.entity.EntityTuplizer} / {@link org.hibernate.tuple.component.ComponentTuplizer}
+ - {@link org.hibernate.type.Type} / {@link org.hibernate.usertype}
+
+Note that there is a large degree of crossover between the notion of extension points and that of an integration SPI (below).
+
-You can find all the Hibernate documentation at .
-
+Integration SPI
+Hibernate provides a number of SPIs intended to integrate itself with various third party frameworks or application code to provide
+additional capabilities. The SPIs fall mainly into 2 categories:
+ - Caching - {@link org.hibernate.cache.RegionFactory}
+ - JDBC Connection management - {@link org.hibernate.connection.ConnectionProvider}
+
+Certainly {@link org.hibernate.dialect.Dialect} could fit in here as well, though we chose to list it under extensions since application
+developers tend to provide extended dialects rather frequently for various reasons.
+
+Another SPI that is not yet exposed but is planned for such is the bytecode provider SPI. See {@link org.hibernate.bytecode}
+for details.
+
+
+Complete Hibernate documentation may be found online at http://docs.jboss.org/hibernate/.
+
+
\ No newline at end of file
diff --git a/core/src/main/javadoc/stylesheet.css b/core/src/main/javadoc/stylesheet.css
index ba20ec0172..fd51b1a36c 100644
--- a/core/src/main/javadoc/stylesheet.css
+++ b/core/src/main/javadoc/stylesheet.css
@@ -28,91 +28,147 @@
/* Page background color */
body {
- font-family: Arial;
- background-color: white;
- font-size: 10pt;
-}
-td {
- font-family: Arial;
- font-size: 10pt;
+ background: #FFFFFF url(images/bkg_gradient.gif) repeat-x;
+ margin:0 auto;
+ font-family:'Lucida Grande', Geneva, Verdana, Arial, sans-serif;
+ font-size:12px;
+ padding:0 2em;
+ color:#333;
+
+ }
+
+/* Common elements */
+
+font {
+ font-family: inherit, sans-serif;
+ font-size: inherit;
+ color: inherit;
+ font-weight: inherit;
}
-/* Table colors */
-.TableHeadingColor { background: #F4F4F4 }
-.TableSubHeadingColor { background: #F4F4F4 }
-.TableRowColor { background: #FFFFFF }
-
-/* Font used in left-hand frame lists */
-.FrameTitleFont { font-size: normal; font-family: Arial }
-.FrameHeadingFont { font-size: normal; font-family: Arial }
-.FrameItemFont { font-size: normal; font-family: Arial }
-
-/* Navigation bar fonts and colors */
-.NavBarCell1 { background-color:#F4F4F4;}
-.NavBarCell1Rev { background-color:silver;}
-.NavBarFont1 { font-family: Arial, Helvetica, sans-serif; color:#000000;}
-.NavBarFont1Rev { font-family: Arial, Helvetica, sans-serif; color:#FFFFFF;}
-.NavBarCell2 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;}
-.NavBarCell3 { font-family: Arial, Helvetica, sans-serif; background-color:#FFFFFF;}
+hr {
+ border-style: none;
+ border-bottom: 1px solid #CCCCCC;
+}
/* Links */
-A { color: #003399; }
-A:active { color: #003399; }
-A:visited { color: #888888; }
-
-
-P, OL, UL, LI, DL, DT, DD, BLOCKQUOTE {
- color: #000000;
+a:link {
+ color:#003399;
+}
+a:visited {
+ color:#888888;
+}
+a:hover {
+ color:#6699cc;
+}
+a:active {
+ color: #003399;
}
-TD, TH, SPAN {
- color: #000000;
+/* Headings */
+h1 {
+ background: url(images/h1_hdr.png) no-repeat;
+ line-height:1.2em;
+ color:#586464;
+ font-size:2em;
+ padding:1.5em;
+ margin-top: 0;
+ text-align:left;
}
-BLOCKQUOTE {
- margin-right: 0px;
+h2 {
+ color:#586464;
}
-TT {
-font-size: 90%;
- font-family: "Courier New", Courier, monospace;
- color: #000000;
+
+/* Default Table elements and colors */
+
+th, table {
+ border-collapse:collapse;
+ border-color: #E6E7E8;
}
-PRE {
-font-size: 90%;
- padding: 5px;
- border-style: solid;
- border-width: 1px;
- border-color: #CCCCCC;
- background-color: #F4F4F4;
+
+.TableHeadingColor {
+ background:#000000 url(images/bkg_blkheader.png) repeat-x scroll left top;
+ color:#FFFFFF;
+ font-size:12px;
+ font-weight:bold;
+ height:31px;
+ text-align:left;
+ padding:1.5em;
}
-UL, OL, LI {
- list-style: disc;
+.TableHeadingColor th {
+ padding-left: 10px;
}
-HR {
- width: 100%;
- height: 1px;
- background-color: #CCCCCC;
- border-width: 0px;
- padding: 0px;
- color: #CCCCCC;
+
+.TableSubHeadingColor {
+ background: #ebe7d7;
+}
+.TableRowColor {
+ background: #FFFFFF;
+ border-color: #E6E7E8;
+}
+.TableRowColor td {
+ line-height: 175%;
+ padding-left: 10px;
}
-.variablelist {
- padding-top: 10;
- padding-bottom:10;
- margin:0;
+/* Font used in left-hand frame lists */
+.FrameTitleFont {
+ font-size: 125%;
+ font-family: Helvetica, Arial, sans-serif;
+ font-weight: bold;
+ margin-top: 1em;
+ display: block;
+}
+.FrameHeadingFont {
+ font-size: 125%;
+ font-family: 'Lucida Grande', Geneva, Verdana, Arial, sans-serif;
+ font-weight: bold;
+ margin-top: 1em;
+ display: block;
+ color:#586464;
+ border-bottom:1px dotted #CCCCCC;
+}
+.FrameItemFont {
+ font-size: 100%;
+ font-family: Helvetica, Arial, sans-serif
}
-.itemizedlist, UL {
- padding-top: 0;
- padding-bottom:0;
- margin:0;
+/* Navigation bar fonts and colors */
+
+.NavBarCell1 {
+ background: #ffffff url(images/bkgheader.png) repeat-x;
+ line-height:3em;
+ padding-left:10px;
+ padding-right:10px;
}
-.term {
- font-weight:bold;
+.NavBarFont1 {
+ color: white;
+}
+.NavBarCell1 a {
+ color: white;
+}
+
+.NavBarCell1Rev {
+ background-color:#FFFFFF;
+ padding-left:6px;
+ padding-right:6px;
+}
+.NavBarFont1 {
+ color:#FFFFFF;
+}
+.NavBarFont1Rev {
+ color:#243446;
+}
+
+.NavBarCell2 {
+ background-color:#FFFFFF;
+}
+.NavBarCell3 {
+ background-color:#FFFFFF;
}
diff --git a/distribution/pom.xml b/distribution/pom.xml
index a0e3c1ab36..1400c6f6db 100644
--- a/distribution/pom.xml
+++ b/distribution/pom.xml
@@ -77,14 +77,16 @@
classPath.createPathElement().path = element
}
+ targetDir = 'target/javadocs';
+
ant.javadoc(
executable: '${jdk16_home}/bin/javadoc',
maxmemory: '512m',
- destdir: 'target/javadocs',
+ destdir: targetDir ,
sourcepathref: sourcePathName,
classpathref: classPathName,
- overview: '../core/src/main/javadoc/package.html',
- stylesheetfile: '../core/src/main/javadoc/stylesheet.css',
+ overview: 'src/javadoc/package.html',
+ stylesheetfile: 'src/javadoc/stylesheet.css',
windowtitle: 'Hibernate JavaDocs',
doctitle: 'Hibernate JavaDoc (${project.version})',
bottom: 'Copyright © 2001-2010