# HG changeset patch
# User Jaroslav Tulach <jaroslav.tulach@oracle.com>
# Date 1440488330 -7200
# Node ID 3b2ae36a942ff2f61da7f377c8fc0e48dfa5babd
# Parent  7ee578004be76c1d9b5db185948e31444b553405
Improving documentation of READ and WRITE Message

diff -r 7ee578004be7 -r 3b2ae36a942f truffle/com.oracle.truffle.api.interop/src/com/oracle/truffle/api/interop/Message.java
--- a/truffle/com.oracle.truffle.api.interop/src/com/oracle/truffle/api/interop/Message.java	Mon Aug 24 09:07:43 2015 +0200
+++ b/truffle/com.oracle.truffle.api.interop/src/com/oracle/truffle/api/interop/Message.java	Tue Aug 25 09:38:50 2015 +0200
@@ -34,7 +34,11 @@
  */
 public abstract class Message {
     /**
-     * Message to read a field.
+     * Message to read an object field. The
+     * {@link Factory#access(com.oracle.truffle.api.interop.Message) target} created for this
+     * message accepts single {@link ForeignAccess#getArguments(com.oracle.truffle.api.frame.Frame)
+     * argument} identifying a field to read - e.g. either {@link String} or an {@link Integer} - if
+     * access to an array at particular index is requested.
      */
     public static final Message READ = Read.INSTANCE;
 
@@ -46,7 +50,12 @@
     public static final Message UNBOX = Unbox.INSTANCE;
 
     /**
-     * Message to write a field.
+     * Message to write a field. The {@link Factory#access(com.oracle.truffle.api.interop.Message)
+     * target} created for this message accepts two
+     * {@link ForeignAccess#getArguments(com.oracle.truffle.api.frame.Frame) arguments}. The first
+     * one identifies a field to read - e.g. either {@link String} or an {@link Integer} - if access
+     * to an array at particular index is requested. The second one is the value to assign to such
+     * field.
      */
     public static Message WRITE = Write.INSTANCE;