svn commit: r1379614 - /jmeter/trunk/src/core/org/apache/jmeter/threads/TestCompiler.java

[pm...@apache.org]

Author: pmouawad
Date: Fri Aug 31 21:14:02 2012
New Revision: 1379614

URL: http://svn.apache.org/viewvc?rev=1379614&view=rev
Log:
Document PARING from sebb comment on mailing list:
http://mail-archives.apache.org/mod_mbox/jmeter-dev/201208.mbox/%3CCAOGo0VZFKGKGu_VS2RqinWW0ZC%2BXSYDc4y3_Qj_nKqE8wq8iuw%40mail.gmail.com%3E

Modified:
    jmeter/trunk/src/core/org/apache/jmeter/threads/TestCompiler.java

Modified: jmeter/trunk/src/core/org/apache/jmeter/threads/TestCompiler.java
URL: http://svn.apache.org/viewvc/jmeter/trunk/src/core/org/apache/jmeter/threads/TestCompiler.java?rev=1379614&r1=1379613&r2=1379614&view=diff
==============================================================================
--- jmeter/trunk/src/core/org/apache/jmeter/threads/TestCompiler.java (original)
+++ jmeter/trunk/src/core/org/apache/jmeter/threads/TestCompiler.java Fri Aug 31 21:14:02 2012
@@ -70,9 +70,11 @@ public class TestCompiler implements Has
 
     public static final boolean IS_USE_STATIC_SET = JMeterUtils.getPropDefault(USE_STATIC_SET, USE_STATIC_SET_DEFAULT);
 
-    /*
+    /**
      * This set keeps track of which ObjectPairs have been seen.
-     * Its purpose is not entirely clear (please document if you know!) but it is needed,..
+     * It seems to be used to prevent adding a child to a parent if the child has already been added.
+     * If the ObjectPair (child, parent) is present, then the child has been added.
+     * Otherwise, the child is added to the parent and the pair is added to the Set.
      */
     private static final Set<ObjectPair> PAIRING = new HashSet<ObjectPair>();