commons-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ebo...@apache.org
Subject svn commit: r1589374 - /commons/proper/bcel/trunk/src/main/java/org/apache/bcel/verifier/VerificationResult.java
Date Wed, 23 Apr 2014 11:30:18 GMT
Author: ebourg
Date: Wed Apr 23 11:30:18 2014
New Revision: 1589374

URL: http://svn.apache.org/r1589374
Log:
Added javadoc links to the constants defined in VerificationResult

Modified:
    commons/proper/bcel/trunk/src/main/java/org/apache/bcel/verifier/VerificationResult.java

Modified: commons/proper/bcel/trunk/src/main/java/org/apache/bcel/verifier/VerificationResult.java
URL: http://svn.apache.org/viewvc/commons/proper/bcel/trunk/src/main/java/org/apache/bcel/verifier/VerificationResult.java?rev=1589374&r1=1589373&r2=1589374&view=diff
==============================================================================
--- commons/proper/bcel/trunk/src/main/java/org/apache/bcel/verifier/VerificationResult.java
(original)
+++ commons/proper/bcel/trunk/src/main/java/org/apache/bcel/verifier/VerificationResult.java
Wed Apr 23 11:30:18 2014
@@ -23,7 +23,6 @@ package org.apache.bcel.verifier;
  *
  * @version $Id$
  * @author Enver Haase
- *
  */
 public class VerificationResult {
 
@@ -32,28 +31,34 @@ public class VerificationResult {
      * This happens if some earlier verification pass did not return VERIFIED_OK.
      */
     public static final int VERIFIED_NOTYET = 0;
+
     /** Constant to indicate verification was passed. */
     public static final int VERIFIED_OK = 1;
+
     /** Constant to indicate verfication failed. */
     public static final int VERIFIED_REJECTED = 2;
+
     /**
      * This string is the canonical message for verifications that have not been tried yet.
-     * This happens if some earlier verification pass did not return VERIFIED_OK.
+     * This happens if some earlier verification pass did not return {@link #VERIFIED_OK}.
      */
     private static final String VERIFIED_NOTYET_MSG = "Not yet verified.";
+
     /** This string is the canonical message for passed verification passes. */
     private static final String VERIFIED_OK_MSG = "Passed verification.";
+
     /**
      * Canonical VerificationResult for not-yet-tried verifications.
-     * This happens if some earlier verification pass did not return VERIFIED_OK.
+     * This happens if some earlier verification pass did not return {@link #VERIFIED_OK}.
      */
-    public static final VerificationResult VR_NOTYET = new VerificationResult(VERIFIED_NOTYET,
-            VERIFIED_NOTYET_MSG);
+    public static final VerificationResult VR_NOTYET = new VerificationResult(VERIFIED_NOTYET,
VERIFIED_NOTYET_MSG);
+
     /** Canonical VerificationResult for passed verifications. */
-    public static final VerificationResult VR_OK = new VerificationResult(VERIFIED_OK,
-            VERIFIED_OK_MSG);
+    public static final VerificationResult VR_OK = new VerificationResult(VERIFIED_OK, VERIFIED_OK_MSG);
+
     /** The numeric status. */
     private int numeric;
+
     /** The detailed message. */
     private String detailMessage;
 
@@ -65,7 +70,10 @@ public class VerificationResult {
     }
 
 
-    /** Returns one one the VERIFIED_OK, VERIFIED_NOTYET, VERIFIED_REJECTED constants. */
+    /**
+     * Returns one one the {@link #VERIFIED_OK}, {@link #VERIFIED_NOTYET},
+     * {@link #VERIFIED_REJECTED} constants.
+     */
     public int getStatus() {
         return numeric;
     }
@@ -77,7 +85,8 @@ public class VerificationResult {
     }
 
 
-    /** @return a hash code value for the object.
+    /**
+     * @return a hash code value for the object.
      */
     @Override
     public int hashCode() {



Mime
View raw message