From 8f13a95bb5dc337f882f95b4344877119bd2308f Mon Sep 17 00:00:00 2001
From: Andreas Schildbach <andreas@schildbach.de>
Date: Fri, 4 Jan 2019 13:41:43 +0100
Subject: [PATCH] Class-level JavaDoc for all HCI-based providers.

---
 enabler/src/de/schildbach/pte/AvvAachenProvider.java | 2 ++
 enabler/src/de/schildbach/pte/BvgProvider.java       | 4 +++-
 enabler/src/de/schildbach/pte/CmtaProvider.java      | 2 ++
 enabler/src/de/schildbach/pte/DbProvider.java        | 2 ++
 enabler/src/de/schildbach/pte/DsbProvider.java       | 2 ++
 enabler/src/de/schildbach/pte/InvgProvider.java      | 2 ++
 enabler/src/de/schildbach/pte/LuProvider.java        | 2 ++
 enabler/src/de/schildbach/pte/NasaProvider.java      | 2 ++
 enabler/src/de/schildbach/pte/NvvProvider.java       | 2 ++
 enabler/src/de/schildbach/pte/OebbProvider.java      | 2 ++
 enabler/src/de/schildbach/pte/OoevvProvider.java     | 2 ++
 enabler/src/de/schildbach/pte/SeProvider.java        | 2 ++
 enabler/src/de/schildbach/pte/ShProvider.java        | 4 +++-
 enabler/src/de/schildbach/pte/SncbProvider.java      | 2 ++
 enabler/src/de/schildbach/pte/SvvProvider.java       | 2 ++
 enabler/src/de/schildbach/pte/VaoProvider.java       | 2 ++
 enabler/src/de/schildbach/pte/VbbProvider.java       | 2 ++
 enabler/src/de/schildbach/pte/VbnProvider.java       | 4 +++-
 enabler/src/de/schildbach/pte/VgsProvider.java       | 2 ++
 enabler/src/de/schildbach/pte/VmobilProvider.java    | 2 ++
 enabler/src/de/schildbach/pte/VmtProvider.java       | 4 +++-
 enabler/src/de/schildbach/pte/VorProvider.java       | 2 ++
 enabler/src/de/schildbach/pte/VvtProvider.java       | 2 ++
 enabler/src/de/schildbach/pte/ZvvProvider.java       | 2 ++
 24 files changed, 52 insertions(+), 4 deletions(-)

diff --git a/enabler/src/de/schildbach/pte/AvvAachenProvider.java b/enabler/src/de/schildbach/pte/AvvAachenProvider.java
index 968bb943..e3eedddd 100644
--- a/enabler/src/de/schildbach/pte/AvvAachenProvider.java
+++ b/enabler/src/de/schildbach/pte/AvvAachenProvider.java
@@ -24,6 +24,8 @@ import de.schildbach.pte.dto.Product;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for the Aachener Verkehrsverbund (Aachen, Germany).
+ * 
  * @author Andreas Schildbach
  */
 public class AvvAachenProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/BvgProvider.java b/enabler/src/de/schildbach/pte/BvgProvider.java
index 86b1f4a6..0a9f864d 100644
--- a/enabler/src/de/schildbach/pte/BvgProvider.java
+++ b/enabler/src/de/schildbach/pte/BvgProvider.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2017 the original author or authors.
+ * Copyright the original author or authors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -38,6 +38,8 @@ import de.schildbach.pte.dto.Style.Shape;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for the Berliner Verkehrsbetriebe (Berlin, Germany).
+ * 
  * @author Andreas Schildbach
  */
 public final class BvgProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/CmtaProvider.java b/enabler/src/de/schildbach/pte/CmtaProvider.java
