Merge pull request #116 from ddebrunner/rel04
Javadoc cleanup & change version to 0.4.
diff --git a/.travis.yml b/.travis.yml
index fc95def..e45701c 100644
--- a/.travis.yml
+++ b/.travis.yml
@@ -1,5 +1,8 @@
language: java
+matrix:
+ fast_finish: true
+
before_install:
- wget http://archive.apache.org/dist/ant/binaries/apache-ant-1.9.4-bin.tar.gz
- tar xzf apache-ant-1.9.4-bin.tar.gz
diff --git a/api/graph/src/main/java/quarks/graph/package-info.java b/api/graph/src/main/java/quarks/graph/package-info.java
new file mode 100644
index 0000000..13a2bcc
--- /dev/null
+++ b/api/graph/src/main/java/quarks/graph/package-info.java
@@ -0,0 +1,10 @@
+/*
+# Licensed Materials - Property of IBM
+# Copyright IBM Corp. 2016
+*/
+
+/**
+ * Low-level graph building API.
+ */
+package quarks.graph;
+
diff --git a/build.xml b/build.xml
index fe29935..55e0037 100644
--- a/build.xml
+++ b/build.xml
@@ -7,6 +7,8 @@
<property name="release.base" location="release-${ant.project.name}"/>
+ <property name="quarks.version" value="0.4.0"/>
+
<property name="report.dir" location="reports"/>
<property name="target.dir" location="target"/>
<property name="javadoc.dir" location="${target.dir}/docs/javadoc"/>
@@ -262,7 +264,7 @@
author="true"
version="true"
use="true"
- windowtitle="Quarks v0.3"
+ windowtitle="Quarks v${quarks.version}"
additionalparam="-Xdoclint:none"
Overview="quarks_overview.html"
failonwarning="true"
@@ -286,7 +288,7 @@
</fileset>
</classpath>
- <doctitle>Quarks v0.3</doctitle>
+ <doctitle>Quarks v${quarks.version}</doctitle>
<footer><![CDATA[<a href="http://quarks-edge.github.io">quarks-edge community @ github.com</a>]]></footer>
<bottom>Copyright IBM 2015,2016 - ${commithash}-${DSTAMP}-${TSTAMP}</bottom>
<group title="Quarks API" packages="quarks.execution,quarks.function,quarks.topology,quarks.topology.*,quarks.execution.*"/>
@@ -308,7 +310,7 @@
<ant dir="platform/android" target="all" useNativeBasedir="true"/>
<mkdir dir="${release.dir}" />
- <property name="releasefilename" value="${release.dir}/quarks-v0.3.0-${DSTAMP}-${TSTAMP}.tgz"/>
+ <property name="releasefilename" value="${release.dir}/quarks-v${quarks.version}-${DSTAMP}-${TSTAMP}.tgz"/>
<tar compression="gzip" longfile="gnu" destfile="${releasefilename}">
<tarfileset dir="${target.dir}" prefix="quarks"
excludes="**/*.sh"/>
diff --git a/connectors/pubsub/src/main/java/quarks/connectors/pubsub/oplets/Publish.java b/connectors/pubsub/src/main/java/quarks/connectors/pubsub/oplets/Publish.java
index c42e398..19273c3 100644
--- a/connectors/pubsub/src/main/java/quarks/connectors/pubsub/oplets/Publish.java
+++ b/connectors/pubsub/src/main/java/quarks/connectors/pubsub/oplets/Publish.java
@@ -13,6 +13,8 @@
* If no such service exists then no tuples are published.
*
* @param <T> Type of the tuples.
+ *
+ * @see quarks.connectors.pubsub.PublishSubscribe#publish(quarks.topology.TStream, String, Class)
*/
public class Publish<T> extends Sink<T> {
diff --git a/connectors/pubsub/src/main/java/quarks/connectors/pubsub/oplets/package-info.java b/connectors/pubsub/src/main/java/quarks/connectors/pubsub/oplets/package-info.java
new file mode 100644
index 0000000..c05f09a
--- /dev/null
+++ b/connectors/pubsub/src/main/java/quarks/connectors/pubsub/oplets/package-info.java
@@ -0,0 +1,10 @@
+/*
+# Licensed Materials - Property of IBM
+# Copyright IBM Corp. 2016
+*/
+
+/**
+ * Oplets supporting publish subscribe service.
+ */
+package quarks.connectors.pubsub.oplets;
+
diff --git a/connectors/pubsub/src/main/java/quarks/connectors/pubsub/package-info.java b/connectors/pubsub/src/main/java/quarks/connectors/pubsub/package-info.java
index c4bd874..5f7b028 100644
--- a/connectors/pubsub/src/main/java/quarks/connectors/pubsub/package-info.java
+++ b/connectors/pubsub/src/main/java/quarks/connectors/pubsub/package-info.java
@@ -4,6 +4,7 @@
*/
/**
+ * Publish subscribe model between jobs.
*/
package quarks.connectors.pubsub;
diff --git a/connectors/pubsub/src/main/java/quarks/connectors/pubsub/service/ProviderPubSub.java b/connectors/pubsub/src/main/java/quarks/connectors/pubsub/service/ProviderPubSub.java
index 754a93e..1a6dd00 100644
--- a/connectors/pubsub/src/main/java/quarks/connectors/pubsub/service/ProviderPubSub.java
+++ b/connectors/pubsub/src/main/java/quarks/connectors/pubsub/service/ProviderPubSub.java
@@ -9,6 +9,10 @@
import quarks.function.Consumer;
+/**
+ * Publish subscribe service allowing exchange of streams between jobs in a provider.
+ *
+ */
public class ProviderPubSub implements PublishSubscribeService {
private final Map<String,TopicHandler<?>> topicHandlers = new HashMap<>();
diff --git a/connectors/pubsub/src/main/java/quarks/connectors/pubsub/service/PublishSubscribeService.java b/connectors/pubsub/src/main/java/quarks/connectors/pubsub/service/PublishSubscribeService.java
index 2cb2f3e..9bd20d1 100644
--- a/connectors/pubsub/src/main/java/quarks/connectors/pubsub/service/PublishSubscribeService.java
+++ b/connectors/pubsub/src/main/java/quarks/connectors/pubsub/service/PublishSubscribeService.java
@@ -7,7 +7,7 @@
import quarks.function.Consumer;
/**
- * Publish subscribe model for streams.
+ * Publish subscribe service.
* <BR>
* Service that allows jobs to subscribe to
* streams published by other jobs.
diff --git a/connectors/pubsub/src/main/java/quarks/connectors/pubsub/service/package-info.java b/connectors/pubsub/src/main/java/quarks/connectors/pubsub/service/package-info.java
new file mode 100644
index 0000000..83e7b04
--- /dev/null
+++ b/connectors/pubsub/src/main/java/quarks/connectors/pubsub/service/package-info.java
@@ -0,0 +1,10 @@
+/*
+# Licensed Materials - Property of IBM
+# Copyright IBM Corp. 2016
+*/
+
+/**
+ * Publish subscribe service.
+ */
+package quarks.connectors.pubsub.service;
+
diff --git a/connectors/serial/src/main/java/quarks/connectors/serial/package-info.java b/connectors/serial/src/main/java/quarks/connectors/serial/package-info.java
new file mode 100644
index 0000000..36720d2
--- /dev/null
+++ b/connectors/serial/src/main/java/quarks/connectors/serial/package-info.java
@@ -0,0 +1,10 @@
+/*
+# Licensed Materials - Property of IBM
+# Copyright IBM Corp. 2016
+*/
+
+/**
+ * Serial port connector API.
+ */
+package quarks.connectors.serial;
+
diff --git a/quarks_overview.html b/quarks_overview.html
index fa530bc..78541fb 100644
--- a/quarks_overview.html
+++ b/quarks_overview.html
@@ -1,7 +1,7 @@
<body>
Quarks provides an programming model and runtime for executing streaming
analytics at the <i>edge</i>
-<H1>Quarks v0.3</H1>
+<H1>Quarks v0.4</H1>
<OL>
<LI><a href="#overview">Overview</A></LI>
<LI><a href="#model">Programming Model</A></LI>
