fix and document

java/api/src/main/java/org/ray/api/annotation/RayRemote.java

@@ -7,8 +7,8 @@
 import java.lang.annotation.Target;
 
 /**
- * Defines a remote function (when used on a method)
- * or actor (when used on a class).
+ * Defines a remote function (when used on a method),
+ * or an actor (when used on a class).
  */
 @Documented
 @Retention(RetentionPolicy.RUNTIME)
@@ -20,5 +20,5 @@
    * for this task or for the lifetime of the actor.
    * @return an array of custom resource items.
    */
-  ResourceItem[] resources() default {@ResourceItem()};
+  ResourceItem[] resources() default {};
 }

java/api/src/main/java/org/ray/api/annotation/ResourceItem.java

@@ -18,7 +18,7 @@
   /**
    * Name of this resource, must not be null or empty.
    */
-  String name() default "";
+  String name();
 
   /**
    * Quantity of this resource.

java/cli/src/main/java/org/ray/cli/RayCli.java

@@ -162,9 +162,6 @@ private static void submit(CommandSubmit cmdSubmit, String configPath) throws Ex
         cmdSubmit.packageZip.lastIndexOf('/') + 1,
         cmdSubmit.packageZip.lastIndexOf('.'));
 
-    //final RemoteFunctionManager functionManager = AbstractRayRuntime
-    //    .getInstance().getRemoteFunctionManager();
-
     UniqueId resourceId = functionManager.registerResource(zip);
 
     // Init RayLog before using it.
@@ -181,7 +178,7 @@ private static void submit(CommandSubmit cmdSubmit, String configPath) throws Ex
     String appDir = "/tmp/" + cmdSubmit.className;
     String extPath = appDir + "/" + packageName;
     if (!FileUtil.createDir(extPath, false)) {
-      throw new RuntimeException("createActor dir " + extPath + " failed ");
+      throw new RuntimeException("create dir " + extPath + " failed ");
     }
 
     ZipFile zipFile = new ZipFile(cmdSubmit.packageZip);
@@ -206,8 +203,6 @@ private static void submit(CommandSubmit cmdSubmit, String configPath) throws Ex
     RayLog.rapp.debug("Find app class path  " + additionalClassPath);
 
     // Start driver process.
-    //RunManager runManager = new RunManager(params, AbstractRayRuntime.getInstance().getPaths(),
-    //  AbstractRayRuntime.configReader);
     RunManager runManager = new RunManager(params, paths, config);
     Process proc = runManager.startDriver(
         DefaultDriver.class.getName(),

java/common/src/main/java/org/ray/util/FileUtil.java

@@ -119,7 +119,7 @@ public static byte[] fileToBytes(String name) throws IOException {
   public static String getCanonicalDirectory(final String rawDir) throws IOException {
     String dir = rawDir.length() == 0 ? "." : rawDir;
 
-    // createActor working dir if necessary
+    // create working dir if necessary
     File dd = new File(dir);
     if (!dd.exists()) {
       dd.mkdirs();

java/runtime-common/src/main/java/org/ray/core/AbstractRayRuntime.java

@@ -389,7 +389,7 @@ private static Object createLocalActor(UniqueId actorId, String className) {
   }
 
   /**
-   * generate the return ids of a task.
+   * Generate the return ids of a task.
    */
   private UniqueId[] genReturnIds(UniqueId taskId, int numReturns) {
     UniqueId[] ret = new UniqueId[numReturns];
@@ -399,6 +399,15 @@ private UniqueId[] genReturnIds(UniqueId taskId, int numReturns) {
     return ret;
   }
 
+  /**
+   * Create the task specification.
+   * @param func The target remote function.
+   * @param actor The actor handle. If the task is not an actor task, actor id must be NIL.
+   * @param args The arguments for the remote function.
+   * @param actorClassForCreation If the task is a actor creation task, the argument should be
+   *     the actor class. Otherwise, it should be null.
+   * @return A TaskSpec object.
+   */
   private TaskSpec createTaskSpec(RayFunc func, RayActorImpl actor, Object[] args,
       Class actorClassForCreation) {
     final TaskSpec current = WorkerContext.currentTask();

java/runtime-common/src/main/java/org/ray/core/LocalFunctionManager.java

@@ -94,7 +94,7 @@ RayMethod getTaskMethod(UniqueId methodId, String className) {
       RayTaskMethods tasks = taskMethods.get(className);
       if (tasks == null) {
         tasks = RayTaskMethods.fromClass(className, classLoader);
-        RayLog.core.info("createActor RayTaskMethods:" + tasks);
+        RayLog.core.info("create RayTaskMethods:" + tasks);
         taskMethods.put(className, tasks);
       }
       RayMethod m = tasks.functions.get(methodId);
@@ -113,7 +113,7 @@ private RayMethod getActorMethod(UniqueId methodId, String className, boolean is
       RayActorMethods actor = actors.get(className);
       if (actor == null) {
         actor = RayActorMethods.fromClass(className, classLoader);
-        RayLog.core.info("createActor RayActorMethods:" + actor);
+        RayLog.core.info("create RayActorMethods:" + actor);
         actors.put(className, actor);
       }
       return isStatic ? actor.staticFunctions.get(methodId) : actor.functions.get(methodId);

java/runtime-common/src/main/java/org/ray/core/UniqueIdHelper.java

@@ -6,9 +6,11 @@
 import org.ray.api.id.UniqueId;
 
 
-//
-// Helper methods for UniqueId. These are the same as the helper functions in src/ray/id.h.
-//
+/**
+ * Helper method for UniqueId.
+ * Note: any changes to these methods must be synced with C++ helper functions
+ * in src/ray/id.h
+ */
 public class UniqueIdHelper {
   public static final int OBJECT_INDEX_POS = 0;
   public static final int OBJECT_INDEX_LENGTH = 4;

java/runtime-native/src/main/java/org/ray/spi/FileStoreLink.java

@@ -60,7 +60,7 @@ public interface FileStoreLink {
   /**
    * Create an FSDataOutputStream at the indicated Path. Files are overwritten by default.
    *
-   * @param f the file to createActor
+   * @param f the file to create
    */
   DataOutputStream create(String f, boolean overwrite);
 

java/runtime-native/src/main/java/org/ray/spi/impl/PlasmaOutOfMemoryException.java

@@ -2,7 +2,7 @@
 
 /**
  * This exception is raised if the object could not be created because the plasma store is unable to
- * evict enough objects to createActor room for it.
+ * evict enough objects to create room for it.
  */
 public class PlasmaOutOfMemoryException extends Exception {