You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@sling.apache.org by ra...@apache.org on 2015/07/14 14:32:42 UTC
svn commit: r1690914 - in /sling/trunk/bundles/scripting/sightly/engine: ./
src/main/java/org/apache/sling/scripting/sightly/
src/main/java/org/apache/sling/scripting/sightly/impl/compiled/
src/main/java/org/apache/sling/scripting/sightly/impl/compiler...
Author: radu
Date: Tue Jul 14 12:32:41 2015
New Revision: 1690914
URL: http://svn.apache.org/r1690914
Log:
trivial: corrected JavaDoc to comply with Java 1.8
Modified:
sling/trunk/bundles/scripting/sightly/engine/pom.xml
sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/ResourceResolution.java
sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/compiled/VariableAnalyzer.java
sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/SightlyCompilerService.java
sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/expression/ExpressionNode.java
sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/frontend/ElementContext.java
sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/engine/UnitLoader.java
sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/filter/Filter.java
sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/filter/FormatFilter.java
sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/html/dom/AttributeList.java
sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/html/dom/DocumentHandler.java
Modified: sling/trunk/bundles/scripting/sightly/engine/pom.xml
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/scripting/sightly/engine/pom.xml?rev=1690914&r1=1690913&r2=1690914&view=diff
==============================================================================
--- sling/trunk/bundles/scripting/sightly/engine/pom.xml (original)
+++ sling/trunk/bundles/scripting/sightly/engine/pom.xml Tue Jul 14 12:32:41 2015
@@ -114,6 +114,14 @@
</execution>
</executions>
</plugin>
+ <plugin>
+ <groupId>org.apache.maven.plugins</groupId>
+ <artifactId>maven-javadoc-plugin</artifactId>
+ <configuration>
+ <stylesheet>maven</stylesheet>
+ <excludePackageNames>*.impl:*.internal:${site.javadoc.exclude}</excludePackageNames>
+ </configuration>
+ </plugin>
</plugins>
</build>
Modified: sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/ResourceResolution.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/ResourceResolution.java?rev=1690914&r1=1690913&r2=1690914&view=diff
==============================================================================
--- sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/ResourceResolution.java (original)
+++ sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/ResourceResolution.java Tue Jul 14 12:32:41 2015
@@ -26,8 +26,7 @@ import org.apache.sling.api.resource.Res
import org.apache.sling.api.resource.ResourceUtil;
/**
- * Utility class which used by the Sightly engine & extensions
- * to resolve resources
+ * Utility class which used by the Sightly engine & extensions to resolve resources.
*/
public final class ResourceResolution {
Modified: sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/compiled/VariableAnalyzer.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/compiled/VariableAnalyzer.java?rev=1690914&r1=1690913&r2=1690914&view=diff
==============================================================================
--- sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/compiled/VariableAnalyzer.java (original)
+++ sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/compiled/VariableAnalyzer.java Tue Jul 14 12:32:41 2015
@@ -45,7 +45,8 @@ public class VariableAnalyzer {
/**
* Mark the declaration of a variable in the Java code
- * @param originalName - the original name of the variable
+ * @param originalName the original name of the variable
+ * @param type the variable's type
* @return - a variable descriptor uniquely assigned to this variable
*/
public VariableDescriptor declareVariable(String originalName, Type type) {
@@ -59,7 +60,7 @@ public class VariableAnalyzer {
/**
* Declare a global variable. Redundant declarations are ignored
- * @param originalName - the original name of the variable
+ * @param originalName the original name of the variable
* @return a variable descriptor
*/
public VariableDescriptor declareGlobal(String originalName) {
@@ -76,7 +77,7 @@ public class VariableAnalyzer {
/**
* Mark this variable as a template
- * @param originalName - the original name of the variable
+ * @param originalName the original name of the variable
* @return a variable descriptor
*/
public VariableDescriptor declareTemplate(String originalName) {
Modified: sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/SightlyCompilerService.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/SightlyCompilerService.java?rev=1690914&r1=1690913&r2=1690914&view=diff
==============================================================================
--- sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/SightlyCompilerService.java (original)
+++ sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/SightlyCompilerService.java Tue Jul 14 12:32:41 2015
@@ -82,6 +82,7 @@ public class SightlyCompilerService {
* Compile the given markup source and feed it to the given backend
* @param source the HTML source code
* @param backend the backend that will process the command stream from the source
+ * @param renderContext the render context
*/
public void compile(String source, CompilerBackend backend, RenderContextImpl renderContext) {
initIfNeeded(renderContext);
Modified: sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/expression/ExpressionNode.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/expression/ExpressionNode.java?rev=1690914&r1=1690913&r2=1690914&view=diff
==============================================================================
--- sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/expression/ExpressionNode.java (original)
+++ sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/expression/ExpressionNode.java Tue Jul 14 12:32:41 2015
@@ -26,6 +26,8 @@ public interface ExpressionNode {
/**
* Accept a visitor to process this node.
* @param visitor The visitor
+ * @param <T> the type of the visitor
+ * @return the node evaluated by the visitor
*/
<T> T accept(NodeVisitor<T> visitor);
Modified: sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/frontend/ElementContext.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/frontend/ElementContext.java?rev=1690914&r1=1690913&r2=1690914&view=diff
==============================================================================
--- sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/frontend/ElementContext.java (original)
+++ sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/compiler/frontend/ElementContext.java Tue Jul 14 12:32:41 2015
@@ -26,6 +26,7 @@ import java.util.List;
import java.util.Map;
import org.apache.sling.scripting.sightly.impl.compiler.expression.Expression;
+import org.apache.sling.scripting.sightly.impl.html.dom.MarkupHandler;
import org.apache.sling.scripting.sightly.impl.plugin.PluginCallInfo;
import org.apache.sling.scripting.sightly.impl.plugin.PluginInvoke;
Modified: sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/engine/UnitLoader.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/engine/UnitLoader.java?rev=1690914&r1=1690913&r2=1690914&view=diff
==============================================================================
--- sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/engine/UnitLoader.java (original)
+++ sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/engine/UnitLoader.java Tue Jul 14 12:32:41 2015
@@ -89,6 +89,7 @@ public class UnitLoader {
* @param bindings the bindings
* @param renderContext the rendering context
* @return the render unit
+ * @throws Exception if the unit creation fails
*/
public RenderUnit createUnit(Resource scriptResource, Bindings bindings, RenderContextImpl renderContext) throws Exception {
ResourceMetadata resourceMetadata = scriptResource.getResourceMetadata();
Modified: sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/filter/Filter.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/filter/Filter.java?rev=1690914&r1=1690913&r2=1690914&view=diff
==============================================================================
--- sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/filter/Filter.java (original)
+++ sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/filter/Filter.java Tue Jul 14 12:32:41 2015
@@ -6,9 +6,9 @@
* to you under the Apache License, Version 2.0 (the
* "License"); you may not use this file except in compliance
* with the License. You may obtain a copy of the License at
- *
- * http://www.apache.org/licenses/LICENSE-2.0
- *
+ * <p/>
+ * http://www.apache.org/licenses/LICENSE-2.0
+ * <p/>
* Unless required by applicable law or agreed to in writing,
* software distributed under the License is distributed on an
* "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
@@ -29,7 +29,9 @@ public interface Filter extends Comparab
/**
* Transform the given expression
- * @param expression the original expression
+ *
+ * @param expression the original expression
+ * @param expressionContext the expression's context
* @return a transformed expression. If the filter is not applicable
* to the given expression, then the original expression shall be returned
*/
@@ -38,6 +40,7 @@ public interface Filter extends Comparab
/**
* The priority with which filters are applied. This establishes order between filters. Filters with
* lower priority are applied first.
+ *
* @return an integer representing the filter's priority
*/
int priority();
Modified: sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/filter/FormatFilter.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/filter/FormatFilter.java?rev=1690914&r1=1690913&r2=1690914&view=diff
==============================================================================
--- sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/filter/FormatFilter.java (original)
+++ sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/filter/FormatFilter.java Tue Jul 14 12:32:41 2015
@@ -35,7 +35,7 @@ import org.apache.sling.scripting.sightl
import org.apache.sling.scripting.sightly.render.RenderContext;
/**
- * Implementation for the format filter & runtime support.
+ * Implementation for the format filter & runtime support.
*/
@Component
@Service({Filter.class, RuntimeExtension.class})
Modified: sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/html/dom/AttributeList.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/html/dom/AttributeList.java?rev=1690914&r1=1690913&r2=1690914&view=diff
==============================================================================
--- sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/html/dom/AttributeList.java (original)
+++ sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/html/dom/AttributeList.java Tue Jul 14 12:32:41 2015
@@ -39,8 +39,9 @@ public interface AttributeList {
/**
* Return a flag indicating whether a specified attribute exists
- * @return <code>true</code> if the specified attribute exists,
- * <code>false</code> otherwise
+ *
+ * @param name the attribute's name
+ * @return <code>true</code> if the specified attribute exists, <code>false</code> otherwise
*/
boolean containsAttribute(String name);
Modified: sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/html/dom/DocumentHandler.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/html/dom/DocumentHandler.java?rev=1690914&r1=1690913&r2=1690914&view=diff
==============================================================================
--- sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/html/dom/DocumentHandler.java (original)
+++ sling/trunk/bundles/scripting/sightly/engine/src/main/java/org/apache/sling/scripting/sightly/impl/html/dom/DocumentHandler.java Tue Jul 14 12:32:41 2015
@@ -28,6 +28,11 @@ public interface DocumentHandler {
/**
* Receive notification of unparsed character data.
+ *
+ * @param ch the character buffer
+ * @param off the offset
+ * @param len the length of the unparsed character data
+ * @throws IOException if the characters cannot be processed
*/
void onCharacters(char[] ch, int off, int len) throws IOException;
@@ -39,6 +44,7 @@ public interface DocumentHandler {
* @param attList attribute list
* @param endSlash flag indicating whether the element is closed with
* an ending slash (xhtml-compliant)
+ * @throws IOException if the element cannot be processed
*/
void onStartElement(String name, AttributeList attList, boolean endSlash)
throws IOException;
@@ -46,17 +52,22 @@ public interface DocumentHandler {
/**
* Receive notification of the end of an element.
* @param name tag name
+ * @throws IOException if the element cannot be processed
*/
void onEndElement(String name)
throws IOException;
/**
* Receive notification of parsing start.
+ *
+ * @throws IOException if the parsing operation cannot start
*/
void onStart() throws IOException;
/**
* Receive notification of parsing end.
+ *
+ * @throws IOException if the parsing operation cannot end
*/
void onEnd() throws IOException;
}