Hibernate
/
hibernate-orm
mirror of https://github.com/hibernate/hibernate-orm
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

HHH-9641 - Resume uploading Javadoc JARs to Maven 

HHH-12187 - Drop custom javadoc css

- dropped "package groups"
This commit is contained in:
Steve Ebersole 2018-01-03 11:23:37 -06:00
parent 7faf1c4d43
commit a625452fe9
3 changed files with 21 additions and 86 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
build.gradle
View File

@ -386,10 +386,10 @@ subprojects { subProject ->
use = true
encoding = 'UTF-8'
links += [
'http://docs.oracle.com/javase/8/docs/api/',
'https://docs.oracle.com/javase/8/docs/api/',
'http://docs.jboss.org/hibernate/beanvalidation/spec/2.0/api/',
'http://docs.jboss.org/cdi/api/2.0/',
'http://docs.oracle.com/javaee/7/api/'
'https://docs.oracle.com/javaee/7/api/'
]
if ( JavaVersion.current().isJava8Compatible() ) {
@ -397,39 +397,8 @@ subprojects { subProject ->
}
doFirst {
// calculation of these groups is expensive - so push
// that process from init/configuration phase to execution
// phase.
//
// Note : this does not affect UP-TO-DATE checking because
// the groups are based on packages of the classes, and
// if the classes change that would already trigger
// re-execution of this task...
Set<String> apiPackages = new HashSet<>()
Set<String> spiPackages = new HashSet<>()
Set<String> testingPackages = new HashSet<String>()
subProject.sourceSets.main.java.each { javaFile ->
final String packageName = determinePackageName( subProject.sourceSets.main.java, javaFile );
if ( packageName.endsWith( ".internal" ) || packageName.contains( ".internal." ) ) {
// nothing to do - we exclude internal packages
}
else if ( packageName.endsWith( ".spi" ) || packageName.contains( ".spi." ) ) {
spiPackages.add( packageName )
}
else if ( packageName.startsWith( "org.hibernate.testing" ) ) {
testingPackages += packageName
}
else {
apiPackages.add( packageName )
}
}
options.group( 'API', apiPackages.asList() )
options.group( 'SPI', spiPackages.asList() )
options.group( 'Testing Support', testingPackages.asList() )
// ordering problems if we try to do this during config phase :(
classpath += subProject.sourceSets.main.output + subProject.sourceSets.main.compileClasspath + subProject.configurations.provided
}
}
}

40
documentation/documentation.gradle
View File

@ -149,45 +149,7 @@ task aggregateJavadocs(type: Javadoc) {
// we only care about the main SourceSet...
source subProject.sourceSets.main.java
// if( classpath ) {
classpath += subProject.sourceSets.main.output + subProject.sourceSets.main.compileClasspath
// }
// else {
// classpath = subProject.sourceSets.main.output + subProject.sourceSets.main.compileClasspath
// }
}
doFirst {
Set<String> apiPackages = new HashSet<String>()
Set<String> spiPackages = new HashSet<String>()
Set<String> testingPackages = new HashSet<String>()
parent.subprojects.each { Project subProject ->
// skip certain sub-projects
if ( projectsToSkip.contains( subProject.name ) ) {
return
}
subProject.sourceSets.main.java.each { javaFile ->
final String packageName = determinePackageName( subProject.sourceSets.main.java, javaFile );
if ( packageName.endsWith( ".internal" ) || packageName.contains( ".internal." ) ) {
// do nothing - we exclude internal packages
}
else if ( packageName.endsWith( ".spi" ) || packageName.contains( ".spi." ) ) {
spiPackages.add( packageName )
}
else if ( packageName.startsWith( "org.hibernate.testing" ) ) {
testingPackages += packageName
}
else {
apiPackages.add( packageName )
}
}
}
options.group( 'API', apiPackages.asList() )
options.group( 'SPI', spiPackages.asList() )
options.group( 'Testing Support', testingPackages.asList() )
classpath += subProject.sourceSets.main.output + subProject.sourceSets.main.compileClasspath + subProject.configurations.provided
}
}

28
documentation/src/main/javadoc/overview.html
View File

@ -17,7 +17,7 @@ Hibernate provides both<ul>
See the latest <a href="http://jcp.org/en/jsr/detail?id=338">JPA JSR</a> for details.
</li>
</ul>
<hr/>
<p></p>
<h3>Native API</h3>
In addition to SessionFactory and Session, applications using the native API will often utilize the following
@ -35,28 +35,32 @@ interfaces:<ul>
</ul>
These interfaces are fully intended to be exposed to application code.
<p></p>
<hr/>
<h3>JPA</h3>
The JPA interfaces are all defined by the JPA specification. For details see {@link javax.persistence}
The JPA interfaces are all defined by the JPA specification. For details see {@link javax.persistence}.
Not that since 5.2 Hibernate extends JPA (e.g. SessionFactory extends EntityManagerFactory) rather
than wrapping it.
<p></p>
<hr/>
<h3>Package Groups</h3>
This documentation groups packages into the following 3 categories:<ul>
<h3>Note about package categories</h3>
Hibernate categorizes packages into a number of groups based on intended consumers:<ul>
<li>
<strong>API</strong> - classes to which application code will generally bind directly.
<strong>API</strong> - classes to which application code will generally bind directly. These
are generally classes which do not have "spi" nor "internal" in their package path and are
not under the "org.hibernate.testing" package
</li>
<li>
<strong>SPI</strong> - classes to which application developers or integrators will commonly bind directly in
order to develop extensions to Hibernate, or to alter its behavior in some way.
<strong>SPI</strong> - classes to which integrator developers will commonly bind directly in
order to develop extensions to Hibernate, or to alter its behavior in some way. These are
generally under packages with "spi" in the package path.
</li>
<li>
<strong>Testing Support</strong> - classes from the hibernate-testing artifact used in building Hibernate test cases.
<strong>Testing Support</strong> - classes from the hibernate-testing artifact used in building
Hibernate test cases. These are classes under the "org.hibernate.testing" package
</li>
</ul>
<hr/>
<p></p>
Complete Hibernate documentation may be found online at <a href="http://hibernate.org/orm/documentation">http://hibernate.org/orm/documentation/</a>