Renames class, removes obsolete, javadoc

[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / mkjsf / pazpar2 / data / package-info.java

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/data/package-info.java b/src/main/java/com/indexdata/mkjsf/pazpar2/data/package-info.java
new file mode 100644 (file)
index 0000000..d217761
--- /dev/null
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/data/package-info.java
@@ -0,0 +1,18 @@
+/**\r
+ * Pazpar2 responses produced by Pazpar2 commands are parsed by the\r
+ * ResponseParser found in this package, the output being response data\r
+ * objects accessible to the UI. \r
+ * \r
+ * <p>The most recent responses from each command are accessible to the UI\r
+ * through the class Responses which is exposed to the UI as <code>pzresp</code></p>\r
+ * \r
+ * <p>Examples:</p>\r
+ * <ul>\r
+ *  <li><code>pzresp.show.hits<code> returns a list of hits from the most recent show command</li>\r
+ *  <li><code>pzresp.show.hits.[0]</code> returns the first hit</li>\r
+ *  <li><code>pzresp.show.hits.[0].author</code> returns the author attribute of the first hit</li>\r
+ *  <li><code>pzresp.show.hits.[0].getOneValue("my-hit-field")</code> returns an arbitrary attribute of the data object</li>\r
+ * </ul>  \r
+ * \r
+ */\r
+package com.indexdata.mkjsf.pazpar2.data;
\ No newline at end of file