javadoc

java/org/jlab/coda/jevio/EvioCompactReaderUnsyncV4.java

@@ -24,10 +24,13 @@
 import java.util.List;
 
 /**
- * This class is used to read an evio format version 4 formatted file or buffer
+ * <p>This class is used to read an evio format version 4 formatted file or buffer
  * and extract specific evio containers (bank, seg, or tagseg)
  * with actual data in them given a tag/num pair. It is NOT thread-safe since
- * all synchronization is removed in order to gain speed.<p>
+ * all synchronization is removed in order to gain speed.</p>
+ *
+ * <p>Although this class can be used directly, it's generally used by
+ * using {@link EvioCompactReader} which, in turn, uses this class.</p>
  *
  * For a list of methods that cannot be run simultaneously, look at
  * the synchronized methods in EvioCompactReaderV4.

java/org/jlab/coda/jevio/EvioCompactReaderUnsyncV6.java

@@ -24,9 +24,12 @@
 import java.util.List;
 
 /**
- * This class is used to read an evio format version 6 formatted file or buffer.
+ * <p>This class is used to read an evio format version 6 formatted file or buffer.
  * It's essentially a wrapper for the hipo.Reader class so the user can have
- * access to the EvioCompactReader methods. It is NOT thread-safe.<p>
+ * access to the EvioCompactReader methods. It is NOT thread-safe.</p>
+ *
+ * <p>Although this class can be used directly, it's generally used by
+ * using {@link EvioCompactReader} which, in turn, uses this class.</p>
  *
  * @author timmer
  */

java/org/jlab/coda/jevio/EvioCompactReaderV4.java

@@ -15,9 +15,12 @@
 import java.util.List;
 
 /**
- * This class is used to read an evio format version 4 formatted file or buffer
+ * <p>This class is used to read an evio format version 4 formatted file or buffer
  * and extract specific evio containers (bank, seg, or tagseg)
- * with actual data in them given a tag/num pair.<p>
+ * with actual data in them given a tag/num pair.</p>
+ *
+ * <p>Although this class can be used directly, it's generally used by
+ * using {@link EvioCompactReader} which, in turn, uses this class.</p>
  *
  * @author timmer
  */

java/org/jlab/coda/jevio/EvioCompactReaderV6.java

@@ -16,9 +16,12 @@
 import java.util.List;
 
 /**
- * This class is used to read an evio format version 6 formatted file or buffer.
+ * <p>This class is used to read an evio format version 6 formatted file or buffer.
  * It's essentially a wrapper for the hipo.Reader class so the user can have
- * access to the EvioCompactReader methods. It <b>IS</b> thread-safe.<p>
+ * access to the EvioCompactReader methods. It <b>IS</b> thread-safe.</p>
+ *
+ * <p>Although this class can be used directly, it's generally used by
+ * using {@link EvioCompactReader} which, in turn, uses this class.</p>
  *
  * @author timmer
  */

java/org/jlab/coda/jevio/EvioReaderUnsyncV4.java

@@ -47,6 +47,9 @@
  * therefore it's not thread safe.
  * <p>
  *
+ * Although this class can be used directly, it's generally used by
+ * using {@link EvioReader} which, in turn, uses this class.<p>
+ *
  * @author heddle
  * @author timmer
  *

java/org/jlab/coda/jevio/EvioReaderUnsyncV6.java

@@ -38,6 +38,11 @@
  * for access to the structures. For those familiar with XML, the event is processed DOM-like.
  * <p>
  *
+ * This class is a NOT thread safe version of EvioReaderV6, but presumably faster.<p>
+ *
+ * Although this class can be used directly, it's generally used by
+ * using {@link EvioCompactReader} which, in turn, uses this class.<p>
+ *
  * @since version 6
  * @author timmer
  */

java/org/jlab/coda/jevio/EvioReaderV4.java

@@ -35,6 +35,12 @@
  * for access to the structures. For those familiar with XML, the event is processed DOM-like.
  * <p>
  *
+ * This class is identical to EvioReaderUnsyncV4 except that critical methods are synchronized,
+ * therefore it is thread safe.<p>
+ *
+ * Although this class can be used directly, it's generally used by
+ * using {@link EvioCompactReader} which, in turn, uses this class.<p>
+ *
  * This class is a thread safe version of EvioReaderUnsync4.
  *
  * @author heddle

java/org/jlab/coda/jevio/EvioReaderV6.java

@@ -28,7 +28,10 @@
  * for access to the structures. For those familiar with XML, the event is processed DOM-like.
  * <p>
  *
- * This class is a thread safe version of EvioReaderUnsyncV6.
+ * This class is a thread safe version of EvioReaderUnsyncV6.<p>
+ *
+ * Although this class can be used directly, it's generally used by
+ * using {@link EvioCompactReader} which, in turn, uses this class.<p>
  *
  * @since version 6
  * @author timmer