Adds support for pazpar2 info command

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

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/commands/package-info.java b/src/main/java/com/indexdata/mkjsf/pazpar2/commands/package-info.java
index 347e81e..4fae890 100644 (file)
--- a/src/main/java/com/indexdata/mkjsf/pazpar2/commands/package-info.java
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/commands/package-info.java
@@ -1,33 +1,33 @@
 /**\r
  * \r
  * Each Pazpar2 command is represented by a class with methods for \r
- * setting parameters and ultimately running the command against \r
+ * setting parameters and running the command against \r
  * the selected Pazpar2 service. \r
  * <p>\r
  * The UI can access the command objects through the bean Pazpar2Commands, \r
- * which is exposed to the UI under the name 'pzreq'.\r
+ * which is exposed to the UI under the name <code>pzreq</code>.\r
  * </p>\r
  * <p>\r
  * For commands that has Service Proxy extension parameters, the UI \r
  * can access the extension parameters through the getSp() method\r
- * on the command.\r
+ * on the command - using for instance <code>pzreq.record.sp</code>\r
  * </p>\r
  * <p>\r
  * The UI can access Service Proxy-only commands through the getSp()\r
- * method on the pzreq bean.\r
+ * method on the pzreq bean - for instance <code>pzreq.sp.categories</code>\r
  * </p>\r
- * Examples\r
+ * <p>Examples:</p>\r
  * <ul>\r
- *  <li>pzreq.search.query references getter and setter for the \r
+ *  <li><code>pzreq.search.query</code> references getter and setter for the \r
  *          query parameter of the search command.</li>\r
  * \r
- *  <li>pzreq.search.run() executes the search command with current\r
+ *  <li><code>pzreq.search.run()</code> executes the search command with current\r
  *          parameters</li>\r
  *                      \r
- *  <li>pzreq.record.sp.recordquery references a Service Proxy-only \r
- *          parameter to the record command</li> \r
+ *  <li><code>pzreq.record.sp.recordquery</code> references getter and setter on a Service Proxy-only \r
+ *          <i>parameter</i> to the record command</li> \r
  *         \r
- *  <li>pzreq.sp.auth.run() executes a Service Proxy-only command</li> \r
+ *  <li><code>pzreq.sp.auth.run()</code> executes a Service Proxy-only <i>command</i></li> \r
  * </ul>          \r
  *          \r
  */\r