From d12c58508339cf04b6a10e56d96afe2c65f2d5ca Mon Sep 17 00:00:00 2001
From: Stefan Kalscheuer <stefan@stklcode.de>
Date: Sun, 25 Mar 2018 14:37:57 +0200
Subject: [PATCH] Add package-info and overview.html for enhanced Javadoc
 output

---
 pom.xml                                       |  3 +++
 .../de/stklcode/pubtrans/ura/UraClient.java   |  2 ++
 .../de/stklcode/pubtrans/ura/model/Model.java |  2 ++
 .../pubtrans/ura/model/package-info.java      | 20 +++++++++++++++++++
 .../stklcode/pubtrans/ura/package-info.java   | 20 +++++++++++++++++++
 src/main/javadoc/overview.html                | 14 +++++++++++++
 6 files changed, 61 insertions(+)
 create mode 100644 src/main/java/de/stklcode/pubtrans/ura/model/package-info.java
 create mode 100644 src/main/java/de/stklcode/pubtrans/ura/package-info.java
 create mode 100644 src/main/javadoc/overview.html

diff --git a/pom.xml b/pom.xml
index b613c51..682eedd 100644
--- a/pom.xml
+++ b/pom.xml
@@ -199,6 +199,9 @@
                         <groupId>org.apache.maven.plugins</groupId>
                         <artifactId>maven-javadoc-plugin</artifactId>
                         <version>3.0.0</version>
+                        <configuration>
+                            <overview>${basedir}/src/main/javadoc/overview.html</overview>
+                        </configuration>
                         <executions>
                             <execution>
                                 <id>attach-javadocs</id>
diff --git a/src/main/java/de/stklcode/pubtrans/ura/UraClient.java b/src/main/java/de/stklcode/pubtrans/ura/UraClient.java
index a76a551..c2cf927 100644
--- a/src/main/java/de/stklcode/pubtrans/ura/UraClient.java
+++ b/src/main/java/de/stklcode/pubtrans/ura/UraClient.java
@@ -30,6 +30,8 @@ import java.util.List;
 
 /**
  * Client for URA based public transport API.
+ * <p>
+ * This client features builder pattern style query functionality to obtain {@link Trip} and {@link Stop} information.
  *
  * @author Stefan Kalscheuer
  */
diff --git a/src/main/java/de/stklcode/pubtrans/ura/model/Model.java b/src/main/java/de/stklcode/pubtrans/ura/model/Model.java
index bf5521e..58f5e7a 100644
--- a/src/main/java/de/stklcode/pubtrans/ura/model/Model.java
+++ b/src/main/java/de/stklcode/pubtrans/ura/model/Model.java
@@ -19,6 +19,8 @@ package de.stklcode.pubtrans.ura.model;
 import java.io.IOException;
 
 /**
+ * Interface for model classes to bundle common methods.
+ *
  * @author Stefan Kalscheuer
  * @since 1.1.1
  */
diff --git a/src/main/java/de/stklcode/pubtrans/ura/model/package-info.java b/src/main/java/de/stklcode/pubtrans/ura/model/package-info.java
new file mode 100644
index 0000000..7c2cc2c
--- /dev/null
+++ b/src/main/java/de/stklcode/pubtrans/ura/model/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2016-2018 Stefan Kalscheuer
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * jURAclient model classes that represent responses returned by the URA interface.
+ */
+package de.stklcode.pubtrans.ura.model;
diff --git a/src/main/java/de/stklcode/pubtrans/ura/package-info.java b/src/main/java/de/stklcode/pubtrans/ura/package-info.java
new file mode 100644
index 0000000..b4a02e4
--- /dev/null
+++ b/src/main/java/de/stklcode/pubtrans/ura/package-info.java
@@ -0,0 +1,20 @@
+/*
+ * Copyright 2016-2018 Stefan Kalscheuer
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+/**
+ * jURAclient base package - see {@link de.stklcode.pubtrans.ura.UraClient} for usage.
+ */
+package de.stklcode.pubtrans.ura;
diff --git a/src/main/javadoc/overview.html b/src/main/javadoc/overview.html
new file mode 100644
index 0000000..a42c4eb
--- /dev/null
+++ b/src/main/javadoc/overview.html
@@ -0,0 +1,14 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+    <meta charset="UTF-8">
+    <title>API Overview</title>
+</head>
+<body>
+<p>Java client for URA based public transport APIs.</p>
+<p>
+    This client allows to simply connect any Java application to the public transport API to implement a monitor for the
+    local bus station or any other custom queries. API versions 1.x and 2.x are supported.
+</p>
+</body>
+</html>