[JIRA-OS] Created: (WF-205) JavaDoc on Hibernate classes

Message:

  A new issue has been created in JIRA.

---------------------------------------------------------------------
View the issue:

  http://jira.opensymphony.com/secure/ViewIssue.jspa?key=WF-205


Here is an overview of the issue:
---------------------------------------------------------------------
        Key: WF-205
    Summary: JavaDoc on Hibernate classes
       Type: Improvement

     Status: Assigned
   Priority: Trivial

    Project: OSWorkflow
 Components: 
             Core

   Assignee: Patrick Lightbody
   Reporter: Robert Dawson

    Created: Wed, 3 Sep 2003 5:46 AM
    Updated: Wed, 3 Sep 2003 5:46 AM

Description:
It would be useful to add in some javadoc on the hibernate classes.

Here is a quick example that I knocked up when reading through the classes.


/**
 * This abstract class provides all the implementation of the step interface.
 * It is abstract because the current and historical steps are stored in seperate tables.  To do the split into tables
 * best in Hibernate the approach of having seperate classes has been used.
 * @author $Author: hani $
 * @version $Revision: 1.1.1.1 $
 */
public abstract class HibernateStep implements Step {

/**
 *
 * This class exists to seperate the persistence of the Steps.  By seperating out the Current Step from the Previous
 * Step in to seperate classes, they can be easily written into seperate tables.
 * @see HibernateHistoryStep
 * @author $Author: hani $
 * @version $Revision: 1.1.1.1 $
 */
public class HibernateCurrentStep extends HibernateStep {

/**
 * This is here to persist the historical steps to the historical table.  It is more used for querying than
 * persistence.
 *
 * @author $Author: hani $
 * @version $Revision: 1.1.1.1 $
 */
public class HibernateHistoryStep extends HibernateStep {



---------------------------------------------------------------------
JIRA INFORMATION:
This message is automatically generated by JIRA.

If you think it was sent incorrectly contact one of the administrators:
   http://jira.opensymphony.com/secure/Administrators.jspa

If you want more information on JIRA, or have a bug to report see:
   http://www.atlassian.com/software/jira



-------------------------------------------------------
This sf.net email is sponsored by:ThinkGeek
Welcome to geek heaven.
http://thinkgeek.com/sf