[hibernate-commits] [hibernate/hibernate-orm] 46430a: remove additional modules which don't contain APIs...
Branch: refs/heads/main
Home: https://github.com/hibernate/hibernate-orm
Commit: 46430a4698337bce655997e987caf833a061fd9e
https://github.com/hibernate/hibernate-orm/commit/46430a4698337bce655997e...
Author: Gavin King <gavin(a)hibernate.org>
Date: 2024-12-16 (Mon, 16 Dec 2024)
Changed paths:
M documentation/documentation.gradle
Log Message:
-----------
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.
Commit: eedcab3c1749a0b0f91f97903acdac4ff9214e1f
https://github.com/hibernate/hibernate-orm/commit/eedcab3c1749a0b0f91f979...
Author: Gavin King <gavin(a)hibernate.org>
Date: 2024-12-16 (Mon, 16 Dec 2024)
Changed paths:
M hibernate-core/src/main/java/org/hibernate/query/MutationQuery.java
Log Message:
-----------
fix Javadoc warning
Compare: https://github.com/hibernate/hibernate-orm/compare/831d4cdb4764...eedcab3...
To unsubscribe from these emails, change your notification settings at
https://github.com/hibernate/hibernate-orm/settings/notifications