[jspwiki] 13/36: complete javadocs

[ju...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

juanpablo pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/jspwiki.git

commit 1f95c378a28498e2e1e713ebde76ff994d2a100a
Author: juanpablo <ju...@apache.org>
AuthorDate: Fri Mar 20 19:55:16 2020 +0100

    complete javadocs
---
 .../src/main/java/org/apache/wiki/WikiProvider.java        | 14 ++++++++++++--
 .../main/java/org/apache/wiki/api/plugin/WikiPlugin.java   |  3 ++-
 2 files changed, 14 insertions(+), 3 deletions(-)

diff --git a/jspwiki-210-adapters/src/main/java/org/apache/wiki/WikiProvider.java b/jspwiki-210-adapters/src/main/java/org/apache/wiki/WikiProvider.java
index 355b7d3..63b5876 100644
--- a/jspwiki-210-adapters/src/main/java/org/apache/wiki/WikiProvider.java
+++ b/jspwiki-210-adapters/src/main/java/org/apache/wiki/WikiProvider.java
@@ -26,10 +26,12 @@ import java.util.Properties;
 
 
 /**
- *  A generic Wiki provider for all sorts of things that the Wiki can store.
+ * Hooks all WikiProviders not using the public API into it.
  *
- *  @since 2.0
+ * @deprecated - implement directly {@link org.apache.wiki.api.providers.WikiProvider}.
+ * @see org.apache.wiki.api.providers.WikiProvider
  */
+@Deprecated
 public interface WikiProvider extends org.apache.wiki.api.providers.WikiProvider {
 
     /**
@@ -45,6 +47,14 @@ public interface WikiProvider extends org.apache.wiki.api.providers.WikiProvider
         initialize( engine.adapt( WikiEngine.class ), properties );
     }
 
+    /**
+     *  Initializes the page provider.
+     *
+     *  @param engine Engine to own this provider
+     *  @param properties A set of properties used to initialize this provider
+     *  @throws NoRequiredPropertyException If the provider needs a property which is not found in the property set
+     *  @throws IOException If there is an IO problem
+     */
     default void initialize( final WikiEngine engine, final Properties properties ) throws NoRequiredPropertyException, IOException {}
 
 }
diff --git a/jspwiki-210-adapters/src/main/java/org/apache/wiki/api/plugin/WikiPlugin.java b/jspwiki-210-adapters/src/main/java/org/apache/wiki/api/plugin/WikiPlugin.java
index 14a7b53..453a8ca 100644
--- a/jspwiki-210-adapters/src/main/java/org/apache/wiki/api/plugin/WikiPlugin.java
+++ b/jspwiki-210-adapters/src/main/java/org/apache/wiki/api/plugin/WikiPlugin.java
@@ -27,7 +27,8 @@ import java.util.Map;
 
 
 /**
- *  Defines an interface for plugins.  Any instance of a wiki plugin should implement this interface.
+ * Defines an interface for plugins.  Any instance of a wiki plugin should implement this interface.
+ *
  * @deprecated use {@link Plugin} instead
  * @see Plugin
  */