Javadoc
[mkjsf-moved-to-github.git] / src / main / java / com / indexdata / mkjsf / pazpar2 / commands / sp / CategoriesCommand.java
index b3794ec..756f85c 100644 (file)
@@ -7,12 +7,13 @@ import com.indexdata.mkjsf.pazpar2.commands.Pazpar2Command;
 import com.indexdata.mkjsf.pazpar2.data.sp.CategoriesResponse;\r
 \r
 /**\r
- * Retrieves target categories available to the current Service Proxy user.\r
+ * Represents a Service Proxy <code>categories</code> command.\r
+ * \r
+ * <p>Retrieves target categories available to the current Service Proxy user.</p> \r
+ * <p>Target categories can be used to limit a search to resources tagged with the given \r
+ * category. The following request in a Faces page would obtain categories for display in, say, a select list:\r
  * <p>\r
- * Target categories can be used to limit a search to resources tagged with the given \r
- * category. The following request in a Faces page would obtain categories for displaying, say, a select list:\r
- * <p>\r
- *  pzreq.sp.categories.run().targetCategories   \r
+ *  <code>pzreq.sp.categories.run().targetCategories</code>   \r
  * <p>\r
  * This would get the Service Proxy extension commands, pick the categories command, execute it, and retrieve\r
  *  a list of TargetCategory objects from the returned response data object.  \r