You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by se...@apache.org on 2013/08/18 16:24:59 UTC
svn commit: r1515118 - in /commons/proper/jci/trunk/core/src/main/java/org/apache/commons/jci: problems/CompilationProblem.java utils/ConversionUtils.java

Author: sebb
Date: Sun Aug 18 14:24:59 2013
New Revision: 1515118

URL: http://svn.apache.org/r1515118
Log:
Javadoc fixes

Modified:
    commons/proper/jci/trunk/core/src/main/java/org/apache/commons/jci/problems/CompilationProblem.java
    commons/proper/jci/trunk/core/src/main/java/org/apache/commons/jci/utils/ConversionUtils.java

Modified: commons/proper/jci/trunk/core/src/main/java/org/apache/commons/jci/problems/CompilationProblem.java
URL: http://svn.apache.org/viewvc/commons/proper/jci/trunk/core/src/main/java/org/apache/commons/jci/problems/CompilationProblem.java?rev=1515118&r1=1515117&r2=1515118&view=diff
==============================================================================
--- commons/proper/jci/trunk/core/src/main/java/org/apache/commons/jci/problems/CompilationProblem.java (original)
+++ commons/proper/jci/trunk/core/src/main/java/org/apache/commons/jci/problems/CompilationProblem.java Sun Aug 18 14:24:59 2013
@@ -28,21 +28,21 @@ public interface CompilationProblem {
      * is the problem an error and compilation cannot continue
      * or just a warning and compilation can proceed
      * 
-     * @return
+     * @return true if the problem is an error
      */
     boolean isError();
 
     /**
      * name of the file where the problem occurred
      * 
-     * @return
+     * @return name of the file where the problem occurred
      */
     String getFileName();
 
     /**
      * position of where the problem starts in the source code
      * 
-     * @return
+     * @return position of where the problem starts in the source code
      */
     int getStartLine();
     int getStartColumn();
@@ -50,7 +50,7 @@ public interface CompilationProblem {
     /**
      * position of where the problem stops in the source code
      * 
-     * @return
+     * @return position of where the problem stops in the source code
      */
     int getEndLine();
     int getEndColumn();
@@ -58,7 +58,7 @@ public interface CompilationProblem {
     /**
      * the description of the problem
      * 
-     * @return
+     * @return the description of the problem
      */
     String getMessage();
 

Modified: commons/proper/jci/trunk/core/src/main/java/org/apache/commons/jci/utils/ConversionUtils.java
URL: http://svn.apache.org/viewvc/commons/proper/jci/trunk/core/src/main/java/org/apache/commons/jci/utils/ConversionUtils.java?rev=1515118&r1=1515117&r2=1515118&view=diff
==============================================================================
--- commons/proper/jci/trunk/core/src/main/java/org/apache/commons/jci/utils/ConversionUtils.java (original)
+++ commons/proper/jci/trunk/core/src/main/java/org/apache/commons/jci/utils/ConversionUtils.java Sun Aug 18 14:24:59 2013
@@ -84,7 +84,7 @@ public final class ConversionUtils {
      * a/b/c.java -> a/b/c.java
      * a\b\c.java -> a/b/c.java
      * @param pFileName
-     * @return
+     * @return the converted name
      */
     public static String getResourceNameFromFileName( final String pFileName ) {
         if ('/' == File.separatorChar) {