index 53a931c7..1bbe6643 100644
--- a/enabler/src/de/schildbach/pte/CmtaProvider.java
+++ b/enabler/src/de/schildbach/pte/CmtaProvider.java
@@ -22,6 +22,8 @@ import de.schildbach.pte.dto.Product;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for the Capital Metropolitan Transportation Authority (Austin, Texas, US).
+ * 
  * @author Colin Murphy
  */
 public class CmtaProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/DbProvider.java b/enabler/src/de/schildbach/pte/DbProvider.java
index 5570ffe2..cbb2b54e 100644
--- a/enabler/src/de/schildbach/pte/DbProvider.java
+++ b/enabler/src/de/schildbach/pte/DbProvider.java
@@ -28,6 +28,8 @@ import de.schildbach.pte.dto.Product;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for Deutsche Bahn (Germany).
+ * 
  * @author Andreas Schildbach
  */
 public final class DbProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/DsbProvider.java b/enabler/src/de/schildbach/pte/DsbProvider.java
index d6084951..50c9fff6 100644
--- a/enabler/src/de/schildbach/pte/DsbProvider.java
+++ b/enabler/src/de/schildbach/pte/DsbProvider.java
@@ -25,6 +25,8 @@ import de.schildbach.pte.dto.Product;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for Rejseplanen (Denmark).
+ * 
  * @author Andreas Schildbach
  */
 public class DsbProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/InvgProvider.java b/enabler/src/de/schildbach/pte/InvgProvider.java
index b27adc33..06a1967e 100644
--- a/enabler/src/de/schildbach/pte/InvgProvider.java
+++ b/enabler/src/de/schildbach/pte/InvgProvider.java
@@ -29,6 +29,8 @@ import de.schildbach.pte.dto.Style;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for the Ingolstädter Verkehrsgesellschaft (Ingolstadt, Germany).
+ * 
  * @author Andreas Schildbach
  */
 public class InvgProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/LuProvider.java b/enabler/src/de/schildbach/pte/LuProvider.java
index eff28370..f43a48d1 100644
--- a/enabler/src/de/schildbach/pte/LuProvider.java
+++ b/enabler/src/de/schildbach/pte/LuProvider.java
@@ -24,6 +24,8 @@ import de.schildbach.pte.dto.Product;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for Mobilitéitszentral (Luxembourg).
+ * 
  * @author Andreas Schildbach
  */
 public class LuProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/NasaProvider.java b/enabler/src/de/schildbach/pte/NasaProvider.java
index 671d7c0c..da09597c 100644
--- a/enabler/src/de/schildbach/pte/NasaProvider.java
+++ b/enabler/src/de/schildbach/pte/NasaProvider.java
@@ -24,6 +24,8 @@ import de.schildbach.pte.dto.Product;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for the Informationssystem Nahverkehr Sachsen-Anhalt (Saxony-Anhalt, Germany).
+ * 
  * @author Andreas Schildbach
  */
 public class NasaProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/NvvProvider.java b/enabler/src/de/schildbach/pte/NvvProvider.java
index a64107c0..d1743a01 100644
--- a/enabler/src/de/schildbach/pte/NvvProvider.java
+++ b/enabler/src/de/schildbach/pte/NvvProvider.java
@@ -24,6 +24,8 @@ import de.schildbach.pte.dto.Product;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for the Nordhessischer Verkehrsverbund (North Hesse, Germany).
+ * 
  * @author Andreas Schildbach
  */
 public class NvvProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/OebbProvider.java b/enabler/src/de/schildbach/pte/OebbProvider.java
index 5938251c..ba8ebf9b 100644
--- a/enabler/src/de/schildbach/pte/OebbProvider.java
+++ b/enabler/src/de/schildbach/pte/OebbProvider.java
@@ -25,6 +25,8 @@ import de.schildbach.pte.dto.Product;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for the Österreichische Bundesbahnen (Austria).
+ * 
  * @author Andreas Schildbach
  */
 public class OebbProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/OoevvProvider.java b/enabler/src/de/schildbach/pte/OoevvProvider.java
