Javadoc

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

diff --git a/src/main/java/com/indexdata/mkjsf/pazpar2/commands/Pazpar2Commands.java b/src/main/java/com/indexdata/mkjsf/pazpar2/commands/Pazpar2Commands.java
index c9dc4c0..b847e17 100644 (file)
--- a/src/main/java/com/indexdata/mkjsf/pazpar2/commands/Pazpar2Commands.java
+++ b/src/main/java/com/indexdata/mkjsf/pazpar2/commands/Pazpar2Commands.java
@@ -14,17 +14,17 @@ import com.indexdata.mkjsf.utils.Utils;
 /**\r
  * Pazpar2Commands holds references to all Pazpar2 commands. \r
  * <p>\r
- * The Pazpar2Commands object itself is exposed to the UI as 'pzreq'. \r
+ * The Pazpar2Commands object itself is exposed to the UI as <code>pzreq</code>. \r
  * </p>\r
  * <p>\r
  * When the UI request a command it will be retrieved from the current state\r
  * through the state manager, so that the command can trigger a mutation of \r
  * the state if the user/UI modifies its parameters. \r
  * </p>\r
- * Examples:\r
+ * <p>Examples:</p>\r
  * <ul>\r
- *  <li>pzreq.show    - will retrieve the show command for editing or execution\r
- *  <li>pzreq.sp.auth - will retrieve the Service Proxy extension command 'auth'\r
+ *  <li><code>pzreq.show</code>    - will retrieve the show command for editing or execution\r
+ *  <li><code>pzreq.sp.auth</code> - will retrieve the Service Proxy extension command 'auth'\r
  * </ul>\r
  * \r
  * @author Niels Erik\r
@@ -52,6 +52,7 @@ public class Pazpar2Commands implements Serializable {
   }\r
   \r
   /**\r
+   * init command - referenced from UI as <code>pzreq.init</code>\r
    * \r
    * @return init command from current state\r
    */\r
@@ -60,6 +61,7 @@ public class Pazpar2Commands implements Serializable {
   }\r
     \r
   /** \r
+   * ping command - referenced from UI as <code>pzreq.ping</code>\r
    * \r
    * @return ping command from current state \r
    */\r
@@ -68,6 +70,7 @@ public class Pazpar2Commands implements Serializable {
   }\r
   \r
   /**\r
+   * settings command - referenced from UI as <code>pzreq.settings</code>\r
    * \r
    * @return settings command from current state\r
    */\r