# HG changeset patch
# User robcast
# Date 1462372398 -7200
# Node ID feebfabae0164a08ec63726676139304d19e5a9f
# Parent  7995afe760a84b562d348b1bdf39bf8d554a7f93
better comments.

diff -r 7995afe760a8 -r feebfabae016 common/src/main/java/digilib/meta/IndexMetaAuthLoader.java
--- a/common/src/main/java/digilib/meta/IndexMetaAuthLoader.java	Mon May 02 20:21:17 2016 +0200
+++ b/common/src/main/java/digilib/meta/IndexMetaAuthLoader.java	Wed May 04 16:33:18 2016 +0200
@@ -38,16 +38,38 @@
  * License along with this program.  If not, see
  * <http://www.gnu.org/licenses/lgpl-3.0.html>.
  * #L%
- * Author: Robert Casties (robcast@berlios.de)
+ * Author: Robert Casties (robcast@users.sourceforge.net)
  */
 
 /**
- * Class loading index.meta files extracting some image file related information.
+ * Class loading index.meta files extracting image file related information.
  * 
  * Extracts into the MetadataMap all tags in the meta/img tag as key-value
- * pairs and access conditions under the access key.
+ * pairs and information from the meta/access tag under the "access" key.
  * 
- * Returns a map with filenames and MetadataMaps.
+ * <pre>
+ * {@code
+ *   <meta>
+ *     <img>
+ *       <original-dpi>600</original-dpi>
+ *     </img>
+ *     <access-conditions>
+ *       <access type="group">
+ *         <name>digigroup</name>
+ *       </access>
+ *     </access-conditions>
+ *   </meta>
+ * }
+ * </pre>
+ * 
+ * Returns a map with filenames and MetadataMaps with directory-wide information 
+ * under the key "":
+ * <pre>
+ *   {
+ *   "pageimg/page140r.jpg" : {"original-dpi" : 300}
+ *   "" : { "access" : "group:digigroup", "original-dpi" : 600}, 
+ *   }
+ * </pre>
  * 
  * Implemented using javax.xml.stream.XMLStreamReader.
  *