HHH-5083 - Align javadoc styles better with docbook / website

git-svn-id: https://svn.jboss.org/repos/hibernate/core/trunk@19226 1b8cb986-b30d-0410-93ca-fae66ebed9b2
This commit is contained in:
Steve Ebersole 2010-04-13 18:16:23 +00:00
parent 84477a7816
commit 23dfa3f264
13 changed files with 440 additions and 86 deletions

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 719 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 270 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

View File

@ -1,31 +1,54 @@
<body>
Hibernate JavaDoc documentation.
<br>
<h2>Hibernate Core (native API) JavaDocs</h2>
The following are considered to define the "core API" of Hibernate, meaning it is fully intended that they
be exposed to application code:
<ul>
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:<ul>
<li>{@link org.hibernate.cfg.Configuration}</li>
<li>{@link org.hibernate.Hibernate}</li>
<li>{@link org.hibernate.Session}</li>
<li>{@link org.hibernate.SessionFactory}</li>
<li>{@link org.hibernate.Transaction}</li>
<li>{@link org.hibernate.Query}</li>
<li>{@link org.hibernate.Criteria}</li>
<li>{@link org.hibernate.ScrollableResults}</li>
<li>{@link org.hibernate.cfg.Configuration}</li>
<li>{@link org.hibernate.criterion.Projection}</li>
<li>{@link org.hibernate.criterion.Projections}</li>
<li>{@link org.hibernate.criterion.Criterion}</li>
<li>{@link org.hibernate.criterion.Restrictions}</li>
<li>{@link org.hibernate.criterion.Order}</li>
<li>{@link org.hibernate.criterion.Example}</li>
</ul>
<br>
These interfaces are fully intended to be exposed to application code.
<hr/>
The <b>Extension SPIs</b> 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.<br>
<br>
<h3>Extensions</h3>
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:<ul>
<li>{@link org.hibernate.EntityNameResolver}</li>
<li>{@link org.hibernate.Interceptor} / {@link org.hibernate.EmptyInterceptor}</li>
<li>{@link org.hibernate.Transaction} / {@link org.hibernate.transaction.TransactionFactory}</li>
<li>{@link org.hibernate.context.CurrentSessionContext}</li>
<li>{@link org.hibernate.dialect.Dialect}</li>
<li>{@link org.hibernate.dialect.resolver.DialectResolver}</li>
<li>{@link org.hibernate.event event listener} interfaces</li>
<li>{@link org.hibernate.id.IdentifierGenerator}</li>
<li>{@link org.hibernate.tuple.entity.EntityTuplizer} / {@link org.hibernate.tuple.component.ComponentTuplizer}</li>
<li>{@link org.hibernate.type.Type} / {@link org.hibernate.usertype}</li>
</ul>
Note that there is a large degree of crossover between the notion of extension points and that of an integration SPI (below).
<hr/>
You can find all the Hibernate documentation at <a href="http://docs.jboss.org/hibernate"></a>.
</body>
<h3>Integration SPI</h3>
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:<ul>
<li>Caching - {@link org.hibernate.cache.RegionFactory}</li>
<li>JDBC Connection management - {@link org.hibernate.connection.ConnectionProvider}
</ul>
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.
<br/>
Another SPI that is not yet exposed but is planned for such is the <em>bytecode provider</em> SPI. See {@link org.hibernate.bytecode}
for details.
<hr/>
Complete Hibernate documentation may be found online at <a href="http://docs.jboss.org/hibernate/">http://docs.jboss.org/hibernate/</a>.
</body>

View File

@ -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;
}

View File

@ -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 &copy; 2001-2010 <a href="http://redhat.com">Red Hat, Inc.</a> All Rights Reserved.',
@ -135,6 +137,12 @@
ant.package( name: 'org.hibernate.junit*' )
}
}
imagesDir = targetDir + '/images'
ant.mkdir( dir: imagesDir )
ant.copy( toDir: imagesDir ) {
fileset( dir: "src/javadoc/images" )
}
]]>
</source>
</configuration>

Binary file not shown.

After

Width:  |  Height:  |  Size: 2.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 1.3 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 270 B

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

View File

