svn commit: r1751856 - in /sling/trunk/bundles/commons/compiler: ./ src/main/java/org/apache/sling/commons/compiler/

[cz...@apache.org]

Author: cziegeler
Date: Fri Jul  8 05:42:12 2016
New Revision: 1751856

URL: http://svn.apache.org/viewvc?rev=1751856&view=rev
Log:
Fix javadocs

Modified:
    sling/trunk/bundles/commons/compiler/pom.xml
    sling/trunk/bundles/commons/compiler/src/main/java/org/apache/sling/commons/compiler/CompilationResult.java
    sling/trunk/bundles/commons/compiler/src/main/java/org/apache/sling/commons/compiler/CompilationUnit.java
    sling/trunk/bundles/commons/compiler/src/main/java/org/apache/sling/commons/compiler/Options.java

Modified: sling/trunk/bundles/commons/compiler/pom.xml
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/commons/compiler/pom.xml?rev=1751856&r1=1751855&r2=1751856&view=diff
==============================================================================
--- sling/trunk/bundles/commons/compiler/pom.xml (original)
+++ sling/trunk/bundles/commons/compiler/pom.xml Fri Jul  8 05:42:12 2016
@@ -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>

Modified: sling/trunk/bundles/commons/compiler/src/main/java/org/apache/sling/commons/compiler/CompilationResult.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/commons/compiler/src/main/java/org/apache/sling/commons/compiler/CompilationResult.java?rev=1751856&r1=1751855&r2=1751856&view=diff
==============================================================================
--- sling/trunk/bundles/commons/compiler/src/main/java/org/apache/sling/commons/compiler/CompilationResult.java (original)
+++ sling/trunk/bundles/commons/compiler/src/main/java/org/apache/sling/commons/compiler/CompilationResult.java Fri Jul  8 05:42:12 2016
@@ -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.

Modified: sling/trunk/bundles/commons/compiler/src/main/java/org/apache/sling/commons/compiler/CompilationUnit.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/commons/compiler/src/main/java/org/apache/sling/commons/compiler/CompilationUnit.java?rev=1751856&r1=1751855&r2=1751856&view=diff
==============================================================================
--- sling/trunk/bundles/commons/compiler/src/main/java/org/apache/sling/commons/compiler/CompilationUnit.java (original)
+++ sling/trunk/bundles/commons/compiler/src/main/java/org/apache/sling/commons/compiler/CompilationUnit.java Fri Jul  8 05:42:12 2016
@@ -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;

Modified: sling/trunk/bundles/commons/compiler/src/main/java/org/apache/sling/commons/compiler/Options.java
URL: http://svn.apache.org/viewvc/sling/trunk/bundles/commons/compiler/src/main/java/org/apache/sling/commons/compiler/Options.java?rev=1751856&r1=1751855&r2=1751856&view=diff
==============================================================================
--- sling/trunk/bundles/commons/compiler/src/main/java/org/apache/sling/commons/compiler/Options.java (original)
+++ sling/trunk/bundles/commons/compiler/src/main/java/org/apache/sling/commons/compiler/Options.java Fri Jul  8 05:42:12 2016
@@ -86,22 +86,33 @@ public class Options extends HashMap<Str
 
     /**
      * 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);