From 1f9012dea47182eb52eac34e2cf91cbfa66cdbc1 Mon Sep 17 00:00:00 2001
From: bobcat_zed <bobcat_zed@201c9376-5148-0410-b534-98494c770f31>
Date: Mon, 17 Mar 2008 10:39:33 +0000
Subject: [PATCH] Changed pom.xml to build better Javadoc. Also improved the
 existing Javadocs on some classes in minor ways.

git-svn-id: https://oai4j-client.svn.sourceforge.net/svnroot/oai4j-client/trunk@9 201c9376-5148-0410-b534-98494c770f31
---
 pom.xml                                           | 15 +++++++++++++++
 .../se/kb/oai/pmh/ErrorResponseException.java     |  2 +-
 src/main/java/se/kb/oai/pmh/IdentifiersList.java  |  3 ++-
 src/main/java/se/kb/oai/pmh/ListBase.java         |  2 +-
 .../java/se/kb/oai/pmh/MetadataFormatsList.java   |  8 +++++---
 src/main/java/se/kb/oai/pmh/RecordsList.java      |  2 +-
 src/main/java/se/kb/oai/pmh/SetsList.java         |  3 ++-
 7 files changed, 27 insertions(+), 8 deletions(-)

diff --git a/pom.xml b/pom.xml
index f3b14fc..5a34169 100644
--- a/pom.xml
+++ b/pom.xml
@@ -40,5 +40,20 @@
       </plugin>
     </plugins>
   </build>
+  
+  <reporting>
+    <plugins>
+      <plugin>
+        <groupId>org.apache.maven.plugins</groupId>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <configuration>
+        	<links>
+        		<value>http://java.sun.com/javase/6/docs/api/</value>
+        		<value>http://www.dom4j.org/apidocs/</value>
+        	</links>
+        </configuration>
+      </plugin>
+    </plugins>
+  </reporting>
 
 </project>
diff --git a/src/main/java/se/kb/oai/pmh/ErrorResponseException.java b/src/main/java/se/kb/oai/pmh/ErrorResponseException.java
index 776e188..8445d80 100644
--- a/src/main/java/se/kb/oai/pmh/ErrorResponseException.java
+++ b/src/main/java/se/kb/oai/pmh/ErrorResponseException.java
@@ -24,7 +24,7 @@ import se.kb.oai.OAIException;
  * Exception that is thrown when the response from the OAI-PMH server
  * has <code>&lt;error&gt;</code> elements in it.
  * 
- * There are eight different error codes returned:
+ * There are eight different error codes that can be returned:
  * 
  * <ul>
  * 	<li> badArgument
diff --git a/src/main/java/se/kb/oai/pmh/IdentifiersList.java b/src/main/java/se/kb/oai/pmh/IdentifiersList.java
index f60498a..7d8458c 100644
--- a/src/main/java/se/kb/oai/pmh/IdentifiersList.java
+++ b/src/main/java/se/kb/oai/pmh/IdentifiersList.java
@@ -23,7 +23,8 @@ import org.dom4j.Node;
 
 /**
  * Class that represents the response from a <code>ListIdentifiers</code> request.
- * Can be used to get a list of <code>Headers</code> that holds identifiers.
+ * Can be used to get a list of <code>Headers</code> that holds identifiers, 
+ * i.e. <code>asList()</code> will return a <code>List&lt;Header&gt;</code>.
  *  
  * @author Oskar Grenholm, National Library of Sweden
  */
diff --git a/src/main/java/se/kb/oai/pmh/ListBase.java b/src/main/java/se/kb/oai/pmh/ListBase.java
index 3ad7123..cb586d0 100644
--- a/src/main/java/se/kb/oai/pmh/ListBase.java
+++ b/src/main/java/se/kb/oai/pmh/ListBase.java
@@ -7,7 +7,7 @@ import org.dom4j.Document;
 /**
  * Abstract base class that holds common functionality for the responses that
  * return lists. Can be used to get the size of the list and the actual list
- * of objects. For respones that don't return all of their results in one response,
+ * of objects. For responses that don't return all of their results in one response,
  * the <code>ResumptionToken</code> to get the next set of data can also be 
  * retrieved.
  * 
diff --git a/src/main/java/se/kb/oai/pmh/MetadataFormatsList.java b/src/main/java/se/kb/oai/pmh/MetadataFormatsList.java
index 16693f8..50b6ce6 100644
--- a/src/main/java/se/kb/oai/pmh/MetadataFormatsList.java
+++ b/src/main/java/se/kb/oai/pmh/MetadataFormatsList.java
@@ -23,7 +23,8 @@ import org.dom4j.Node;
 
 /**
  * This class represents the response from a <code>ListMetadataFormats</code> request 
- * to the OAI-PMH server. Can be used to get a list of <code>MetadataFormats</code>.
+ * to the OAI-PMH server. Can be used to get a list of <code>MetadataFormats</code>,
+ * i.e. <code>asList()</code> will return a <code>List&lt;MetadataFormat&gt;</code>.
  * 
  * @author Oskar Grenholm, National Library of Sweden
  */
@@ -47,8 +48,9 @@ public class MetadataFormatsList extends ListBase<MetadataFormat> {
     }
     
     /**
-     * The response from a <code>ListMetadataFormats</code> request will never 
-     * have a resumption token, so this method will throw a <code>NoSuchMethodError</code>
+     * Overrides <code>getResumptionToken</code> in <code>ListBase</code> and because
+     * the response from a <code>ListMetadataFormats</code> request will never 
+     * have a resumption token this method will throw a <code>NoSuchMethodError</code>
      * to prevent it from being used in that way.
      */
     @Override
diff --git a/src/main/java/se/kb/oai/pmh/RecordsList.java b/src/main/java/se/kb/oai/pmh/RecordsList.java
index ad4f7cb..d8437d0 100644
--- a/src/main/java/se/kb/oai/pmh/RecordsList.java
+++ b/src/main/java/se/kb/oai/pmh/RecordsList.java
@@ -24,7 +24,7 @@ import org.dom4j.Node;
 /**
  * Class that represents the response from a <code>ListRecords</code> request.
  * Can be used to get the list of <code>Records</code> that made up the
- * response.
+ * response, i.e. <code>asList()</code> will return a <code>List&lt;Record&gt;</code>.
  * 
  * @author Oskar Grenholm, National Library of Sweden
  */
diff --git a/src/main/java/se/kb/oai/pmh/SetsList.java b/src/main/java/se/kb/oai/pmh/SetsList.java
index 824bdcd..e7ab1a2 100644
--- a/src/main/java/se/kb/oai/pmh/SetsList.java
+++ b/src/main/java/se/kb/oai/pmh/SetsList.java
@@ -23,7 +23,8 @@ import org.dom4j.Node;
 
 /**
  * Class that represents the response from a <code>ListSets</code> request.
- * Can be used to get a list of <code>Sets</code>.
+ * Can be used to get a list of <code>Sets</code>, i.e. <code>asList()</code> 
+ * will return a <code>List&lt;Set&gt;</code>.
  * 
  * @author Oskar Grenholm, National Library of Sweden
  */