@ -0,0 +1,93 @@
<!--
~ Hibernate, Relational Persistence for Idiomatic Java
~
~ Copyright (c) 2010, Red Hat Inc. 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 Inc.
~
~ 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
-->
<body>
<h2>Aggregated Hibernate Core JavaDocs</h2>
Hibernate provides both<ul>
<li>
a native API comprised mainly of {@link org.hibernate.SessionFactory} and {@link org.hibernate.Session}
</li>
<li>
an implementation of the <a href="">JSR-317</a> Java Persistence API (JPA) specification comprised mainly of
{@link org.hibernate.ejb.EntityManagerFactoryImpl} and {@link org.hibernate.ejb.EntityManagerImpl}
</li>
</ul>
<hr/>
<h3>Native API</h3>
In addition to {@link org.hibernate.SessionFactory} and {@link org.hibernate.Session}, applications using the
native API will often need to utilize the following interfaces:<ul>
<li>{@link org.hibernate.cfg.Configuration}</li>
<li>{@link org.hibernate.Hibernate}</li>
<li>{@link org.hibernate.Transaction}</li>
<li>{@link org.hibernate.Query}</li>
<li>{@link org.hibernate.Criteria}</li>
<li>{@link org.hibernate.criterion.Projection}</li>
<li>{@link org.hibernate.criterion.Projections}</li>
<li>{@link org.hibernate.criterion.Criterion}</li>
<li>{@link org.hibernate.criterion.Restrictions}</li>
<li>{@link org.hibernate.criterion.Order}</li>
<li>{@link org.hibernate.criterion.Example}</li>
</ul>
These interfaces are fully intended to be exposed to application code.
<hr/>
<h3>JPA</h3>
The JPA interfaces are all defined by the JPA specification. For details see {@link javax.persistence}
<hr/>
<h3>Extensions</h3>
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:<ul>
<li>{@link org.hibernate.EntityNameResolver}</li>
<li>{@link org.hibernate.Interceptor} / {@link org.hibernate.EmptyInterceptor}</li>
<li>{@link org.hibernate.Transaction} / {@link org.hibernate.transaction.TransactionFactory}</li>
<li>{@link org.hibernate.context.CurrentSessionContext}</li>
<li>{@link org.hibernate.dialect.Dialect}</li>
<li>{@link org.hibernate.dialect.resolver.DialectResolver}</li>
<li>{@link org.hibernate.event event listener} interfaces</li>
<li>{@link org.hibernate.id.IdentifierGenerator}</li>
<li>{@link org.hibernate.tuple.entity.EntityTuplizer} / {@link org.hibernate.tuple.component.ComponentTuplizer}</li>
<li>{@link org.hibernate.type.Type} / {@link org.hibernate.usertype}</li>
</ul>
Note that there is a large degree of crossover between the notion of extension points and that of an integration SPI (below).
<hr/>
<h3>Integration SPI</h3>
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:<ul>
<li>Caching - {@link org.hibernate.cache.RegionFactory}</li>
<li>JDBC Connection management - {@link org.hibernate.connection.ConnectionProvider}
</ul>
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.
<br/>
Another SPI that is not yet exposed but is planned for such is the <em>bytecode provider</em> SPI. See {@link org.hibernate.bytecode}
for details.
<hr/>
Complete Hibernate documentation may be found online at <a href="http://docs.jboss.org/hibernate/">http://docs.jboss.org/hibernate/</a>.
</body>

View File

@ -0,0 +1,174 @@
/*
* Hibernate, Relational Persistence for Idiomatic Java
*
* Copyright (c) 2010, Red Hat Inc. 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 Inc.
*
* 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
*/
/*
* Custom Hibernate javadoc style sheet
*/
/* Page background color */
body {
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;
}
hr {
border-style: none;
border-bottom: 1px solid #CCCCCC;
}
/* Links */
a:link {
color:#003399;
}
a:visited {
color:#888888;
}
a:hover {
color:#6699cc;
}
a:active {
color: #003399;
}
/* 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;
}
h2 {
color:#586464;
}
/* Default Table elements and colors */
th, table {
border-collapse:collapse;
border-color: #E6E7E8;
}
.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;
}
.TableHeadingColor th {
padding-left: 10px;
}
.TableSubHeadingColor {
background: #ebe7d7;
}
.TableRowColor {
background: #FFFFFF;
border-color: #E6E7E8;
}
.TableRowColor td {
line-height: 175%;
padding-left: 10px;
}
/* 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
}
/* Navigation bar fonts and colors */
.NavBarCell1 {
background: #ffffff url(images/bkgheader.png) repeat-x;
line-height:3em;
padding-left:10px;
padding-right:10px;
}
.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;
}