[Babeldoc-devel] babeldoc/modules/core/src/com/babeldoc/core/journal/dummy DummyJournal.java,1.4,1.5

[bruce m. <tr...@us...>]

Update of /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal/dummy
In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv7955/modules/core/src/com/babeldoc/core/journal/dummy

Modified Files:
	DummyJournal.java 
Log Message:
javadoc and formatting here.

Index: DummyJournal.java
===================================================================
RCS file: /cvsroot/babeldoc/babeldoc/modules/core/src/com/babeldoc/core/journal/dummy/DummyJournal.java,v
retrieving revision 1.4
retrieving revision 1.5
diff -C2 -d -r1.4 -r1.5
*** DummyJournal.java	23 Jul 2004 22:31:55 -0000	1.4
--- DummyJournal.java	30 Jul 2004 01:33:00 -0000	1.5
***************
*** 21,29 ****
      implements IJournal {
  
!   /** maintain the configuration information object */
    private IConfigInfo info;
  
    /**
!    * Get the configuration iformation for this class
     *
     * @return IConfigInfo object
--- 21,29 ----
      implements IJournal {
  
!   /** maintain the configuration information object. */
    private IConfigInfo info;
  
    /**
!    * Get the configuration iformation for this class.
     *
     * @return IConfigInfo object
***************
*** 64,72 ****
  
    /**
!    * getChildrenTickets.  Get all the tickets which are children of this ticket
!    *
!    * @param parent
     *
     * @return array of child tickets.
     */
    public IJournalTicket[] getAllChildTickets(IJournalTicket parent)
--- 64,72 ----
  
    /**
!    * getChildrenTickets.  Get all the tickets which are children of this ticket.
     *
+    * @param parent parent ticket.
     * @return array of child tickets.
+    * @throws JournalException journal exception.
     */
    public IJournalTicket[] getAllChildTickets(IJournalTicket parent)
***************
*** 79,84 ****
     *
     * @param ticket number
-    *
     * @return array of querytickets
     */
    public QueryTicket[] getAllTicketSteps(IJournalTicket ticket)
--- 79,84 ----
     *
     * @param ticket number
     * @return array of querytickets
+    * @throws JournalException journal exception.
     */
    public QueryTicket[] getAllTicketSteps(IJournalTicket ticket)
***************
*** 92,99 ****
     * @param ticket - the ticket to replay
     * @param step - the step to replay from
!    *
!    * @return
!    *
!    * @throws JournalException
     */
    public PipelineDocument getDocumentAtTicketStep(IJournalTicket ticket,
--- 92,97 ----
     * @param ticket - the ticket to replay
     * @param step - the step to replay from
!    * @return Get the dummy document.
!    * @throws JournalException journal exception.
     */
    public PipelineDocument getDocumentAtTicketStep(IJournalTicket ticket,
***************
*** 105,111 ****
     * Get an existing ticket from the string identifier.
     *
!    * @param identifier ;
!    *
     * @return the created tracker ticket
     */
    public IJournalTicket getTicket(String identifier) throws JournalException {
--- 103,109 ----
     * Get an existing ticket from the string identifier.
     *
!    * @param identifier identifier to search for (this is a dummy remember)
     * @return the created tracker ticket
+    * @throws JournalException journal exception.
     */
    public IJournalTicket getTicket(String identifier) throws JournalException {
***************
*** 118,123 ****
     *
     * @param jQuery journal query object
-    *
     * @return the results.
     */
    public QueryTicket[] getTickets(JournalQuery jQuery)
--- 116,121 ----
     *
     * @param jQuery journal query object
     * @return the results.
+    * @throws JournalException journal exception.
     */
    public QueryTicket[] getTickets(JournalQuery jQuery)
***************
*** 130,133 ****
--- 128,132 ----
     *
     * @return the created tracker ticket
+    * @throws JournalException exception
     */
    public IJournalTicket dummyTicket() throws JournalException {
***************
*** 139,144 ****
     *
     * @param parentTicket the creating ticket
-    *
     * @return the created tracker ticket
     */
    public IJournalTicket forkTicket(IJournalTicket parentTicket)
--- 138,143 ----
     *
     * @param parentTicket the creating ticket
     * @return the created tracker ticket
+    * @throws JournalException exception
     */
    public IJournalTicket forkTicket(IJournalTicket parentTicket)
***************
*** 151,154 ****
--- 150,154 ----
     *
     * @return the created tracker ticket
+    * @throws JournalException exception
     */
    public IJournalTicket newTicket() throws JournalException {
***************
*** 157,161 ****
  
    /**
!    * Log a message into the log file
     *
     * @param ticket track the document
--- 157,161 ----
  
    /**
!    * Log a message into the log file.
     *
     * @param ticket track the document
***************
*** 169,176 ****
  
    /**
!    * Replay this ticket from the step
     *
     * @param ticket - the ticket to replay
     * @param step - the step to replay from
     */
    public void replayTicket(IJournalTicket ticket, int step)
--- 169,177 ----
  
    /**
!    * Replay this ticket from the step.
     *
     * @param ticket - the ticket to replay
     * @param step - the step to replay from
+    * @throws JournalException exception
     */
    public void replayTicket(IJournalTicket ticket, int step)
***************
*** 179,187 ****
  
    /**
!    * Update a document associated with this ticket
     *
     * @param ticket - the ticket to replay
     * @param document the document to update
     * @param stage the pipeline stage resulting in this status change
     */
    public void updateDocument(IJournalTicket ticket, PipelineDocument document,
--- 180,189 ----
  
    /**
!    * Update a document associated with this ticket.
     *
     * @param ticket - the ticket to replay
     * @param document the document to update
     * @param stage the pipeline stage resulting in this status change
+    * @throws JournalException exception
     */
    public void updateDocument(IJournalTicket ticket, PipelineDocument document,
***************
*** 190,198 ****
  
    /**
!    * Update the status of this ticket
     *
     * @param ticket - the ticket for this status
     * @param status - the status of the ticket
     * @param stage the pipeline stage resulting in this status change
     */
    public void updateStatus(IJournalTicket ticket, IJournalStatus status,
--- 192,201 ----
  
    /**
!    * Update the status of this ticket.
     *
     * @param ticket - the ticket for this status
     * @param status - the status of the ticket
     * @param stage the pipeline stage resulting in this status change
+    * @throws JournalException exception
     */
    public void updateStatus(IJournalTicket ticket, IJournalStatus status,