This is an automated email from the ASF dual-hosted git repository. rombert pushed a commit to branch master in repository https://gitbox.apache.org/repos/asf/sling-org-apache-sling-commons-compiler.git
commit 56c6c925643c5ccd81bf921b98a13ee7f0d534de Author: Carsten Ziegeler <[email protected]> AuthorDate: Fri Jul 8 05:42:12 2016 +0000 Fix javadocs git-svn-id: https://svn.apache.org/repos/asf/sling/trunk@1751856 13f79535-47bb-0310-9956-ffa450edef68 --- pom.xml | 6 +----- .../org/apache/sling/commons/compiler/CompilationResult.java | 3 ++- .../org/apache/sling/commons/compiler/CompilationUnit.java | 6 ++++-- src/main/java/org/apache/sling/commons/compiler/Options.java | 11 +++++++++++ 4 files changed, 18 insertions(+), 8 deletions(-) diff --git a/pom.xml b/pom.xml index c5e1500..3ffc2e3 100644 --- a/pom.xml +++ b/pom.xml @@ -75,10 +75,6 @@ </instructions> </configuration> </plugin> - </plugins> - </build> - <reporting> - <plugins> <plugin> <groupId>org.apache.maven.plugins</groupId> <artifactId>maven-javadoc-plugin</artifactId> @@ -89,7 +85,7 @@ </configuration> </plugin> </plugins> - </reporting> + </build> <dependencies> <dependency> diff --git a/src/main/java/org/apache/sling/commons/compiler/CompilationResult.java b/src/main/java/org/apache/sling/commons/compiler/CompilationResult.java index 4a72cbd..6011cbd 100644 --- a/src/main/java/org/apache/sling/commons/compiler/CompilationResult.java +++ b/src/main/java/org/apache/sling/commons/compiler/CompilationResult.java @@ -44,7 +44,7 @@ public interface CompilationResult { /** * Was a compilation required or were all classes recent? - * @return <code>true>/code> if classes were compiled. + * @return {@code true} if classes were compiled. */ boolean didCompile(); @@ -55,6 +55,7 @@ public interface CompilationResult { * or if a class loader writer has been used in combination * with a class loader that is not able to load the classes * written by the class loader writer. + * @param className The class name of the compiled class. * @return The compiled class * @throws ClassNotFoundException If the class could not be found * or compilation failed. diff --git a/src/main/java/org/apache/sling/commons/compiler/CompilationUnit.java b/src/main/java/org/apache/sling/commons/compiler/CompilationUnit.java index 415c237..289d791 100644 --- a/src/main/java/org/apache/sling/commons/compiler/CompilationUnit.java +++ b/src/main/java/org/apache/sling/commons/compiler/CompilationUnit.java @@ -26,8 +26,10 @@ import java.io.Reader; public interface CompilationUnit { /** - * Return an input stream for the contents. - * The compiler will close this stream in all cases! + * Return a reader for the contents. + * The compiler will close this reader in all cases! + * @return The reader. + * @throws IOException If the source can't be read. */ Reader getSource() throws IOException; diff --git a/src/main/java/org/apache/sling/commons/compiler/Options.java b/src/main/java/org/apache/sling/commons/compiler/Options.java index 302c8c2..ee6048a 100644 --- a/src/main/java/org/apache/sling/commons/compiler/Options.java +++ b/src/main/java/org/apache/sling/commons/compiler/Options.java @@ -86,22 +86,33 @@ public class Options extends HashMap<String, Object> { /** * Create a new options object based on an existing one. + * @param options The base options. */ public Options(final Options options) { super(options); } + /** + * Get the source version. + * @return The source version. + */ public String getSourceVersion() { return (String) this.get(KEY_SOURCE_VERSION); } /** + * Get the target version. + * @return The target version * @since 2.0 */ public String getTargetVersion() { return (String) this.get(KEY_TARGET_VERSION); } + /** + * Should debug info be generated? + * @return {@code true} if debug info should be generated. + */ public boolean isGenerateDebugInfo() { if ( this.get(KEY_GENERATE_DEBUG_INFO) != null ) { return (Boolean) this.get(KEY_GENERATE_DEBUG_INFO); -- To stop receiving notification emails like this one, please contact "[email protected]" <[email protected]>.
