Print

---

Author: [log in to unmask]
Date: Tue Feb  3 10:48:04 2015
New Revision: 2030

Log:
Add documentation.

Modified:
    java/trunk/evio/src/main/java/org/hps/evio/EvioReader.java

Modified: java/trunk/evio/src/main/java/org/hps/evio/EvioReader.java
 =============================================================================
--- java/trunk/evio/src/main/java/org/hps/evio/EvioReader.java	(original)
+++ java/trunk/evio/src/main/java/org/hps/evio/EvioReader.java	Tue Feb  3 10:48:04 2015
@@ -1,29 +1,47 @@
-/*
- * To change this template, choose Tools | Templates
- * and open the template in the editor.
- */
 package org.hps.evio;
 
 import org.jlab.coda.jevio.EvioEvent;
+
 import org.lcsim.event.EventHeader;
 
 /**
+ *	Abstract class containing shared methods used by EVIO readers.
  *
- * @author meeg
+ *	@author Sho Uemura <[log in to unmask]>
  */
 public abstract class EvioReader {
 
-	// Debug flag.
+	// Debug flag
 	protected boolean debug = false;
+	
+	// Name of the hit collection that will be created
 	protected String hitCollectionName = null;
 
-	//return true if appropriate EVIO bank found
+	/**
+	 *	Make a LCIO hit collection (e.g. {@link RawTrackerHit}, 
+	 * 	{@link CalorimeterHit} from raw EVIO data.
+	 * 
+	 * 	@param event : The EVIO event to read the raw data from
+	 * 	@param lcsimEvent : The LCSim event to write the collections to
+	 * 	@return True if the appropriate EVIO bank is found, false otherwise	
+	 * 
+	 */
 	abstract boolean makeHits(EvioEvent event, EventHeader lcsimEvent);
 
+	/**
+	 *	Set the hit collection name.
+	 * 
+	 * 	@param hitCollectionName : Name of the hit collection
+	 */
 	public void setHitCollectionName(String hitCollectionName) {
 		this.hitCollectionName = hitCollectionName;
 	}
 
+	/**
+	 *	Enable/disable debug output.
+	 * 
+	 * 	@param debug : Set to true to enable, false to disable.
+	 */
 	public void setDebug(boolean debug) {
 		this.debug = debug;
 	}