Fix javadoc errors and add javadoc to Travis

Partial resolution of: https://jira.duraspace.org/browse/FCREPO-1556
fcrepo-exts · Jun 2, 2015 · 6259adc · 6259adc
1 parent c6bdda7
commit 6259adc
Show file tree

Hide file tree

Showing 3 changed files with 21 additions and 1 deletion.
diff --git a/.travis.yml b/.travis.yml
@@ -4,6 +4,12 @@ jdk:
 before_install:  
  - "echo $JAVA_OPTS"
  - "export JAVA_OPTS=-Xmx512m"
+
+script:
+ - mvn install -B -V
+ - mvn javadoc:jar
+ - mvn javadoc:test-aggregate
+
 notifications:
   irc: "irc.freenode.org#fcrepo"
   email:

diff --git a/pom.xml b/pom.xml
@@ -77,7 +77,7 @@
     <gpg.plugin.version>1.6</gpg.plugin.version>
     <graph.plugin.version>1.35</graph.plugin.version>
     <jacoco.plugin.version>0.7.2.201409121644</jacoco.plugin.version>
-    <javadoc.plugin.version>2.10.1</javadoc.plugin.version>
+    <javadoc.plugin.version>2.10.3</javadoc.plugin.version>
     <jetty.plugin.version>9.2.6.v20141205</jetty.plugin.version>
     <license.plugin.version>2.9</license.plugin.version>
     <maven.site.plugin.version>3.4</maven.site.plugin.version>

diff --git a/src/test/java/org/fcrepo/camel/integration/FcrepoTestUtils.java b/src/test/java/org/fcrepo/camel/integration/FcrepoTestUtils.java
@@ -36,6 +36,8 @@ private FcrepoTestUtils() {
 
     /**
      * Retrieve the baseUrl for the fcrepo instance
+     *
+     * @return string containing base url
      */
     public static String getFcrepoBaseUrl() {
         if (FCREPO_PORT == 80) {
@@ -46,6 +48,8 @@ public static String getFcrepoBaseUrl() {
 
     /**
      * Retrieve the endpoint uri for fcrepo
+     *
+     * @return string containing endpoint uri
      */
     public static String getFcrepoEndpointUri() {
         if (FCREPO_PORT == 80) {
@@ -56,6 +60,8 @@ public static String getFcrepoEndpointUri() {
 
     /**
      * Retrieve the endpoint uri with an explicit scheme
+     *
+     * @return string containing endpoint uri
      */
     public static String getFcrepoEndpointUriWithScheme() {
         if (FCREPO_PORT == 80) {
@@ -66,6 +72,8 @@ public static String getFcrepoEndpointUriWithScheme() {
 
     /**
      * Retrieve an RDF document serialized in TTL
+     *
+     * @return string containing RDF doc in TTL
      */
     public static String getTurtleDocument() {
         return "PREFIX dc: <http://purl.org/dc/elements/1.1/>\n\n" +
@@ -74,6 +82,8 @@ public static String getTurtleDocument() {
 
     /**
      * Retrieve an N3 document
+     *
+     * @return string containing NS document
      */
     public static String getN3Document() {
         return "<http://localhost/rest/path/a/b/c> <http://purl.org/dc/elements/1.1/author> \"Author\" .\n" +
@@ -82,13 +92,17 @@ public static String getN3Document() {
 
     /**
      * Retrieve a simple text document
+     *
+     * @return string containing text document
      */
     public static String getTextDocument() {
         return "Simple plain text document";
     }
 
     /**
      * Retrieve a sparql-update document
+     *
+     * @return string containing sparql document
      */
     public static String getPatchDocument() {
         return "PREFIX dc: <http://purl.org/dc/elements/1.1/> \n\n" +