Actually, its in the code but is missed by the javadoc tool because of a typo. Details originally reported as a comment to:
https://hibernate.onjira.com/browse/HHH-7856