# HG changeset patch
# User Christos Kotselidis <christos.kotselidis@oracle.com>
# Date 1374492483 -7200
# Node ID ba2769b3a4384b01f46a3539ed4a8422c5735805
# Parent  000ee2d0c518fe1cc3369155ea177f1b3031a590
Add Javadoc to G1ReferentFieldReadBarrier

diff -r 000ee2d0c518 -r ba2769b3a438 graal/com.oracle.graal.nodes/src/com/oracle/graal/nodes/G1ReferentFieldReadBarrier.java
--- a/graal/com.oracle.graal.nodes/src/com/oracle/graal/nodes/G1ReferentFieldReadBarrier.java	Sun Jul 21 22:13:21 2013 +0200
+++ b/graal/com.oracle.graal.nodes/src/com/oracle/graal/nodes/G1ReferentFieldReadBarrier.java	Mon Jul 22 13:28:03 2013 +0200
@@ -25,6 +25,12 @@
 import com.oracle.graal.api.meta.*;
 import com.oracle.graal.nodes.extended.*;
 
+/**
+ * The {@code G1ReferentFieldReadBarrier} is added when a read access is performed to the referent
+ * field of a {@link java.lang.ref.Reference} object (through a {@code LoadFieldNode} or an
+ * {@code UnsafeLoadNode}). The return value of the read is passed to the snippet implementing the
+ * read barrier and consequently is added to the SATB queue if the concurrent marker is enabled.
+ */
 public class G1ReferentFieldReadBarrier extends WriteBarrier implements DeoptimizingNode {
 
     @Input private ValueNode expectedObject;