Merge branch 'master' of ssh://git.indexdata.com/home/git/private/mkjsf.git into...

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

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/data/sp/package-info.java b/src/main/java/com/indexdata/mkjsf/pazpar2/data/sp/package-info.java
new file mode 100644 (file)
index 0000000..d5994a7
--- /dev/null
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/data/sp/package-info.java
@@ -0,0 +1,14 @@
+/**\r
+ * Service Proxy responses produced by Service Proxy commands.\r
+ * \r
+ * <p>The most recent respons from each command is accessible to the UI\r
+ * through the class SpResponses, which is exposed to the UI as <code>pzresp.sp</code></p>\r
+ * \r
+ * <p>Examples:</p>\r
+ * <ul>\r
+ *  <li><code>pzresp.sp.auth.status<code> returns the status of the most recent authentication request</li>\r
+ *  <li><code>pzresp.sp.categories.tagetCategories</code> returns target categories for filtering by category</li>\r
+ * </ul>  \r
+ * \r
+ */\r
+package com.indexdata.mkjsf.pazpar2.data.sp;
\ No newline at end of file