index d85eb174..93f041ca 100644
--- a/enabler/src/de/schildbach/pte/OoevvProvider.java
+++ b/enabler/src/de/schildbach/pte/OoevvProvider.java
@@ -26,6 +26,8 @@ import de.schildbach.pte.dto.Product;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for the Oberösterreichischer Verkehrsverbund (Upper Austria, Austria).
+ * 
  * @author Andreas Schildbach
  */
 public class OoevvProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/SeProvider.java b/enabler/src/de/schildbach/pte/SeProvider.java
index 100d9b79..cca93156 100644
--- a/enabler/src/de/schildbach/pte/SeProvider.java
+++ b/enabler/src/de/schildbach/pte/SeProvider.java
@@ -26,6 +26,8 @@ import de.schildbach.pte.dto.Product;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for Samtrafiken (Sweden).
+ * 
  * @author Andreas Schildbach
  */
 public class SeProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/ShProvider.java b/enabler/src/de/schildbach/pte/ShProvider.java
index f5811d08..df5734bc 100644
--- a/enabler/src/de/schildbach/pte/ShProvider.java
+++ b/enabler/src/de/schildbach/pte/ShProvider.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2015 the original author or authors.
+ * Copyright the original author or authors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -32,6 +32,8 @@ import de.schildbach.pte.dto.Style;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for the Nahverkehrsverbund Schleswig-Holstein (Schleswig-Holstein, Germany).
+ * 
  * @author Andreas Schildbach
  */
 public class ShProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/SncbProvider.java b/enabler/src/de/schildbach/pte/SncbProvider.java
index 8b76e559..777cf08f 100644
--- a/enabler/src/de/schildbach/pte/SncbProvider.java
+++ b/enabler/src/de/schildbach/pte/SncbProvider.java
@@ -25,6 +25,8 @@ import de.schildbach.pte.dto.Product;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for the Nationale Maatschappij der Belgische Spoorwegen (Belgium).
+ * 
  * @author Andreas Schildbach
  */
 public class SncbProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/SvvProvider.java b/enabler/src/de/schildbach/pte/SvvProvider.java
index 2073acae..ed9b7ff1 100644
--- a/enabler/src/de/schildbach/pte/SvvProvider.java
+++ b/enabler/src/de/schildbach/pte/SvvProvider.java
@@ -29,6 +29,8 @@ import de.schildbach.pte.dto.Style;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for the Salzburger Verkehrsverbund (Salzburg, Austria).
+ * 
  * @author Andreas Schildbach
  */
 public class SvvProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/VaoProvider.java b/enabler/src/de/schildbach/pte/VaoProvider.java
index 654c5cba..967da5c3 100644
--- a/enabler/src/de/schildbach/pte/VaoProvider.java
+++ b/enabler/src/de/schildbach/pte/VaoProvider.java
@@ -29,6 +29,8 @@ import de.schildbach.pte.dto.Style;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for the Verkehrsauskunft Österreich (Austria).
+ * 
  * @author Andreas Schildbach
  */
 public class VaoProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/VbbProvider.java b/enabler/src/de/schildbach/pte/VbbProvider.java
index 57b2998a..1635abbe 100644
--- a/enabler/src/de/schildbach/pte/VbbProvider.java
+++ b/enabler/src/de/schildbach/pte/VbbProvider.java
@@ -29,6 +29,8 @@ import de.schildbach.pte.dto.Product;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for the Verkehrsverbund Berlin-Brandenburg (Brandenburg, Germany).
+ * 
  * @author Andreas Schildbach
  */
 public class VbbProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/VbnProvider.java b/enabler/src/de/schildbach/pte/VbnProvider.java
