From 20b97eb241bf0d1d330000d8dfe386c9c508ff95 Mon Sep 17 00:00:00 2001
From: Florian Schmaus <flo@geekplace.eu>
Date: Wed, 21 Feb 2018 10:37:25 +0100
Subject: [PATCH] Add javadoc to Provider

---
 .../org/jivesoftware/smack/provider/Provider.java   | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/smack-core/src/main/java/org/jivesoftware/smack/provider/Provider.java b/smack-core/src/main/java/org/jivesoftware/smack/provider/Provider.java
index 225ff3079..87250c50f 100644
--- a/smack-core/src/main/java/org/jivesoftware/smack/provider/Provider.java
+++ b/smack-core/src/main/java/org/jivesoftware/smack/provider/Provider.java
@@ -1,6 +1,6 @@
 /**
  *
- * Copyright © 2014 Florian Schmaus
+ * Copyright © 2014-2018 Florian Schmaus
  *
  * Licensed under the Apache License, Version 2.0 (the "License");
  * you may not use this file except in compliance with the License.
@@ -22,6 +22,17 @@ import org.jivesoftware.smack.util.ParserUtils;
 
 import org.xmlpull.v1.XmlPullParser;
 
+/**
+ * Smack provider are the parsers used to deserialize raw XMPP into the according Java {@link Element}s.
+ * <p>
+ * At any time when {@link #parse(XmlPullParser, int)} is invoked any type of exception can be thrown. If the parsed
+ * element does not follow the specification, for example by putting a string where only integers are allowed, then a
+ * {@link org.jivesoftware.smack.SmackException} should be thrown.
+ * </p>
+ * 
+ * @author Florian Schmaus
+ * @param <E> the type of the resulting element.
+ */
 public abstract class Provider<E extends Element> {
 
     public final E parse(XmlPullParser parser) throws Exception {