This is an automated email from the ASF dual-hosted git repository. rombert pushed a commit to annotated tag org.apache.sling.scripting.sightly.compiler-1.0.0 in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-scripting-sightly-compiler.git
commit 01162696ba8b0c7c6f61b7f19f3d85db053bdc57 Author: Radu Cotescu <[email protected]> AuthorDate: Mon Sep 5 11:50:53 2016 +0000 trivial: corrected JavaDoc git-svn-id: https://svn.apache.org/repos/asf/sling/trunk/bundles/scripting/sightly/compiler@1759238 13f79535-47bb-0310-9956-ffa450edef68 --- pom.xml | 24 ------- .../sightly/compiler/RuntimeFunction.java | 78 ++++++++++------------ .../sightly/compiler/commands/CommandStream.java | 17 +++-- 3 files changed, 45 insertions(+), 74 deletions(-) diff --git a/pom.xml b/pom.xml index c43b694..cc8a66b 100644 --- a/pom.xml +++ b/pom.xml @@ -117,14 +117,6 @@ </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> - <plugin> <groupId>org.codehaus.mojo</groupId> <artifactId>findbugs-maven-plugin</artifactId> <version>3.0.3</version> @@ -147,22 +139,6 @@ </build> <!-- ======================================================================= --> - <!-- R E P O R T I N G --> - <!-- ======================================================================= --> - <reporting> - <plugins> - <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> - </reporting> - - <!-- ======================================================================= --> <!-- D E P E N D E N C I E S --> <!-- ======================================================================= --> <dependencies> diff --git a/src/main/java/org/apache/sling/scripting/sightly/compiler/RuntimeFunction.java b/src/main/java/org/apache/sling/scripting/sightly/compiler/RuntimeFunction.java index 46208e4..ea59f31 100644 --- a/src/main/java/org/apache/sling/scripting/sightly/compiler/RuntimeFunction.java +++ b/src/main/java/org/apache/sling/scripting/sightly/compiler/RuntimeFunction.java @@ -36,12 +36,11 @@ public final class RuntimeFunction { * <p> * The name of the {@link org.apache.sling.scripting.sightly.compiler.expression.nodes.RuntimeCall} function that will process string * formatting. The function will receive the following parameters: - * - * <ol> - * <li>the format String (e.g. 'Hello {0}, welcome to {1}')</li> - * <li>an array of objects that will replace the format placeholders</li> - * </ol> * </p> + * <ol> + * <li>the format String (e.g. 'Hello {0}, welcome to {1}')</li> + * <li>an array of objects that will replace the format placeholders</li> + * </ol> * <p> * For more details check https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#122-format. * </p> @@ -52,15 +51,14 @@ public final class RuntimeFunction { * <p> * The name of the {@link org.apache.sling.scripting.sightly.compiler.expression.nodes.RuntimeCall} function that will process * i18n. The function will receive the following parameters: - * - * <ol> - * <li>the String to translate</li> - * <li>optional: locale information</li> - * <li>optional: hint information</li> - * <li>optional (not part of the specification): basename information; for more details see - * {@link java.util.ResourceBundle#getBundle(String, Locale)}</li> - * </ol> * </p> + * <ol> + * <li>the String to translate</li> + * <li>optional: locale information</li> + * <li>optional: hint information</li> + * <li>optional (not part of the specification): basename information; for more details see + * {@link java.util.ResourceBundle#getBundle(String, Locale)}</li> + * </ol> * <p> * For more details check https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#123-i18n. * </p> @@ -71,12 +69,11 @@ public final class RuntimeFunction { * <p> * The name of the {@link org.apache.sling.scripting.sightly.compiler.expression.nodes.RuntimeCall} function that will process * join operations on arrays. The function will receive the following parameters: - * - * <ol> - * <li>the array of objects to join (e.g. [1, 2, 3])</li> - * <li>the join string (e.g. ';')</li> - * </ol> * </p> + * <ol> + * <li>the array of objects to join (e.g. [1, 2, 3])</li> + * <li>the join string (e.g. ';')</li> + * </ol> * <p> * For more details check https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#124-array-join. * </p> @@ -87,12 +84,11 @@ public final class RuntimeFunction { * <p> * The name of the {@link org.apache.sling.scripting.sightly.compiler.expression.nodes.RuntimeCall} function that will provide * URI manipulation support. The function will receive the following parameters: - * - * <ol> - * <li>optional: a URI string to process</li> - * <li>optional: a Map containing URI manipulation options</li> - * </ol> * </p> + * <ol> + * <li>optional: a URI string to process</li> + * <li>optional: a Map containing URI manipulation options</li> + * </ol> * <p> * For more details check https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#125-uri-manipulation. * </p> @@ -103,12 +99,11 @@ public final class RuntimeFunction { * <p> * The name of the {@link org.apache.sling.scripting.sightly.compiler.expression.nodes.RuntimeCall} function that will provide * XSS escaping and filtering support. The function will receive the following parameters: - * - * <ol> - * <li>the original string to escape / filter</li> - * <li>the context to be applied - see {@link org.apache.sling.scripting.sightly.compiler.expression.MarkupContext}</li> - * </ol> * </p> + * <ol> + * <li>the original string to escape / filter</li> + * <li>the context to be applied - see {@link org.apache.sling.scripting.sightly.compiler.expression.MarkupContext}</li> + * </ol> * <p> * For more details check https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#121-display-context. * </p> @@ -119,12 +114,11 @@ public final class RuntimeFunction { * <p> * The name of the {@link org.apache.sling.scripting.sightly.compiler.expression.nodes.RuntimeCall} function that will perform * script execution delegation. The function will receive the following parameters: - * - * <ol> - * <li>optional: the relative or absolute path of the script to execute</li> - * <li>optional: a Map of options to perform script include processing</li> - * </ol> * </p> + * <ol> + * <li>optional: the relative or absolute path of the script to execute</li> + * <li>optional: a Map of options to perform script include processing</li> + * </ol> * <p> * For more details about the supported options check * https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#228-include. @@ -136,12 +130,11 @@ public final class RuntimeFunction { * <p> * The name of the {@link org.apache.sling.scripting.sightly.compiler.expression.nodes.RuntimeCall} function that will perform * resource inclusion in the rendering process. The function will receive the following parameters: - * - * <ol> - * <li>optional: a relative or absolute path of the resource to be included</li> - * <li>optional: a Map containing the resource processing options</li> - * </ol> * </p> + * <ol> + * <li>optional: a relative or absolute path of the resource to be included</li> + * <li>optional: a Map containing the resource processing options</li> + * </ol> * <p> * For more details about the supported options check * https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#229-resource. @@ -153,12 +146,11 @@ public final class RuntimeFunction { * <p> * The name of the {@link org.apache.sling.scripting.sightly.compiler.expression.nodes.RuntimeCall} function that will provide * the support for loading Use-API objects. The function will receive the following parameters: - * - * <ol> - * <li>an identifier that allows to discover the Use-API object that needs to be loaded</li> - * <li>optional: a Map of the arguments that are passed to the Use-API object for initialisation or to provide context</li> - * </ol> * </p> + * <ol> + * <li>an identifier that allows to discover the Use-API object that needs to be loaded</li> + * <li>optional: a Map of the arguments that are passed to the Use-API object for initialisation or to provide context</li> + * </ol> * <p> * For more details check https://github.com/Adobe-Marketing-Cloud/htl-spec/blob/1.2/SPECIFICATION.md#221-use. * </p> diff --git a/src/main/java/org/apache/sling/scripting/sightly/compiler/commands/CommandStream.java b/src/main/java/org/apache/sling/scripting/sightly/compiler/commands/CommandStream.java index c6b151a..4d61453 100644 --- a/src/main/java/org/apache/sling/scripting/sightly/compiler/commands/CommandStream.java +++ b/src/main/java/org/apache/sling/scripting/sightly/compiler/commands/CommandStream.java @@ -27,20 +27,23 @@ import org.osgi.annotation.versioning.ProviderType; * This interface defines a stream to which {@link Command}s are pushed during the compilation of a HTL script by the {@link * org.apache.sling.scripting.sightly.compiler.SightlyCompiler}. Depending on how a consumer wants to use the stream there are several * options: - * <ul> - * <li>if the stream needs to be consumed immediately then a {@link CommandHandler} can be attached to the stream; the stream, - * in turn, will notify the handler for every command that has been pushed;</li> - * <li>if the stream can be consumed after the actual compilation there's no need to attach a {@link CommandHandler}, as the - * {@link Command}s that were written to the stream can be replayed in the exact order in which they have been pushed.</li> - * </ul> * </p> + * <ul> + * <li>if the stream needs to be consumed immediately then a {@link CommandHandler} can be attached to the stream; the stream, + * in turn, will notify the handler for every command that has been pushed;</li> + * <li>if the stream can be consumed after the actual compilation there's no need to attach a {@link CommandHandler}, as the + * {@link Command}s that were written to the stream can be replayed in the exact order in which they have been pushed.</li> + * </ul> */ @ProviderType public interface CommandStream { /** - * Registers a listening {@link CommandHandler} to the stream. The {@link CommandHandler} will be notified for every new {@link Command} + * Registers a listening {@link CommandHandler} to the stream. The {@link CommandHandler} will be notified for every new {@link + * Command} * pushed to this stream. + * + * @param handler the handler to attach to this stream */ void addHandler(CommandHandler handler); -- To stop receiving notification emails like this one, please contact "[email protected]" <[email protected]>.
