[hibernate-issues] [Hibernate-JIRA] Commented: (HHH-2958) Incomplete/non-informative javadocs for events system

[Jacob L E Blain Christen (JIRA)]

    [ http://opensource.atlassian.com/projects/hibernate/browse/HHH-2958?page=com.atlassian.jira.plugin.system.issuetabpanels:comment-tabpanel#action_28890 ] 

Jacob L E Blain Christen commented on HHH-2958:
-----------------------------------------------

Ah Monday morning brain farts.  Whoever picks this up please change the Link to HHH-476 to "relates to" instead of "clones" please.

> Incomplete/non-informative javadocs for events system
> -----------------------------------------------------
>
>                 Key: HHH-2958
>                 URL: http://opensource.atlassian.com/projects/hibernate/browse/HHH-2958
>             Project: Hibernate3
>          Issue Type: Task
>          Components: documentation
>    Affects Versions: 3.0.5, 3.1 beta 1, 3.1 beta 2, 3.1 rc 1, 3.1 rc2, 3.1 rc3, 3.1, 3.1.1, 3.1.2, 3.2.0.alpha1, 3.2.0.alpha2, 3.1.3, 3.2.0 cr1, 3.2.0.cr2, 3.2.0.cr3, 3.2.0.cr4, 3.2.0.cr5, 3.2.0.ga, 3.2.1, 3.2.2, 3.2.3, 3.2.4, 3.2.4.sp1, 3.2.5
>            Reporter: Jacob L E Blain Christen
>            Priority: Minor
>
> See also HHH-1942.
> As per the documentation at http://www.hibernate.org/hib_docs/v3/api/org/hibernate/event/PreUpdateEventListener.html (as an example) and HHH-1942 I most definately do not consider <pre><code>org.hibernate.event
> Interface PreUpdateEventListener
> All Superinterfaces:
>     Serializable
> All Known Implementing Classes:
>     JACCPreUpdateEventListener
> public interface PreUpdateEventListener extends Serializable
> Called before updating the datastore
> Author:
>     Gavin King
> Method Summary
>  boolean 	onPreUpdate(PreUpdateEvent event)
>            
> Method Detail
> onPreUpdate
> public boolean onPreUpdate(PreUpdateEvent event)</code></pre> to be "documented" in any meaningful sense. It would be terrific if the event system javadocs as a whole were on par with the quality of the core hibernate javadocs.

-- 
This message is automatically generated by JIRA.
-
If you think it was sent incorrectly contact one of the administrators: http://opensource.atlassian.com/projects/hibernate/secure/Administrators.jspa
-
For more information on JIRA, see: http://www.atlassian.com/software/jira