Fix javadoc errors and add javadoc to Travis

Partial resolution of: https://jira.duraspace.org/browse/FCREPO-1556
fcrepo4-archive · Jun 1, 2015 · 98b6953 · 98b6953
1 parent 05ba120
commit 98b6953
Show file tree

Hide file tree

Showing 5 changed files with 29 additions and 3 deletions.
diff --git a/.travis.yml b/.travis.yml
@@ -5,9 +5,16 @@ before_script:
  - "echo $JAVA_OPTS"
  - "export JAVA_OPTS=-Xmx512m"
 install: JAVA_OPTS=-Xmx512m mvn install -DskipTests=true
+
 branches:
-    only:
-        - master
+  only:
+    - master
+    - /^fcrepo-*/
+
+script:
+ - mvn javadoc:jar
+ - mvn javadoc:test-aggregate
+
 notifications:
   irc: "irc.freenode.org#fcrepo"
   email:

diff --git a/README.md b/README.md
@@ -1,3 +1,9 @@
+fcrepo-message-consumer
+=======================
+
+[![Build Status](https://travis-ci.org/fcrepo4/fcrepo-message-consumer.png?branch=master)](https://travis-ci.org/fcrepo4/fcrepo-message-consumer)
+
+
 This is a fcrepo 4.x indexer that listens to the Fedora JMS topic, retrieves a message including pid and eventType, looks up object properties, gets and passes the transformed or untransformed properties on to any number of registered handlers.  It is built relying heavily on Spring machinery, including:
 
 * spring-lang

diff --git a/fcrepo-message-consumer-core/src/test/java/org/fcrepo/indexer/TestIndexer.java b/fcrepo-message-consumer-core/src/test/java/org/fcrepo/indexer/TestIndexer.java
@@ -80,6 +80,9 @@ public Boolean call() throws Exception {
 
     /**
      * Test whether an update message has been received for a PID.
+     *
+     * @param id Pid to check for updates
+     * @return true if one or more messasges were received for this Pid
     **/
     public boolean receivedUpdate(final URI id) {
         LOGGER.debug("Checked whether we received an update for: {}, {}", id,
@@ -89,6 +92,9 @@ public boolean receivedUpdate(final URI id) {
 
     /**
      * Test whether a remove message has been received for a PID.
+     *
+     * @param id Pid to check if a remove message has been received
+     * @return true if one or more remove messages have been received
     **/
     public boolean receivedRemove(final URI id) {
         LOGGER.debug("Checked whether we received a remove for: {}, {}", id,

diff --git a/...sumer-core/src/test/java/org/fcrepo/indexer/integration/sparql/SparqlIndexerITHelper.java b/...sumer-core/src/test/java/org/fcrepo/indexer/integration/sparql/SparqlIndexerITHelper.java
@@ -41,7 +41,7 @@ private SparqlIndexerITHelper() {
     /**
      * Count the number of triples in the triplestore for a Fedora object.
      *
-     * @param uri
+     * @param uri URI to object to perform this action on
      * @return the number of triples
      */
     public static int countDescribeTriples(final String uri) {
@@ -58,6 +58,9 @@ public static int countDescribeTriples(final String uri) {
 
     /**
      * Perform a SPARQL search and return the number of triples returned.
+     *
+     * @param searchQuery The SPARQL query to perform
+     * @return the number of triples found by the query
      */
     public static int countQueryTriples(final String searchQuery) {
         // perform query

diff --git a/pom.xml b/pom.xml
@@ -363,6 +363,10 @@
         <groupId>org.apache.maven.plugins</groupId>
         <artifactId>maven-checkstyle-plugin</artifactId>
       </plugin>
+      <plugin>
+        <artifactId>maven-javadoc-plugin</artifactId>
+        <version>2.10.3</version>
+      </plugin>
     </plugins>
   </build>