[sling-org-apache-sling-scripting-freemarker] 06/21: [checkstyle] (javadoc) MissingJavadocType

[ol...@apache.org]

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

olli pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-scripting-freemarker.git

commit 1108c527a568bd29aa8ea7aa4690df7d5f540091
Author: Oliver Lietz <ol...@apache.org>
AuthorDate: Sat Oct 29 11:40:14 2022 +0200

    [checkstyle] (javadoc) MissingJavadocType
---
 .../org/apache/sling/scripting/freemarker/internal/AdaptToMethod.java  | 3 +++
 .../freemarker/internal/FreemarkerBindingsValuesProvider.java          | 3 +++
 .../sling/scripting/freemarker/internal/FreemarkerScriptEngine.java    | 3 +++
 .../scripting/freemarker/internal/FreemarkerScriptEngineFactory.java   | 3 +++
 .../apache/sling/scripting/freemarker/internal/IncludeDirective.java   | 3 +++
 5 files changed, 15 insertions(+)

diff --git a/src/main/java/org/apache/sling/scripting/freemarker/internal/AdaptToMethod.java b/src/main/java/org/apache/sling/scripting/freemarker/internal/AdaptToMethod.java
index 8441cbf..421511a 100644
--- a/src/main/java/org/apache/sling/scripting/freemarker/internal/AdaptToMethod.java
+++ b/src/main/java/org/apache/sling/scripting/freemarker/internal/AdaptToMethod.java
@@ -27,6 +27,9 @@ import org.apache.sling.commons.classloader.DynamicClassLoaderManager;
 import org.osgi.service.component.annotations.Component;
 import org.osgi.service.component.annotations.Reference;
 
+/**
+ * Support for Sling's adaptTo() in FreeMarker templates.
+ */
 @Component(
     service = {
         TemplateModel.class
diff --git a/src/main/java/org/apache/sling/scripting/freemarker/internal/FreemarkerBindingsValuesProvider.java b/src/main/java/org/apache/sling/scripting/freemarker/internal/FreemarkerBindingsValuesProvider.java
index eb9da8e..950c97d 100644
--- a/src/main/java/org/apache/sling/scripting/freemarker/internal/FreemarkerBindingsValuesProvider.java
+++ b/src/main/java/org/apache/sling/scripting/freemarker/internal/FreemarkerBindingsValuesProvider.java
@@ -23,6 +23,9 @@ import org.apache.sling.api.scripting.SlingBindings;
 import org.apache.sling.scripting.api.BindingsValuesProvider;
 import org.osgi.service.component.annotations.Component;
 
+/**
+ * Bindings provider for Resource properties.
+ */
 @Component(
     property = {
         "javax.script.name=freemarker"
diff --git a/src/main/java/org/apache/sling/scripting/freemarker/internal/FreemarkerScriptEngine.java b/src/main/java/org/apache/sling/scripting/freemarker/internal/FreemarkerScriptEngine.java
index 8d2bbe7..9c92a96 100644
--- a/src/main/java/org/apache/sling/scripting/freemarker/internal/FreemarkerScriptEngine.java
+++ b/src/main/java/org/apache/sling/scripting/freemarker/internal/FreemarkerScriptEngine.java
@@ -29,6 +29,9 @@ import org.apache.sling.api.scripting.SlingBindings;
 import org.apache.sling.api.scripting.SlingScriptHelper;
 import org.apache.sling.scripting.api.AbstractSlingScriptEngine;
 
+/**
+ * Script Engine using FreeMarker's templates.
+ */
 public final class FreemarkerScriptEngine extends AbstractSlingScriptEngine {
 
     private final FreemarkerScriptEngineFactory freemarkerScriptEngineFactory;
diff --git a/src/main/java/org/apache/sling/scripting/freemarker/internal/FreemarkerScriptEngineFactory.java b/src/main/java/org/apache/sling/scripting/freemarker/internal/FreemarkerScriptEngineFactory.java
index 22ed9fb..de4cc42 100644
--- a/src/main/java/org/apache/sling/scripting/freemarker/internal/FreemarkerScriptEngineFactory.java
+++ b/src/main/java/org/apache/sling/scripting/freemarker/internal/FreemarkerScriptEngineFactory.java
@@ -46,6 +46,9 @@ import org.osgi.service.metatype.annotations.Designate;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * Factory for {@link FreemarkerScriptEngine}s.
+ */
 @Component(
     service = ScriptEngineFactory.class,
     immediate = true,
diff --git a/src/main/java/org/apache/sling/scripting/freemarker/internal/IncludeDirective.java b/src/main/java/org/apache/sling/scripting/freemarker/internal/IncludeDirective.java
index 5b59dd1..1b0730f 100644
--- a/src/main/java/org/apache/sling/scripting/freemarker/internal/IncludeDirective.java
+++ b/src/main/java/org/apache/sling/scripting/freemarker/internal/IncludeDirective.java
@@ -43,6 +43,9 @@ import org.osgi.service.component.annotations.Component;
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
+/**
+ * Support for Sling Include in FreeMarker templates.<br>Includes a Resource rendering into the current template.
+ */
 @Component(
     service = {
         TemplateModel.class