From 39c08545e54fee0dd075cae856ce5b9d9dee6ed9 Mon Sep 17 00:00:00 2001
From: Nelson Tavares de Sousa <ntd@informatik.uni-kiel.de>
Date: Tue, 16 Dec 2014 15:46:45 +0100
Subject: [PATCH] added javadoc for the important packages

---
 src/main/java/teetime/framework/package-info.java        | 4 ++++
 src/main/java/teetime/framework/pipe/package-info.java   | 4 ++++
 src/main/java/teetime/framework/signal/package-info.java | 4 ++++
 src/main/java/teetime/stage/package-info.java            | 4 ++++
 src/main/java/teetime/util/package-info.java             | 4 ++++
 5 files changed, 20 insertions(+)
 create mode 100644 src/main/java/teetime/framework/package-info.java
 create mode 100644 src/main/java/teetime/framework/pipe/package-info.java
 create mode 100644 src/main/java/teetime/framework/signal/package-info.java
 create mode 100644 src/main/java/teetime/stage/package-info.java
 create mode 100644 src/main/java/teetime/util/package-info.java

diff --git a/src/main/java/teetime/framework/package-info.java b/src/main/java/teetime/framework/package-info.java
new file mode 100644
index 00000000..c53e8f60
--- /dev/null
+++ b/src/main/java/teetime/framework/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Contains the implementation of the TeeTime framework.
+ */
+package teetime.framework;
\ No newline at end of file
diff --git a/src/main/java/teetime/framework/pipe/package-info.java b/src/main/java/teetime/framework/pipe/package-info.java
new file mode 100644
index 00000000..00bd2bc3
--- /dev/null
+++ b/src/main/java/teetime/framework/pipe/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Contains all pipes related classes, such as factories and pre-defined pipes.
+ */
+package teetime.framework.pipe;
\ No newline at end of file
diff --git a/src/main/java/teetime/framework/signal/package-info.java b/src/main/java/teetime/framework/signal/package-info.java
new file mode 100644
index 00000000..d5e1fc50
--- /dev/null
+++ b/src/main/java/teetime/framework/signal/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Contains the signals that are used within the framework.
+ */
+package teetime.framework.signal;
\ No newline at end of file
diff --git a/src/main/java/teetime/stage/package-info.java b/src/main/java/teetime/stage/package-info.java
new file mode 100644
index 00000000..776c708b
--- /dev/null
+++ b/src/main/java/teetime/stage/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Contains a set of pre-defined stages, which are ready-to-go and can be used for analysis configuration.
+ */
+package teetime.stage;
\ No newline at end of file
diff --git a/src/main/java/teetime/util/package-info.java b/src/main/java/teetime/util/package-info.java
new file mode 100644
index 00000000..b4d79541
--- /dev/null
+++ b/src/main/java/teetime/util/package-info.java
@@ -0,0 +1,4 @@
+/**
+ * Contains a set of utility classes, which are used by the TeeTime framework.
+ */
+package teetime.util;
\ No newline at end of file
-- 
GitLab