stklcode/juraclient
0
0
Fork 0
Code Issues Actions Releases 21 Activity

Add package-info and overview.html for enhanced Javadoc output

Browse Source
This commit is contained in:
Stefan Kalscheuer 2018-03-25 14:37:57 +02:00
parent ffa8af2d5d
commit d12c585083
6 changed files with 61 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
pom.xml
View File

@ -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>

2
src/main/java/de/stklcode/pubtrans/ura/UraClient.java
View File

@ -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
*/

2
src/main/java/de/stklcode/pubtrans/ura/model/Model.java
View File

@ -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
*/

20
src/main/java/de/stklcode/pubtrans/ura/model/package-info.java Normal file
View File

@ -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;

20
src/main/java/de/stklcode/pubtrans/ura/package-info.java Normal file
View File

@ -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;

14
src/main/javadoc/overview.html Normal file
View File

@ -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>