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 ae43c07cd86475de3202ccd12b973dd8f2792b60 Author: juanpablo <[email protected]> AuthorDate: Thu Feb 20 17:58:24 2020 +0100 class javadocs --- jspwiki-main/src/main/java/org/apache/wiki/WikiEngine.java | 11 ++++------- .../src/main/java/org/apache/wiki/api/core/Engine.java | 10 ++++++++++ 2 files changed, 14 insertions(+), 7 deletions(-) diff --git a/jspwiki-main/src/main/java/org/apache/wiki/WikiEngine.java b/jspwiki-main/src/main/java/org/apache/wiki/WikiEngine.java index 1afc4b1..8b4aca4 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/WikiEngine.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/WikiEngine.java @@ -80,17 +80,14 @@ import java.util.concurrent.ConcurrentHashMap; /** - * Provides Wiki services to the JSP page. + * Main implementation for {@link Engine}. * * <P> - * This is the main interface through which everything should go. - * - * <P> - * Using this class: Always get yourself an instance from JSP page by using the WikiEngine.getInstance() method. Never create a new - * WikiEngine() from scratch, unless you're writing tests. + * Using this class: Always get yourself an instance from JSP page by using the {@code WikiEngine.getInstance(..)} method. Never create + * a new WikiEngine() from scratch, unless you're writing tests. * * <p> - * There's basically only a single WikiEngine for each web application, and you should always get it using the WikiEngine.getInstance() method. + * {@inheritDoc} */ public class WikiEngine implements Engine { diff --git a/jspwiki-main/src/main/java/org/apache/wiki/api/core/Engine.java b/jspwiki-main/src/main/java/org/apache/wiki/api/core/Engine.java index bab095c..d51cb0d 100644 --- a/jspwiki-main/src/main/java/org/apache/wiki/api/core/Engine.java +++ b/jspwiki-main/src/main/java/org/apache/wiki/api/core/Engine.java @@ -37,6 +37,16 @@ import java.util.Date; import java.util.Properties; +/** + * Provides Wiki services to the JSP page. + * + * <P> + * This is the main interface through which everything should go. + * + * <p> + * There's basically only a single Engine for each web application, and you should always get it using the {@code WikiEngine.getInstance(..)} + * method. + */ public interface Engine { /** The default inlining pattern. Currently "*.png" */