index daf2c988..87fcd1f6 100644
--- a/enabler/src/de/schildbach/pte/VbnProvider.java
+++ b/enabler/src/de/schildbach/pte/VbnProvider.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2010-2015 the original author or authors.
+ * Copyright the original author or authors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -35,6 +35,8 @@ import de.schildbach.pte.dto.Style.Shape;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for the Verkehrsverbund Bremen/Niedersachsen (Lower Saxony, Germany).
+ * 
  * @author Andreas Schildbach
  */
 public class VbnProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/VgsProvider.java b/enabler/src/de/schildbach/pte/VgsProvider.java
index af5114fb..055b8c07 100644
--- a/enabler/src/de/schildbach/pte/VgsProvider.java
+++ b/enabler/src/de/schildbach/pte/VgsProvider.java
@@ -24,6 +24,8 @@ import de.schildbach.pte.dto.Product;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for Saarfahrplan (Saarland, Germany).
+ * 
  * @author Andreas Schildbach
  */
 public class VgsProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/VmobilProvider.java b/enabler/src/de/schildbach/pte/VmobilProvider.java
index d08d0570..4a28285b 100644
--- a/enabler/src/de/schildbach/pte/VmobilProvider.java
+++ b/enabler/src/de/schildbach/pte/VmobilProvider.java
@@ -26,6 +26,8 @@ import de.schildbach.pte.dto.Product;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for the Verkehrsverbund Vorarlberg (Vorarlberg, Austria).
+ * 
  * @author Andreas Schildbach
  */
 public class VmobilProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/VmtProvider.java b/enabler/src/de/schildbach/pte/VmtProvider.java
index 301cfd52..8f417a72 100644
--- a/enabler/src/de/schildbach/pte/VmtProvider.java
+++ b/enabler/src/de/schildbach/pte/VmtProvider.java
@@ -1,5 +1,5 @@
 /*
- * Copyright 2017 the original author or authors.
+ * Copyright the original author or authors.
  *
  * This program is free software: you can redistribute it and/or modify
  * it under the terms of the GNU General Public License as published by
@@ -24,6 +24,8 @@ import de.schildbach.pte.dto.Product;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for the Verkehrsverbund Mittelthüringen (Thuringia, Germany).
+ * 
  * @author Andreas Schildbach
  */
 public class VmtProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/VorProvider.java b/enabler/src/de/schildbach/pte/VorProvider.java
index ac5af4dc..54fef0ca 100644
--- a/enabler/src/de/schildbach/pte/VorProvider.java
+++ b/enabler/src/de/schildbach/pte/VorProvider.java
@@ -29,6 +29,8 @@ import de.schildbach.pte.dto.Style;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for the Verkehrsverbund Ost-Region (Lower Austria and Burgenland, Austria).
+ * 
  * @author Andreas Schildbach
  */
 public class VorProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/VvtProvider.java b/enabler/src/de/schildbach/pte/VvtProvider.java
index 2da77cf0..9aa5d307 100644
--- a/enabler/src/de/schildbach/pte/VvtProvider.java
+++ b/enabler/src/de/schildbach/pte/VvtProvider.java
@@ -26,6 +26,8 @@ import de.schildbach.pte.dto.Product;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for the Verkehrsverbund Tirol (Tyrol, Austria).
+ * 
  * @author Andreas Schildbach
  */
 public class VvtProvider extends AbstractHafasClientInterfaceProvider {
diff --git a/enabler/src/de/schildbach/pte/ZvvProvider.java b/enabler/src/de/schildbach/pte/ZvvProvider.java
index 059e5f7e..51ad9b4e 100644
--- a/enabler/src/de/schildbach/pte/ZvvProvider.java
+++ b/enabler/src/de/schildbach/pte/ZvvProvider.java
@@ -29,6 +29,8 @@ import de.schildbach.pte.dto.Style.Shape;
 import okhttp3.HttpUrl;
 
 /**
+ * Provider implementation for the Zürcher Verkehrsverbund (Zurich, Switzerland).
+ * 
  * @author Andreas Schildbach
  */
 public class ZvvProvider extends AbstractHafasClientInterfaceProvider {