Skip to content

Javadoc updates #10213

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 2 commits into from
May 23, 2025
Merged

Javadoc updates #10213

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
0e58a7c
update javadoc overview
gavinking May 23, 2025
221ab3f
fix formatting of lists in member desciption in javadoc
gavinking May 23, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 15 additions & 6 deletions shared/javadoc/overview.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,8 +11,8 @@ <h2>Hibernate ORM Javadocs</h2>
</p>
<ul>
<li>
a <em>native API</em> centered around {@link org.hibernate.SessionFactory} and
{@link org.hibernate.Session},
a <em>native API</em> centered around {@link org.hibernate.SessionFactory},
{@link org.hibernate.Session}, and {@link org.hibernate.StatelessSession},
</li>
<li>
an implementation of the <em>Java (or Jakarta) Persistence API</em> (JPA),
Expand All @@ -35,12 +35,17 @@ <h3>Native API</h3>
using the native API will often make use of the following interfaces:
</p>
<ul>
<li>{@link org.hibernate.cfg.Configuration} to configure and bootstrap Hibernate,</li>
<li>{@link org.hibernate.StatelessSession} for processes involving many entity instances,</li>
<li>{@link org.hibernate.jpa.HibernatePersistenceConfiguration} or
{@link org.hibernate.cfg.Configuration} to configure and bootstrap Hibernate,</li>
<li>{@link org.hibernate.Cache} to manage the second-level cache,</li>
<li>{@link org.hibernate.Transaction} to control local transactions,</li>
<li>{@link org.hibernate.query.Query} to execute HQL queries,</li>
<li>{@link org.hibernate.query.SelectionQuery} and {@link org.hibernate.query.MutationQuery} to
execute HQL queries,</li>
<li>{@link org.hibernate.query.NativeQuery} to execute native SQL queries,</li>
<li>{@link org.hibernate.query.specification.SelectionSpecification} and
{@link org.hibernate.query.specification.MutationSpecification} for working with dynamic
{@linkplain org.hibernate.query.restriction.Restriction restrictions} and
{@linkplain org.hibernate.query.Order ordering},</li>
<li>{@link org.hibernate.Filter} to manage filters,</li>
<li>{@link org.hibernate.query.criteria.HibernateCriteriaBuilder} to construct criteria queries,
and</li>
Expand All @@ -60,10 +65,14 @@ <h3>JPA</h3>
{@link jakarta.persistence.EntityManager}, programs based on the standard JPA API often use:
</p>
<ul>
<li>{@link jakarta.persistence.Persistence} to bootstrap Hibernate via JPA,</li>
<li>{@link jakarta.persistence.Persistence} and {@link jakarta.persistence.PersistenceConfiguration}
to bootstrap Hibernate via JPA,</li>
<li>{@link jakarta.persistence.TypedQuery} to execute queries,</li>
<li>{@link jakarta.persistence.EntityGraph} to control the boundaries of fetched data,</li>
<li>{@link jakarta.persistence.EntityTransaction} to control local transactions,</li>
<li>{@link jakarta.persistence.Cache} to manage the second-level cache,</li>
<li>{@link jakarta.persistence.SchemaManager} to execute DDL in tests,</li>
<li>{@link jakarta.persistence.criteria.CriteriaBuilder} to construct criteria queries,</li>
<li>{@link jakarta.persistence.metamodel.Metamodel} to implement generic code which makes use of
persistent entity classes in a reflective fashion, and</li>
<li>{@link jakarta.persistence.criteria.CriteriaBuilder} to build JPA criteria queries.</li>
Expand Down
5 changes: 5 additions & 0 deletions shared/javadoc/stylesheet.css
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -391,6 +391,11 @@ ul.summary-list {
padding: 0;
}

div.block > ul {
margin-block-start: 1em;
margin-block-end: 1em;
}

ul.block-list > li,
ul.details-list > li,
ul.member-list > li,
Expand Down