Fixes javadoc typos
[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / mkjsf / config / package-info.java
index a131afc..aec5200 100644 (file)
  * </pre>\r
  * \r
  * <p>For the web.xml configuration scheme (choosing WebXmlConfigReader in beans.xml)\r
- * to pre-define the URL of the Pazpar2 to use, the configuration could be:</p>\r
+ * to pre-define the URL of the Pazpar2 to use and choose Pazpar2 as the selected\r
+ * service type, the configuration could be:</p>\r
  * \r
  * <pre>\r
  *  &lt;context-param&gt;\r
  *   &lt;param-name&gt;PAZPAR2_URL&lt;/param-name&gt;\r
  *   &lt;param-value&gt;http://localhost:8004/&lt;/param-value&gt;\r
  *  &lt;/context-param&gt;\r
+ *  &lt;context-param&gt;\r
+ *   &lt;description&gt;Service type. Possible values: SP, PZ2, TBD&lt;/description&gt;\r
+ *   &lt;param-name&gt;TYPE&lt;/param-name&gt;\r
+ *   &lt;param-value&gt;PZ2&lt;/param-value&gt;  \r
+ *  &lt;/context-param&gt;\r
  * </pre>\r
  * \r
  * <p>For the Mk2ConfigReader scheme to work, the web.xml must then contain pointers to the configuration directory \r
- * and properties file. \r
+ * and properties file. The specific configuration itself would be in those files then.\r
  * In this example the configuration directory is in the web application itself (war://testconfig). A more regular \r
  * example would put it in a separate directory to not have it overwritten by each deployment of the war.</p> \r
  * <pre>\r
@@ -77,7 +83,7 @@
  * \r
  * <code>pz2client.PAZPAR2_URL = http://localhost:8004/</code>\r
  * \r
- * <p>Some of the other know parameters in this format could be:</p>\r
+ * <p>Some of the other known parameters in this format could be:</p>\r
  * \r
  * <pre>\r
  * service.TYPE = SP              \r
@@ -89,7 +95,7 @@
  * and inject that class in beans.xml instead of any of the two predefined options. The extended\r
  * class must construct a Configuration object -- which is basically a set of key-value pairs -- \r
  * and then set the desired values and hand it off to the Configurable (currently Pz2Service, Pz2Client, \r
- * ServiceProxyClient</p> \r
+ * and ServiceProxyClient)</p> \r
  * \r
  * <p>Finally it's possible to set the URL runtime even from the UI pages.</p> \r
  * \r