You are viewing a plain text version of this content. The canonical link for it is here.
Posted to scm-commits@maven.apache.org by ca...@apache.org on 2006/03/31 01:38:32 UTC

svn commit: r390284 - in /maven/scm/trunk/maven-scm-test/src/main/java/org/apache/maven/scm: manager/ScmManagerStub.java repository/ScmRepositoryStub.java

Author: carlos
Date: Thu Mar 30 15:38:30 2006
New Revision: 390284

URL: http://svn.apache.org/viewcvs?rev=390284&view=rev
Log:
Improve javadocs

Modified:
    maven/scm/trunk/maven-scm-test/src/main/java/org/apache/maven/scm/manager/ScmManagerStub.java
    maven/scm/trunk/maven-scm-test/src/main/java/org/apache/maven/scm/repository/ScmRepositoryStub.java

Modified: maven/scm/trunk/maven-scm-test/src/main/java/org/apache/maven/scm/manager/ScmManagerStub.java
URL: http://svn.apache.org/viewcvs/maven/scm/trunk/maven-scm-test/src/main/java/org/apache/maven/scm/manager/ScmManagerStub.java?rev=390284&r1=390283&r2=390284&view=diff
==============================================================================
--- maven/scm/trunk/maven-scm-test/src/main/java/org/apache/maven/scm/manager/ScmManagerStub.java (original)
+++ maven/scm/trunk/maven-scm-test/src/main/java/org/apache/maven/scm/manager/ScmManagerStub.java Thu Mar 30 15:38:30 2006
@@ -28,7 +28,8 @@
 import org.apache.maven.scm.repository.UnknownRepositoryStructure;
 
 /**
- * Stub for ScmManager
+ * Stub implementation of ScmManager for unit testing purposes. It allows setting the expected results that the different methods will return.
+ * More information about Stubs on <a href="http://martinfowler.com/bliki/TestDouble.html">Martin Fowler's TestDouble</a>
  * 
  * @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>
  * @version $Id$
@@ -40,7 +41,7 @@
     private ScmRepository scmRepository;
 
     private ScmProvider scmProvider;
-    
+
     private List messages;
 
     /**
@@ -50,7 +51,7 @@
     {
         setScmRepository( new ScmRepositoryStub() );
         setScmProvider( new ScmProviderStub() );
-        setMessages( new ArrayList(0) );
+        setMessages( new ArrayList( 0 ) );
     }
 
     public void setScmProvider( ScmProvider scmProvider )

Modified: maven/scm/trunk/maven-scm-test/src/main/java/org/apache/maven/scm/repository/ScmRepositoryStub.java
URL: http://svn.apache.org/viewcvs/maven/scm/trunk/maven-scm-test/src/main/java/org/apache/maven/scm/repository/ScmRepositoryStub.java?rev=390284&r1=390283&r2=390284&view=diff
==============================================================================
--- maven/scm/trunk/maven-scm-test/src/main/java/org/apache/maven/scm/repository/ScmRepositoryStub.java (original)
+++ maven/scm/trunk/maven-scm-test/src/main/java/org/apache/maven/scm/repository/ScmRepositoryStub.java Thu Mar 30 15:38:30 2006
@@ -19,7 +19,8 @@
 import org.apache.maven.scm.provider.ScmProviderRepositoryStub;
 
 /**
- * Stub for ScmRepository
+ * Stub for ScmRepository for unit testing purposes.
+ * More information about Stubs on <a href="http://martinfowler.com/bliki/TestDouble.html">Martin Fowler's TestDouble</a>
  *  
  * @author <a href="mailto:carlos@apache.org">Carlos Sanchez</a>
  * @version $Id$
@@ -30,7 +31,6 @@
 
     /**
      * Creates a new stub with a new ScmProviderRepositoryStub as scmProviderRepository
-     *
      */
     public ScmRepositoryStub( )
     {