Commit Graph

2108 Commits

Author SHA1 Message Date
Gavin King 429f5beff6 HHH-18948 move the EventMonitor SPI to its own namespace 2024-12-16 22:58:02 +01:00
Gavin King 46430a4698 remove additional modules which don't contain APIs from the generated Javadoc
These modules don't contain APIs which are called by users or implemented by
integrators. Including them in the generated Javadoc results in confusion
for users and makes the Javadoc much more difficult to navigate and consume.

In particular, we definitely don't want packages like these included in the
main Javadoc distribution for Hibernate ORM:

  org.hibernate.testing.orm.domain.gambit
  org.hibernate.testing.orm.domain.helpdesk

"Good documentation" isn't about having the maximum possible quantity of
documentation; it's about having documentation where people actually have a
hope of finding what they're looking for. In general, generated Javadoc is
entirely useless except when we've actually taken time to actually write
meaningful and readable prose. If all I need is a list of classes and their
methods, my IDE is quite capable of presenting that information to me.

Worse, documentation for things that aren't API appears to invite users to
interact with these things, which is precisely what we don't want them to do!

I'm leaving Envers alone, but I'm honestly not even sure if the Envers packages
belong here, since it doesn't look like anyone has actually spent much time
writing Javadoc for these packages. If Envers Javadoc is useful, it would be
better to put it in a separate Javadoc build, IMO.
2024-12-16 22:57:29 +01:00
Gavin King 831d4cdb47 tune the documentation CSS 2024-12-16 22:50:46 +01:00
Gavin King af679e1d96 mention Hibernate JFR in the Short Guide 2024-12-16 02:01:56 +01:00
Nathan Xu 2df92c25b8
improve integration doc (#9322)
* improve integration doc

Co-authored-by: nathan.xu <nathan.xu@procor.com>
Co-authored-by: Gavin King <gavin@hibernate.org>
2024-12-14 17:06:35 +01:00
Gavin King c88b1e8cc9 links to settings from doc
(oops!)
2024-12-10 21:31:28 +01:00
Gavin King 8f11eb56a3 links to settings from doc 2024-12-10 21:25:09 +01:00
Gavin King 02cf728bcb median function documentation, improve test 2024-12-07 17:01:15 +01:00
Gavin King 1a5db3bf42 HHH-18892 add hex() function 2024-12-03 23:16:28 +01:00
Gavin King c73a12ced6 HHH-18892 document hash function support 2024-12-03 21:10:19 +01:00
Gavin King cf5b2955db add links to connection pool doc 2024-12-03 08:53:11 +01:00
Gavin King 5efd37a4d8 HHH-18902 completely remove Vibur
it has not been updated in 5 years
2024-12-03 08:35:29 +01:00
Gavin King 90ff5e712a HHH-18902 completely remove Proxool
it has not been updated in 20 years!
2024-12-03 08:35:29 +01:00
Gavin King 05852b706f
more cleanups to dependencies (#9354) 2024-12-01 13:37:51 +01:00
Gavin King 38fb68a57c correctly describe automatic quoting in doc 2024-11-29 14:06:25 +01:00
Gavin King 79aa178047 HHH-16516 rework CamelCaseToUnderscoresNamingStrategy and handle quoted identifiers 2024-11-28 14:36:32 +01:00
Gavin King 5383c81d18 fix capitalization in a title 2024-11-25 23:39:34 +00:00
Gavin King 030e1fdc25 simplify code examples by using conveniences of HibernatePersistenceConfiguration 2024-11-24 11:22:06 +01:00
Gavin King 89fee1cf42 add CAUTION to doc 2024-11-23 17:30:22 +01:00
Gavin King a294048dd1 HHH-14119 test showing parameter padding works with criteria literals 2024-11-23 14:52:06 +01:00
Gavin King cdf88f6a31 talk about events and about EntityListeners in the intro doc 2024-11-23 14:52:06 +01:00
Jan Schatteman f65f393a01 Fix a couple of typo's
Signed-off-by: Jan Schatteman <jschatte@redhat.com>
2024-11-22 20:51:09 +01:00
Gavin King 82060f282d Update documentation/src/main/asciidoc/introduction/Configuration.adoc
Co-authored-by: Yoann Rodière <yoann@hibernate.org>
2024-11-21 22:53:43 +01:00
Gavin King 697d820a7f add some documentation about date/time config settings
and also add some links
2024-11-21 22:53:43 +01:00
Steve Ebersole 21095565bc HHH-7913 - Schema replacement in <subselect> / @Subselect 2024-11-21 06:53:51 -06:00
Gavin King 779d9c94c9 document the syntax sugar 2024-11-17 15:02:08 +01:00
Gavin King 8f85e6ca47 mention SQL arrays in HQL documentation 2024-11-16 23:35:09 +01:00
Gavin King 632485f8b1 revise new doc section 2024-11-16 21:21:52 +01:00
Gavin King ce48367607 new doc section on date/time types 2024-11-16 19:05:43 +01:00
Gavin King 439c90f501 add links between chapters 2024-11-16 19:05:43 +01:00
Gavin King d6e1c9b2a8 add an example use of hibernate.type.preferred_instant_jdbc_type 2024-11-15 20:00:49 +01:00
Gavin King f3482078c1 clarifications in section on collection mapping
(to agree with blog)
2024-11-12 15:07:40 +01:00
Gavin King a2c714e8f8 add a forward link 2024-11-12 12:29:19 +01:00
Gavin King 4669827465 add a link to the new blog post 2024-11-12 12:29:19 +01:00
Gavin King ec4310a6de HHH-18843 remove deprecated @OrderBy 2024-11-11 19:16:48 +01:00
Gavin King d5e829d26c add section on quoted identifiers to doc
Signed-off-by: Gavin King <gavin@hibernate.org>
2024-11-10 09:37:09 +01:00
Gavin King 68abe5aa70 proofread the Short Guide
Signed-off-by: Gavin King <gavin@hibernate.org>
2024-11-08 21:25:19 +01:00
Steve Ebersole 2ea226999d HHH-18728 - Allow mixed discriminator-value mappings for ANY
HHH-18729 - Allow custom strategy for implicit discriminator-value determination for ANY
2024-11-06 20:05:36 -07:00
Marco Belladelli 0378e591cc HHH-17612 HHH-18762 Migration guide and Envers documentation updates 2024-11-01 11:52:56 -05:00
Christian Beikov e1a8990358 HHH-18759 Add xmltable() set-returning function 2024-10-31 18:04:05 +01:00
Christian Beikov 854a982927 HHH-18758 Add json_table() set-returning function 2024-10-31 18:04:05 +01:00
Gavin King 7bf6004ef8 fix broken code examples, and make 'em more readable
Signed-off-by: Gavin King <gavin@hibernate.org>
2024-10-24 18:59:13 +02:00
Gavin King 7002ee8d0d shorter method name in doc example
Signed-off-by: Gavin King <gavin@hibernate.org>
2024-10-24 14:07:22 +02:00
Gavin King 93c18dafae more doc updates for JPA 3.2
Signed-off-by: Gavin King <gavin@hibernate.org>
2024-10-24 01:26:28 +02:00
Gavin King 1fa10e3b53 update prefaces
Signed-off-by: Gavin King <gavin@hibernate.org>
2024-10-23 21:24:47 +02:00
Gavin King 6480154cd7 more updates for JPA 3.2
Signed-off-by: Gavin King <gavin@hibernate.org>
2024-10-23 21:24:47 +02:00
Christian Beikov 82b20a0e90 HHH-18731 Add generate_series() set-returning function 2024-10-23 18:29:20 +02:00
Gavin King 5bd244dd20 whitespace fix
Signed-off-by: Gavin King <gavin@hibernate.org>
2024-10-23 17:25:36 +02:00
Gavin King 7f3c73b438 update processor chapter for JPA 3.2
Signed-off-by: Gavin King <gavin@hibernate.org>
2024-10-23 16:32:54 +02:00
Gavin King 517056140f split a rant into two rants
Signed-off-by: Gavin King <gavin@hibernate.org>
2024-10-23 16:12:25 +02:00